Associates a DHCP options set with a virtual private cloud (VPC).

Usage notes

  • The AttachDhcpOptionsSetToVpc operation is asynchronous. After you send the request, the system returns a request ID. However, the operation is still being performed in the system background. You can call the DescribeVpcAttribute operation to query the status of a DHCP options set:
    • If the DHCP options set is in the Pending state, the DHCP options set is being associated.
    • If the DHCP options set is in the InUse state, the DHCP options set is associated.
  • You cannot repeatedly call the AttachDhcpOptionsSetToVpc operation to associate DHCP options sets with a VPC within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AttachDhcpOptionsSetToVpc

The operation that you want to perform. Set the value to AttachDhcpOptionsSetToVpc.

RegionId String Yes cn-hangzhou

The region to which the DHCP options set belongs. You can call the DescribeRegions operation to query the most recent region list.

DhcpOptionsSetId String Yes dopt-o6w0df4epg9zo8isy****

The ID of the DHCP options set.

VpcId String Yes vpc-sfdkfdjkdf****

The ID of the VPC to be associated with the DHCP options set.

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
DryRun Boolean No false

Specifies whether to check the request without performing the operation. Valid values:

true: checks the request without performing the operation. The system checks whether your AccessKey pair is valid, whether the Resource Access Management (RAM) user is authorized, and whether the required parameters are set. If the request fails to pass the check, the corresponding error message is returned. If the request passes the check, the DryRunOperation error code is returned.

false (default): sends the request. If the request passes the check, a 2XX HTTP status code is returned and the operation is performed.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AttachDhcpOptionsSetToVpc
&RegionId=cn-hangzhou
&DhcpOptionsSetId=dopt-o6w0df4epg9zo8isy****
&VpcId=vpc-sfdkfdjkdf****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&DryRun=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<AttachDhcpOptionsSetToVpcResponse>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</AttachDhcpOptionsSetToVpcResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HttpCode Error code Error message Description
400 Forbidden.OperateShareResource You cannot operate shared resources. The error message returned because shared resources do not support this operation.
400 InvalidDhcpOptionsSetId.NotFound The specified dhcpOptionsSetId does not exist. The error message returned because the DHCP options set does not exist. Check whether the parameter is set to a valid value.
400 IncorrectStatus.DhcpOptionsSet The DhcpOptionsSet status does not support this operation. The error message returned because the DHCP options set that is associated with the VPC is being configured. As a result, the DHCP options set does not support this operation. You can perform the operation after the state of the DHCP options set is stable.
400 InvalidVpcId.NotFound Specified value of VpcId is not found in our record. The error message returned because the specified VPC does not exist. Check whether the specified VPC is valid.
400 IncorrectStatus.VpcDhcpOptionsSet The dhcpOptionsSet status of VPC does not support this operation. The error message returned because the DHCP options set that is associated with the VPC is being configured. As a result, the DHCP options set does not support this operation.
400 OperationFailed.AttachmentExist The current VPC is already attached to a DHCP options set. The error message returned because the VPC has been associated with a DHCP options set. You can associate a VPC with only one DHCP options set.
400 QuotaExceeded.AttachVpcNumber The maximum number of VPCs that can be attached to a DHCP options set is exceeded. The error message returned because the number of VPCs that can be associated with a DHCP options set exceeds the quota limit.
400 TaskConflict The operation is too frequent. Please wait a moment and try again. The error message returned because the system is busy. Try again later.
404 InvalidRegionId.NotFound The specified RegionId does not exist. The error message returned because the specified region does not exist. Check whether the region ID is valid.

For a list of error codes, visit the API Error Center.