All Products
Search
Document Center

ENS:DescribeEnsNetDistrict

Last Updated:Mar 12, 2024

Queries regions in which ENS resources can be created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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
EnsNetDistrictsobject []

The information about the regions.

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.

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": ""
      }
    ]
  },
  "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.-
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 changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version