ModifyDisksRenewFlag

Last updated: 2019-09-09 20:17:32

PDF

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (ModifyDisksRenewFlag) is used to modify the renewal setting of one or more cloud disks.

Default request rate limit: 20/sec.

Note: This API supports finance AZs. As finance AZs and non-finance AZs are isolated, when accessing the services in a finance AZ (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the finance AZ, preferably in the same region as specified in Region.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value​used for this API: ModifyDisksRenewFlag
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, see List of Regions supported by the product.
DiskIds.N Yes Array of String ID(s) of one or more cloud disks to be operated.
RenewFlag Yes String Cloud disk renewal setting. Value range:
  • NOTIFY_AND_AUTO_RENEW: Enable both expiration notification and auto-renewal
  • NOTIFY_AND_MANUAL_RENEW: Enable expiration notification but not auto-renewal
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not enable expiration notification and auto-renewal
  • 3. Output Parameters

    Parameter Name Type Description
    RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

    4. Samples

    Sample 1. Configuring Auto Renewal for a Cloud Disk

    Input Sample Code

    https://cbs.tencentcloudapi.com/?Action=ModifyDisksRenewFlag
    &DiskIds.0=disk-5w50lrms
    &RenewFlag=NOTIFY_AND_AUTO_RENEW
    &<Common request parameters>

    Output Sample Code

    {
      "Response": {
        "RequestId": "1f01171e-6a0f-4208-bb04-d342d97d42c8"
      }
    }

    5. Resources for Developers

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

    Command line tools

    6. Error Codes

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

    Error Code Description
    InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
    MissingParameter Missing parameter. A required parameter is missing in the request.