SearchCloudGtmInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:SearchCloudGtmInstances	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the return value. Options are: zh-CN: Chinese. en-US: English.	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	1ae05db4-10e7-11ef-b126-00163e24**22
PageNumber	integer	No	Current page number, starting from 1, default is 1.	1
PageSize	integer	No	The number of rows per page when paginating queries, with a maximum value of 100, and a default of 20.	20
InstanceId	string	No	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-wwo3a3hbz**
InstanceName	string	No	Schedule instance name, supports fuzzy search.	test

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Unique request identification code.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	Current page number, starting at 1, default is 1.	1
PageSize	integer	The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.	20
TotalPages	integer	Total number of pages.	1
TotalItems	integer	Total number of instances found from the search.	10
Instances	array<object>	The instances.
Instance	object	The instance.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-wwo3a3hbz**
CreateTime	string	Instance creation time.	2024-03-15T01:46Z
CreateTimestamp	long	Instance creation time (timestamp).	1710467214858
UpdateTime	string	The last modified time of the instance.	2024-03-15T01:46Z
UpdateTimestamp	long	The last modified time of the instance (timestamp).	1710467214858
VersionCode	string	Global Traffic Management version 3.0 instance types: standard: Standard Edition ultimate: Ultimate Edition	ultimate
CommodityCode	string	The commodity code. Valid values: dns_gtm_public_cn: commodity code on the China site (aliyun.com) dns_gtm_public_intl: commodity code on the international site (alibabacloud.com)	dns_gtm_public_cn
MonthlySmsQuota	integer	SMS quota, only supported on the China site. International site does not support SMS.	2000
MonitorTaskQuota	integer	Monitor probe task quota.	100
InstanceName	string	Schedule instance name.	test
ExpireTime	long	Instance expiration time.	2024-09-05T16:00Z
ExpireTimestamp	string	Instance expiration time (timestamp).	1725552000000
ScheduleDomainName	string	The access domain name, which consists of a hostname and a zone or a subzone.	www.example.com
MonthlySmsUsed	integer	Monthly SMS sending volume, only supported by the China site as international sites do not support SMS.	200
MonthlyEmailUsed	integer	Monthly email sending volume.	200
MonthlyWebhookUsed	integer	Monthly webhook dispatch volume.	100

Examples

Sample success responses

JSONformat

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 10,
  "Instances": {
    "Instance": [
      {
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1710467214858,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1710467214858,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "MonthlySmsQuota": 2000,
        "MonitorTaskQuota": 100,
        "InstanceName": "test",
        "ExpireTime": 0,
        "ExpireTimestamp": "1725552000000",
        "ScheduleDomainName": "www.example.com",
        "MonthlySmsUsed": 200,
        "MonthlyEmailUsed": 200,
        "MonthlyWebhookUsed": 100
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history