tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for PostgreSQL
    Documentation
    Download PDF

    RenewInstance

    Last updated: 2024-06-17 14:26:17
    Download PDF

      1. API Description

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

      This API is used to renew an instance.

      A maximum of 100 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: RenewInstance.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region No String Common Params. This parameter is not required for this API.
      DBInstanceId Yes String Instance ID in the format of postgres-6fego161
      Period Yes Integer Renewal duration in months
      AutoVoucher No Integer Whether to automatically use vouchers. 1: yes, 0: no. Default value: 0
      VoucherIds.N No Array of String Voucher ID list (only one voucher can be specified currently)

      3. Output Parameters

      Parameter Name Type Description
      DealName String Order name
      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 Renewing instance "postgres-apzvwncr"

      Input Example

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

{
    "DBInstanceId": "postgres-apzvwncr",
    "Period": "1"
}

      Output Example

      {
    "Response": {
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
        "DealName": "201806181256"
    }
}

      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
      AuthFailure.UnauthorizedOperation Authentication failed.
      FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
      FailedOperation.CreateOrderFailed Failed to create the renewal order.
      FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
      FailedOperation.FailedOperationError Operation failed. Please try again later.
      FailedOperation.GetVpcInfoError Failed to query VPC information. Please try again later. If the problem persists, please contact customer service.
      FailedOperation.QueryVpcFailed Failed to query VPC.
      FailedOperation.QueryVpcFalied Failed to get VPC details.
      FailedOperation.TradeCreateError Failed to request the billing platform to create an order.
      FailedOperation.TradePayOrdersError Failed to request to pay for the order.
      InternalError.DBError Backend database execution error.
      InternalError.InternalHttpServerError An exception occurred while executing the request.
      InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
      InvalidParameter Parameter error.
      InvalidParameter.VpcNotFoundError Failed to query VPC information.
      InvalidParameterValue.BadSpec The instance specification to upgrade to is not purchasable.
      InvalidParameterValue.IllegalInstanceChargeType Incorrect billing mode.
      InvalidParameterValue.IllegalRegion Invalid Region parameter.
      InvalidParameterValue.IllegalZone Invalid Zone parameter.
      InvalidParameterValue.InstanceNotExist The current instance does not exist.
      InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
      InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
      OperationDenied.CamDeniedError This operation cannot be performed.
      OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
      OperationDenied.InstanceStatusLimitError This operation cannot be performed on an instance in this status.
      OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
      OperationDenied.PostPaidPayModeError Pay-as-you-go instances cannot be renewed.
      OperationDenied.VpcDeniedError You do not have the permission to operate the VPC.
      ResourceNotFound.InstanceNotFoundError The instance does not exist.
      ResourceUnavailable.ResourceNoPermission No permission for the VPC.
      ResourceUnavailable.VpcResourceNotFound Failed to get the information of the VPC where the instance resides.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy