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

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	インスタンスが配置されているリージョンの ID。DescribeRegions を呼び出してリージョン ID を取得します。	cn-hangzhou
QueryStr	string	任意	インスタンス名であいまい検索するためのキーワード。	test
PageNumber	integer	任意	返すページ番号。	1
PageSize	integer	任意	ページングクエリで各ページに返すエントリ数。	20
ServiceType	string	任意	インスタンスのタイプ。有効値： lindorm：シングルゾーン Lindorm インスタンス。 lindorm_multizone：マルチゾーン Lindorm インスタンス。 serverless_lindorm：Lindorm Serverless インスタンス。 lindorm_standalone：Lindorm スタンドアロンインスタンス。 lts：Lindorm Tunnel Service (LTS) タイプ。	lindorm
SupportEngine	integer	任意	クエリするインスタンスがサポートするエンジンのタイプ。有効値： 1：検索エンジン。 2：LindormTSDB。 4：LindormTable。 8：ファイルエンジン。説明例えば、値が 15 (8 + 4 + 2 + 1) の場合、インスタンスがファイルエンジン、LindormTable、LindormTSDB、および検索エンジンをサポートすることを示します。値が 6 (4 + 2) の場合、インスタンスが LindormTSDB と LindormTable をサポートすることを示します。	15
Tag	array<object>	任意	タグのリスト。最大 20 個のタグを指定できます。
	object	任意	タグのリスト。
Key	string	任意	タグのキー。説明複数のタグのキーを渡すことができます。例えば、最初のペアの Key は最初のタグのキーを表し、2 番目のペアの Key は 2 番目のタグのキーを表します。	test
Value	string	任意	タグの値。説明複数のタグの値を指定できます。例えば、最初のペアの 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	ページに返されたエントリ数。	20
Total	integer	見つかったインスタンスの総数。	1
InstanceList	array<object>	インスタンスのリスト。
	array<object>
VpcId	string	インスタンスがデプロイされている VPC の ID。	vpc-bp1n3i15v90el48nx****
EngineType	string	インスタンスがサポートするエンジンのタイプ。このパラメーターの値は、サポートされているエンジンの値の合計です。 1：検索エンジン。 2：LindormTSDB。 4：LindormTable。 8：ファイルエンジン。説明例えば、値が 15 (8 + 4 + 2 + 1) の場合、インスタンスがファイルエンジン、LindormTable、LindormTSDB、および検索エンジンをサポートすることを示します。値が 6 (4 + 2) の場合、インスタンスが LindormTSDB と LindormTable をサポートすることを示します。	15
ExpireTime	string	インスタンスの有効期限。説明このパラメーターは、サブスクリプションインスタンスに対してのみ返されます。	2022-04-26 00:00:00
CreateTime	string	インスタンスが作成された時間。	2021-09-16 14:13:13
PayType	string	インスタンスの課金方法。有効値： PREPAY：サブスクリプション。 POSTPAY：従量課金。	PREPAY
AliUid	integer	Alibaba Cloud アカウントの 16 桁の ID。	164901546557****
InstanceStorage	string	インスタンスのストレージ容量。	960
InstanceId	string	インスタンスの ID。	ld-bp17pwu1541ia****
NetworkType	string	インスタンスのネットワークタイプ。	vpc
ServiceType	string	インスタンスのタイプ。有効値： lindorm：Lindorm インスタンス。 serverless_lindorm：Lindorm Serverless インスタンス。 lindorm_standalone：Lindorm スタンドアロンインスタンス。 lts：Lindorm Tunnel Service タイプ。	lindorm
RegionId	string	リージョンの ID。	cn-hangzhou
CreateMilliseconds	integer	インスタンスが作成されたときのタイムスタンプ。値は、1970 年 1 月 1 日 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 年 1 月 1 日 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.

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

変更履歴

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