ListTagResources - Elasticsearch - Alibaba Cloud ドキュメントセンター

1 つ以上のリソースに追加されたタグをクエリします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

CreateInstance 操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。詳細については、共通リクエストパラメータのドキュメントをご参照ください。

リクエスト構文

GET /openapi/tags HTTP/1.1

リクエストパラメータ

パラメータ	タイプ	位置	必須	例	説明
Page	Integer	Query	No	1	リソース関係リストのページ数。このフィールドは廃止されました。
Size	Integer	Query	No	10	各ページに戻されるエントリの数。このフィールドは廃止されました。
ResourceType	String	Query	Yes	INSTANCE	ラベル付けするリソースのタイプ。
NextToken	String	Query	No	1d2db86sca4384811e0b5e8707e******	ページネーショントークン。次のリクエストで新しい結果ページを取得するために使用できます。
ResourceIds	String	Query	No	["es-cn-aaa","es-cn-bbb"]	クエリするインスタンスの ID。 JSON 配列を使用して ID を指定します。最大 20 個の ID を指定できます。
Tags	String	Query	No	[{"key":"env","value":"dev"},{"key":"dev", "value":"IT"}]	クエリするタグのリスト。 JSON 文字列であり、最大 20 個のサブ項目が含まれています。

ResourceIds パラメータと Tags パラメータの少なくとも 1 つを指定する必要があります。指定しない場合、エラーが返されます。
システムタグの表示可能なタグのみをクエリできます。非表示のタグはクエリできません。
説明システムタグとは、Alibaba Cloud サービスによってユーザーインスタンスに追加されるタグのことです。システムラベルは、表示ラベルと非表示ラベルに分類されます。

レスポンスパラメータ

パラメータ	タイプ	例	説明
PageSize	Integer	1	返されたページ番号。
RequestId	String	F99407AB-2FA9-489E-A259-40CF6D******	リクエスト ID。
Headers	Object		レスポンスのヘッダー。このパラメータは空であり、参照用です。プログラムでこのパラメータに強制的に依存することはできません。説明このパラメータは返された例には含まれていません。
X-Total-Count	Integer	10	クエリされた TagResource リソースの数。
TagResources	Object		タグを持つリソースのリスト。
TagResource	TagResource の配列		タグのリスト。
TagValue	String	dev	ラベル値。
ResourceType	String	ALIYUN::ELASTICSEARCH::INSTANCE	リソースのタイプ。値は `ALIYUN:: Elasticsearch::INSTANCE` に固定されています。
ResourceId	String	es-cn-oew1q8bev0002****	リソースの ID。
TagKey	String	env	ラベルキー。

例

リクエストの例

GET /openapi/tags?ResourceType=INSTANCE&NextToken=1d2db86sca4384811e0b5e8707e******&ResourceIds=["es-cn-aaa","es-cn-bbb"]&Tags=[{"key":"env", "value":"dev"},{"key":"dev", "value":"IT"}] HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

成功レスポンスの例

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A5423B74-DBD5-4714-BF28-6725E5BE****",
  "TagResources" : {
    "TagResource" : [ {
      "ResourceType" : "ALIYUN::ELASTICSEARCH::INSTANCE",
      "ResourceId" : "es-cn-oew1q8bev0002****",
      "TagKey" : "env",
      "TagValue" : "dev"
    } ]
  }
}

エラーコード

エラーコードの一覧については、サービスエラーコードをご参照ください。