ListIpamResourceDiscoveries - 查询资源发现实例_专有网络VPC(VPC)-阿里云帮助中心

查询IPAM资源发现实例。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vpc:ListIpamResourceDiscoveries

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询资源发现的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
ResourceGroupId	string	否	资源发现的资源组 ID。	rg-aek2sermdd6****
IpamResourceDiscoveryIds	array	否	资源发现的实例 ID 列表。N 的取值范围为 1~100，即一次最多查询 100 个资源发现实例。
	string	否	资源发现的实例 ID。	ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryName	string	否	资源发现的名称。长度为 1～128 个字符，不能以 http://或 https://开头。	test
Type	string	否	资源发现的类型。说明当前支持的类型： system：系统创建的默认资源发现。 custom：用户创建的自定义类型的资源发现。	system
Tags	array<object>	否	标签列表信息。
	object	否	标签列表信息。
Key	string	否	标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持 128 个字符，不能包含`http://`或者`https://`。	FinanceJoshua
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	10
IsShared	boolean	否	是否是共享的资源发现。	true

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
IpamResourceDiscoveries	array<object>	资源发现的实例列表。
	object	资源发现的实例列表。
IpamResourceDiscoveryId	string	资源发现的实例 ID。	ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryName	string	资源发现的名称。	test
IpamResourceDiscoveryDescription	string	资源发现的描述信息。	test description
OperatingRegionList	array	资源发现的操作地域列表。
	string	资源发现的操作地域。	cn-hangzhou
Type	string	资源发现的类型。	system
IpamResourceDiscoveryStatus	string	资源发现实例的状态。取值： Creating：表示创建中。 Created：表示创建完成。 Modifying：表示修改中。 Deleting：表示删除中。 Deleted：表示已删除。	Created
ResourceGroupId	string	资源发现的资源组 ID。	rg-aek2sermdd6****
CreateTime	string	资源发现创建的时间。	2022-07-01T02:05:23Z
Tags	array<object>	标签列表。
	object	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua
RegionId	string	查询到的资源发现实例的地域 ID。	cn-hangzhou
OwnerId	integer	资源发现实例资源拥有者的阿里云主账号。	1210123456******
ShareType	string	资源的共享状态。取值为空时，表示该资源发现为普通的实例。取值为 Shared 时，表示该资源发现来自共享。取值为 Sharing 时，表示该资源发现在共享中。	Shared
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	本次请求条件下的数据总量。	1
MaxResults	integer	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	10
Count	integer	分批次查询时返回的具体条目数。	1
RequestId	string	请求 ID。	86137597-443F-5B66-B9B6-8514E0C50B8F

示例

正常返回示例

JSON格式

{
  "IpamResourceDiscoveries": [
    {
      "IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
      "IpamResourceDiscoveryName": "test",
      "IpamResourceDiscoveryDescription": "test description",
      "OperatingRegionList": [
        "cn-hangzhou"
      ],
      "Type": "system",
      "IpamResourceDiscoveryStatus": "Created",
      "ResourceGroupId": "rg-aek2sermdd6****",
      "CreateTime": "2022-07-01T02:05:23Z",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "RegionId": "cn-hangzhou",
      "OwnerId": 0,
      "ShareType": "Shared"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1,
  "MaxResults": 10,
  "Count": 1,
  "RequestId": "86137597-443F-5B66-B9B6-8514E0C50B8F"
}

错误码

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

变更历史

更多信息，参考变更详情。