All Products
Search
Document Center

ENS:DescribeEnsNetDistrict

Last Updated:Nov 18, 2024

Queries regions in which ENS resources can be created.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeEnsNetDistrictget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NetLevelCodestringYes

The level of the region.

  • Big: area
  • Middle: province
  • Small: city
Big
NetDistrictCodestringNo

The code of the region.

If you do not specify this parameter, only nodes in the regions of the level that is specified by the NetLevelCode parameter are queried.

If you specify this parameter, only nodes in the regions of the level that is specified by this parameter are queried.

100106

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The returned service code. A value of 0 indicates that the operation was successful.

0
EnsNetDistrictsarray<object>

The information about the regions.

EnsNetDistrictobject

The information about the ISPs in the area.

EnsRegionIdCountstring

The number of nodes in the region.

2
NetDistrictCodestring

The code of the region.

100106
NetDistrictEnNamestring

The name of the region.

southWest
NetDistrictFatherCodestring

The parent code of the region.

100000
NetDistrictLevelstring

The level of the region.

  • Big: area
  • Middle: province
  • Small: city
Big
NetDistrictNamestring

The name of the region.

southwest China
RequestIdstring

The request ID.

F3B261DD-3858-4D3C-877D-303ADF374600

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "EnsNetDistricts": {
    "EnsNetDistrict": [
      {
        "EnsRegionIdCount": "2",
        "NetDistrictCode": "100106",
        "NetDistrictEnName": "southWest",
        "NetDistrictFatherCode": "100000",
        "NetDistrictLevel": "Big",
        "NetDistrictName": "southwest China\n"
      }
    ]
  },
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter domainName that is mandatory for processing this request is not supplied.-
400InstanceIdNotFoundThe input parameter instancdId that is not found.The specified instance ID does not exist.
400NoPermissionPermission denied.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.
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
2023-12-26API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details