Call the DeleteEnterpriseCode API to delete an enterprise code - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Operation description

Before you delete an enterprise code, note the following information:

Default enterprise codes cannot be deleted. If the enterprise code that you want to delete is a default enterprise code, change it to a common enterprise code first, and then delete it. For more information, see UpdateEnterpriseCode.
Enterprise codes that are attached to Smart Access Gateway app instances cannot be deleted. If the enterprise code that you want to delete is attached to Smart Access Gateway app instances, change the enterprise code of the Smart Access Gateway app instances to another enterprise code first, and then delete the current enterprise code. For more information, see UpdateSmartAGEnterpriseCode.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DeleteEnterpriseCode

delete

*EnterpriseCode

acs:smartag:{#regionId}:{#accountId}:enterprisecode/{#EnterpriseCode}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by Smart Access Gateway and the corresponding region IDs.	cn-shanghai
EnterpriseCode	string	Yes	The enterprise code.	12***
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter. Ensure that the value is unique among different requests. The value can be up to 64 ASCII characters in length.	02fb3da4****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9DD3DFB2-A9BF-4BEE-9542-661411A9851E

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	EnterpriseCode.BeingUsed	The specified enterprise code is being used.	The enterprise code is in use.
400	EnterpriseCode.DeleteLimit	The specified default enterprise code cannot be deleted.	You cannot delete the default enterprise code.
400	EnterpriseCode.NotExist	The specified enterprise code does not exist.	The enterprise code does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.