All Products
Search

This Product

    Virtual Private Cloud:DeleteDhcpOptionsSet

    Document Center

    Virtual Private Cloud:DeleteDhcpOptionsSet

    Last Updated:Aug 29, 2024

    Deletes a DHCP options set.

    Operation description

    Description

    • DeleteDhcpOptionsSet is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetDhcpOptionsSet operation to query the status of the task.

      • If the DHCP options set is in the Deleting state, the DHCP options set is being deleted.
      • If you cannot query the DHCP options set, the DHCP options set is deleted.

    • You cannot repeatedly call the DeleteDhcpOptionsSet operation to delete a DHCP options set 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.

    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:DeleteDhcpOptionsSetdelete
    • DhcpOptionsSet
      acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/{#DhcpOptionsSetId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region of the DHCP options set to be deleted. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DhcpOptionsSetIdstringYes

    The ID of the DHCP options set to be deleted.

    		dopt-o6w0df4epg9zo8isy****
    ClientTokenstringNo

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

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.

    false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    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.
    400OperationUnsupported.DhcpOptionsSetThe DHCP options set feature in this region is not supported.The current region does not support the DHCP options sets feature.
    400DependencyViolation.VpcAttachmentDhcpOptionsSet cannot be deleted when it is attached to VPC.The DHCP options set is associated with a VPC and cannot be deleted.
    400InvalidDhcpOptionsSetId.NotFoundThe specified dhcpOptionsSetId does not exist.The DHCP options set does not exist. Check whether the parameter is set to a valid value.
    404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region does not exist.

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