ListCloudGtmInstances-阿里云帮助中心

Retrieves a list of GTM 3.0 instances based on the 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:ListCloudGtmInstances

list

*All Resource

*

None

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	A client token that is used to ensure the idempotence of the request. Generate a unique value on the client. The token can contain only ASCII characters and cannot exceed 64 characters in length.	1ae05db4-10e7-11ef-b126-00163e24****
PageNumber	integer	No	The page number. 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 GTM instance.	gtm-cn-jmp3qnw****
InstanceName	string	No	The name of the instance. This helps you identify the business purpose of the instance.	test
ChargeType	string	No		postpay/prepay

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned on each 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.	15
Instances	object
Instance	array<object>	The list of instances.
	object	The information about the instance.
InstanceId	string	The ID of the GTM instance.	gtm-cn-jmp3qnw****
InstanceName	string	The name of the instance.	test
CreateTime	string	The time when the instance was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The UNIX timestamp that indicates when the instance was created.	1231298343343
UpdateTime	string	The time when the instance was last modified.	2024-03-15T01:46Z
UpdateTimestamp	integer	The UNIX timestamp that indicates when the instance was last modified.	1231298343343
VersionCode	string	The edition of the GTM 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. Text messages are supported only on the China site (aliyun.com).	1000
MonitorTaskQuota	integer	The quota for health check tasks.	100
ExpireTimestamp	integer	The UNIX timestamp that indicates when the instance expires.	1231298343343
ExpireTime	string	The time when the instance expires.	2024-03-15T01:46Z
ScheduleDomainName	string	The access domain name of GTM. The domain name is a combination of the host record (the value of the ScheduleHostname parameter) and the primary domain or subdomain (the value of the ScheduleZoneName parameter).	www.example.com
MonthlySmsUsed	integer	The number of text messages sent in the current month. Text messages are supported only on the China site (aliyun.com).	100
MonthlyEmailUsed	integer	The number of emails sent in the current month.	50
MonthlyWebhookUsed	integer	The number of webhook notifications sent in the current month.	80
ChargeType	string		postpay / prepay

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Instances": {
    "Instance": [
      {
        "InstanceId": "gtm-cn-jmp3qnw****",
        "InstanceName": "test",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1231298343343,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1231298343343,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "MonthlySmsQuota": 1000,
        "MonitorTaskQuota": 100,
        "ExpireTimestamp": 1231298343343,
        "ExpireTime": "2024-03-15T01:46Z",
        "ScheduleDomainName": "www.example.com",
        "MonthlySmsUsed": 100,
        "MonthlyEmailUsed": 50,
        "MonthlyWebhookUsed": 80,
        "ChargeType": "postpay / prepay"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.