全部产品
Search

搜索本产品

    云解析 DNS：ListCloudGtmInstances - 获取实例列表

    文档中心

    云解析 DNS：ListCloudGtmInstances - 获取实例列表

    更新时间：Nov 04, 2024

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    alidns:ListCloudGtmInstanceslist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    AcceptLanguagestring否

    返回值语言，取值：

    • zh-CN：中文。

    • en-US：英文。

    		en-US
    ClientTokenstring否

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

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

    当前页数，起始值为 1，默认为 1。

    		1
    PageSizeinteger否

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

    		20
    InstanceIdstring否

    GTM 实例 ID。

    		gtm-cn-jmp3qnw****
    InstanceNamestring否

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

    		test

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    唯一请求识别码。

    		536E9CAD-DB30-4647-AC87-AA5CC38C5382
    PageNumberinteger

    当前页数，起始值为 1，默认为 1。

    		1
    PageSizeinteger

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

    		20
    TotalPagesinteger

    总页数。

    		1
    TotalItemsinteger

    实例总条目数。

    		15
    Instancesarray<object>

    实例列表。

    Instanceobject

    实例信息。

    InstanceIdstring

    GTM 实例 ID。

    		gtm-cn-jmp3qnw****
    InstanceNamestring

    实例名称。

    		test
    CreateTimestring

    实例创建时间。

    		2024-03-15T01:46Z
    CreateTimestamplong

    实例创建时间（时间戳）。

    		1231298343343
    UpdateTimestring

    实例最后一次修改时间。

    		2024-03-15T01:46Z
    UpdateTimestamplong

    实例最后一次修改时间（时间戳）。

    		1231298343343
    VersionCodestring

    GTM 实例版本：

    • standard：标准版

    • ultimate：旗舰版

    		ultimate
    CommodityCodestring

    商品编码：

    • dns_gtm_public_cn：中国站商品编码。

    • dns_gtm_public_intl：国际站商品编码。

    		dns_gtm_public_cn
    MonthlySmsQuotainteger

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

    		1000
    MonitorTaskQuotainteger

    监控探测任务配额。

    		100
    ExpireTimestamplong

    实例到期时间（时间戳）。

    		1231298343343
    ExpireTimestring

    实例到期时间。

    		2024-03-15T01:46Z
    ScheduleDomainNamestring

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

    		www.example.com
    MonthlySmsUsedinteger

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

    		100
    MonthlyEmailUsedinteger

    当月邮件发送量。

    		50
    MonthlyWebhookUsedinteger

    当月 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
      }
    ]
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史