调用DescribeGtmInstanceAddressPools获取GTM实例地址池列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeGtmInstanceAddressPools

系统规定参数。取值:DescribeGtmInstanceAddressPools

InstanceId String gtmtest

实例ID。

Lang String en

用户语言。

PageNumber Integer 1

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

PageSize Integer 20

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

返回数据

名称 类型 示例值 描述
AddrPools Array

地址池列表。

AddrPool

地址池列表。

AddrCount Integer 2

地址数量

AddrPoolId String 1234abc

地址池ID

CreateTime String 2017-12-28T13:08Z

创建时间

CreateTimestamp Long 1527690629357

创建时间(时间戳)

MinAvailableAddrNum Integer 2

最小可用地址数量

MonitorConfigId String 100abc

监控配置ID

MonitorStatus String OPEN

监控状态。其中,

  • OPEN:开启
  • CLOSE:关闭
  • UNCONFIGURED:未配置
Name String 名称

地址池名称

Status String AVAILABLE

地址池可用状态。

  • AVAILABLE:可用
  • NOT_AVAILABLE:不可用
Type String IP

地址池类型。

  • IP:ip
  • DOMAIN:域名
UpdateTime String 2017-12-28T13:08Z

更新时间

UpdateTimestamp Long 1527690629357

更新时间(时间戳)

PageNumber Integer 1

当前页码。

PageSize Integer 20

页面大小。

RequestId String 6856BCF6-11D6-4D7E-AC53-FD579933522B

请求ID。

TotalItems Integer 2

总个数。

TotalPages Integer 1

总页数

示例

请求示例


http(s)://alidns.aliyuncs.com/?Action=DescribeGtmInstanceAddressPools
&InstanceId=gtmtest
&<公共请求参数>

正常返回示例

XML 格式

<DescribeGtmInstanceAddressPoolsResponse>
  <PageNumber>1</PageNumber>
	  <PageSize>20</PageSize>
	  <RequestId>6856BCF6-11D6-4D7E-AC53-FD579933522B</RequestId>
	  <TotalItems>2</TotalItems>
	  <TotalPages>1</TotalPages>
	  <AddrPools>
		    <AddrPoolId>1234abc</AddrPoolId>
		    <CreateTime>2017-12-28T13:08Z</CreateTime>
		    <CreateTimestamp>1527690629357</CreateTimestamp>
		    <AddrCount>2</AddrCount>
		    <MinAvailableAddrNum>2</MinAvailableAddrNum>
		    <MonitorConfigId>100abc</MonitorConfigId>
		    <MonitorStatus>OPEN</MonitorStatus>
		    <Name>名称测试1</Name>
		    <Status>AVAILABLE</Status>
		    <Type>IP</Type>
		    <UpdateTime>2018-01-03T08:57Z</UpdateTime>
		    <UpdateTimestamp>1527690629357</UpdateTimestamp>
	  </AddrPools>
	  <AddrPools>
		    <AddrPoolId>2345abc</AddrPoolId>
		    <CreateTime>2017-12-28T13:08Z</CreateTime>
		    <CreateTimestamp>1527690629357</CreateTimestamp>
		    <AddrCount>2</AddrCount>
		    <MinAvailableAddrNum>2</MinAvailableAddrNum>
		    <MonitorConfigId>101abc</MonitorConfigId>
		    <MonitorStatus>OPEN</MonitorStatus>
		    <Name>名称测试2</Name>
		    <Status>AVAILABLE</Status>
		    <Type>IP</Type>
		    <UpdateTime>2018-01-03T08:57Z</UpdateTime>
		    <UpdateTimestamp>1527690629357</UpdateTimestamp>
	  </AddrPools>
</DescribeGtmInstanceAddressPoolsResponse>

JSON 格式

{
	"PageNumber":1,
	"PageSize":20,
	"RequestId":"6856BCF6-11D6-4D7E-AC53-FD579933522B",
	"TotalItems":2,
	"TotalPages":1,
	"AddrPools":[
		{
			"Name":"名称测试1",
			"Status":"AVAILABLE",
			"CreateTimestamp":1527690629357,
			"AddrCount":2,
			"MonitorConfigId":"100abc",
			"Type":"IP",
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"MonitorStatus":"OPEN",
			"AddrPoolId":"1234abc",
			"MinAvailableAddrNum":2
		},
		{
			"Name":"名称测试2",
			"Status":"AVAILABLE",
			"CreateTimestamp":1527690629357,
			"AddrCount":2,
			"MonitorConfigId":"101abc",
			"Type":"IP",
			"UpdateTimestamp":1527690629357,
			"CreateTime":"2017-12-28T13:08Z",
			"UpdateTime":"2018-01-03T08:57Z",
			"MonitorStatus":"OPEN",
			"AddrPoolId":"2345abc",
			"MinAvailableAddrNum":2
		}
	]
}

错误码

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