UpdateIpamScope - Virtual Private Cloud - Alibaba Cloud Documentation Center

Updates the basic information of an IPAM scope.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM is hosted. Call the DescribeRegions operation to get the region ID.	cn-hangzhou
IpamScopeId	string	Yes	The ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
IpamScopeName	string	No	The name of the IPAM scope. The name must be 1 to 128 characters long and cannot start with `http://` or `https://`.	test
IpamScopeDescription	string	No	The description of the IPAM scope. The description must be 1 to 256 characters long. It must start with a letter and cannot start with `http://` or `https://`. If you do not specify this parameter, the value is not modified.	test description
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request for potential issues, including missing required parameters, incorrect request format, and instance status. If the request fails the dry run, an error is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (Default): Sends a normal request. After the request passes the check, the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a value for this parameter that is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is unique.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	BA8054F5-852A-570A-ACFF-BCA63E0B02D5

Examples

Success response

JSON format

{
  "RequestId": "BA8054F5-852A-570A-ACFF-BCA63E0B02D5"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.IpamScope	The specified resource of IPAM scope is not found.	The input IPAM scope does not exist.
400	IncorrectStatus.IpamScope	The status of the IPAM scope is incorrect.	The status of the IPAM scope is incorrect.
400	DryRunOperation	Request validation has been passed with DryRun flag set.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.