All Products
Search
Document Center

DescribeDnsGtmInstance (new)

Last Updated: Mar 04, 2021

Queries detailed information about a Global Traffic Manager (GTM) instance.

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

DescribeDnsGtmInstance

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

InstanceId

String

Yes

instance1

The ID of the instance.

Lang

String

No

en

The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.

Response parameters

Parameter

Type

Example

Description

Config

Struct

The configurations of the instance.

AlertConfig

Array of AlertConfig

The alert notification methods.

AlertConfig

EmailNotice

Boolean

true

Indicates whether email notifications were configured. Valid values:

  • true: configured

  • false | null: not configured

NoticeType

String

ADDR_ALERT

The type of the alert event. Valid values:

  • ADDR_ALERT: The address is unavailable.

  • ADDR_RESUME: The address is restored and becomes available.

  • ADDR_POOL_GROUP_UNAVAILABLE: The address pool group is unavailable.

  • ADDR_POOL_GROUP_AVAILABLE: The address pool group is restored and becomes available.

  • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Switchover is triggered between the primary and secondary address pools.

  • MONITOR_NODE_IP_CHANGE: Monitor node IP address changes

SmsNotice

Boolean

true

Indicates whether SMS notifications were configured. Valid values:

  • true: configured

  • false | null: not configured

AlertGroup

String

alertgroup1

The alert group.

CnameType

String

public

The access type of the CNAME domain name.

  • The value was set to PUBLIC, which indicates Internet access.

InstanceName

String

instancetest1

The name of the instance.

PubicZoneName

String

gtmtestinstance.example.com

The domain name that is used to access GTM over the Internet.

PublicCnameMode

String

custom

Indicates whether a custom CNAME domain name or a CNAME domain name assigned by the system is used to access GTM over the Internet. Valid values:

  • CUSTOM: a custom CNAME domain name

  • SYSTEM_ASSIGN: a CNAME domain name assigned by the system

PublicUserDomainName

String

example.com

The website domain name that the user uses on the Internet.

StrategyMode

String

GEO

The type of the access policy. Valid values:

  • LATENCY: latency-based

  • GEO: geographical location-based

Ttl

Integer

1

The global time to live (TTL).

CreateTime

String

2020-10-14T06:58Z

The time when the instance was created.

CreateTimestamp

Long

1602656937000

The timestamp that indicates when the instance was created.

ExpireTime

String

2020-10-14T06:58Z

The time when the instance expires.

ExpireTimestamp

Long

1602656937000

The timestamp that indicates when the instance expires.

InstanceId

String

instanceid1

The ID of the instance.

PaymentType

String

Subscription

The billing method of the instance.

  • The value is set to Subscription.

RequestId

String

84314904-D047-4176-A0EC-256D7F68C7F5

The ID of the request.

ResourceGroupId

String

resourcegroupid1

The ID of the resource group to which the instance belongs.

SmsQuota

Integer

100

The total number of SMS notifications.

TaskQuota

Integer

100

The total number of detection tasks.

UsedQuota

Struct

The used quota.

EmailUsedCount

Integer

123

The total number of email notifications that were sent.

SmsUsedCount

Integer

123

The total number of SMS notifications that were sent.

TaskUsedCount

Integer

123

The number of detection tasks that were created.

VersionCode

String

versioncode1

The version of the instance.

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=DescribeDnsGtmInstance
&InstanceId=instance1
&<Common request parameters>

Sample success responses

XML format

<ExpireTimestamp>1602656937000</ExpireTimestamp>
<VersionCode>versioncode1</VersionCode>
<ResourceGroupId>resourcegroupid1</ResourceGroupId>
<RequestId>84314904-D047-4176-A0EC-256D7F68C7F5</RequestId>
<InstanceId>instanceid1</InstanceId>
<PaymentType>Subscription</PaymentType>
<TaskQuota>100</TaskQuota>
<Config>
    <InstanceName>instancetest1</InstanceName>
    <AlertGroup>alertgroup1</AlertGroup>
    <PubicZoneName>gtmtestinstance.example.com</PubicZoneName>
    <AlertConfig>
        <AlertConfig>
            <SmsNotice>true</SmsNotice>
            <NoticeType>ADDR_ALERT</NoticeType>
            <EmailNotice>true</EmailNotice>
        </AlertConfig>
    </AlertConfig>
    <CnameType>public</CnameType>
    <PublicUserDomainName>example.com</PublicUserDomainName>
    <StrategyMode>GEO</StrategyMode>
    <Ttl>1</Ttl>
    <PublicCnameMode>custom</PublicCnameMode>
</Config>
<CreateTime>2020-10-14T06:58Z</CreateTime>
<ExpireTime>2020-10-14T06:58Z</ExpireTime>
<CreateTimestamp>1602656937000</CreateTimestamp>
<SmsQuota>100</SmsQuota>
<UsedQuota>
    <TaskUsedCount>123</TaskUsedCount>
    <SmsUsedCount>123</SmsUsedCount>
    <EmailUsedCount>123</EmailUsedCount>
</UsedQuota>

JSON format

{
        "ExpireTimestamp": "1602656937000",
        "VersionCode": "versioncode1",
        "ResourceGroupId": "resourcegroupid1",
        "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
        "InstanceId": "instanceid1",
    "PaymentType": "Subscription",
        "TaskQuota": "100",
        "Config": {
                "InstanceName": "instancetest1",
                "AlertGroup": "alertgroup1",
                "PubicZoneName": "gtmtestinstance.example.com",
                "AlertConfig": {
                        "AlertConfig": [{
                                "SmsNotice": "true",
                                "NoticeType": "ADDR_ALERT",
                                "EmailNotice": "true"
                        }]
                },
                "CnameType": "public",
                "PublicUserDomainName": "example.com",
                "StrategyMode": "GEO",
                "Ttl": "1",
                "PublicCnameMode": "custom"
        },
        "CreateTime": "2020-10-14T06:58Z",
        "ExpireTime": "2020-10-14T06:58Z",
        "CreateTimestamp": "1602656937000",
        "SmsQuota": "100",
        "UsedQuota": {
                "TaskUsedCount": "123",
                "SmsUsedCount": "123",
                "EmailUsedCount": "123"
        }
}

Error codes

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