SearchCloudGtmInstances - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

This operation searches for instances based on specified parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US: English.	en-US
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. 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****
PageNumber	integer	No	The number of the page to return. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100. The default value is 20.	20
InstanceId	string	No	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-wwo3a3h****
InstanceName	string	No	The name of the scheduling instance. Fuzzy search is supported.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	The number of the returned page. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of instances found.	10
Instances	object
Instance	array<object>	The list of instances.
	object	The instance details.
InstanceId	string	The GTM 3.0 instance ID.	gtm-cn-wwo3a3h****
CreateTime	string	The time when the instance was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The timestamp that indicates when the instance was created.	1710467214858
UpdateTime	string	The time when the instance was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The timestamp that indicates when the instance was last modified.	1710467214858
VersionCode	string	The edition of the GTM 3.0 instance: standard: Standard Edition ultimate: Ultimate Edition	ultimate
CommodityCode	string	The commodity code: dns_gtm_public_cn: The commodity code for the China site (aliyun.com). dns_gtm_public_intl: The commodity code for the international site (alibabacloud.com).	dns_gtm_public_cn
MonthlySmsQuota	integer	The monthly quota for text messages. This feature is available only on the China site (aliyun.com).	2000
MonitorTaskQuota	integer	The quota for health check tasks.	100
InstanceName	string	The name of the scheduling instance.	test
ExpireTime	integer	The time when the instance expires.	2024-09-05T16:00Z
ExpireTimestamp	string	The timestamp that indicates when the instance expires.	1725552000000
ScheduleDomainName	string	The access domain name for GTM. The domain name is formed by combining the host record (ScheduleHostname) and the domain name (ScheduleZoneName).	www.example.com
MonthlySmsUsed	integer	The number of text messages sent in the current month. This feature is available only on the China site (aliyun.com).	200
MonthlyEmailUsed	integer	The number of emails sent in the current month.	200
MonthlyWebhookUsed	integer	The number of webhook notifications sent in the current month.	100
ChargeType	string		postpay / prepay

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 10,
  "Instances": {
    "Instance": [
      {
        "InstanceId": "gtm-cn-wwo3a3h****",
        "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,
        "ChargeType": "postpay / prepay"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.