Use DescribeEnsNetDistrict to query available regions and districts - ENS

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeEnsNetDistrict

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NetLevelCode	string	Yes	The level of the region. Big: area Middle: province Small: city	Big
NetDistrictCode	string	No	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
NetDistrictCodeNode	boolean	No	Region code

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned service code. A value of 0 indicates that the operation was successful.	0
EnsNetDistricts	object
EnsNetDistrict	array<object>	The information about the regions.
	object	The information about the ISPs in the area.
EnsRegionIdCount	string	The number of nodes in the region.	2
NetDistrictCode	string	The code of the region.	100106
NetDistrictEnName	string	The name of the region.	southWest
NetDistrictFatherCode	string	The parent code of the region.	100000
NetDistrictLevel	string	The level of the region. Big: area Middle: province Small: city	Big
NetDistrictName	string	The name of the region.	Southwest China
RequestId	string	The request ID.	F3B261DD-3858-4D3C-877D-303ADF374600

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	The specified instance ID does not exist.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.