Hologres インスタンス詳細の GetInstance API 概要 - Hologres - Alibaba Cloud - Hologres

インスタンスの詳細を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hologram:GetInstance

get

*インスタンス。

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

GET /api/v1/instances/{instanceId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	任意	インスタンスの ID。このパラメーターは必須です。	hgprecn-cn-i7m2v08uu00a

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	インスタンス情報。
InstanceChargeType	string	インスタンスの課金方法。列挙値: PostPaid : 従量課金。 PrePaid : サブスクリプション。	PrePaid
CommodityCode	string	商品コード。列挙値: hologram_maxcomputeAccelerate_public_cn : 中国サイト / Lakehouse アクセラレーション。 hologram_combo_public_cn : 中国サイト / サブスクリプション。 hologram_prepay_public_intl : 国際サイト / サブスクリプション。 hologram_storage_dp_cn : 中国サイト / ストレージ控除プラン。 hologram_postpay_public_cn : 中国サイト / 従量課金。 hologram_postpay_public_intl : 国際サイト / 従量課金。 hologram_maxcomputeAccelerate_public_intl : 国際サイト / Lakehouse アクセラレーション。 hologram_cu_dp_cn : 中国サイト / コンピューティング控除プラン。	hologram_combo_public_cn
Cpu	integer	CPU コア数。	32
CreationTime	string	作成時間。時間は協定世界時 (UTC) の ISO 8601 標準形式です。	2021-02-03T13:06:06Z
Disk	string	標準ストレージサイズ。単位: GB。	500
Endpoints	array<object>	エンドポイントのリスト。
	object	エンドポイントの詳細。
Endpoint	string	エンドポイント。	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	ネットワークタイプ。列挙値: VPCSingleTunnel : VPC。 Intranet : 内部ネットワーク。 VPCAnyTunnel : 新しいインスタンスではサポートされていません。 Internet : インターネット。	Internet
Enabled	boolean	ネットワークが有効かどうかを示します。列挙値: true : 有効。 false : 無効。	true
VSwitchId	string	vSwitch ID。	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	VPC ID。	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	VPC インスタンスの ID。	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	一部のレガシインスタンスでは、AnyTunnel と SingleTunnel の両方が有効になっています。AnyTunnel から SingleTunnel に切り替える場合、両方のエンドポイントが保持されます。このフィールドには追加のエンドポイントが格納されます。	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	有効期限時間。時間は協定世界時 (UTC) の ISO 8601 標準形式です。従量課金インスタンスには有効期限時間はありません。	2021-02-03T13:06:06Z
InstanceId	string	インスタンスの ID。	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	インスタンス名。名前の長さは 2～64 文字です。英字または漢字は 1 文字としてカウントされます。	test
InstanceType	string	インスタンスタイプ。列挙値: Warehouse : コンピューティンググループ。 Follower : 読み取り専用セカンダリインスタンス。 Standard : 標準。 Serverless : サーバーレス。 Shared : 共有。	標準
Memory	integer	メモリサイズ。単位: GB。	128
InstanceOwner	string	インスタンス所有者。	12345678900000
InstanceStatus	string	インスタンスステータス。列挙値: Creating : 作成中。 Running : 実行中。 Suspended : 停止中。 Allocating : 処理中。	Running
Version	string	インスタンスのバージョン。	r1.3.37
SuspendReason	string	停止理由。列挙値: Indebet : 支払い遅延。 Manual : 手動で停止。 Overdue : サブスクリプションの有効期限切れ。	Manual
Tags	array<object>	インスタンスタグ。
	object	タグの詳細。
Key	string	タグキー。	tag
Value	string	タグ値。	値
LeaderInstanceId	string	プライマリインスタンスの ID。	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	データレイクアクセラレーションが有効かどうかを示します。	true
ResourceGroupId	string	リソースグループの ID。	rg-aekzuq7hpybze2i
ComputeNodeCount	integer	コンピューティングノード数。シングルノードの標準的な構成は 16 コア、32 GB のメモリです。	2
ZoneId	string	ゾーンの ID。	cn-hangzhou-h
ColdStorage	integer	コールドストレージ容量。単位: GB。SSD はホットストレージ (標準ストレージ) に相当します。HDD はコールドストレージに相当します。	800
AutoRenewal	string	自動更新が有効かどうかを示します。列挙値: true : 自動更新は有効です。 false : 自動更新は無効です。	true
GatewayCount	integer	ゲートウェイノード数。	2
GatewayCpu	integer	ゲートウェイの CPU リソース。単位: コア。	4
GatewayMemory	integer	ゲートウェイのメモリリソース。単位: GB。	16
RegionId	string	リージョンの ID。	cn-hangzhou
ReplicaRole	string	ディザスタリカバリインスタンスのロール。有効な値: Active: プライマリディザスタリカバリインスタンス。 Passive: スタンバイディザスタリカバリインスタンス。 PreActive: 望ましい状態に達していないプライマリディザスタリカバリインスタンス。	Active
EnableServerless	boolean	ServerlessComputing が有効かどうかを示します。列挙値: true : 有効。 false : 無効。	true
StorageType	string	ストレージタイプ。有効な値: redundant: 3 ゾーン Deployment。 local: シングルゾーン Deployment。	redundant
EnableSSL	boolean	SSL が有効かどうかを示します。	true
Success	boolean	リクエスト結果。リクエストで例外が発生したかどうかを示します。これはビジネスロジックとは関係ありません。	true
ErrorCode	string	エラーコード。	null
ErrorMessage	string	エラーメッセージ。	null
HttpStatusCode	string	HTTP 状態コード。	200

例

成功レスポンス

JSONJSON

{
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。