You can call this operation to query the details about a Global Traffic Manger (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 DescribeGtmInstance

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

InstanceId String Yes instance1

The ID of the GTM instance that you want to query.

Lang String No en

The language used by the user.

NeedDetailAttributes Boolean No false

Specifies whether additional information is required. Default value: false.

Response parameters

Parameter Type Example Description
AccessStrategyNum Integer 5

The number of access policies of the GTM instance.

AddressPoolNum Integer 5

The number of address pools of the GTM instance.

AlertGroup String [\"Daily test - R&D group\"]

The alert group of the GTM instance.

Cname String instance1.14.com

The CNAME record of the access domain name.

CnameMode String SYSTEM_ASSIGN

Specifies whether the CNAME record is user-defined or automatically assigned by the system. Valid values:

  • SYSTEM_ASSIGN: Assigned by the system
  • CUSTOM: User-defined
CreateTime String 2018-06-06T11:34Z

The time when the GTM instance was created.

CreateTimeStamp Long 1528284856000

A timestamp that indicates the time when the GTM instance was created.

ExpireTime String 2018-06-06T11:34Z

The time when the GTM instance expires.

ExpireTimestamp Long 1528284856000

A timestamp that indicates the time when the GTM instance expires.

InstanceId String instance1

The ID of the GTM instance queried.

InstanceName String test

The name of the GTM instance queried.

LbaStrategy String RATIO

The load balancing policy. Valid values:

  • ALL_RR: Load balancing
  • RATIO: Weighted round robin
RequestId String E41AA251-F9BA-48C6-99B2-2B82B26A573A

The ID of the request.

Ttl Integer 60

The global time to live (TTL).

UserDomainName String www.example.com

The user's domain name that can access the GTM instance.

VersionCode String biaozhun

The code of the version.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeGtmInstanceResponse>
	  <Cname>instance1.14.com</Cname>
	  <CnameMode>SYSTEM_ASSIGN</CnameMode>
	  <CreateTimestamp>1528284856000</CreateTimestamp>
	  <InstanceId>instance1</InstanceId>
	  <ExpireTimestamp>1528284856000</ExpireTimestamp>
	  <ExpireTime>2018-06-06T11:34Z</ExpireTime>
	  <Ttl>60</Ttl>
	  <RequestId>E41AA251-F9BA-48C6-99B2-2B82B26A573A</RequestId>
	  <VersionCode>biaozhun</VersionCode>
	  <CreateTime>2018-06-06T11:34Z</CreateTime>
	  <UserDomainName>www.example.com</UserDomainName>
	  <AlertGroup>["Daily test - R&D group"]</AlertGroup>
	  <InstanceName>Wenya Test (Do not delete)</InstanceName>
	  <LbaStrategy>RATIO</LbaStrategy>
	  <AccessStrategyNum>5</AccessStrategyNum>
	  <AddressPoolNum>5</AddressPoolNum>
</DescribeGtmInstanceResponse>

JSON format

{
	"Cname":"instance1.14.com",
	"CnameMode":"SYSTEM_ASSIGN",
	"CreateTimestamp":1528284856000,
	"InstanceId":"instance1",
	"AddressPoolNum":5,
	"ExpireTimestamp":1528284856000,
	"AccessStrategyNum":5,
	"ExpireTime":"2018-06-06T11:34Z",
	"Ttl":60,
	"RequestId":"E41AA251-F9BA-48C6-99B2-2B82B26A573A",
	"VersionCode":"biaozhun",
	"CreateTime":"2018-06-06T11:34Z",
	"UserDomainName":"www.example.com",
	"AlertGroup":"[\"Daily test - R&D group\"]",
	"LbaStrategy":"RATIO",
	"InstanceName":"Wenya Test (Do not delete)"
}

Error codes

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