DescribeNodeDataDisks

Last updated: 2025-11-13 20:48:57

DescribeNodeDataDisks

Last updated: 2025-11-13 20:48:57

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to query data disk information of nodes.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeNodeDataDisks.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	ID of the EMR cluster instance.
CvmInstanceIds.N	Yes	Array of String	ID list of node CVM instances.
Filters.N	No	Array of Filters	Filter criteria for querying cloud disks.
InnerSearch	No	String	Fuzzy search.
Limit	No	Integer	Number of items returned per page. The default value is 100, and the maximum value is 100.
Offset	No	Integer	Data offset.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number.
CBSList	Array of CBSInstance	Cloud disk list. Note: This field may return null, indicating that no valid values can be obtained.
MaxSize	Integer	Maximum cloud disk capacity.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Node Data Disk Information

Input Example

POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodeDataDisks
<Common request parameters>

{
    "InstanceId": "emr-xxxxxxx",
    "CvmInstanceIds": [
        "ins-xxxxxxxx"
    ]
}

Output Example

{
    "Response": {
        "CBSList": [
            {
                "Attached": true,
                "DeadlineTime": "",
                "DeleteWithInstance": true,
                "DifferDaysOfDeadline": 0,
                "DiskChargeType": "POSTPAID_BY_HOUR",
                "DiskId": "disk-bpcm1kg4",
                "DiskName": "emr-Master.1_emr-gzpmy487_data disk_1",
                "DiskSize": 200,
                "DiskState": "ATTACHED",
                "DiskType": "CLOUD_HSSD",
                "DiskUsage": "DATA_DISK",
                "InstanceId": "ins-4y5u591o",
                "InstanceIdList": [
                    "ins-4y5u591o"
                ],
                "RenewFlag": "",
                "Shareable": false
            }
        ],
        "RequestId": "e681bb5e-e0b9-49ba-b3bd-be504a76e91b",
        "TotalCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.CbsError	An error occurred while calling another service API.
InvalidParameter.InvalidClusterId	Invalid parameter: ClusterId.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud