ListIpamDiscoveredResource - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries discovered resources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ListIpamDiscoveredResource

list

*IpamResourceDiscovery

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region of the resource discovery instance. You can call the DescribeRegions operation to get the region ID.	cn-hangzhou
IpamResourceDiscoveryId	string	Yes	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
ResourceRegionId	string	Yes	The ID of the region where the resource is located.	cn-hangzhou
ResourceType	string	No	The resource type. Valid values: VPC VSwitch	VPC
NextToken	string	No	The token to retrieve the next page of results. Leave this parameter empty for the first query. For subsequent queries, set this parameter to the NextToken value returned from the previous query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The returned information.
IpamDiscoveredResources	array<object>	The information about the resources.
	object	The information about the resources.
AliUid	integer	The ID of the Alibaba Cloud account.	132193271328****
ResourceType	string	The resource type. Valid values: VPC VSwitch	VPC
ResourceId	string	The resource ID.	vpc-uf611fp465c7dyb4z****
ResourceOwnerId	integer	The ID of the Alibaba Cloud account to which the resource belongs.	132193271328****
ResourceRegionId	string	The ID of the region to which the resource belongs.	cn-hangzhou
Cidr	string	The CIDR block of the resource.	192.168.1.0/32
IpUsage	string	The IP address usage. The value is a decimal.	0
IpCountDetail	object
FreeIpCount	string
TotalIpCount	string
UsedIpCount	string
IpamResourceDiscoveryId	string	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
VpcId	string	The ID of the VPC to which the resource belongs.	vpc-uf611fp465c7dyb4z****
DiscoveryTime	string	The time when the resource was discovered. Note If the resource is not modified after it is created, the discovery time of the resource remains unchanged.	2024-01-01 00:00:00
SourceCidr	string	The source CIDR block.	192.168.1.0/24
NextToken	string	The token to use to retrieve the next page of results. This value is empty when there are no more results to return. If NextToken is empty, no subsequent query is to be sent. If NextToken has a value, the value is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that match the query conditions.	1000
MaxResults	integer	The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned on the current page.	10
RequestId	string	The request ID.	3748DEFF-68BE-5EED-9937-7C1D0C21BAB4

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.ResourceRegion	The input parameter ResourceRegionId is invalid.	The input parameter ResourceRegionId is invalid.
400	ResourceNotFound.IpamResourceDiscovery	The dependent instance of IPAM resource discovery is not found.	The dependent instance of IPAM resource discovery is not found.
400	MissingParam.IpamResourceDiscoveryId	The IpamResourceDiscoveryId must be input.	The IpamResourceDiscoveryId must be input.
400	MissingParam.ResourceRegionId	The ResourceRegionId must be input.	The ResourceRegionId must be input.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.