ListCloudGtmInstances - 获取实例列表

根据传入参数获取GTM 3.0实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alidns:ListCloudGtmInstances

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AcceptLanguage

string

返回值语言,取值:

  • zh-CN:中文。

  • en-US:英文。

en-US

ClientToken

string

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

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

PageNumber

integer

当前页数,起始值为 1,默认为 1

1

PageSize

integer

分页查询时设置的每页行数,最大值 100,默认为 20

20

InstanceId

string

GTM 实例 ID。

gtm-cn-jmp3qnw****

InstanceName

string

实例名称,方便区分实例的业务用途。

test

返回参数

名称

类型

描述

示例值

object

RequestId

string

唯一请求识别码。

536E9CAD-DB30-4647-AC87-AA5CC38C5382

PageNumber

integer

当前页数,起始值为 1,默认为 1

1

PageSize

integer

分页查询时设置的每页行数,最大值 100,默认为 20。

20

TotalPages

integer

总页数。

1

TotalItems

integer

实例总条目数。

15

Instances

object

Instance

array<object>

实例列表。

object

实例信息。

InstanceId

string

GTM 实例 ID。

gtm-cn-jmp3qnw****

InstanceName

string

实例名称。

test

CreateTime

string

实例创建时间。

2024-03-15T01:46Z

CreateTimestamp

integer

实例创建时间(时间戳)。

1231298343343

UpdateTime

string

实例最后一次修改时间。

2024-03-15T01:46Z

UpdateTimestamp

integer

实例最后一次修改时间(时间戳)。

1231298343343

VersionCode

string

GTM 实例版本:

  • standard:标准版

  • ultimate:旗舰版

ultimate

CommodityCode

string

商品编码:

  • dns_gtm_public_cn:中国站商品编码。

  • dns_gtm_public_intl:国际站商品编码。

dns_gtm_public_cn

MonthlySmsQuota

integer

短息配额,仅中国站支持短消息,国际站不支持短消息。

1000

MonitorTaskQuota

integer

监控探测任务配额。

100

ExpireTimestamp

integer

实例到期时间(时间戳)。

1231298343343

ExpireTime

string

实例到期时间。

2024-03-15T01:46Z

ScheduleDomainName

string

GTM 接入域名。格式为接入域名主机记录(ScheduleHostname 参数值)+主域或子域(ScheduleZoneName 参数值)。

www.example.com

MonthlySmsUsed

integer

当月短信发送量,仅中国站支持短信,国际站不支持短信。

100

MonthlyEmailUsed

integer

当月邮件发送量。

50

MonthlyWebhookUsed

integer

当月 webhook 发送量。

80

示例

正常返回示例

JSON格式

{
  "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
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情