指定された Elasticsearch クラスタの詳細情報をクエリします。
デバッグ
リクエストヘッダー
この操作には操作固有のリクエストヘッダーがなく、共通のリクエストヘッダーのみを使用します。 詳細については、「共通パラメータ」トピックの「共通リクエストヘッダー」セクションをご参照ください。
構文
GET /openapi/instances/{InstanceId} HTTP/1.1
リクエストパラメータ
|
パラメータ |
タイプ |
位置 |
必須 |
例 |
説明 |
| InstanceId | String | Path | Yes | es-cn-3h4k3axh33th9**** | インスタンス N の ID。 |
レスポンスパラメータ
パラメータ |
タイプ |
例 |
説明 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | リクエスト ID。 |
| Result | Object | レスポンスパラメータ。 |
|
| advancedDedicateMaster | Boolean | true | クラスタに専用のマスターノードが含まれているかどうかを示します。有効な値:
|
| protocol | String | HTTP | 通信プロトコル。有効な値: HTTP および HTTPS。 |
| enableKibanaPublicNetwork | Boolean | true | インターネット経由での Kibana へのアクセスが有効になっているかどうかを示します。有効な値:
|
| nodeAmount | Integer | 2 | データノードの数。 |
| createdAt | String | 2018-07-13T03:58:07.253Z | インスタンスが作成された時刻。 |
| enableKibanaPrivateNetwork | Boolean | false | 内部ネットワーク経由での Kibana へのアクセスが有効になっているかどうかを示します。有効な値:
|
| vpcInstanceId | String | vpc-bp1uag5jj38c**** | VPC ID。 |
| port | Integer | 9200 | クラスタへのアクセスに使用されるポート番号。 |
| enablePublic | Boolean | true | インターネット経由でのクラスタへのアクセスが有効になっているかどうかを示します。有効な値:
|
| dedicateMaster | Boolean | false | クラスタに専用のマスターノードが含まれているかどうかを示します。このパラメータは非推奨です。 |
| kibanaPort | Integer | 5601 | Kibana へのアクセスに使用されるポート番号。 |
| esConfig | Map | クラスタの YML ファイル構成。 |
|
| resourceGroupId | String | rg-aekzvowej3i**** | ALB インスタンスが属するリソースグループの ID。 |
| paymentType | String | postpaid | クラスタの課金方法。有効な値:
|
| postpaidServiceStatus | String | active | サブスクリプションクラスタの従量課金サービスのステータス。有効な値:
|
| esVersion | String | 6.3.2_with_X-Pack | インスタンスのバージョン。 |
| haveKibana | Boolean | true | クラスタに Kibana ノードが含まれているかどうかを示します。有効な値:
|
| isNewDeployment | Boolean | true | クラスタが新しいアーキテクチャにデプロイされているかどうかを示します。 |
| warmNode | Boolean | true | クラスタでウォームノードが有効になっているかどうかを示します。有効な値:
|
| updatedAt | String | 2018-07-13T03:58:07.253Z | インスタンスが最後に更新された時刻。 |
| instanceId | String | es-cn-3h4k3axh33th9**** | インスタンス ID。 |
| zoneCount | Integer | 2 | ゾーンの数。 |
| publicDomain | String | es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com | クラスタのパブリックエンドポイント。 |
| status | String | active | インスタンスのステータス。有効な値:
|
| serviceVpc | Boolean | true | VPC が Elasticsearch サービスアカウント内にあるかどうかを示します。 |
| publicPort | Integer | 9200 | インターネット経由でクラスタにアクセスするために使用されるポート番号。 |
| haveClientNode | Boolean | true | クラスタにクライアントノードが含まれているかどうかを示します。有効な値:
|
| domain | String | es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com | クラスタの内部エンドポイント。 |
| description | String | es-cn-abc | インスタンス名。 |
| kibanaDomain | String | es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com | Kibana のエンドポイント。 |
| dictList | Array of DictList | IK 辞書の構成。 |
|
| fileSize | Long | 2782602 | 辞書ファイルのサイズ。単位:バイト。 |
| sourceType | String | ORIGIN | 辞書ファイルのソースタイプ。有効な値:
|
| name | String | SYSTEM_MAIN.dic | 辞書ファイルの名前。 |
| type | String | MAIN | 辞書のタイプ。有効な値:
|
| synonymsDicts | Array of SynonymsDicts | 類義語辞書の構成。 |
|
| fileSize | Long | 2782602 | 辞書ファイルのサイズ。単位:バイト。 |
| sourceType | String | ORIGIN | ソースタイプ。 |
| name | String | SYSTEM_MAIN.dic | 辞書ファイルの名前。 |
| type | String | STOP | 辞書のタイプ。有効な値:
|
| zoneInfos | Array of ZoneInfo | ゾーンに関する情報。 |
|
| status | String | NORMAL | ゾーンステータス。有効な値:
|
| zoneId | String | cn-hangzhou-b | ゾーンの ID。 |
| aliwsDicts | Array of Dict | Alibaba Cloud IK 辞書の構成。 |
|
| fileSize | Long | 2782602 | 辞書ファイルのサイズ。単位:バイト。 |
| sourceType | String | OSS | 辞書ファイルのソースタイプ。有効な値:
|
| name | String | aliws_ext_dict.txt | 辞書ファイルの名前。 |
| type | String | ALI_WS | 辞書のタイプ。有効な値:
|
| tags | Array of Tag | インスタンスのタグ。各タグはキーと値のペアです。 |
|
| tagKey | String | env | タグキー。 |
| tagValue | String | dev | タグ値。 |
| esIPWhitelist | Array of String | [ "0.0.0.0/0" ] | プライベート IP アドレスホワイトリスト。このパラメータは非推奨です。 |
| extendConfigs | Array of Object | [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }] | インスタンスの拡張構成。 |
| privateNetworkIpWhiteList | Array of String | 0.0.0.0/0 | インスタンスの IP アドレスホワイトリスト。 |
| publicIpWhitelist | Array of String | [ "0.0.0.0/0" ] | インスタンスのパブリックエンドポイントアクセスホワイトリスト。 |
| kibanaPrivateIPWhitelist | Array of String | ["192.168.XX.XX"] | Kibana のホワイトリストに含まれるプライベート IP アドレスのリスト。 |
| esIPBlacklist | Array of String | [ "0.0.0.0/0" ] | プライベートネットワークアクセスブラックリスト (廃止)。 |
| kibanaIPWhitelist | Array of String | [ "0.0.0.0/0" ] | Kibana パブリックエンドポイントアクセスホワイトリスト。 |
| nodeSpec | Object | データノードの構成。 |
|
| spec | String | elasticsearch.n4.small | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| disk | Integer | 0 | ストレージ容量。単位:GB。 |
| diskEncryption | Boolean | true | ディスクの暗号化が有効になっているかどうかを示します。有効な値:
|
| diskType | String | cloud_ssd | ノードのディスクカテゴリ。有効な値:
|
| performanceLevel | String | PL1 | ESSD のパフォーマンスレベル (PL)。このパラメータは、diskType の値が cloud_essd の場合に返されます。有効な値: PL1、PL2、PL3。 |
| specInfo | String | 1C 2G | ノード仕様の説明 |
| networkConfig | Object | ネットワークタイプ。 |
|
| vpcId | String | vpc-abc | 仮想プライベートクラウド (VPC) の ID。 |
| vsArea | String | cn-hangzhou-b | クラスタが存在するゾーン。 |
| type | String | vpc | ネットワークタイプ。VPC のみがサポートされています。 |
| vswitchId | String | vsw-abc | vSwitch ID。 |
| whiteIpGroupList | Array of whiteIpGroupList | ホワイトリストのリスト。 |
|
| whiteIpType | String | PRIVATE_ES | ホワイトリストのタイプ。有効な値:
|
| groupName | String | default | ホワイトリストグループの名前。デフォルトでは、デフォルトのホワイトリストが含まれています。 |
| ips | Array of String | ["0.0.0.0", "127.0.XX.XX"] | IP アドレスホワイトリストに含まれる IP アドレス。 |
| kibanaConfiguration | Object | Kibana ノードの構成。 |
|
| amount | Integer | 1 | ノードの数。 |
| spec | String | elasticsearch.n4.small | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| disk | Integer | 20 | 各ノードのストレージ容量。単位:GB。 |
| specInfo | String | 1C 2G | ノード仕様の説明 |
| masterConfiguration | Object | 専用マスターノードの構成。 |
|
| spec | String | elasticsearch.n4.small | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| amount | Integer | 3 | ノードの数。 |
| disk | Integer | 40 | ストレージ容量。単位:GB。 |
| diskType | String | cloud_ssd | ストレージタイプ。 cloud_ssd のみがサポートされています。 |
| specInfo | String | 1C 2G | ノード仕様の説明 |
| clientNodeConfiguration | Object | クライアントノードの構成。 |
|
| spec | String | elasticsearch.n4.small | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| amount | Integer | 3 | ノードの数。 |
| disk | Integer | 40 | ストレージ容量。単位:GB。 |
| diskType | String | cloud_efficiency | ストレージタイプ。 cloud_efficiency のみがサポートされています。 |
| specInfo | String | 1C 2G | ノード仕様の説明 |
| warmNodeConfiguration | Object | ウォームノードの構成。 |
|
| amount | Integer | 6 | ノードの数。 |
| spec | String | elasticsearch.n4.small | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| disk | Integer | 500 | ストレージ容量。単位:GB。 |
| diskEncryption | Boolean | true | ディスクの暗号化を有効にするかどうかを指定します。有効な値:
|
| diskType | String | cloud_efficiency | ストレージタイプ。 cloud_efficiency のみがサポートされています。 |
| specInfo | String | 1C 2G | ノード仕様の説明 |
| advancedSetting | Object | 詳細設定。 |
|
| gcName | String | CMS | ガベージコレクタ (GC) の名前。有効な値: CMS および G1。 |
| elasticDataNodeConfiguration | Object | 弾性ノードの構成。 |
|
| amount | Integer | 3 | ノードの数。 |
| spec | String | elasticsearch.sn2ne.large | 仕様カテゴリ。詳細については、製品仕様をご参照ください。 |
| disk | Integer | 20 | ストレージ容量。単位:GB。 |
| diskEncryption | Boolean | true | ディスクの暗号化が有効になっているかどうかを示します。有効な値:
|
| diskType | String | cloud_ssd | ストレージタイプ。有効な値:
|
| specInfo | String | 1C 2G | ノード仕様の説明。 |
| ikHotDicts | Array of ikHotDicts | IK 辞書のローリングアップデートの構成。 |
|
| type | String | MAIN | 更新する辞書のタイプ。有効な値:
|
| sourceType | String | OSS | 辞書ファイルのソースタイプ。有効な値:
|
| fileSize | Integer | 6 | 辞書ファイルのサイズ。単位:バイト。 |
| name | String | deploy_0.dic | 辞書ファイルの名前。 |
| instanceCategory | String | advanced | Elasticsearch クラスタのエディション。返される値は次のとおりです。
|
| endtime | Long | 1715826092044 | キャッシュリザーブインスタンスの有効期限が切れる時刻。 |
| archType | String | public | デプロイモード、アーキテクチャタイプ: exclusive: 基本管理 public: クラウドネイティブ新コントロール |
| kibanaPrivateDomain | String | es-cn-x0r3*********.elasticsearch.aliyuncs.com | Kibana のプライベートエンドポイント |
| kibanaPrivatePort | String | 5601 | Kibana のプライベートポート |
例
サンプルリクエスト
GET /openapi/instances/es-cn-3h4k3axh33th9**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
サンプルの成功レスポンス
JSON 形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"instanceId" : "es-cn-3h4k3axh33th9****",
"domain" : "es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com",
"description" : "es-cn-3h4k3axh33th9****",
"nodeAmount" : 2,
"paymentType" : "postpaid",
"status" : "active",
"port" : 9200,
"esVersion" : "6.3.2_with_X-Pack",
"archType" : "exclusive",
"instanceCategory" : "x-pack",
"esConfig" : {
"action.destructive_requires_name" : "true",
"xpack.security.audit.outputs" : "index",
"xpack.watcher.enabled" : "false",
"xpack.security.audit.enabled" : "false",
"action.auto_create_index" : "+.*,-*"
},
"esIPWhitelist" : [ "0.0.0.0/0" ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
"kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
"publicIpWhitelist" : [ ],
"kibanaDomain" : "es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort" : 5601,
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn1ne.large",
"disk" : 21,
"diskType" : "cloud_ssd"
},
"serviceVpc" : true,
"networkConfig" : {
"vpcId" : "vpc-bp13n1j3fcv1cqfkg****",
"vswitchId" : "vsw-bp12q2vrqvko0ilg8****",
"vsArea" : "cn-hangzhou-h",
"type" : "vpc",
"whiteIpGroupList" : [ {
"groupName" : "default",
"whiteIpType" : "PRIVATE_ES",
"ips" : [ "0.0.0.0", "127.0.XX.XX" ]
} ]
},
"createdAt" : "2019-08-28T07:48:59.736Z",
"updatedAt" : "2019-08-28T08:11:33.229Z",
"inited" : true,
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : true,
"warmNode" : true,
"warmNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 500,
"diskEncryption" : true
},
"clientNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 20
},
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"commodityCode" : "elasticsearch",
"endTime" : 4722681600000,
"dictList" : [ {
"name" : "SYSTEM_MAIN.dic",
"fileSize" : 2782602,
"type" : "MAIN",
"sourceType" : "ORIGIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"fileSize" : 132,
"type" : "STOP",
"sourceType" : "ORIGIN"
} ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"vpcInstanceId" : "es-cn-3h4k3axh33th9****-worker",
"resourceGroupId" : "rg-acfm3ghp32r****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-h",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : true,
"advancedSetting" : {
"gcName" : "CMS"
}
},
"RequestId" : "68104CC2-DA27-446D-8049-A024F0D4EFEC"
}
エラーコード
エラーコードのリストについては、サービスエラーコード をご参照ください。