GetLindormInstance API パラメータとレスポンスフィールド - Lindorm - Alibaba Cloud - Lindorm

Lindorm インスタンスのインスタンスタイプ、課金方法、VPC などの詳細情報を取得します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。ID を取得するには、GetLindormInstanceList を呼び出します。	ld-bp1o3y0yme2i2****

レスポンスフィールド

フィールド	型	説明	例
	object
VpcId	string	インスタンスが属する VPC (Virtual Private Cloud) の ID。	vpc-bp1n3i15v90el48nx****
VswitchId	string	vSwitch の ID。	vsw-bp1vbjzmod9q3l9eo****
CreateTime	string	インスタンスが作成された時刻。時刻は yyyy-MM-dd HH:mm:ss 形式で表示されます。	2021-07-26 17:10:26
PayType	string	インスタンスの課金方法。有効な値： PREPAY：サブスクリプション POSTPAY：従量課金	POSTPAY
NetworkType	string	インスタンスのネットワークタイプ。	vpc
ServiceType	string	インスタンスのタイプ。有効な値： lindorm：シングルゾーンインスタンス。 lindorm_multizone：マルチゾーンインスタンス。 serverless_lindorm：サーバーレスインスタンス。 lindorm_standalone：シングルノードインスタンス。 lts：Lindorm Tunnel Service (LTS) インスタンス。	lindorm
EnableKms	boolean	Key Management Service (KMS) が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	false
EnableStoreTDE	boolean	TDE (透過的データ暗号化) が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	false
DiskUsage	string	ディスク使用率。	0.0%
DiskCategory	string	ストレージタイプ。有効な値： cloud_efficiency：標準。 cloud_ssd：パフォーマンス。 cloud_essd：Enhanced SSD (ESSD)。 cloud_essd_pl0：ESSD PL0。 capacity_cloud_storage：容量。 local_ssd_pro：ローカル SSD。 local_hdd_pro：ローカル HDD。	cloud_efficiency
RequestId	string	リクエスト ID。	633F1BE4-C8DA-5744-8FDF-A3075C3FE37F
ColdStorage	integer	コールドストレージの容量。	0GB
ArchiveStorage	integer	アーカイブストレージの課金対象ストレージ容量。単位：GB。	0GB
ExpiredMilliseconds	integer	インスタンスの有効期限。この値は、1970年1月1日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。	1629993600000
EngineType	integer	インスタンスでサポートされているエンジンのタイプ。このパラメーターの値は、サポートされているすべてのエンジンタイプの値の合計です。 1：検索エンジン 2：時系列エンジン 4：ワイドテーブルエンジン 8：ファイルエンジン説明例えば、このパラメーターの値が 15 の場合、1 + 2 + 4 + 8 = 15 であるため、インスタンスが検索、時系列、ワイドテーブル、ファイルエンジンをサポートしていることを示します。このパラメーターの値が 6 の場合、2 + 4 = 6 であるため、インスタンスが時系列およびワイドテーブルエンジンをサポートしていることを示します。	15
ExpireTime	string	インスタンスの有効期限。時刻は yyyy-MM-dd HH:mm:ss 形式で表示されます。説明このパラメーターは、サブスクリプションインスタンスの場合にのみ返されます。	2021-08-27 00:00:00
AutoRenew	boolean	インスタンスの自動更新が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。説明このパラメーターは、サブスクリプションインスタンスの場合にのみ返されます。	false
DeletionProtection	string	インスタンスのリリース保護が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	false
InstanceStorage	string	インスタンスのストレージ容量。	480
AliUid	integer	Alibaba Cloud アカウントの UID。	164901546557****
InstanceId	string	インスタンス ID。	ld-bp1o3y0yme2i2****
RegionId	string	リージョン ID。	cn-hangzhou
CreateMilliseconds	integer	インスタンスが作成された時刻。この値は、1970年1月1日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。	1627290664000
InstanceAlias	string	インスタンス名。	test0726
DiskThreshold	string	ディスク領域のしきい値。	80%
ZoneId	string	ゾーン ID。	cn-hangzhou-h
InstanceStatus	string	インスタンスのステータス。有効な値： CREATING：インスタンスは作成中です。 ACTIVATION：インスタンスは実行中です。 COLD_EXPANDING：コールドストレージの容量は拡張中です。 MINOR_VERSION_TRANSITIONING：インスタンスのマイナーバージョンは変更中です。 RESIZING：ノード数は変更中です。 SHRINKING：ノード数は変更中です。 CLASS_CHANGING：インスタンスの仕様は変更中です。 SSL_SWITCHING：SSL は有効または無効にされています。 CDC_OPENING：CDC 機能は有効化中です。 TRANSFER：データは移行中です。 DATABASE_TRANSFER：データは移行中です。 GUARD_CREATING：ディザスタリカバリインスタンスは作成中です。 BACKUP_RECOVERING：データはバックアップから復元中です。 DATABASE_IMPORTING：データはインポート中です。 NET_MODIFYING：ネットワークタイプは変更中です。 NET_SWITCHING：ネットワークは切り替え中です。 NET_CREATING：ネットワーク接続は作成中です。 NET_DELETING：ネットワーク接続は削除中です。 DELETING：インスタンスは削除中です。 RESTARTING：インスタンスは再起動中です。 LOCKED：インスタンスはロックされています。	ACTIVATION
EngineList	array<object>	エンジンに関する情報。
	object	エンジンに関する情報。
Version	string	エンジンのバージョン。	2.2.3
CpuCount	string	エンジンノードの vCPU 数。	4
CoreCount	string	エンジンノードの数。	2
Engine	string	エンジンのタイプ。有効な値： lindorm：ワイドテーブルエンジン。 tsdb：時系列エンジン。 solr：検索エンジン。 store：ファイルエンジン。 bds：LTS エンジン。 compute：コンピュートエンジン。	lindorm
Specification	string	エンジンノードの仕様。	lindorm.g.2xlarge
MemorySize	string	エンジンノードのメモリサイズ。	8GB
IsLastVersion	boolean	エンジンが最新バージョンであるかどうかを示します。有効な値： true：エンジンは最新バージョンです。 false：エンジンは最新バージョンではありません。	false
LatestVersion	string	エンジンの最新バージョン。	2.2.19.2
PrimaryCoreCount	string	プライマリゾーンのノード数。	2
StandbyCoreCount	string	セカンダリゾーンのノード数。	2
ArbiterCoreCount	string	アービターゾーンのノード数。	2
EnableCompute	boolean	インスタンスのコンピュートエンジンが有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	true
EnableSSL	boolean	SSL 暗号化が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	false
EnableMLCtrl	boolean	ML ノードが有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	False
EnableCdc	boolean	インスタンスで Change Data Capture (CDC) が有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	false
EnableStream	boolean	インスタンスのストリームエンジンが有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	true
EnableLTS	boolean	インスタンスの LTS エンジンが有効になっているかどうかを示します。有効な値： true：有効。 false：無効。	true
EnableShs	boolean	コンピュートエンジンで History Server が有効になっているかどうかを示します。	true
EnableBlob	boolean	LBlob が有効になっているかどうかを示します。有効な値： true：有効。false：無効。	true
MaintainStartTime	string	メンテナンスウィンドウの開始時刻。	00:00Z
MaintainEndTime	string	メンテナンスウィンドウの終了時刻。	20:00Z
ResourceGroupId	string	リソースグループ ID。	rg-aek2wvd6oia****
PrimaryZoneId	string	マルチゾーンインスタンスのプライマリゾーン ID。	cn-shanghai-e
StandbyZoneId	string	マルチゾーンインスタンスのセカンダリゾーン ID。	cn-shanghai-f
ArbiterZoneId	string	マルチゾーンインスタンスのアービターゾーン ID。	cn-shanghai-g
PrimaryVSwitchId	string	マルチゾーンインスタンスのプライマリゾーンにある vSwitch の ID。vSwitch は `PrimaryZoneId` で指定されたゾーンにデプロイする必要があります。	vsw-uf6fdqa7c0pipnqzq****
StandbyVSwitchId	string	マルチゾーンインスタンスのセカンダリゾーンにある vSwitch の ID。vSwitch は `StandbyZoneId` で指定されたゾーンにデプロイする必要があります。	vsw-2zec0kcn08cgdtr6****
ArbiterVSwitchId	string	マルチゾーンインスタンスのアービターゾーンにある vSwitch の ID。vSwitch は `ArbiterZoneId` で指定されたゾーンにデプロイする必要があります。	vsw-uf6664pqjawb87k36****
MultiZoneCombination	string	ゾーンの組み合わせ。サポートされているゾーンの組み合わせの詳細については、インスタンスの購入ページをご参照ください。 ap-southeast-5abc-aliyun：インドネシア (ジャカルタ) ゾーン A、B、C。 cn-hangzhou-ehi-aliyun：中国 (杭州) ゾーン E、H、I。 cn-beijing-acd-aliyun：中国 (北京) ゾーン A、C、D。 ap-southeast-1-abc-aliyun：シンガポールゾーン A、B、C。 cn-zhangjiakou-abc-aliyun：中国 (張家口) ゾーン A、B、C。 cn-shanghai-efg-aliyun：中国 (上海) ゾーン E、F、G。 cn-shanghai-abd-aliyun：中国 (上海) ゾーン A、B、D。 cn-hangzhou-bef-aliyun：中国 (杭州) ゾーン B、E、F。 cn-hangzhou-bce-aliyun：中国 (杭州) ゾーン B、C、E。 cn-beijing-fgh-aliyun：中国 (北京) ゾーン F、G、H。 cn-shenzhen-abc-aliyun：中国 (深セン) ゾーン A、B、C。	cn-shanghai-efg-aliyun
CoreDiskCategory	string	マルチゾーンインスタンスのコアノードのディスクタイプ。有効な値： cloud_efficiency：標準。 cloud_ssd：パフォーマンス。 cloud_essd：ESSD。 cloud_essd_pl0：ESSD PL0。	cloud_efficiency
CoreSpec	string	マルチゾーンインスタンスのコアノードの仕様。	lindorm.g.xlarge
CoreNum	integer	マルチゾーンインスタンスのコアノード数。	4
CoreSingleStorage	integer	マルチゾーンインスタンスの単一コアノードのストレージ容量。	400
LogDiskCategory	string	マルチゾーンインスタンスのログノードのディスクタイプ。有効な値： cloud_efficiency：標準。 cloud_ssd：パフォーマンス。	cloud_ssd
LogSpec	string	マルチゾーンインスタンスのログノードの仕様。	lindorm.sn1.large
LogNum	integer	マルチゾーンインスタンスのログノード数。	4
LogSingleStorage	integer	マルチゾーンインスタンスの単一ログノードのストレージ容量。	400GB
BackupInstance	string	バックアップインスタンスの ID。	ld-xxxx
EnableLsqlVersionV3	boolean	MySQL プロトコルと互換性のある LindormSQL V3.0 がワイドテーブルエンジンでサポートされているかどうかを示します。この機能は、2023年10月24日以降に作成されたインスタンスではデフォルトでサポートされています。既存のインスタンスについては、テクニカルサポートに連絡してこの機能を有効にしてください。 true：サポートされています。 false：サポートされていません。	True
EnableLProxy	boolean	ワイドテーブルエンジンが Thrift および CQL プロトコルをサポートしているかどうかを指定します。この機能が無効になっている場合は、SwitchLProxyService 操作を呼び出して有効にすることができます。 true：サポートされています。 false：サポートされていません。	False
ArchVersion	string	デプロイアーキテクチャ。有効な値： 1.0：シングルゾーンデプロイ。 2.0：マルチゾーンデプロイ。	1.0

説明

例

成功レスポンス

JSONJSON

{
  "VpcId": "vpc-bp1n3i15v90el48nx****",
  "VswitchId": "vsw-bp1vbjzmod9q3l9eo****",
  "CreateTime": "2021-07-26 17:10:26",
  "PayType": "POSTPAY",
  "NetworkType": "vpc",
  "ServiceType": "lindorm",
  "EnableKms": false,
  "EnableStoreTDE": false,
  "DiskUsage": "0.0%",
  "DiskCategory": "cloud_efficiency",
  "RequestId": "633F1BE4-C8DA-5744-8FDF-A3075C3FE37F",
  "ColdStorage": 0,
  "ArchiveStorage": 0,
  "ExpiredMilliseconds": 1629993600000,
  "EngineType": 15,
  "ExpireTime": "2021-08-27 00:00:00",
  "AutoRenew": false,
  "DeletionProtection": "false",
  "InstanceStorage": "480",
  "AliUid": 0,
  "InstanceId": "ld-bp1o3y0yme2i2****",
  "RegionId": "cn-hangzhou",
  "CreateMilliseconds": 1627290664000,
  "InstanceAlias": "test0726",
  "DiskThreshold": "80%",
  "ZoneId": "cn-hangzhou-h",
  "InstanceStatus": "ACTIVATION",
  "EngineList": [
    {
      "Version": "2.2.3",
      "CpuCount": "4",
      "CoreCount": "2",
      "Engine": "lindorm",
      "Specification": "lindorm.g.2xlarge",
      "MemorySize": "8GB",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2",
      "PrimaryCoreCount": "2",
      "StandbyCoreCount": "2",
      "ArbiterCoreCount": "2"
    }
  ],
  "EnableCompute": true,
  "EnableSSL": false,
  "EnableMLCtrl": true,
  "EnableCdc": false,
  "EnableStream": true,
  "EnableLTS": true,
  "EnableShs": true,
  "EnableBlob": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "ResourceGroupId": "rg-aek2wvd6oia****",
  "PrimaryZoneId": "cn-shanghai-e",
  "StandbyZoneId": "cn-shanghai-f",
  "ArbiterZoneId": "cn-shanghai-g",
  "PrimaryVSwitchId": "vsw-uf6fdqa7c0pipnqzq****",
  "StandbyVSwitchId": "vsw-2zec0kcn08cgdtr6****",
  "ArbiterVSwitchId": "vsw-uf6664pqjawb87k36****",
  "MultiZoneCombination": "cn-shanghai-efg-aliyun",
  "CoreDiskCategory": "cloud_efficiency",
  "CoreSpec": "lindorm.g.xlarge",
  "CoreNum": 4,
  "CoreSingleStorage": 400,
  "LogDiskCategory": "cloud_ssd",
  "LogSpec": "lindorm.sn1.large",
  "LogNum": 4,
  "LogSingleStorage": 0,
  "BackupInstance": "ld-xxxx",
  "EnableLsqlVersionV3": true,
  "EnableLProxy": true,
  "ArchVersion": "1.0"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Instance.IsDeleted	The instance is deleted.
400	Instance.IsNotValid	The instance is invalid.
400	LindormErrorCode.%s	%s.
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.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.

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

変更履歴

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