调用DescribeGtmInstances获取GTM实例列表(旧版)_云解析DNS(DNS)-阿里云帮助中心

获取GTM实例列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
alidns:DescribeGtmInstances	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	语言。	en
PageNumber	integer	否	当前页数，起始值为 1，默认为 1。	1
PageSize	integer	否	分页查询时设置的每页行数，最大值 100，默认为 20。	20
Keyword	string	否	查询关键字，支持实例 Id，实例名称精确搜索。	test
ResourceGroupId	string	否	资源组 ID。	rg-xxxxx
NeedDetailAttributes	boolean	否	是否需要额外信息，默认为 false。	false

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页查询时设置的每页行数，最大值 100，默认为 20。	20
RequestId	string	唯一请求识别码。	193B0163-7F93-42DF-AB05-ACEEB7D22707
PageNumber	integer	当前页数，起始值为 1，默认为 1。	1
GtmInstances	array<object>	GTM 实例列表。
GtmInstance	object
ExpireTime	string	实例到期时间。	2018-06-06T11:34Z
AccessStrategyNum	integer	访问策略个数。	5
CreateTime	string	实例创建时间。	2018-06-06T11:34Z
CnameMode	string	当前接入方式。其中： SYSTEM_ASSIGN：系统分配 CUSTOM：自定义	CUSTOM
InstanceId	string	实例 ID。	gtm-cn-wwo3a3hbz**
ExpireTimestamp	long	实例到期时间（时间戳）。	1528284856000
Ttl	integer	全局 TTL。	60
AlertGroup	string	报警组。	[\"研发组\"]
AddressPoolNum	integer	地址池个数。	5
InstanceName	string	实例名称。	test
LbaStrategy	string	负载均衡策略。 ALL_RR: 负载均摊 RATIO: 加权轮询	RATIO
Cname	string	CNAME 接入域名。	gtm-cn-wwo3a3hbz**.dns-example.top
VersionCode	string	版本 Code。	biaozhun
UserDomainName	string	用户域名。	dns-example.top
CreateTimestamp	long	创建时间（时间戳）。	1528284856000
ResourceGroupId	string	资源组 ID。	rg-acfm2q2jqpjh***
TotalPages	integer	总页数。	1
TotalItems	integer	总个数。	1

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "193B0163-7F93-42DF-AB05-ACEEB7D22707",
  "PageNumber": 1,
  "GtmInstances": {
    "GtmInstance": [
      {
        "ExpireTime": "2018-06-06T11:34Z",
        "AccessStrategyNum": 5,
        "CreateTime": "2018-06-06T11:34Z",
        "CnameMode": "CUSTOM",
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "ExpireTimestamp": 1528284856000,
        "Ttl": 60,
        "AlertGroup": "[\\\"研发组\\\"]",
        "AddressPoolNum": 5,
        "InstanceName": "test",
        "LbaStrategy": "RATIO",
        "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top\n",
        "VersionCode": "biaozhun",
        "UserDomainName": "dns-example.top",
        "CreateTimestamp": 1528284856000,
        "ResourceGroupId": "rg-acfm2q2jqpjh***"
      }
    ]
  },
  "TotalPages": 1,
  "TotalItems": 1
}

错误码

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