All Products
Search
Document Center

Smart Access Gateway:ListEnterpriseCode

Last Updated:Mar 29, 2024

Queries enterprise codes.

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:ListEnterpriseCodeList
  • 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
EnterpriseCodestringNo

The enterprise code that you want to query.

12P**
IsDefaultbooleanNo

Specifies whether to query only default enterprise codes. Valid values:

  • true: yes
  • false (default): no
false
NextTokenstringNo

The token for returning the next page when the data is returned in more than one page.

caeba0bbb2be03f84eb48b699f0*****
MaxResultsintegerNo

The number of entries returned per page.

Valid values: 1 to 100. Default value: 10.

2

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

2
NextTokenstring

The token for returning the next page when the data is returned in more than one page.

caeba0bbb2be03f84eb48b699f0*****
RequestIdstring

The ID of the request.

1A57EF84-D587-4CF9-B0C8-307488BF52C9
MaxResultsinteger

The number of entries returned per page.

2
EnterpriseCodesobject []

The information about enterprise codes.

IsDefaultboolean

Indicates whether the enterprise code is the default one.

  • true: yes
  • false: no
true
EnterpriseCodestring

The enterprise code.

12P**

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "RequestId": "1A57EF84-D587-4CF9-B0C8-307488BF52C9",
  "MaxResults": 2,
  "EnterpriseCodes": [
    {
      "IsDefault": true,
      "EnterpriseCode": "12P**"
    }
  ]
}

Error codes

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