GetInstance API によるインスタンス詳細の取得 - OpenSearch

ID に基づいてインスタンスの詳細を取得します。

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:GetInstance

get

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId} HTTP/1.1

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

リクエスト例

GET /openapi/ha3/instances/ha3-cn-xxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
result	object	返された結果。
description	string	インスタンスの説明。	test
resourceGroupId	string	リソースグループ ID。	rg-aekzjvw24****
expiredTime	string	有効期限。	024-05-21 16:49:31.0
commodityCode	string	商品コード。	opensearch_ha3post_public_cn
instanceId	string	インスタンス ID。	ha-cn-pl32rf0****
createTime	string	インスタンスが作成された時刻。	2022-06-17T02:01:26Z
lockMode	string	ロックステータス。	Unlock
chargeType	string	課金方法。	POSYPAY
updateTime	string	インスタンスが最後に更新された時刻。	024-05-21 16:49:31.0
inDebt	boolean	インスタンスの支払いが延滞しているかどうかを示します。	false
status	string	インスタンスのステータス。 INIT: インスタンスは初期化中です。 WAIT_CONFIG: インスタンスは設定待ちです。 CONFIG_UPDATING: 設定を適用中です。 READY: インスタンスは実行中です。	INIT
tags	array<object>	タグ。
	object	タグ。
key	string	タグキー。	opensearch
value	string	タグの値。	opensearch
edition	string	インスタンスのエディション。有効な値: - vector: Vector Search Edition - engine: Recall Engine Edition	vector
userName	string	ユーザー名。	admin
version	string	エンジンのバージョン番号。	ha3_3.10.0
bsVersion	string	BS のバージョン番号。	bs_3.13.2
noQrs	boolean	インスタンスがスタンドアロンインスタンスであるかどうかを示します。	false
newMode	boolean	新しいバージョンのコンソールが使用されているかどうかを示します。	true
network	object	検索エンジンインスタンスのネットワーク情報。
vSwitchId	string	vSwitch の ID。	vsw-bp11ldcf59q2n****
vpcId	string	VPC の ID。	vpc-wz9axk41d9vff****
endpoint	string	ゲートウェイのエンドポイント。	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	パブリックドメイン名。	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	パブリックドメイン名のホワイトリスト。	127.0.0.1
spec	object	ノードの仕様。
qrsResource	object	クエリノードの仕様。
category	string	インスタンスのタイプ。値 local_ssd はローカル SSD タイプを示し、値 cloud はディスクタイプを示します。	local_ssd
cpu	integer	CPU コアの数。	2
mem	integer	メモリサイズ (GB)。	10
disk	integer	ノードのストレージ容量 (GB)。	100
nodeCount	integer	ノード数。	1
searchResource	object	データノードの仕様。
category	string	マシンタイプ。有効な値:	local_ssd
cpu	integer	CPU コアの数。	2
mem	integer	メモリサイズ (GB)。	10
disk	integer	ノードのストレージ容量 (GB)。	100
nodeCount	integer	ノード数。	1
zoneCount	integer	ゾーンの数。	1
requestId	string	リクエスト ID。	E7B7D598-B080-5C8E-AA35-D43EC0D5F886

応答例

成功応答の例

{
    "result":
    {
        "inDebt": false,
        "lockMode": "Unlock",
        "trFreeUrl": "",
        "chargeType": "POSTPAY",
        "edition": "vector",
        "description": "ha-cn-vkl3rgrfc01",
        "updateTime": "2024-05-30 10:52:00.0",
        "userName": "admin",
        "version": "vector_service_1.2.2",
        "spec":
        {
            "qrsResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 8,
                "disk": 100,
                "nodeCount": 0
            },
            "searchResource":
            {
                "category": "local_ssd",
                "cpu": 2,
                "mem": 16,
                "disk": 100,
                "nodeCount": 1
            }
        },
        "network":
        {
            "vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
            "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
            "endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
        },
        "tags":
        [
            {
                "value": "rg-acfmv2hk2jpsxia",
                "key": "acs:rm:rgId"
            }
        ],
        "noQrs": true,
        "instanceId": "ha-cn-vkl3rgrfc01",
        "createTime": "2024-05-30 10:50:33.0",
        "commodityCode": "opensearch_ha3post_public_cn",
        "resourceGroupId": "rg-acfmv2hk2jpsxia",
        "newMode": true,
        "status": "READY"
    },
    "requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}

エラー応答の例

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

例

成功レスポンス

JSONJSON

{
  "result": {
    "description": "test",
    "resourceGroupId": "rg-aekzjvw24****",
    "expiredTime": "024-05-21 16:49:31.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2022-06-17T02:01:26Z",
    "lockMode": "Unlock",
    "chargeType": "POSYPAY",
    "updateTime": "024-05-21 16:49:31.0",
    "inDebt": false,
    "status": "INIT",
    "tags": [
      {
        "key": "opensearch",
        "value": "opensearch"
      }
    ],
    "edition": "vector",
    "userName": "admin",
    "version": "ha3_3.10.0",
    "bsVersion": "bs_3.13.2",
    "noQrs": false,
    "newMode": true,
    "network": {
      "vSwitchId": "vsw-bp11ldcf59q2n****\n",
      "vpcId": "vpc-wz9axk41d9vff****\n",
      "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com\n",
      "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com\n",
      "allow": "127.0.0.1\n"
    },
    "spec": {
      "qrsResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      },
      "searchResource": {
        "category": "local_ssd",
        "cpu": 2,
        "mem": 10,
        "disk": 100,
        "nodeCount": 1
      }
    },
    "zoneCount": 1
  },
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}

エラーコード

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

変更履歴

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