Lindorm インスタンスリストの取得 - Lindorm - Alibaba Cloud - Lindorm

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

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

lindorm:GetLindormInstanceList

get

*インスタンス。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	インスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
QueryStr	string	任意	インスタンス名のキーワード。あいまい一致がサポートされています。	test
PageNumber	integer	任意	返されるページのページ番号。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。	20
ServiceType	string	任意	インスタンスタイプ。有効な値: lindorm: Lindorm シングルゾーンインスタンス。 lindorm_multizone: Lindorm マルチゾーンインスタンス。 serverless_lindorm: Lindorm サーバーレスインスタンス。 lindorm_standalone: Lindorm シングルノードインスタンス。 lts: Lindorm トンネルサービスインスタンス。	lindorm
SupportEngine	integer	任意	照会されたインスタンスでサポートされているデータエンジンのタイプ。有効な値: 1: 検索インデックスエンジンがサポートされています。 2: LindormTSDB がサポートされています。 4: LindormTable がサポートされています。 8: ファイルエンジンがサポートされています。説明たとえば、SupportEngine が 8+4+2+1 に等しい 15 に設定されている場合、インスタンスは検索インデックスエンジン、LindormTSDB、LindormTable、およびファイルエンジンをサポートします。SupportEngine が 4+2 に等しい 6 に設定されている場合、インスタンスは LindormTSDB と LindormTable をサポートします。	15
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグキー。N の有効な値: 1～20。説明複数のタグキーを指定できます。たとえば、最初のペアの Key は最初のタグキーを指定し、2 番目のペアの Key は 2 番目のタグキーを指定します。	test
Value	string	任意	タグ値。N の有効な値: 1～20。説明複数のタグ値を指定できます。たとえば、最初のペアの Value は最初のタグ値を指定し、2 番目のペアの Value は 2 番目のタグ値を指定します。	2.2.18
ResourceGroupId	string	任意	リソースグループ ID。	rg-aek3b63arvg27vi

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber	integer	返されるページのページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	20
Total	integer	返されるインスタンスの総数。	1
InstanceList	array<object>	インスタンスのリスト。
	array<object>
VpcId	string	インスタンスの VPC ID。	vpc-bp1n3i15v90el48nx****
EngineType	string	インスタンスでサポートされているエンジンタイプ。戻り値は、以下のエンジンタイプの値の合計です。 1: 検索インデックス。 2: LindormTSDB。 4: LindormTable。 8: 検索エンジン。説明たとえば、EngineType が 15 (15 = 8 + 4 + 2 + 1) の場合、インスタンスは検索インデックス、LindormTSDB、LindormTable、および検索エンジンをサポートします。EngineType が 6 (6 = 4 + 2) の場合、インスタンスは LindormTSDB と LindormTable をサポートします。	15
ExpireTime	string	インスタンスの有効期限時間。フォーマットは yyyy-MM-dd HH:mm:ss です。説明このパラメーターは、インスタンスの課金方法がサブスクリプションの場合にのみ返されます。	2022-04-26 00:00:00
CreateTime	string	インスタンスが作成された時間。フォーマットは yyyy-MM-dd HH:mm:ss です。	2021-09-16 14:13:13
PayType	string	インスタンスの課金方法。有効な値: PREPAY: サブスクリプション。 POSTPAY: 従量課金。	PREPAY
AliUid	integer	Alibaba Cloud アカウントの 16 桁の AliUid。	164901546557****
InstanceStorage	string	インスタンスのストレージ容量。	960
InstanceId	string	インスタンス ID。	ld-bp17pwu1541ia****
NetworkType	string	インスタンスのネットワークタイプ。	vpc
ServiceType	string	インスタンスタイプ。有効な値: lindorm: Lindorm インスタンス。 serverless_lindorm: Lindorm サーバーレスインスタンス。 lindorm_standalone: Lindorm シングルノードインスタンス。 lts: Lindorm トンネルサービスインスタンス。	lindorm
RegionId	string	リージョン ID。	cn-hangzhou
CreateMilliseconds	integer	インスタンスの作成時間と 1970-01-01 00:00:00 の間に経過した時間 (ミリ秒)。	1631772842000
InstanceAlias	string	インスタンス名。	test
ZoneId	string	ゾーン ID。	cn-hangzhou-h
InstanceStatus	string	インスタンスステータス。有効な値: CREATING: 作成中。 ACTIVATION: 実行中。 COLD_EXPANDING: ストレージ最適化クラウドストレージのストレージ拡張中。 MINOR_VERSION_TRANSING: マイナーバージョンのスペックアップ中。 RESIZING: ノードのスケーリングアウト中。 SHRINKING: ノードのスケーリングイン中。 CLASS_CHANGING: 仕様のクォータのスペックアップまたは縮小中。 SSL_SWITCHING: SSL セットの変更中。 CDC_OPENING: データサブスクライブする特徴の有効化中。 TRANSFER: データ移行中。 DATABASE_TRANSFER: データベースへのデータ移行中。 GUARD_CREATING: ディザスタリカバリインスタンスの作成中。 BACKUP_RECOVERING: バックアップからの復元中。 DATABASE_IMPORTING: データインポート中。 NET_MODIFYING: ネットワークの変更中。 NET_SWITCHING: 内部ネットワークとパブリックネットワークの切り替え中。 NET_CREATING: ネットワーク接続の作成中。 NET_DELETING: ネットワーク接続の削除中。 DELETING: 削除中。 RESTARTING: 再起動中。 LOCKED: インスタンスの有効期限切れによりロック済み。	ACTIVATION
ExpiredMilliseconds	integer	インスタンスの有効期限切れと 1970-01-01 00:00:00 の間に経過した時間 (ミリ秒)。	1650902400000
EnableStream	boolean	インスタンスでストリームエンジンが有効になっているかどうかを示します。有効な値: true: ストリームエンジンが有効になっています。 false: ストリームエンジンが有効になっていません。	true
Tags	array<object>	タグ。
	object
Key	string	タグキー。	test
Value	string	タグ値。	2.2.18
EnableCompute	boolean	インスタンスでコンピュートエンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
ResourceGroupId	string	リソースグループ ID。	rg-aekzledqeat****
EnableMessage	boolean	メッセージエンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
EnableVector	boolean	ベクトルエンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
EnableLts	boolean	LTS エンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
EnableColumn	boolean	列のストアエンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
EnableRow	boolean	LindormTable 3.0 エンジンが有効になっているかどうかを示します。有効な値: true: 有効。 false: 無効。	true
CreateErrorCode	string	作成失敗のエラーコード。	Resource is not enough

例

成功レスポンス

JSONJSON

{
  "RequestId": "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1,
  "InstanceList": [
    {
      "VpcId": "vpc-bp1n3i15v90el48nx****",
      "EngineType": "15",
      "ExpireTime": "2022-04-26 00:00:00",
      "CreateTime": "2021-09-16 14:13:13",
      "PayType": "PREPAY",
      "AliUid": 0,
      "InstanceStorage": "960",
      "InstanceId": "ld-bp17pwu1541ia****",
      "NetworkType": "vpc",
      "ServiceType": "lindorm",
      "RegionId": "cn-hangzhou",
      "CreateMilliseconds": 1631772842000,
      "InstanceAlias": "test",
      "ZoneId": "cn-hangzhou-h",
      "InstanceStatus": "ACTIVATION",
      "ExpiredMilliseconds": 1650902400000,
      "EnableStream": true,
      "Tags": [
        {
          "Key": "test",
          "Value": "2.2.18"
        }
      ],
      "EnableCompute": true,
      "ResourceGroupId": "rg-aekzledqeat****",
      "EnableMessage": true,
      "EnableVector": true,
      "EnableLts": true,
      "EnableColumn": true,
      "EnableRow": true,
      "CreateErrorCode": "Resource is not enough"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Instance.IsDeleted	The instance is deleted.	操作が失敗したため、インスタンスは削除されています。
400	Instance.IsNotAvailable	The instance is unavailable.	操作が失敗したため、インスタンスは使用できません。
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.
403	API.Forbidden	The API operation is forbidden in this environment.	操作が失敗したため、現在の環境ではこの API は使用できません。

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

変更履歴

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