DescribeEnsRegionIdResource API Reference for Node Resources - ENS

Queries node resources.

Operation description

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:DescribeEnsRegionIdResource

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2020-06-16T06:33:15Z
EndTime	string	Yes	The end time of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2020-06-16T06:33:15
OrderByParams	string	No	The order in which the resources to return are sorted. Valid values: InstanceCount: desc Area: asc InternetBandwidth: asc	InstanceCount:desc
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
Isp	string	No	The Internet service provider (ISP). Valid values: cmcc: China Mobile telecom: China Telecom unicom: China Unicom multiCarrier: multi-line ISP	cmcc

Response elements

Element	Type	Description	Example
	object
EnsRegionIdResources	object
EnsRegionIdResource	array<object>	The returned data. For more information, see EnsRegionIdResources in sample JSON responses.
	object
Area	string	The region. Set the value to West.	West
AreaCode	string	The code of the region.	300100
BizDate	string	The date when the transaction was processed.	2019-10-30
EnsRegionId	string	The ID of the node.	cn-hangzhou-telecom
EnsRegionIdName	string	The name of the node.	NanjingMobile
InstanceCount	integer	The number of instances.	10
InternetBandwidth	integer	The public bandwidth of the instance. Unit: Bits/s.	100
Isp	string	The ISP. Valid values: cmcc: China Mobile unicom: China Unicom telecom: China Telecom multiCarrier: multi-line ISP	cmcc
VCpu	integer	The number of vCPUs.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	476600B1-C9E2-4245-A26F-DC7EA8071425
TotalCount	integer	The total number of queried nodes.	58

Examples

Success response

JSON format

{
  "EnsRegionIdResources": {
    "EnsRegionIdResource": [
      {
        "Area": "West",
        "AreaCode": "300100",
        "BizDate": "2019-10-30",
        "EnsRegionId": "cn-hangzhou-telecom",
        "EnsRegionIdName": "NanjingMobile",
        "InstanceCount": 10,
        "InternetBandwidth": 100,
        "Isp": "cmcc",
        "VCpu": 10
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "476600B1-C9E2-4245-A26F-DC7EA8071425",
  "TotalCount": 58
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InsufficientEipCapacity	Insufficient EIP inventory under the specified territory.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.