All Products
Search
Document Center

Smart Access Gateway:DeleteEnterpriseCode

Last Updated:Mar 29, 2024

Deletes a specified enterprise code.

Operation description

Before you call this operation, take note of the following rules:

  • You cannot delete default enterprise codes.

    To delete a default enterprise code, change it to a custom enterprise code and then delete it. For more information, see UpdateEnterpriseCode .

  • You cannot delete enterprise codes that are associated with a Smart Access Gateway (SAG) APP instance.

    To delete an enterprise code that is associated with an SAG APP instance, associate the SAG APP instance with another enterprise code, and then delete the enterprise code. For more information, see UpdateSmartAGEnterpriseCode .

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
smartag:DeleteEnterpriseCodeWrite
  • EnterpriseCode
    acs:smartag:{#regionId}:{#accountId}:enterprisecode/{#EnterpriseCode}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the enterprise code belongs.

You can call the DescribeRegions operation to query the most recent region list.

cn-shanghai
EnterpriseCodestringYes

The enterprise code that you want to delete.

12***
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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

02fb3da4****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

9DD3DFB2-A9BF-4BEE-9542-661411A9851E

Examples

Sample success responses

JSONformat

{
  "RequestId": "9DD3DFB2-A9BF-4BEE-9542-661411A9851E"
}

Error codes

HTTP status codeError codeError messageDescription
400EnterpriseCode.BeingUsedThe specified enterprise code is being used.The enterprise code is in use.
400EnterpriseCode.DeleteLimitThe specified default enterprise code cannot be deleted.You cannot delete the default enterprise code.
400EnterpriseCode.NotExistThe specified enterprise code does not exist.The enterprise code does not exist.

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