UpdateIpamResourceDiscovery - Virtual Private Cloud - Alibaba Cloud Documentation Center

Modifies a resource discovery instance.

Operation description

You can add or remove operating regions only for custom resource discovery instances.
When you remove an operating region from a resource discovery instance, you cannot remove the managed region of the resource discovery instance.

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

update

*IpamResourceDiscovery

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
IpamResourceDiscoveryId	string	Yes	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
IpamResourceDiscoveryName	string	No	The name of the resource discovery.	test
IpamResourceDiscoveryDescription	string	No	The description of the resource discovery.	test description
AddOperatingRegion	array	No	The operating regions to add to the resource discovery.
	string	No	The operating region to add to the resource discovery.	eu-central-1
RemoveOperatingRegion	array	No	The operating regions to remove from the resource discovery.
	string	No	The operating region to remove from the resource discovery.	cn-beijing
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 you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	BB2C39DE-CEB8-595A-981A-F2EFCBE7324E

Examples

Success response

JSON format

{
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.OperatingRegion	The operating region is invalid.	The operating region is invalid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	OperationDenied.OperateShareResource	The operation is not allowed because the instance is a shared resource.	The operation is not allowed because the instance is a shared resource.
400	OperationDenied.UnexpectedType	The operation is not allowed because the input type is unexpected.	The operation is not allowed because the input type is unexpected.
400	OperationDenied.RemoveResourceDiscoveryHomeRegion	The home region of IPAM resource discovery cannot be removed.	The home region of IPAM resource discovery cannot be removed.
400	ResourceNotFound.IpamResourceDiscovery	The dependent instance of IPAM resource discovery is not found.	The dependent instance of IPAM resource discovery is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.