All Products
Search
Document Center

ENS:DescribeEnsNetSaleDistrict

Last Updated:Jul 26, 2024

Queries the information about ISPs and number of ISPs in an area.

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

Request parameters

ParameterTypeRequiredDescriptionExample
NetLevelCodestringYes

The network level. Valid values:

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

The region code.

  • If you do not specify this parameter, only nodes under the area level that is specified by NetLevelCode are queried.
  • If you specify this parameter, only child nodes in the area that is specified by NetDistrictCode are queried.
100105

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 ISPs in the area.

object
EnsRegionIdCountstring

The information about the ISP.

InstanceCountstring

The information about the instance.

{ "count":2, "code":"multiCarrier" }
NetDistrictCodestring

The region code.

100101
NetDistrictEnNamestring

The name of the region.

northEast
NetDistrictFatherCodestring

The parent code of the region.

100000
NetDistrictLevelstring

The region level. Valid values:

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

The Chinese name of the region.

RequestIdstring

The request ID.

1707B55C-A12F-43EF-BC66-14FFDB9253C3

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "EnsNetDistricts": {
    "EnsNetDistrict": [
      {
        "EnsRegionIdCount": "",
        "InstanceCount": "{                         \"count\":2,                         \"code\":\"multiCarrier\"                     }",
        "NetDistrictCode": "100101",
        "NetDistrictEnName": "northEast",
        "NetDistrictFatherCode": "100000",
        "NetDistrictLevel": "Big",
        "NetDistrictName": ""
      }
    ]
  },
  "RequestId": "1707B55C-A12F-43EF-BC66-14FFDB9253C3"
}

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-10-10API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details