Requests an IPv6 address.
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is 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:AllocateIpv6Address | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. | cn-hangzhou |
VSwitchId | string | Yes | The ID of the vSwitch to which the IPv6 address belongs. | vsw-asdfjlnaue4g**** |
Ipv6Address | string | No | The IPv6 address. The IPv6 address must be an idle one that falls within the vSwitch CIDR block. | 2408:XXXX:153:3921:851c:c435:7b12:1c5f |
Ipv6AddressName | string | No | The name of the IPv6 address. | ipv6-name |
Ipv6AddressDescription | string | No | The description of the IPv6 address. | ipv6-description |
ResourceGroupId | string | No | The resource group ID. For more information about resource groups, see related documentation. | rg-bp67acfmxazb4ph**** |
Tag | object [] | No | The tag list. | |
Key | string | No | The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with | FinanceDept |
Value | string | No | The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://. | FinanceJoshua |
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 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.
| 02fb3da4-130e-11e9-8e44-0016e04**** |
DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSON
format
{
"Ipv6AddressId": "ipv6-2zen5j4axcp5l5qyy****",
"Ipv6Address": "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
"ResourceGroupId": "rg-acfmxazdjdhd****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | OperationFailed.IPv6AddressAlreadyAllocated | The operation is failed because of the ipv6 address specified was allocated. | The specified IPv6 address is already allocated |
400 | OperationFailed.AddressNotInVSwitchCidr | The operation is failed because of %s. | The specified IP address is not in the vSwitch CIDR block. Please modify it as described in the API document and try again. |
400 | IllegalParam.IpAddress | The param of %s is illegal. | The IP address format is invalid. See the API reference and specify a valid IP address. |
400 | OperationFailed.IPv6Disabled | Operation failed because IPv6 is not enabled for the vSwitch. | The IPv6 feature is disabled. |
404 | ResourceNotFound.VSwitch | The specified resource of %s is not found. | The specified vSwitch does not exist, please check your input is correct |
For a list of error codes, visit the Service error codes.