ListIpamResourceDiscoveryAssociations - Virtual Private Cloud

Lists the associations between resource discoveries and IP Address Managers (IPAMs).

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:ListIpamResourceDiscoveryAssociations

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
IpamId	string	No	The ID of the IPAM instance.	ipam-ccxbnsbhew0d6t****
IpamResourceDiscoveryId	string	No	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
NextToken	string	No	The token that is used to retrieve the next page of results. For the first query, leave this parameter empty. For a subsequent query, set this parameter to the NextToken value returned from the previous response.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The list of returned information.
IpamResourceDiscoveryAssociations	array<object>	A list of association details.
	object	A list of association details.
IpamResourceDiscoveryId	string	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
IpamId	string	The ID of the IPAM instance.	ipam-ccxbnsbhew0d6t****
Status	string	The association status. Valid values: Created Deleted	Created
IpamResourceDiscoveryOwnerId	string	The ID of the Alibaba Cloud account that owns the resource discovery instance.	1210123456******
IpamResourceDiscoveryType	string	The type of the resource discovery. Valid values: system: a default resource discovery that is automatically created by the system. custom: a custom resource discovery that is created by a user.	custom
IpamResourceDiscoveryStatus	string	The status of the resource discovery instance. Valid values: Creating Created Modifying Deleting Deleted	Created
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 needed. If NextToken is not empty, its value is the token to start the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that match the query criteria.	20
MaxResults	integer	The maximum number of entries returned per 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.	F28A239E-F88D-500E-ADE7-FA5E8CA3A170

Examples

Success response

JSON format

{
  "IpamResourceDiscoveryAssociations": [
    {
      "IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
      "IpamId": "ipam-ccxbnsbhew0d6t****",
      "Status": "Created",
      "IpamResourceDiscoveryOwnerId": "1210123456******",
      "IpamResourceDiscoveryType": "custom",
      "IpamResourceDiscoveryStatus": "Created"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 20,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "F28A239E-F88D-500E-ADE7-FA5E8CA3A170"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.