すべてのプロダクト
Search
ドキュメントセンター

Direct Mail:QueryTagByParam

最終更新日:Jan 07, 2026

QueryTagByParam を呼び出してタグを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dm:QueryTagByParam

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNo

integer

任意

ページ番号。

1

PageSize

integer

任意

ページサイズ。

10

KeyWord

string

任意

タグ名。長さは 1~50 文字です。指定しない場合、デフォルトですべてのタグが対象となります。

1aTag

レスポンスフィールド

フィールド

説明

object

PageSize

integer

ページサイズ。

10

RequestId

string

リクエスト ID。

10A1AD70-E48E-476D-98D9-39BD92193837

PageNumber

integer

現在のページ番号。

5

TotalCount

integer

合計数。

2

data

object

tag

array<object>

データレコード。

object

TagName

string

タグ名。

hellopal

TagId

string

タグ ID。

52366

TagDescription

string

タグの説明。

test description

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNumber": 5,
  "TotalCount": 2,
  "data": {
    "tag": [
      {
        "TagName": "hellopal",
        "TagId": "52366",
        "TagDescription": "test description"
      }
    ]
  }
}

エラーコード

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

変更履歴

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