DescribeIdcProbeList - 查询IDC机房资产发现探针列表

获取多云配置管理功能中IDC机房资产发现探针的列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeIdcProbeListget
*全部资源
*

请求参数

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

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
Statusinteger

探针使用状态。取值:

  • 0:启用
  • 1:停用
0
IdcNamestring

IDC 的名称。

3K IDC

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

0C8487EF-50C2-54BB-8634-10F8C35D****
PageInfoobject

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

总条数。

30
Countinteger

分页查询时,当前页显示数据条数。

17
IdcProbesarray<object>

IDC 探针列表。

IdcProbeobject

IDC 探针列表。

Statusinteger

探针使用状态。取值:

  • 0:启用
  • 1:停用
0
LinuxPortstring

Linux 端口。

22
InternetIpstring

公网 IP 地址。

47.98.*.*
IdcRegionstring

地域。

cn-hangzhou
InstanceIdstring

资产的实例 id。

i-xxxxx
IpSegmentsstring

IP 段范围。

192.168.1.0/24
IntranetIpstring

实例的私网 IP。

10.68.*.*
Uuidstring

服务器 UUID。

inet-eae02b9a-1dbd-44a6-844c-69072b27****
IntervalPeriodinteger

扫描周期。

16
InstanceNamestring

实例名称。

oraclexxx
PeriodUnitstring

扫描周期的单位,取值:

  • day:天。
  • hour:小时。
day
WinPortstring

Windows 端口。

3389
IdcNamestring

IDC 机房名称。

3K IDC
ServiceStatusinteger

探针服务状态。取值:

  • 0:正常
  • 1:异常
0

示例

正常返回示例

JSON格式

{
  "RequestId": "0C8487EF-50C2-54BB-8634-10F8C35D****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 30,
    "Count": 17
  },
  "IdcProbes": [
    {
      "Status": 0,
      "LinuxPort": "22",
      "InternetIp": "47.98.*.*",
      "IdcRegion": "cn-hangzhou",
      "InstanceId": "i-xxxxx",
      "IpSegments": "192.168.1.0/24",
      "IntranetIp": "10.68.*.*",
      "Uuid": "inet-eae02b9a-1dbd-44a6-844c-69072b27****",
      "IntervalPeriod": 16,
      "InstanceName": "oraclexxx",
      "PeriodUnit": "day",
      "WinPort": "3389",
      "IdcName": "3K IDC",
      "ServiceStatus": 0
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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