All Products
Search

This Product

    Alibaba Cloud DNS:ListCloudGtmInstances

    Document Center

    Alibaba Cloud DNS:ListCloudGtmInstances

    Last Updated:Apr 21, 2025

    Obtains the GTM 3.0 instances based on the specified parameters.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alidns:ListCloudGtmInstanceslist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    Return language value. Options:

    • zh-CN: Chinese.
    • en-US: English.
    		en-US
    ClientTokenstringNo

    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.

    		1ae05db4-10e7-11ef-b126-00163e24**22
    PageNumberintegerNo

    Current page number, starting from 1, default is 1.

    		1
    PageSizeintegerNo

    The number of rows per page when paginating queries, with a maximum value of 100, and a default of 20.

    		20
    InstanceIdstringNo

    The ID of the GTM instance.

    		gtm-cn-jmp3qnw**03
    InstanceNamestringNo

    Instance name, used to distinguish the business purpose of the instance.

    		test

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		536E9CAD-DB30-4647-AC87-AA5CC38C5382
    PageNumberinteger

    Current page number, starting with 1, default is 1.

    		1
    PageSizeinteger

    The number of rows per page when paginating queries, with a maximum value of 100 and a default of 20.

    		20
    TotalPagesinteger

    Total number of pages.

    		1
    TotalItemsinteger

    Total number of instance entries.

    		15
    Instancesarray<object>

    The instances.

    Instanceobject

    The instance.

    InstanceIdstring

    The ID of the GTM instance.

    		gtm-cn-jmp3qnw**03
    InstanceNamestring

    Instance name.

    		test
    CreateTimestring

    Instance creation time.

    		2024-03-15T01:46Z
    CreateTimestamplong

    Instance creation time (timestamp).

    		1231298343343
    UpdateTimestring

    The last time the instance was modified.

    		2024-03-15T01:46Z
    UpdateTimestamplong

    The last modification time of the instance (timestamp).

    		1231298343343
    VersionCodestring

    GTM instance version:

    • standard: Standard Edition
    • ultimate: Ultimate Edition
    		ultimate
    CommodityCodestring

    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
    MonthlySmsQuotainteger

    SMS quota, only supported on the China site as international sites do not support SMS.

    		1000
    MonitorTaskQuotainteger

    Monitor probe task quota.

    		100
    ExpireTimestamplong

    Instance expiration time (timestamp).

    		1231298343343
    ExpireTimestring

    Instance expiration time.

    		2024-03-15T01:46Z
    ScheduleDomainNamestring

    The access domain name, which consists of a hostname and a zone or a subzone.

    		www.example.com
    MonthlySmsUsedinteger

    Monthly SMS sending volume, only supported by the China site as international sites do not support SMS.

    		100
    MonthlyEmailUsedinteger

    Monthly email sending volume.

    		50
    MonthlyWebhookUsedinteger

    Monthly webhook send volume.

    		80

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Instances": {
    "Instance": [
      {
        "InstanceId": "gtm-cn-jmp3qnw**03",
        "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
      }
    ]
  }
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history