You can call this operation to query the Global Traffic Manager (GTM) instances under your account.

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 DescribeGtmInstances

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

Keyword String No test

The keyword that you use for query. You can search for instances by the GTM instance ID or instance name.

Lang String No en

The language used by the user.

NeedDetailAttributes Boolean No false

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

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 20

The number of entries returned per page.

ResourceGroupId String No rg-xxxxx

The ID of the resource group.

Response parameters

Parameter Type Example Description
GtmInstances Array

The returned list of GTM instances.

GtmInstance

The details about a GTM instance.

AccessStrategyNum Integer 5

The number of access policies of the GTM instance.

AddressPoolNum Integer 5

The number of address pools of the GTM instances.

AlertGroup String [\"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.

InstanceName String test

The name of the GTM instance.

LbaStrategy String RATIO

The load balancing policy. Valid values:

  • ALL_RR: Load balancing
  • RATIO: Weighted round robin
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.

PageNumber Integer 1

The number of the page returned.

PageSize Integer 20

The number of entries returned per page.

RequestId String 193B0163-7F93-42DF-AB05-ACEEB7D22707

The ID of the request.

TotalItems Integer 1

The total number of entries returned on all pages.

TotalPages Integer 1

The total number of pages returned.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeGtmInstancesResponse>
  <GtmInstances>
		    <GtmInstance>
			      <Cname>instance1.14.com</Cname>
			      <CnameMode>SYSTEM_ASSIGN</CnameMode>
			      <CreateTimestamp>1528284856000</CreateTimestamp>
			      <ExpireTime>2018-06-06T11:34Z</ExpireTime>
			      <Ttl>60</Ttl>
			      <CreateTime>2018-06-06T11:34Z</CreateTime>
			      <InstanceId>instance1</InstanceId>
			      <AlertGroup>["R&D group"]</AlertGroup>
			      <UserDomainName>www.example.com</UserDomainName>
			      <ExpireTimestamp>1528284856000</ExpireTimestamp>
			      <LbaStrategy>RATIO</LbaStrategy>
			      <InstanceName>Wenya Test (Do not delete)</InstanceName>
			      <VerisonCode>biaozhun</VerisonCode>
			      <AccessStrategyNum>5</AccessStrategyNum>
			      <AddressPoolNum>5</AddressPoolNum>
		    </GtmInstance>
	  </GtmInstances>
	  <PageNumber>1</PageNumber>
	  <PageSize>20</PageSize>
	  <RequestId>193B0163-7F93-42DF-AB05-ACEEB7D22707</RequestId>
	  <TotalItems>1</TotalItems>
	  <TotalPages>1</TotalPages>
</DescribeGtmInstancesResponse>

JSON format

{
	"GtmInstances":{
		"GtmInstance":[
			{
				"Cname":"instance1.14.com",
				"CnameMode":"SYSTEM_ASSIGN",
				"CreateTimestamp":1528284856000,
				"InstanceId":"instance1",
				"AddressPoolNum":5,
				"ExpireTimestamp":1528284856000,
				"AccessStrategyNum":5,
				"ExpireTime":"2018-06-06T11:34Z",
				"Ttl":60,
				"CreateTime":"2018-06-06T11:34Z",
				"VerisonCode":"biaozhun",
				"AlertGroup":"[\"R&D group\"]",
				"UserDomainName":"www.example.com",
				"LbaStrategy":"RATIO",
				"InstanceName":"Wenya Test (Do not delete)"
			}
		]
	},
	"PageNumber":1,
	"PageSize":20,
	"RequestId":"193B0163-7F93-42DF-AB05-ACEEB7D22707",
	"TotalItems":1,
	"TotalPages":1
}

Error codes

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