edit-icon download-icon

DescribeTags

最終更新日: May 25, 2018

説明

タグの情報を照会します。

注意:

  • インスタンス ID、タグキー、タグ値でタグを照会することができます。

  • 指定された条件は”and”リレーションであり、指定された条件をすべて満たすタグセットのみが返されます。

  • タグキーを指定するがタグ値は指定しない場合、タグキーに関連付けられたすべてのタグが照会されます。

  • タグ値だけを指定することはできますが、タグキーは指定できません。

  • タグキー/タグ値のペアを指定すると、対応するタグは完全に一致します。

リクエストパラメータ

リクエストパラメータ データ型 必須 説明
Action String Yes

システムに必要なパラメータ。

有効な値: DescribeTags

RegionId String Yes Server Load Balancer インスタンスのリージョン ID。
LoadBalancerID String No Server Load Balancer インスタンスの ID。
Tags String No 照会するタグ。
PageSize Integer No デフォルト値は 50、最大値は 100 です。
PageNumber Integer No インスタンスリストのページ番号。開始値は 1 で、デフォルト値は 1 です。
Tags objects
TagKey String Yes

タグのキー。

これは 64 文字までで、aliyunで始めることも、空にすることもできません。

TagValue String No

タグの値。

これは 128 文字までで、aliyunで始めることはできません。

レスポンスパラメータ

レスポンスパラメータ データ型 説明
RequestId String リクエストの ID。
TagSets List タグのリスト。
PageSize Integer デフォルト値は 50、最大値は 100 です。
PageNumber Integer インスタンスリストのページ番号。開始値は 1 で、デフォルト値は 1 です。
TotalCount Integer 濾過条件によって得られたインスタンスの総数。
TagSet objects
TagKey String タグのキー。
TagValue String タグの値。
InstanceCount Integer タグにバインドされたインスタンスの総数。

リクエストの例

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeTags
  3. &RegionId=cn-east-hangzhou-01
  4. &LoadBalancerID=139a00604ad-cn-east-hangzhou-01
  5. &<Common parameters>

レスポンスの例

  • XML 形式

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeTagsResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <TagSets>
    5. <TagSet>
    6. <TagKey>test</TagKey>
    7. <TagValue>api</TagValue>
    8. </TagSet>
    9. </TagSets>
    10. <PageSize>50</PageSize>
    11. <PageNumber>1</PageNumber>
    12. <TotalCount>1</TotalCount>
    13. </DescribeTagsResponse>
  • JSON 形式

    1. {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "TagSets": {
    4. "TagSet": [
    5. {
    6. "TagKey": "test",
    7. "TagValue": "api"
    8. }
    9. "PageNumber": 1,
    10. "PageSize": 50,
    11. "TotalCount": 1
    12. }