DescribeRoMinScale

Download PDF

DescribeRoMinScale

最后更新时间：2024-01-30 10:26:02

下载PDF

1. API Description

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

This API is used to query the minimum specification of a read-only instance that can be purchased or upgraded to.

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.

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: DescribeRoMinScale.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	No	String	Common Params. This parameter is not required for this API.
RoInstanceId	No	String	Read-only instance ID in the format of "cdbro-c1nl9rpv". Its value is the same as the instance ID in the TencentDB Console. This parameter and the `MasterInstanceId` parameter cannot both be empty.
MasterInstanceId	No	String	Primary instance ID in the format of "cdbro-c1nl9rpv". Its value is the same as the instance ID in the TencentDB Console. This parameter and the `RoInstanceId` parameter cannot both be empty. Note: when the parameters are passed in with `RoInstanceId`, the return value refers to the minimum specification to which a read-only instance can be upgraded; when the parameters are passed in with `MasterInstanceId` but without `RoInstanceId`, the return value refers to the minimum purchasable specification for a read-only instance.

3. Output Parameters

Parameter Name	Type	Description
Memory	Integer	Memory size in MB.
Volume	Integer	Disk size in GB.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the minimum specification of a read-only instance which can be purchased or upgraded to

Input Example

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

{
    "RoInstanceId": "cdbro-831kwfnh",
    "MasterInstanceId": "cdb-r66ityd5"
}

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "Volume": 50,
        "Memory": 1000
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError.DBRecordNotExistError	The database record does not exist.
InternalError.DatabaseAccessError	Internal database error.
InternalError.UnknownError	Unknown error
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
MissingParameter.MissingParamError	Required parameters are missing.

tencent cloud

Recent Pages

DescribeRoMinScale

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the minimum specification of a read-only instance which can be purchased or upgraded to

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeRoMinScale

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the minimum specification of a read-only instance which can be purchased or upgraded to

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？