DescribeTags - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

指定されたリージョン内のすべてのタグを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeTags

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID です。	cn-hangzhou
ResourceType	string	任意	リソースタイプです。有効な値は INSTANCE または instance です。	INSTANCE
NextToken	string	任意	次のページの結果を取得する際に、次回のリクエストで使用するページネーショントークンです。説明最初のリクエストではこのパラメーターは必須ではありません。1 回のクエリですべての結果が返されない場合、前回のクエリから取得したトークンを NextToken の値として指定できます。	212db86sca4384811e0b5e8707ec2****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のページを取得する際に使用するページネーショントークンです。このフィールドが空の場合、これ以上結果はありません。説明 1 回のクエリですべての結果が返されない場合、このパラメーターが応答に含まれます。次回のクエリでは、このパラメーターの返却値を渡すことができます。	212db86sca4384811e0b5e8707ec2****
RequestId	string	リクエスト ID です。	F3F44BE3-5419-4B61-9BAC-E66E295A****
Tags	array<object>	タグの詳細情報です。
	object	タグに関する情報です。
TagKey	string	タグのキーです。	size
TagValues	array	タグ値です。
	string	タグの値です。	['test_value_2']

例

成功レスポンス

JSONJSON

{
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "Tags": [
    {
      "TagKey": "size",
      "TagValues": [
        "['test_value_2']"
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTagKey.Malformed	The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.
400	InvalidTagValue.Malformed	The specified parameter 'Tag.n.Value' is not valid.
400	InvalidParameter.ResourceId	The specified parameter 'ResourceId.n' is not valid.
400	MissParameter.TagOrResourceId	The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400	InvalidParameter.Scope	The specified parameter 'Scope' is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.
400	NumberExceed.Tags	The Tags parameter's number is exceed.
400	Duplicate.TagKey	The specified parameter 'Tag.n.Key' is duplicated.
400	InvalidParameter.ResourceType	The specified parameter 'ResourceType' is not valid.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

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

変更履歴

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