ListInstances API によるインスタンス一覧の取得 - OpenSearch

インスタンスのリストを取得します。

操作説明

メソッド

GET

URI

/openapi/ha3/instances

今すぐお試しください

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

get

*Instance

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

なし

リクエスト構文

GET /openapi/ha3/instances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
pageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
pageSize	integer	任意	各ページで返されるエントリの数。デフォルト値は 10 です。値は 1 から 50 の範囲である必要があります。	10
instanceId	string	任意	インスタンスの ID。	ha-cn-pl32rf0****
description	string	任意	説明によってインスタンスをフィルターします。あいまい一致がサポートされています。	searchengine instance
resourceGroupId	string	任意	リソースグループの ID。	rg-aekzgpiswzbksdi
edition	string	任意	インスタンスのエディション。有効な値: vector (Vector Search Edition) および engine (Retrieval Engine Edition)。	vector
tags	array<object>	任意	タグ。
	object	任意	インスタンスのタグ。
key	string	任意	タグキー。	opensearch
value	string	任意	タグの値。	opensearch
catalog	string	任意
database	string	任意
table	string	任意
dataSourceType	string	任意

パラメーター	タイプ	必須	説明
status	String	いいえ	ステータスによってインスタンスをフィルターします。有効な値: Running、Ready、Initializing、および Starting。
expiredTime	Long	いいえ	UNIX タイムスタンプ (秒単位)。このパラメーターは、有効期限によってインスタンスをフィルターするために使用されます。値が現在の時刻より大きい場合、有効期限が切れそうなインスタンスが返されます。有効期限切れのインスタンスは含まれません。

例

リクエストの例

GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
result	array<object>	返された結果。
	array<object>	インスタンスの詳細。
description	string	インスタンスの説明。	test
resourceGroupId	string	リソースグループの ID。	ha-cn-pl32rf0****
expiredTime	string	有効期限。	1634885083
commodityCode	string	商品コード。	opensearch_ha3post_public_cn
status	string	インスタンスのステータス。	READY
instanceId	string	インスタンスの ID。	ha-cn-pl32rf0****
createTime	string	インスタンスが作成された時刻。	2022-06-04T02:03:21Z
lockMode	string	ロックステータス。	Unlock
chargeType	string	課金方法。	POSTPAY
updateTime	string	インスタンスが最後に更新された時刻。	2018-12-06T11:17:49.0
inDebt	boolean	インスタンスに支払い遅延があるかどうかを示します。	false
network	object	検索エンジンインスタンスのネットワーク情報。
vSwitchId	string	vSwitch の ID。	vsw-bp11ldcf59q2n****
vpcId	string	VPC (Virtual Private Cloud) の 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
tags	array<object>	タグ。
	object	タグ。
key	string	タグキー。	opensearch
value	string	タグの値。	opensearch
edition	string	インスタンスのエディション。vector: Vector Search Editionengine: Retrieval Engine Edition	vector
userName	string	ユーザー名。	admin
version	string	エンジンのバージョン。	ha3_3.10.0
noQrs	boolean	インスタンスがスタンドアロンインスタンスであるかどうかを示します。	false
spec	object	ノードの仕様。
qrsResource	object	クエリノードの仕様。
category	string	インスタンスタイプ。有効な値: local_ssd: ローカルソリッドステートドライブ (SSD) cloud: ディスク	local_ssd
cpu	integer	CPU コアの数。	1
mem	integer	メモリサイズ (GB)。	10
disk	integer	ノードのストレージ容量 (GB)。	100
nodeCount	integer	ノード数。	3
searchResource	object	データノードの仕様。
category	string	インスタンスタイプ。有効な値: local_ssd: ローカル SSDcloud: ディスク	local_ssd
cpu	integer	CPU コアの数。	1
mem	integer	メモリサイズ (GB)。	10
disk	integer	ノードのストレージ容量 (GB)。	100
nodeCount	integer	ノード数。	3
dataSourceDetails	array<object>
	array<object>
indexName	string
type	string
config	object
endpoint	string
accessKey	string
project	string
partition	string
table	string
namespace	string
path	string
ossPath	string
bucket	string
catalog	string
database	string
tag	string
totalCount	integer	エントリの総数。	5
requestId	string	リクエストの ID。	89B968E6-1E41-58DF-BB25-5F98ECC759CE

レスポンスの例

成功レスポンスの例

{
    "result":
    [
        {
            "inDebt": false,
            "lockMode": "Unlock",
            "trFreeUrl": "",
            "chargeType": "POSTPAY",
            "edition": "engine",
            "description": "test",
            "updateTime": "2024-05-06 14:08:24.0",
            "userName": "admin",
            "version": "ha3_3.10.0",
            "spec":
            {
                "qrsResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 8,
                    "disk": 100,
                    "nodeCount": 5
                },
                "searchResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 16,
                    "disk": 100,
                    "nodeCount": 4
                }
            },
            "network":
            {
                "vSwitchId": "vsw-bp179zkffzyva26ua8xil",
                "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
                "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",
                "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",
                "allow": "127.0.0.1"
            },
            "tags":
            [
                {
                    "value": "rg-acfmv2hk2jpsxia",
                    "key": "acs:rm:rgId"
                }
            ],
            "noQrs": false,
            "instanceId": "ha-cn-35t3ni61z06",
            "createTime": "2024-03-14 10:49:32.0",
            "commodityCode": "opensearch_ha3post_public_cn",
            "resourceGroupId": "rg-acfmv2hk2jpsxia",
            "status": "READY"
        }
    ],
    "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",
    "totalCount": 1
}

エラーレスポンスの例

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

例

成功レスポンス

JSONJSON

{
  "result": [
    {
      "description": "test",
      "resourceGroupId": "ha-cn-pl32rf0****",
      "expiredTime": "1634885083",
      "commodityCode": "opensearch_ha3post_public_cn",
      "status": "READY",
      "instanceId": "ha-cn-pl32rf0****",
      "createTime": "2022-06-04T02:03:21Z",
      "lockMode": "Unlock",
      "chargeType": "POSTPAY",
      "updateTime": "2018-12-06T11:17:49.0",
      "inDebt": false,
      "network": {
        "vSwitchId": "vsw-bp11ldcf59q2n****",
        "vpcId": "vpc-wz9axk41d9vff****",
        "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com",
        "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com",
        "allow": "127.0.0.1"
      },
      "tags": [
        {
          "key": "opensearch",
          "value": "opensearch"
        }
      ],
      "edition": "vector",
      "userName": "admin",
      "version": "ha3_3.10.0",
      "noQrs": false,
      "spec": {
        "qrsResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        },
        "searchResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        }
      },
      "dataSourceDetails": [
        {
          "indexName": "",
          "type": "",
          "config": {
            "endpoint": "",
            "accessKey": "",
            "project": "",
            "partition": "",
            "table": "",
            "namespace": "",
            "path": "",
            "ossPath": "",
            "bucket": "",
            "catalog": "",
            "database": "",
            "tag": ""
          }
        }
      ]
    }
  ],
  "totalCount": 5,
  "requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}

エラーコード

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

変更履歴

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