1. API Description
Domain name for API request: lighthouse.intl.tencentcloudapi.com.
This API is used to modify the configuration of auto-renewal of cloud disks.
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.
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: ModifyDisksRenewFlag. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2020-03-24. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| DiskIds.N |
Yes |
Array of String |
List of cloud disk IDs. |
| RenewFlag |
Yes |
String |
Whether Auto-Renewal is enabled |
3. Output Parameters
| Parameter Name |
Type |
Description |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Modifying the renewal flag of disks
POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDisksRenewFlag
<Common request parameters>
{
"DiskIds": [
"lhdisk-qx45d7ik"
],
"RenewFlag": "NOTIFY_AND_AUTO_RENEW"
}
Output Example
{
"Response": {
"RequestId": "0d5e192e-10a2-44a6-a6ce-2ac6b01f7646"
}
}
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
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 |
| InvalidParameter |
Incorrect parameter. |
| InvalidParameterValue.InvalidDiskIdMalformed |
Invalid parameter value: the disk ID format is invalid. |
| OperationDenied.DiskCreating |
The disk is being created. |
| OperationDenied.DiskOperationInProgress |
The disk is being manipulated. Try again later. |
| OperationDenied.DiskUsageNotSupportOperation |
The cloud disk type of the disk does not support this operation. |
| ResourceNotFound.DiskIdNotFound |
The disk ID does not exist. |
| ResourceNotFound.DiskNotFound |
The disk does not exist. |