SearchCloudGtmAddresses - 搜索地址列表

按照地址名称、备注信息、地址引用的探测模板或地址DI等信息搜索地址列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

alidns:SearchCloudGtmAddresses

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AcceptLanguage

string

返回值语言,取值:

  • zh-CN:中文。

  • en-US(默认值):英文。

en-US

Names

array

地址名称,一般为方便用户区分的名称。

string

地址名称搜索条件,支持同时输入多个关键词进行查询。

["address_1", "test"]

NameSearchCondition

string

按地址名称查询时的搜索逻辑(选择地址名称查询时必选参数):

  • and:展示输入的搜索条件全部命中的查询结果。

  • or:展示输入的搜索条件部分或全部命中的查询结果。

or

AvailableStatus

string

按照地址可用状态条件精确搜索:

  • available:可用

  • unavailable:不可用

available

Type

string

按照地址类型条件精确搜索:

  • IPv4

  • IPv6

  • domain

IPv4

Address

string

按照服务地址条件精确查询,支持 IP 地址或者域名。

223.5.XX.XX

MonitorTemplateName

string

健康探测模板名称。

Ping-IPv4

EnableStatus

string

按照地址启用状态进行精确查询:

  • enable:启用状态

  • disable:禁用状态

enable

HealthStatus

string

按照地址健康状态进行精确查询:

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

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

  • ok_no_monitor:地址没有引用任何健康探测模板。

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

ok

Remarks

array

地址的备注。

string

地址备注搜索条件,支持同时输入多个关键词进行查询。

["", "test"]

RemarkSearchCondition

string

按地址备注查询时的搜索逻辑(选择地址备注查询时必选参数):

and:展示输入的搜索条件全部命中的查询结果。

or:展示输入的搜索条件部分或全部命中的查询结果。

or

PageNumber

integer

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

1

PageSize

integer

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

20

AddressId

string

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

addr-89518218114368****

返回参数

名称

类型

描述

示例值

object

RequestId

string

唯一请求识别码。

536E9CAD-DB30-4647-AC87-AA5CC38C5382

PageNumber

integer

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

1

PageSize

integer

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

20

TotalPages

integer

总页数。

1

TotalItems

integer

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

15

Addresses

object

Address

array<object>

地址列表。

object

地址列表。

AddressId

string

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

addr-89518218114368**92

CreateTime

string

地址的创建时间。

2024-03-23T13:09Z

CreateTimestamp

integer

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

1527690629357

UpdateTime

string

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

2024-03-29T13:20Z

UpdateTimestamp

integer

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

1527690629357

Name

string

地址名称。

Address-1

Type

string

地址类型:

  • IPv4:ipv4 地址

  • IPv6:ipv6 地址

  • domain:域名

IPv4

Address

string

IP 地址或者域名。

223.5.XX.XX

AttributeInfo

string

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

当前版本不返回此参数。

Remark

string

备注。

test

EnableStatus

string

地址当前启用状态:

  • enable:启用状态

  • disable:禁用状态

enable

AvailableMode

string

地址探测异常切换方式:

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

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

auto

ManualAvailableStatus

string

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

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

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

available

AvailableStatus

string

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

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

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

available

HealthStatus

string

地址健康检查探测结果:

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

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

  • ok_no_monitor:地址没有引用任何健康探测模板。

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

ok

HealthJudgement

string

地址健康状态判定条件:

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

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

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

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

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

p50_ok

HealthTasks

object

HealthTask

array<object>

健康探测任务列表。

object

地址引用的健康探测任务信息。

Port

integer

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

80

TemplateId

string

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

mtp-89518052425100****

TemplateName

string

健康探测模板名称。

IPv4-Ping

MonitorStatus

string

健康探测模板探测任务状态:

  • ok:正常。

  • alert:告警。

  • no_data:无数据,一般是健康探测任务刚创建,探测任务数据暂未采集到。

ok

示例

正常返回示例

JSON格式

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368**92",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100****",
              "TemplateName": "IPv4-Ping",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情