All Products
Search
Document Center

ENS:DescribeEnsRegions

Last Updated:Sep 13, 2024

Queries the Edge Node Service (ENS) nodes that you can use.

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
ens:DescribeEnsRegions
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the node.

By default, all available node IDs are returned.

cn-dalian-unicom

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The service code. 0 is returned for a successful request. An error code is returned for a failed request.

0
EnsRegionsarray<object>

The information about the regions.

object
Areastring

The code of the region.

NorthEastChina
EnNamestring

The name of the node.

NorthChina
EnsRegionIdstring

The ID of the node.

cn-dalian-unicom
Namestring

The name of the node.

Dalian Unicom
Provincestring

The province where the node is deployed.

Liaoning Province
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "EnsRegions": {
    "EnsRegions": [
      {
        "Area": "NorthEastChina",
        "EnName": "NorthChina",
        "EnsRegionId": "cn-dalian-unicom",
        "Name": "Dalian Unicom\n",
        "Province": "Liaoning Province\n\n"
      }
    ]
  },
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError message
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
No change history