文档

SearchCloudGtmAddressPools - 搜索地址池列表

更新时间:

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

返回值语言,取值:

  • zh-CN:中文。

  • en-US:英文。

en-US
ClientTokenstring

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

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

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

1
PageSizeinteger

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

20
AddressPoolNamestring

地址池名称,支持对输入的地址池名称进行模糊搜索。

AddressPool-1
AddressPoolTypestring

地址池类型,支持对地址池类型进行精确查询:

  • IPv4

  • IPv6

  • domain

IPv4
EnableStatusstring

地址池启用状态,支持对地址池启用状态进行精确查询:

  • enable:启用状态

  • disable:禁用状态

enable
Remarkstring

地址池备注,支持对输入的备注进行模糊搜索。

test
HealthStatusstring

地址池健康状态,支持对地址池健康状态精确查询:

ok:正常,地址池引用的所有地址全部可用。

ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析

exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。

ok
AvailableStatusstring

地址池可用状态,支持对地址池可用状态进行精确查询:

  • available:可用

  • unavailable:不可用

available

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumberinteger

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

1
PageSizeinteger

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

20
TotalPagesinteger

总页数。

1
TotalItemsinteger

符合查询条件的地址池总条目数。

11
AddressPoolsobject []

地址池列表。

CreateTimestring

地址池创建时间。

2024-03-15T01:46Z
CreateTimestamplong

地址池创建时间(时间戳)。

1527690629357
UpdateTimestring

地址池最后一次修改时间。

024-03-15T01:46Z
UpdateTimestamplong

地址池最后一次修改时间(时间戳)。

1527690629357
AddressPoolIdstring

地址池 Id,地址池的唯一标识码。

pool-895280232254422016
AddressPoolNamestring

地址池名称。

AddressPool-1
AddressPoolTypestring

地址池类型:

  • IPv4

  • IPv6

  • domain

IPv4
AddressLbStrategystring

地址池中地址间负载均衡策略:

  • round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。

  • sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。

  • weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。

  • source_nearest:来源就近,即智能解析功能,GTM 可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。

round_robin
SequenceLbStrategyModestring

地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:

  • preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址;

  • non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址;

preemptive
EnableStatusstring

地址池启用状态:

  • enable:启用状态

  • disable:禁用状态

enable
HealthJudgementstring

地址池健康状态判定条件:

  • any_ok:地址池内至少 1 个地址是可用地址;

  • p30_ok:地址池内至少 30%地址是可用地址;

  • p50_ok:地址池内至少 50%地址是可用地址;

  • p70_ok:地址池内至少 70%地址是可用地址;

  • all_ok:地址池内地址全部可用;

any_ok
HealthStatusstring

地址池健康状态:

  • ok:正常,地址池引用的所有地址全部可用。

  • ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析

  • exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。

ok
AvailableStatusstring

地址池可用性状态:

  • available:可用

  • unavailable:不可用

available
Addressesobject []

IP 地址或者域名列表。

CreateTimestring

地址创建时间。

2024-03-15T01:46Z
CreateTimestamplong

地址创建时间(时间戳)。

1527690629357
UpdateTimestring

地址最后一次修改时间。

2024-03-15T01:46Z
UpdateTimestamplong

地址的最后一次的修改时间(时间戳)。

1527690629357
AddressIdstring

地址 ID,地址的唯一标识码。

addr-895182181143688192
WeightValueinteger

权重值(1-100 内的整数),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。

1
SerialNumberinteger

顺序号,标识地址返回的优先级,越小优先级越高。

1
RequestSourcestring

请求来源,是指解析请求的来源,GTM 是根据终端所用 LocalDNS 的出口 IP 进行调度。若 LocalDNS 支持 ECS (edns-client-subnet),也可以根据访问终端的 IP 进行智能调度。

default
Namestring

地址名称。

Address-1
Typestring

地址类型:

  • IPv4:ipv4 地址
  • IPv6:ipv6 地址
  • domain:域名
IPv4
Addressstring

IP 地址或者域名。

223.5.XX.XX
AttributeInfostring

地址归属信息,当前版本不支持返回此参数。

当前版本不支持返回此参数。
Remarkstring

备注。

test
EnableStatusstring

地址启用状态,表示地址当前是否可用:

  • enable:启用状态

  • disable:禁用状态

enable
AvailableModestring

地址探测异常切换方式:

  • auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)

  • manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析。)

auto
ManualAvailableStatusstring

当地址探测异常切换模式为 manual 时,地址设置的可用状态:

  • available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析;

  • unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析;

available
AvailableStatusstring

地址可用状态:

  • available:地址可用

  • unavailable:地址不可用

available
HealthStatusstring

地址健康探测状态:

  • ok:地址引用的健康探测模板探测任务全部正常;

  • ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态;

  • ok_no_monitor:地址没有引用任何健康探测模板,状态正常;

  • exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态;

ok
HealthJudgementstring

地址健康状态判定条件:

  • any_ok:所有探测模板至少一个探测正常

  • p30_ok:所有探测模板至少 30%探测正常

  • p50_ok:所有探测模板至少 50%探测正常

  • p70_ok:所有探测模板至少 70%探测正常

  • all_ok:所有探测模板全部探测正常

any_ok
HealthTasksobject []

健康探测任务列表。

Portinteger

健康检查探测的目标地址服务端口,当健康检查选择 Ping 协议时,不支持服务端口的配置。

80
TemplateIdstring

地址关联的健康探测模板 ID。

mtp-89518052425100**80
TemplateNamestring

健康探测模板名称。

IPv4-Ping
Remarkstring

地址备注。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 11,
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-895280232254422016",
        "AddressPoolName": "AddressPool-1",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-895182181143688192",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": "default",
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "HealthTasks": {
                "HealthTask": [
                  {
                    "Port": 80,
                    "TemplateId": "mtp-89518052425100**80",
                    "TemplateName": "IPv4-Ping"
                  }
                ]
              }
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

错误码

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