Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to renew one or more Lighthouse cloud disks.
This operation can only be performed on data disks with the status of ATTACHED
, UNATTACHED
or SHUTDOWN
.
Up to 50 cloud disks are supported at one time.
This API is async. After the request is sent, a RequestId
is returned. At this time, the operation is not completed yet. To check the result, you need to call DescribeDisks. If the latest operation status (LatestOperationState) of the disk is SUCCESS
, the operation is successful.
A maximum of 20 requests can be initiated per second for this API.
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: RenewDisks. |
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 | IDs of cloud disks. The value can be obtained from the DiskId parameter returned by the DescribeDisks API. Up to 50 disks can be requested at a time. |
RenewDiskChargePrepaid | Yes | RenewDiskChargePrepaid | Parameter settings for renewing the monthly subscribed cloud disk. |
AutoVoucher | No | Boolean | Whether to use the vouchers automatically. It defaults to No. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to review a cloud disk.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewDisks
<Common request parameters>
{
"DiskIds": [
"lhdisk-ovav4qmi"
],
"RenewDiskChargePrepaid": {
"CurInstanceDeadline": "2023-09-09 23:59:59"
},
"AutoVoucher": true
}
{
"Response": {
"RequestId": "c139e106-cdb2-4923-8f1e-ea1dc4fe3a47"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.InsufficientBalance | |
FailedOperation.RenewResourcesFailed | Unable to renew the resource |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InvalidCurInstanceDeadline | The current instance expiration time cannot be earlier than the cloud disk expiration time. |
InvalidParameterValue.InvalidDiskIdMalformed | Invalid parameter value: the disk ID format is invalid. |
MissingParameter.MissingParameterPeriodCurInstanceDeadline | Period or CurInstanceDeadline is required. |
OperationDenied.DiskCreating | The disk is being created. |
ResourceNotFound.DiskIdNotFound | The disk ID does not exist. |
UnsupportedOperation.DiskLatestOperationUnfinished | Unsupported operation: the last operation of the disk has not been completed. |
UnsupportedOperation.InvalidDiskState | The disk's status does not support this operation. |
Was this page helpful?