赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 专有网络VPC
  4. 开发参考
  5. API参考(IP地址管理)
  6. API目录
  7. 资源发现
  8. ListIpamResourceDiscoveries - 查询资源发现实例

ListIpamResourceDiscoveries - 查询资源发现实例

  • 资源发现
  • 发布于 2025-04-22
  • 0 次阅读
文档编辑
文档编辑

查询IPAM资源发现实例。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring是

要查询资源发现的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ResourceGroupIdstring否

资源发现的资源组 ID。

rg-aek2sermdd6****
IpamResourceDiscoveryIdsarray否

资源发现的实例 ID 列表。N 的取值范围为 1~100,即一次最多查询 100 个资源发现实例。

IpamResourceDiscoveryIdstring否

资源发现的实例 ID。

ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryNamestring否

资源发现的名称。

长度为 1~128 个字符,不能以 http://或 https://开头。

test
Typestring否

资源发现的类型。

说明 当前支持的类型:
  • system:系统创建的默认资源发现。
  • custom:用户创建的自定义类型的资源发现。
  • system
    Tagsarray<object>否

    标签列表信息。

    Tagobject否

    标签列表信息。

    Keystring否

    标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

    一个标签键最多支持 64 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyun和acs:开头,不能包含http://或者https://。

    FinanceDept
    Valuestring否

    标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

    一个标签值最多支持 128 个字符,不能包含http://或者https://。

    FinanceJoshua
    NextTokenstring否

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

    • 如果 NextToken 为空表示没有下一次查询。
    • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResultsinteger否

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

    10
    IsSharedboolean否

    是否是共享的资源发现。

    true

    返回参数

    名称类型描述示例值
    object

    返回的信息列表。

    IpamResourceDiscoveriesarray<object>

    资源发现的实例列表。

    IpamResourceDiscoveryobject

    资源发现的实例列表。

    IpamResourceDiscoveryIdstring

    资源发现的实例 ID。

    ipam-res-disco-jt5f2af2u6nk2z321****
    IpamResourceDiscoveryNamestring

    资源发现的名称。

    test
    IpamResourceDiscoveryDescriptionstring

    资源发现的描述信息。

    test description
    OperatingRegionListarray

    资源发现的操作地域列表。

    OperatingRegionListstring

    资源发现的操作地域。

    cn-hangzhou
    Typestring

    资源发现的类型。

    system
    IpamResourceDiscoveryStatusstring

    资源发现实例的状态。取值:

    • Creating:表示创建中。
    • Created:表示创建完成。
    • Modifying:表示修改中。
    • Deleting:表示删除中。
    • Deleted:表示已删除。
    Created
    ResourceGroupIdstring

    资源发现的资源组 ID。

    rg-aek2sermdd6****
    CreateTimestring

    资源发现创建的时间。

    2022-07-01T02:05:23Z
    Tagsarray<object>

    标签列表。

    Tagobject

    标签列表。

    Keystring

    标签键。

    FinanceDept
    Valuestring

    标签值。

    FinanceJoshua
    RegionIdstring

    查询到的资源发现实例的地域 ID。

    cn-hangzhou
    OwnerIdlong

    资源发现实例资源拥有者的阿里云主账号。

    1210123456******
    ShareTypestring

    资源的共享状态。

    • 取值为空时,表示该资源发现为普通的实例。

    • 取值为 Shared 时,表示该资源发现来自共享。

    • 取值为 Sharing 时,表示该资源发现在共享中。

    Shared
    NextTokenstring

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

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

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

    1
    MaxResultsinteger

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

    10
    Countinteger

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

    1
    RequestIdstring

    请求 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"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2025-02-13OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    相关文章

    CreateIpamResourceDiscovery - 创建自定义类型的资源发现实例 2025-04-22 18:20

    创建自定义类型的资源发现实例。 接口说明

    DeleteIpamResourceDiscovery - 删除自定义类型的资源发现实例 2025-04-22 18:20

    删除自定义类型的资源发现实例。 接口说明

    UpdateIpamResourceDiscovery - 修改资源发现实例 2025-04-22 18:19

    修改资源发现实例。 接口说明

    ListIpamResourceDiscoveries - 查询资源发现实例 2025-04-22 18:19

    查询IPAM资源发现实例。

    AssociateIpamResourceDiscovery - 关联资源发现和IPAM实例 2025-04-22 18:19

    关联资源发现和IPAM实例。 接口说明

    DissociateIpamResourceDiscovery - 解关联资源发现和IPAM实例 2025-04-22 18:19

    解关联资源发现和IPAM实例。

    目录
    Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
    京ICP备14022346号-15
    gongan beian 京公网安备11010802041014号