All Products
Search

This Product

    Virtual Private Cloud:AttachDhcpOptionsSetToVpc

    Document Center

    Virtual Private Cloud:AttachDhcpOptionsSetToVpc

    Last Updated:Dec 20, 2024

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

    Operation description

    • 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:AttachDhcpOptionsSetToVpcupdate
    *DhcpOptionsSet
    acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/{#DhcpOptionsSetId}
    *VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    DhcpOptionsSetIdstringYes

    The ID of the DHCP options set.

    		dopt-o6w0df4epg9zo8isy****
    VpcIdstringYes

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

    		vpc-sfdkfdjkdf****
    ClientTokenstringNo

    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.
    		0c593ea1-3bea-11e9-b96b-88e9fe637760
    DryRunbooleanNo

    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.

    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		0ED8D006-F706-4D23-88ED-E11ED28DCAC0

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400Forbidden.OperateShareResourceYou cannot operate shared resources.Shared resources do not support this operation.
    400InvalidDhcpOptionsSetId.NotFoundThe specified dhcpOptionsSetId does not exist.The DHCP options set does not exist. Check whether the parameter is set to a valid value.
    400IncorrectStatus.DhcpOptionsSetThe DhcpOptionsSet status does not support this operation.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 status of the DHCP options set is stable.
    400InvalidVpcId.NotFoundSpecified value of VpcId is not found in our record.The VPC does not exist. Check whether the specified VPC is valid.
    400IncorrectStatus.VpcDhcpOptionsSetThe dhcpOptionsSet status of VPC does not support this operation.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.
    400OperationFailed.AttachmentExistThe current VPC is already attached to a DHCP options set.The VPC is associated with a DHCP options set. You can associate a VPC with only one DHCP options set.
    400QuotaExceeded.AttachVpcNumberThe maximum number of VPCs that can be attached to a DHCP options set is exceeded.The number of VPCs that can be associated with a DHCP options set reaches the upper limit.
    400TaskConflictThe operation is too frequent. Please wait a moment and try again.The system is unavailable. Try again later.
    404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region does not exist.

    For a list of error codes, visit the Service error codes.