tencent cloud

文档反馈

ModifyDBInstanceSpec

最后更新时间:2024-06-17 14:26:19

    1. API Description

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

    This API is used to modify instance specifications, including memory and disk size.

    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: ModifyDBInstanceSpec.
    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-6bwgamo3.
    Memory Yes Integer Instance memory size in GiB after modification.
    Storage Yes Integer Instance disk size in GiB after modification.
    AutoVoucher No Integer Whether to automatically use coupons:
  • 0: no
  • 1: yes

  • Default value: 0
    VoucherIds.N No Array of String Voucher ID list. Currently, you can specify only one voucher.
    ActivityId No Integer Campaign ID.
    SwitchTag No Integer Switch time after instance configurations are modified.
  • 0: Switch immediately
  • 1: Switch at specified time
  • 2: Switch during maintenance time window

  • Default value: 0
    SwitchStartTime No String Switch start time in the format of HH:MM:SS, such as 01:00:00. When SwitchTag is 0 or 2, this parameter becomes invalid.
    SwitchEndTime No String Switch end time in the format of HH:MM:SS, such as 01:30:00. When SwitchTag is 0 or 2, this parameter becomes invalid.
    Cpu No Integer Instance CPU size in Cores after modification.

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order ID.
    BillId String Bill ID of frozen fees.
    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 Modifying Instance Configurations

    This example shows you how to modify the configuration of instance postgres-6bwgamo3 to 1 CPU core, 2GB memory, and 200GB storage.

    Input Example

    POST / HTTP/1.1
    Host: postgres.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyDBInstanceSpec
    <Common request parameters>
    
    {
        "Storage": 200,
        "DBInstanceId": "postgres-6bwgamo3",
        "Cpu": 1,
        "Memory": 2
    }
    

    Output Example

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

    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
    FailedOperation Operation 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.PayOrderFailed Failed to make order payment.
    FailedOperation.PreCheckError Pre-check failed
    FailedOperation.QueryPriceFailed Failed to query the price.
    FailedOperation.QuerySpecError Failed to query specifications. Please try again later. If the problem persists, please contact customer service.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidParameter.ParameterCheckError Failed to check the parameter.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    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.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.