Hologres:ListInstances - Hologres - Alibaba Cloud - Hologres - Alibaba Cloud ドキュメントセンター

インスタンスのリストを取得します。

今すぐお試しください

この 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:ListInstances

list

*インスタンス。

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

なし

リクエスト構文

POST /api/v1/instances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。
resourceGroupId	string	任意	リソースグループの ID。	rg-acfmvscak73zmby
tag	array<object>	任意	インスタンスのタグ。
	object	任意	タグの詳細。
key	string	任意	タグキー。	mytag
value	string	任意	タグ値。	value
cmsInstanceType	string	任意	CloudMonitor のインスタンスタイプ。有効な値: standard follower mc-acceleration warehouse high-memory serverless 説明これは CloudMonitor 用です。	standard

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	D1303CD4-AA70-5998-8025-F55B22C50840
InstanceList	array<object>	インスタンスのリスト。
	array<object>	インスタンスの詳細。
CommodityCode	string	商品コード。ユーザーセンターのプロダクト詳細コードと同じです。	hologram_postpay_public_cn
CreationTime	string	作成時間。時間は協定世界時 (UTC) の ISO 8601 フォーマットです。	2022-12-16T02:24:05Z
ExpirationTime	string	有効期限。時間は協定世界時 (UTC) の ISO 8601 フォーマットです。	2023-05-04T16:00:00.000Z
InstanceId	string	インスタンスの ID。	hgpostcn-cn-aaab9ad2d8fb
InstanceName	string	インスタンス名。	test_instance
InstanceStatus	string	インスタンスステータス。列挙値: Creating : 作成中。 Running : 正常に実行中。 Suspended : 停止中。 Allocating : 処理中。	Running
InstanceType	string	インスタンスタイプ。列挙値: Warehouse : コンピュートグループタイプ。 Follower : 読み取り専用フォロワーインスタンス。 Standard : 標準タイプ。 Serverless : サーバーレスタイプ。 Shared : 共有タイプ。	Standard
Tags	array<object>	タグのリスト。
	object	タグの詳細。
Key	string	タグキー。	tag
Value	string	タグ値。	value
InstanceChargeType	string	インスタンスの課金方法。列挙値: PostPaid : 従量課金。 PrePaid : サブスクリプション。	PrePaid
LeaderInstanceId	string	プライマリインスタンスの ID。	hgprecn-cn-2r42sqvxm006
SuspendReason	string	停止の理由。	Manual
EnableHiveAccess	string	データレイクハウスエディションのアクセラレーションが有効かどうかを示します。列挙値: true : 有効。 false : 無効。	true
Version	string	インスタンスのバージョン。	1.3.37
ResourceGroupId	string	リソースグループの ID。	rg-acfmvscak73zmby
Endpoints	array<object>	エンドポイントのリスト。
	object	エンドポイントの詳細。
Endpoint	string	エンドポイント。	hgpostcn-cn-aaab9ad2d8fb-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-wz9oap28raidjevhuszg4
VpcId	string	VPC の ID。	vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceId	string	VPC 接続インスタンスの ID。	hgpostcn-cn-wwo3665tx004-frontend-st
RegionId	string	リージョンの ID。	cn-hangzhou
ZoneId	string	ゾーンの ID。	cn-hangzhou-h
StorageType	string	ストレージタイプ。有効な値: redundant: 3 ゾーン Deployment。 local: シングルゾーン Deployment。	redundant
EnableSSL	string	SSL が有効かどうかを示します。	true
Success	string	API 呼び出しが成功したかどうかを示します。	true
ErrorCode	string	エラーコード。	null
ErrorMessage	string	エラーメッセージ。	null
HttpStatusCode	string	HTTP 状態コード。	200

例

成功レスポンス

JSONJSON

{
  "RequestId": "D1303CD4-AA70-5998-8025-F55B22C50840",
  "InstanceList": [
    {
      "CommodityCode": "hologram_postpay_public_cn",
      "CreationTime": "2022-12-16T02:24:05Z",
      "ExpirationTime": "2023-05-04T16:00:00.000Z",
      "InstanceId": "hgpostcn-cn-aaab9ad2d8fb",
      "InstanceName": "test_instance",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tag",
          "Value": "value"
        }
      ],
      "InstanceChargeType": "PrePaid",
      "LeaderInstanceId": "hgprecn-cn-2r42sqvxm006",
      "SuspendReason": "Manual",
      "EnableHiveAccess": "true",
      "Version": "1.3.37",
      "ResourceGroupId": "rg-acfmvscak73zmby",
      "Endpoints": [
        {
          "Endpoint": "hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80",
          "Type": "Internet",
          "Enabled": true,
          "VSwitchId": "vsw-wz9oap28raidjevhuszg4",
          "VpcId": "vpc-uf6mrahzyu7uorlqqpz5f",
          "VpcInstanceId": "hgpostcn-cn-wwo3665tx004-frontend-st"
        }
      ],
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-h",
      "StorageType": "redundant",
      "EnableSSL": "true"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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

変更履歴

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