Updates an IP Address Manager (IPAM).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:UpdateIpam | update | *Ipam acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the IPAM instance is hosted. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| IpamId | string | Yes | The ID of the IPAM. | ipam-ccxbnsbhew0d6t**** |
| IpamName | string | No | The name of the IPAM. It must be 1 to 128 characters in length and cannot start with | test |
| IpamDescription | string | No | The description of the IPAM. It must be 2 to 256 characters in length and must start with a letter. It cannot start with | test description |
| AddOperatingRegion | array | No | The effective region that you want to add. | |
| AddOperatingRegion | string | No | The effective region that you want to add. | eu-central-1 |
| RemoveOperatingRegion | array | No | The effective region that you want to remove. | |
| RemoveOperatingRegion | string | No | The effective region that you want to remove. | eu-central-1 |
| DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "F4650E33-895C-53F0-9CD5-D1338F322DE8"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ResourceNotFound.Ipam | The specified resource of ipam is not found. | The IPAM entered does not exist. |
| 400 | IllegalParam.OperatingRegion | The operating region is invalid. | The operating region is invalid. |
| 400 | DependencyViolation.IpamPool | The specified resource of %s depends on %s, so the operation cannot be completed. | The specified resource is dependent on other resources and the current operation is not allowed. |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | - |
| 400 | OperationDenied.IpamRegionCannotBeRemoved | The IPAM region cannot be removed. | The IPAM region cannot be removed. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|