DescribeNodeCidrList - Data Management - Alibaba Cloud Documentation Center

Queries the CIDR blocks of nodes on which Database Backup (DBS) is running.

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

dbs:DescribeNodeCidrList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region in which DBS is activated. Valid values: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-beijing: China (Beijing) cn-shenzhen: China (Shenzhen) cn-hongkong: China (Hong Kong) ap-southeast-1: Singapore (Singapore) cn-hangzhou-finance: China East 1 Finance cn-shanghai-finance: China East 2 Finance cn-shenzhen-finance: China South 1 Finance	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx

Response elements

Element	Type	Description	Example
	object	Possible return values include details as follows.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	5B352E69-E7B1-4EA7-BB8E-29FFE969C791
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
IntranetIPs	object
IntranetIP	array	The internal CIDR blocks.
	string	The internal CIDR blocks.	"10.X.X.0/24"
InternetIPs	object
InternetIP	array	The public CIDR blocks.
	string	The public CIDR blocks.	"10.X.X.0/24"

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "5B352E69-E7B1-4EA7-BB8E-29FFE969C791",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "IntranetIPs": {
    "IntranetIP": [
      "\"10.X.X.0/24\""
    ]
  },
  "InternetIPs": {
    "InternetIP": [
      "\"10.X.X.0/24\""
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.