Elasticsearch インスタンスの一覧を取得します。
デバッグ
リクエストヘッダー
この操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。 詳細については、「共通パラメーター」トピックの「共通リクエストヘッダー」セクションをご参照ください。
構文
GET /openapi/instances HTTP/1.1
リクエストパラメーター
パラメーター |
タイプ |
位置 |
必須 |
例 |
説明 |
page | Integer | Query | いいえ | 1 | ページ番号。 開始値: 1。 デフォルト値: 1。 |
size | Integer | Query | いいえ | 10 | 各ページに返すエントリの数。 最大値: 100。 デフォルト値: 10。 |
description | String | Query | いいえ | aliyunes_test1 | インスタンスの名前。 キーワードを指定して複数のインスタンスを照合できます。 たとえば、abc のすべてのインスタンスを検索すると、abc、abcde、xyabc、xabcy のすべてのインスタンスが返される場合があります。 |
instanceId | String | Query | いいえ | es-cn-v641a0ta3000g**** | インスタンス ID。 |
esVersion | String | Query | いいえ | 6.7_with_X-Pack | インスタンスのバージョン。 |
resourceGroupId | String | Query | いいえ | rg-aekzvowej3i**** | ECS インスタンスが属するリソースグループの ID。 |
tags | String | Query | いいえ | [{"tagKey":"key1","tagValue":"value1"}] | ALB インスタンスのタグ。 |
vpcId | String | Query | いいえ | vpc-bp16k1dvzxtmagcva**** | インスタンスが属する仮想プライベートクラウド (VPC) の ID。 |
zoneId | String | Query | いいえ | cn-hangzhou-i | インスタンスのゾーン ID。 |
paymentType | String | Query | いいえ | postpaid | インスタンスの課金方法。有効な値:
|
instanceCategory | String | Query | いいえ | advanced | Elasticsearch クラスタのエディション。有効な値:
|
レスポンスパラメーター
パラメーター |
タイプ |
例 |
説明 |
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | リクエスト ID。 |
Headers | Object | レスポンスのヘッダー。 |
|
X-Total-Count | Integer | 10 | 1 ページあたりに返されるエントリの数。 |
Result | Instance の配列 | レスポンスパラメーター。 |
|
advancedDedicateMaster | Boolean | false | 専用マスターノードが含まれているかどうかを示します。有効な値:
|
nodeAmount | Integer | 2 | データノードの数。 |
createdAt | String | 2018-07-13T03:58:07.253Z | インスタンスが作成された日時。 |
status | String | active | インスタンスのステータス。有効な値:
|
dedicateMaster | Boolean | false | 専用マスターノードを含めるかどうか (非推奨)。有効な値:
|
serviceVpc | Boolean | true | サービス VPC かどうか。 |
paymentType | String | postpaid | クラスタの課金方法。有効な値:
|
resourceGroupId | String | rg-aekzvowej3i**** | リソースグループの ID。 |
postpaidServiceStatus | String | active | サブスクリプションクラスタの従量課金サービスのステータス。有効な値:
|
description | String | es-cn-abc | インスタンス名。 |
esVersion | String | 6.7_with_X-Pack | インスタンスのバージョン。 |
isNewDeployment | String | true | クラスタが新しいアーキテクチャにデプロイされているかどうかを示します。 |
updatedAt | String | 2018-07-18T10:10:04.484Z | インスタンスが最後に更新された日時。 |
instanceId | String | es-cn-v641a0ta3000g**** | インスタンス ID。 |
tags | Tag の配列 | インスタンスのタグ。各タグはキーと値のペアです。 |
|
tagKey | String | env | タグキー。 |
tagValue | String | dev | タグ値。 |
extendConfigs | Object の配列 | [{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }] | クラスタ拡張パラメーターの構成。 |
clientNodeConfiguration | Object | クライアントノードの構成。 |
|
spec | String | elasticsearch.sn2ne.large | 仕様カテゴリ。 詳細については、「製品仕様」をご参照ください。 |
amount | Integer | 3 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskType | String | cloud_efficiency | ノードのストレージタイプ。 Ultra ディスク (cloud_efficiency) のみがサポートされています。 |
specInfo | String | 1C 2G | ノード仕様の説明。 |
elasticDataNodeConfiguration | Object | Elastic ノードの構成。 |
|
spec | String | elasticsearch.sn2ne.large | 仕様カテゴリ。 詳細については、「製品仕様」をご参照ください。 |
amount | Integer | 3 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskEncryption | Boolean | true | ディスクの暗号化が有効になっているかどうかを示します。有効な値:
|
diskType | String | cloud_ssd | ストレージタイプ。有効な値:
|
specInfo | String | 1C 2G | ノード仕様の説明 |
kibanaConfiguration | Object | Kibana ノードの構成。 |
|
spec | String | elasticsearch.n4.small | 仕様カテゴリ。 詳細については、「製品仕様」をご参照ください。 |
amount | Integer | 1 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskType | String | cloud_ssd | ストレージタイプ。 |
specInfo | String | 1C 2G | ノード仕様の説明 |
masterConfiguration | Object | 専用マスターノードの構成。 |
|
spec | String | elasticsearch.sn2ne.large | 仕様カテゴリ。 詳細については、「製品仕様」をご参照ください。 |
amount | Integer | 3 | ノードの数。 |
disk | Integer | 20 | ノードストレージスペースのサイズ。単位: GB。 |
diskType | String | cloud_ssd | ストレージタイプ。 cloud_ssd のみがサポートされています。 |
specInfo | String | 1C 2G | ノード仕様の説明 |
networkConfig | Object | ネットワークタイプ。 |
|
vpcId | String | vpc-abc | VPC ID。 |
vsArea | String | cn-hangzhou-e | クラスタが存在するゾーン。 |
type | String | vpc | ネットワークタイプ。 VPC のみがサポートされています。 |
vswitchId | String | vsw-def | vSwitch ID。 |
whiteIpGroupList | whiteIpGroupList の配列 | クラスタのパブリックネットワークとプライベートネットワークのホワイトリスト。 |
|
groupName | String | default | IP ホワイトリストの名前。 |
whiteIpType | String | PUBLIC_KIBANA | ネットワークタイプ。 PRIVATE_ES: Elasticsearch はイントラネットです。 PUBLIC_KIBANA。 インターネット経由の Kibana。 PUBLIC_ES、ES パブリックネットワーク。 PRIVATE_KIBANA: Kibana のプライベートネットワーク。 |
ips | String の配列 | ["0.0.0.0", "127.0.XX.XX"] | ネットワークホワイトリスト。 |
nodeSpec | Object | データノードの構成。 |
|
spec | String | elasticsearch.n4.small | 仕様カテゴリ。 詳細については、「製品仕様」をご参照ください。 |
disk | Integer | 50 | ノードのストレージ容量。単位: GB。 |
diskEncryption | Boolean | false | ディスクの暗号化を使用するかどうか。有効な値:
|
diskType | String | cloud_ssd | ストレージタイプ。有効な値:
|
performanceLevel | String | PL1 | ESSD のパフォーマンスレベル (PL)。 このパラメーターは、diskType の値が cloud_essd の場合に返されます。有効な値: PL1、PL2、PL3。 |
specInfo | String | 1C 2G | ノード仕様の説明 |
vpcInstanceId | String | vpc-bp1uag5jj38c**** | VPC ID。 |
kibanaIPWhitelist | String の配列 | "0.0.0.0/0" | クラスタ内の Kibana ノードのパブリック IP アドレスホワイトリスト。 |
kibanaPrivateIPWhitelist | String の配列 | ["192.168.XX.XX"] | クラスタ内の Kibana ノードのプライベート IP アドレスホワイトリスト。 |
publicIpWhitelist | String の配列 | [ "0.0.0.0/0" ] | クラスタの Elasticsearch パブリックネットワークホワイトリスト。 |
privateNetworkIpWhiteList | String の配列 | ["192.168.XX.XX/25"] | クラスタの Elasticsearch プライベートネットワークアクセスホワイトリスト。 |
endTime | Long | 1715826092044 | キャッシュリザーブインスタンスの有効期限が切れる日時。 |
archType | String | public | デプロイモード、アーキテクチャタイプ: exclusive: 基本管理 public: クラウドネイティブ新コントロール |
domain | String | es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com | クラスタの内部エンドポイント。 |
例
サンプルリクエスト
GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i 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-v641a0ta3000g****",
"description" : "aliyunes_test1",
"nodeAmount" : 3,
"paymentType" : "postpaid",
"status" : "active",
"esVersion" : "6.7.0_with_X-Pack",
"esConfig" : { },
"esIPWhitelist" : [ ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ ],
"kibanaIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"serviceVpc" : true,
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn1ne.large",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : true
},
"networkConfig" : {
"vpcId" : "vpc-bp1xk0naij7jx4ph1****",
"vswitchId" : "vsw-bp1ogpdintii5qvyx****",
"vsArea" : "cn-hangzhou-g",
"type" : "vpc"
},
"createdAt" : "2019-08-26T08:18:06.652Z",
"updatedAt" : "2019-08-26T08:19:49.448Z",
"inited" : true,
"tags" : [ {
"tagKey" : "key1",
"tagValue" : "value1"
} ],
"dedicateMaster" : false,
"advancedDedicateMaster" : true,
"masterConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 3,
"diskType" : "cloud_ssd",
"disk" : 20
},
"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" : 4722508800000,
"dictList" : [ ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"resourceGroupId" : "rg-acfmwriiikz****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-g",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : false,
"advancedSetting" : {
"gcName" : "CMS"
}
}, {
"instanceId" : "es-cn-v641920bh0006****",
"description" : "aliyunes_test2",
"nodeAmount" : 2,
"paymentType" : "postpaid",
"status" : "active",
"esVersion" : "6.7.0_with_X-Pack",
"archType" : "exclusive",
"esConfig" : { },
"esIPWhitelist" : [ ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ ],
"kibanaIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn2ne.2xlarge",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : false
},
"networkConfig" : {
"vpcId" : "vpc-bp1op7luys63go2x5****",
"vswitchId" : "vsw-bp1rusvg785q97ucp****",
"vsArea" : "cn-hangzhou-i",
"type" : "vpc"
},
"createdAt" : "2019-08-07T13:14:07.974Z",
"updatedAt" : "2019-08-12T03:04:27.215Z",
"inited" : true,
"tags" : [ ],
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : false,
"warmNode" : false,
"warmNodeConfiguration" : { },
"clientNodeConfiguration" : { },
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"commodityCode" : "elasticsearch",
"endTime" : 4720867200000,
"dictList" : [ ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"resourceGroupId" : "rg-acfmwriiikz****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-i",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : false,
"advancedSetting" : { "gcName" : "CMS"
}
} ]
}
エラーコード
エラーコードの一覧については、「サービスエラーコード」をご参照ください。