Use AssociateIpamResourceDiscovery to link a resource discovery to an IPAM instance - Virtual Private Cloud

Operation description

You can associate a resource discovery instance with an IPAM instance only once.

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

update

*IpamResourceDiscovery

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

*Ipam

acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
IpamId	string	Yes	The ID of the IPAM instance.	ipam-ccxbnsbhew0d6t****
IpamResourceDiscoveryId	string	Yes	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error. false (default): Sends the request. On success, returns a 2xx status and performs the operation.	false
ClientToken	string	No	Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. Note If this parameter is not specified, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	E897D16A-50EB-543F-B002-C5A26AB818FF

Examples

Success response

JSON format

{
  "RequestId": "E897D16A-50EB-543F-B002-C5A26AB818FF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	ResourceNotFound.IpamResourceDiscovery	The dependent instance of IPAM resource discovery is not found.	The dependent instance of IPAM resource discovery is not found.
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	The IPAM entered does not exist.
400	OperationDenied.ResourceDiscoveryAlreadyAssociated	You cannot associate the resource discovery because an association already exists.	You cannot associate the resource discovery because an association already exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.