Queries tag rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDynamicTagRuleList

The operation that you want to perform. Set the value to DescribeDynamicTagRuleList.

TagKey String No tagkey1

The key of the tag.

PageNumber String No 1

The number of the page to return.

Pages start from page 1. Default value: 1.

PageSize String No 10

The number of entries to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the call was successful.

Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String success

The error message.

RequestId String 0D50523D-8D59-4A61-B58E-E2286ECFB3A9

The ID of the request.

Total Integer 12

The total number of returned entries.

PageNumber String 1

The number of the returned page.

Pages start from page 1. Default value: 1.

PageSize String 10

The number of entries returned on each page. Default value: 10.

TagGroupList Array

The tag rules of application groups.

DynamicTagRuleId String d19d8c1e-9fea-41bb-9e0d-********1e14

The ID of the tag rule.

TagKey String tagkey1

The key of the tag.

RegionId String cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query the most recent region list.
MatchExpressFilterRelation String and

The logical operator used between conditional expressions. Valid values:

  • and
  • or
Note
Status String FINISH

The status of adding instances that meet the tag rule to the application group. Valid values:

  • RUNNING
  • FINISH
MatchExpress Array

The conditional expressions used to create an application group based on the tag.

TagValueMatchFunction String all

The method used to match the value of the tag. Valid values:

  • all:
  • startWith
  • endWith
  • contains
  • notContains
  • equals
TagValue String tagValue1

The value of the tag.

Note This parameter and the MatchExpress.N.TagValueMatchFunction parameter must be used in pairs.
TemplateIdList List 123456

The ID of the alert template.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDynamicTagRuleList
&<Common request parameters>

Sample success responses

XML format

<PageNumber>1</PageNumber>
<PageSize>30</PageSize>
<TagGroupList>
    <TagGroup>
        <Status>FINISH</Status>
        <TemplateIdList>
            <TemplateIdList>12345</TemplateIdList>
        </TemplateIdList>
        <TagKey>aaaa</TagKey>
        <RegionId>cn-zhangjiakou</RegionId>
        <DynamicTagRuleId>d19d8c1e-9fea-41bb-9e0d-********1e14</DynamicTagRuleId>
        <MatchExpressFilterRelation>and</MatchExpressFilterRelation>
        <MatchExpress>
            <MatchExpress>
                <TagValue>tagValue1</TagValue>
                <TagValueMatchFunction>all</TagValueMatchFunction>
                <TagName>aaaa</TagName>
            </MatchExpress>
        </MatchExpress>
    </TagGroup>
</TagGroupList>
<Success>true</Success>
<Code>200</Code>
<Total>12</Total>

JSON format

{
    "PageNumber": 1,
    "PageSize": 30,
    "TagGroupList": {
        "TagGroup": [
            {
                "Status": "FINISH",
                "TemplateIdList": {
                    "TemplateIdList": [
                        12345
                    ]
                },
                "TagKey": "aaaa",
                "RegionId": "cn-zhangjiakou",
                "DynamicTagRuleId": "d19d8c1e-9fea-41bb-9e0d-********1e14",
                "MatchExpressFilterRelation": "and",
                "MatchExpress": {
                    "MatchExpress": [
                        {
                            "TagValue": "tagValue1",
                            "TagValueMatchFunction": "all",
                            "TagName": "aaaa"
                        }
                    ]
                }
            }
        ]
    },
    "Success": true,
    "Code": 200,
    "Total": 12
}

Error codes

For a list of error codes, visit the API Error Center.