All Products
Search
Document Center

Smart Access Gateway:CreateEnterpriseCode

Last Updated:Mar 29, 2024

Creates an enterprise code.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

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

cn-shanghai
EnterpriseCodestringYes

The enterprise code.

The enterprise code must be five characters in length and must contain letters and digits. Each enterprise code must be globally unique.

12P**
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. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, the system automatically set ClientToken to the value of RequestId. The value of RequestId may be different for each API request.
02fb3da4****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

FBDB18D8-E91E-4978-8D6C-6E2E3EE10133

Examples

Sample success responses

JSONformat

{
  "RequestId": "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133"
}

Error codes

HTTP status codeError codeError messageDescription
400EnterpriseCode.BeenOccupiedThe specified enterprise code is occupied by other enterprises.The enterprise code belongs to another enterprise.

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