全部产品
Search

搜索本产品

    云解析 DNS：SearchCloudGtmAddresses - 搜索地址列表

    文档中心

    云解析 DNS：SearchCloudGtmAddresses - 搜索地址列表

    更新时间：Nov 04, 2024

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

    调试

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

    授权信息

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

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

    请求参数

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

    返回值语言，取值：

    • zh-CN：中文。

    • en-US（默认值）：英文。

    		en-US
    Namesarray否

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

    string否

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

    		["address_1", "test"]
    NameSearchConditionstring否

    按地址名称查询时的搜索逻辑（选择地址名称查询时必选参数）：

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

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

    		or
    AvailableStatusstring否

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

    • available：可用

    • unavailable：不可用

    		available
    Typestring否

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

    • IPv4

    • IPv6

    • domain

    		IPv4
    Addressstring否

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

    		223.5.XX.XX
    MonitorTemplateNamestring否

    健康探测模板名称。

    		Ping-IPv4
    EnableStatusstring否

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

    • enable：启用状态

    • disable：禁用状态

    		enable
    HealthStatusstring否

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

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

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

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

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

    		ok
    Remarksarray否

    地址的备注。

    string否

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

    		["", "test"]
    RemarkSearchConditionstring否

    按地址备注查询时的搜索逻辑（选择地址备注查询时必选参数）：

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

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

    		or
    PageNumberinteger是

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

    		1
    PageSizeinteger是

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

    		20
    AddressIdstring否

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

    		addr-89518218114368****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    唯一请求识别码。

    		536E9CAD-DB30-4647-AC87-AA5CC38C5382
    PageNumberinteger

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

    		1
    PageSizeinteger

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

    		20
    TotalPagesinteger

    总页数。

    		1
    TotalItemsinteger

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

    		15
    Addressesarray<object>

    地址列表。

    Addressobject

    地址列表。

    AddressIdstring

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

    		addr-89518218114368**92
    CreateTimestring

    地址的创建时间。

    		2024-03-23T13:09Z
    CreateTimestamplong

    地址的创建时间（时间戳）。

    		1527690629357
    UpdateTimestring

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

    		2024-03-29T13:20Z
    UpdateTimestamplong

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

    		1527690629357
    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

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

    • 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：所有探测模板全部探测正常。

    		p50_ok
    HealthTasksarray<object>

    健康探测任务列表。

    HealthTaskobject

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

    Portinteger

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

    		80
    TemplateIdstring

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

    		mtp-89518052425100****
    TemplateNamestring

    健康探测模板名称。

    		IPv4-Ping
    MonitorStatusstring

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

    • 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"
            }
          ]
        }
      }
    ]
  }
}

    错误码

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