ListIpamDiscoveredResource - 查询资源发现下的资源信息

查询资源发现下的资源信息。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vpc:ListIpamDiscoveredResource

list

*IpamResourceDiscovery

acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

资源发现实例的托管地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

IpamResourceDiscoveryId

string

资源发现实例 ID。

ipam-res-disco-jt5f2af2u6nk2z321****

ResourceRegionId

string

资源发现的操作地域。

cn-hangzhou

ResourceType

string

资源类型。取值:

  • VPC:表示资源类型为 VPC。

  • VSwitch:表示资源类型为交换机。

VPC

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResults

integer

分批次查询时返回的最多条目数。取值范围:1~100,默认值为 10。

10

返回参数

名称

类型

描述

示例值

object

返回的信息列表。

IpamDiscoveredResources

array<object>

资源列表信息。

object

资源列表信息。

AliUid

integer

阿里云账号(主账号)ID。

132193271328****

ResourceType

string

资源类型。取值:

  • VPC:表示资源类型为 VPC。

  • VSwitch:表示资源类型为交换机。

VPC

ResourceId

string

资源 ID。

vpc-uf611fp465c7dyb4z****

ResourceOwnerId

integer

资源归属的阿里云账号(主账号)ID。

132193271328****

ResourceRegionId

string

资源归属的地域 ID。

cn-hangzhou

Cidr

string

资源的地址段。

192.168.1.0/32

IpUsage

string

IP 的利用率,小数形式。

0

IpCountDetail

object

FreeIpCount

string

TotalIpCount

string

UsedIpCount

string

IpamResourceDiscoveryId

string

资源发现实例 ID。

ipam-res-disco-jt5f2af2u6nk2z321****

VpcId

string

资源所属的 VPC 实例 ID。

vpc-uf611fp465c7dyb4z****

DiscoveryTime

string

资源被发现的时间。

说明

如果资源被创建后未被修改过,资源被发现的时间保持不变。

2024-01-01 00:00:00

SourceCidr

string

源 CIDR 地址段。

192.168.1.0/24

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****

TotalCount

integer

本次请求条件下的数据总量。

1000

MaxResults

integer

分批次查询时返回的最多条目数。取值范围:1~100,默认值为 10。

10

Count

integer

分批次查询时返回的具体条目数。

10

RequestId

string

请求 ID。

3748DEFF-68BE-5EED-9937-7C1D0C21BAB4

示例

正常返回示例

JSON格式

{
  "IpamDiscoveredResources": [
    {
      "AliUid": 0,
      "ResourceType": "VPC",
      "ResourceId": "vpc-uf611fp465c7dyb4z****",
      "ResourceOwnerId": 0,
      "ResourceRegionId": "cn-hangzhou",
      "Cidr": "192.168.1.0/32",
      "IpUsage": "0",
      "IpCountDetail": {
        "FreeIpCount": "",
        "TotalIpCount": "",
        "UsedIpCount": ""
      },
      "IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
      "VpcId": "vpc-uf611fp465c7dyb4z****",
      "DiscoveryTime": "2024-01-01 00:00:00",
      "SourceCidr": "192.168.1.0/24"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "3748DEFF-68BE-5EED-9937-7C1D0C21BAB4"
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalParam.ResourceRegion The input parameter ResourceRegionId is invalid. 输入的参数ResourceRegionId未在操作地域中。
400 ResourceNotFound.IpamResourceDiscovery The dependent instance of IPAM resource discovery is not found. 未找到IPAM资源发现实例。
400 MissingParam.IpamResourceDiscoveryId The IpamResourceDiscoveryId must be input. 查询发现的资源时,请输入参数IpamResourceDiscoveryId。
400 MissingParam.ResourceRegionId The ResourceRegionId must be input. 查询发现的资源时,请输入参数ResourceRegionId。

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

变更历史

更多信息,参考变更详情