All Products
Search
Document Center

DescribeDnsGtmInstanceAddressPool (new)

Last Updated: Mar 04, 2021

Queries detailed information about an address pool of 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

DescribeDnsGtmInstanceAddressPool

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

AddrPoolId

String

Yes

testpool1

The ID of the address pool.

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

AddrCount

Integer

1

The number of address pools.

AddrPoolId

String

testpool1

The ID of the address pool.

Addrs

Array of Addr

The addresses in the address pool.

Addr

Addr

String

1.1.1.1

The address.

AlertStatus

String

ok

The status of the last health check on the address. Valid values:

  • OK: No active alerts are triggered based on the alert rules.

  • ALERT: Alerts are triggered based on the alert rules.

AttributeInfo

String

"LineCode": "default", "LineName": "default"

The source region of the address.

LineCode: The line code of the source region of the address.(Abused, based on lineCodes data)

LineName: The line name of the source region of the address.(Abused)

LineCodes: List of home lineCodes

CreateTime

String

2017-12-28T13:08Z

The time when the address was created.

CreateTimestamp

Long

1527690629357

The timestamp that indicates when the address was created.

LbaWeight

Integer

1

The weight of the address.

Mode

String

online

The type of the address. Valid values:

  • SMART: smart return

  • ONLINE: always online

  • OFFLINE: always offline

Remark

String

test

The description of the address.

UpdateTime

String

2017-12-28T13:08Z

The time when the address was updated.

UpdateTimestamp

Long

1527690629357

The timestamp that indicates when the address was updated.

CreateTime

String

2017-12-28T13:08Z

The time when the address pool was created.

CreateTimestamp

Long

1527690629357

The timestamp that indicates when the address pool was created.

LbaStrategy

String

all_rr

The load balancing policy of the address pool. Valid values:

  • ALL_RR: returns all addresses.

  • RATIO: returns addresses by weight.

MonitorConfigId

String

test1

The ID of the health check task.

MonitorStatus

String

open

Indicates whether health checks are configured. Valid values:

  • OPEN: enabled

  • CLOSE: disabled

  • UNCONFIGURED: not configured

Name

String

test

The name of the address pool.

RequestId

String

6856BCF6-11D6-4D7E-AC53-FD579933522B

The ID of the request.

Type

String

ipv4

The type of the address pool. Valid values:

  • IPV4: IPv4 address

  • IPV6: IPv6 address

  • DOMAIN: domain name

UpdateTime

String

2017-12-28T13:08Z

The time when the address pool was updated.

UpdateTimestamp

Long

1527690629357

The timestamp that indicates when the address pool was updated.

Examples

Sample requests

http(s)://alidns.aliyuncs.com/? Action=DescribeDnsGtmInstanceAddressPool
&AddrPoolId=testpool1
&<Common request parameters>

Sample success responses

XML format

<Addrs>
    <Addr>
        <AttributeInfo>"LineCode":"default", "LineName": "default"</AttributeInfo>
        <LbaWeight>1</LbaWeight>
        <AlertStatus>ok</AlertStatus>
        <Mode>online</Mode>
        <CreateTime>2017-12-28T13:08Z</CreateTime>
        <AddrId>1</AddrId>
        <UpdateTime>2017-12-28T13:08Z</UpdateTime>
        <UpdateTimestamp>1527690629357</UpdateTimestamp>
        <CreateTimestamp>1527690629357</CreateTimestamp>
        <Addr>1.1.1.1</Addr>
        <Remark>test</Remark>
    </Addr>
</Addrs>
<LbaStrategy>all_rr</LbaStrategy>
<RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
<CreateTime>2017-12-28T13:08Z</CreateTime>
<Name>test</Name>
<AddrCount>1</AddrCount>
<Type>ipv4</Type>
<UpdateTime>2017-12-28T13:08Z</UpdateTime>
<AddrPoolId>testpool1</AddrPoolId>
<UpdateTimestamp>1527690629357</UpdateTimestamp>
<MonitorConfigId>test1</MonitorConfigId>
<MonitorStatus>open</MonitorStatus>
<CreateTimestamp>1527690629357</CreateTimestamp>

JSON format

{
        "Addrs": {
                "Addr": [{
                        "AttributeInfo": "LineCode": "default", "LineName": "default"",
                        "LbaWeight": "1",
                        "AlertStatus": "ok",
                        "Mode": "online",
                        "CreateTime": "2017-12-28T13:08Z",
                        "AddrId": "1",
                        "UpdateTime": "2017-12-28T13:08Z",
                        "UpdateTimestamp": "1527690629357",
                        "CreateTimestamp": "1527690629357",
                        "Addr": "1.1.1.1",
                        "Remark": "test"
                }]
        },
        "LbaStrategy": "all_rr",
        "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
        "CreateTime": "2017-12-28T13:08Z",
        "Name": "test",
        "AddrCount": "1",
        "Type": "ipv4",
        "UpdateTime": "2017-12-28T13:08Z",
        "AddrPoolId": "testpool1",
        "UpdateTimestamp": "1527690629357",
        "MonitorConfigId": "test1",
        "MonitorStatus": "open",
        "CreateTimestamp": "1527690629357"
}

Error codes

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