tencent cloud

DescribeInstanceTradeParameter
Last updated: 2025-10-28 22:48:46
DescribeInstanceTradeParameter
Last updated: 2025-10-28 22:48:46

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the instance billing parameters.

A maximum of 120 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: DescribeInstanceTradeParameter.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
Zone Yes String Instance AZ, such as ap-guangzhou-1 (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the DescribeZones API.
Cpu Yes Integer Number of CPU cores.
Memory Yes Integer Instance memory size in GB.
Storage Yes Integer Instance storage capacity in GB.
InstanceType Yes String Type of purchased instances. HA: high-availability edition (including dual-server high-availability edition and Always On cluster edition); RO: read-only replica edition; SI: single-node edition; BI: business intelligence edition; cvmHA: new high-availability edition; cvmRO: new read-only replica edition; MultiHA: multi-node edition; cvmMultiHA: multi-node cloud disk edition.
MachineType Yes String Host disk type of purchased instances. CLOUD_HSSD - Enhanced SSD for CVMs, CLOUD_TSSD - Tremendous SSD for CVMs, CLOUD_BSSD - Balanced SSD for CVMs.
InstanceChargeType No String Billing mode. Valid value: POSTPAID (pay-as-you-go).
ProjectId No Integer Project ID.
GoodsNum No Integer Number of instances purchased this time. Default value: 1. Maximum value: 10.
DBVersion No String SQL Server version. Valid values: 2008R2 (SQL Server 2008 R2 Enterprise), 2012SP3 (SQL Server 2012 Enterprise), 201202 (SQL Server 2012 Standard), 2014SP2 (SQL Server 2014 Enterprise), 201402 (SQL Server 2014 Standard), 2016SP1 (SQL Server 2016 Enterprise), 201602 (SQL Server 2016 Standard), 2017 (SQL Server 2017 Enterprise), 201702 (SQL Server 2017 Standard), 2019 (SQL Server 2019 Enterprise), 201902 (SQL Server 2019 Standard). Default value: 2008R2. The available version varies by region, and you can pull the version information by calling the DescribeProductConfig API.
SubnetId No String VPC subnet ID in the format of subnet-bdoe83fa. SubnetId and VpcId should be set or ignored simultaneously.
VpcId No String VPC ID in the format of vpc-dsp338hz. SubnetId and VpcId should be set or ignored simultaneously.
Period No Integer Length of purchase of instance. The default value is 1, indicating one month. The value cannot exceed 48.
SecurityGroupList.N No Array of String Security group list, which contains security group IDs in the format of sg-xxx.
AutoRenewFlag No Integer Auto-renewal flag. 0: normal renewal, 1: auto-renewal. Default value: 1.
Weekly.N No Array of Integer Configuration of the maintenance window, which specifies the day of the week when maintenance can be performed. Valid values: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday).
StartTime No String Configuration of the maintenance window, which specifies the start time of daily maintenance.
Span No Integer Configuration of the maintenance window, which specifies the maintenance duration in hours.
MultiZones No Boolean Whether to deploy across availability zones. Default value: false.
ResourceTags.N No Array of ResourceTag Tags associated with the instances to be created.
TimeZone No String System time zone. Default value: China Standard Time.
Collation No String Collation of system character sets. Default value: Chinese_PRC_CI_AS.
MultiNodes No Boolean Whether it is a multi-node architecture instance. Default value: false.
DrZones.N No Array of String The zone in which the standby node is available. Default is empty. If it is a multi-node architecture, it must be transmitted. When MultiNodes = true, the availability zones of the primary and standby nodes cannot all be the same. The minimum number of availability zones for the standby nodes is 2, and the maximum is 5.

3. Output Parameters

Parameter Name Type Description
Parameter String Billing parameter.
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 Querying the Billing Parameters of a Newly Purchased OnCvm Two-Node Instance

This example shows you how to query the billing parameters of a newly purchased OnCvm two-node instance.

Input Example

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

{
    "Zone": "ap-guangzhou-6",
    "InstanceChargeType": "PREPAID",
    "InstanceType": "cvmHA",
    "Memory": 4,
    "Storage": 200,
    "GoodsNum": 1,
    "SubnetId": "subnet-15y3y4eo",
    "VpcId": "vpc-hqxhp43z",
    "Period": 1,
    "DBVersion": "2008R2",
    "AutoRenewFlag": 1,
    "Weekly": [
        "1",
        "3",
        "5"
    ],
    "StartTime": "01:00",
    "Span": 3,
    "MultiZones": "true",
    "Cpu": 2,
    "MachineType": "CLOUD_BSSD"
}

Output Example

{
    "Response": {
        "Parameter": "{\"uin\":\"2919041563\",\"ownerUin\":\"2919041563\",\"appId\":251000111,\"goods\":[{\"goodsCategoryId\":1025890,\"goodsNum\":1,\"payMode\":1,\"regionId\":1,\"zoneId\":100006,\"goodsDetail\":{\"pid\":1019180,\"productCode\":\"p_sqlserver\",\"subProductCode\":\"sp_sqlserver_dual_exclusive_cloud\",\"timeSpan\":1,\"timeUnit\":\"m\",\"productInfo\":[{\"name\":\"Project\",\"value\":\"default project\"},{\"name\":\"Configuration\",\"value\":\"4 GB memory; 200 GB storage space; QPS: 0; SQL Server 2008R2\"},{\"name\":\"Instance edition\",\"value\":\"Dual-server high-availability edition\"},{\"name\":\"Region\",\"value\":\"Guangzhou\"},{\"name\":\"Network\",\"value\":\"Exclusive network in zone 3\"},{\"name\":\"AZ\",\"value\":\"Guangzhou Zone 6\"},{\"name\":\"RequestSource\",\"value\":\"API\"}],\"autoRenewFlag\":1,\"goodsNum\":1,\"type\":\"CLOUD_BSSD\",\"version\":\"2008R2\",\"subnetId\":1604224,\"vpcId\":74483,\"model\":3,\"weekly\":[1,3,5],\"startTime\":\"01:00\",\"span\":3,\"RoGroupForcedUpgrade\":0,\"ResourceTags\":null,\"waitSwitch\":1,\"ExtParam\":{\"token\":\"\",\"useragent\":\"\",\"referer\":\"\",\"from\":\"\"},\"collation\":\"Chinese_PRC_CI_AS\",\"timeZone\":\"China Standard Time\",\"sv_sqlserver_cpu_dual_exclusive_cloud_enterprise\":2,\"sv_sqlserver_cpu_dual_exclusive_cloud_standard\":0,\"sv_sqlserver_mem_dual_exclusive_cloud_enterprise\":4,\"sv_sqlserver_mem_dual_exclusive_cloud_standard\":0,\"sv_sqlserver_disk_dual_enhancedssd\":0,\"sv_sqlserver_disk_dual_fastssd\":0,\"sv_sqlserver_disk_dual_universalssd\":200},\"platform\":1,\"projectId\":0}]}\n",
        "RequestId": "2a2c00b5-77a8-4eda-be01-3f58230da22e"
    }
}

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.CreateOrderFailed Failed to create order.
FailedOperation.DBError Database error.
FailedOperation.GetVpcFailed Failed to get VPC information.
InternalError.DBError Database error
InternalError.UnknownError Unknown error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameter.PayOrderFailed Failed to make order payment.
InvalidParameterValue.IllegalRegion Invalid region.
InvalidParameterValue.IllegalSpec Incorrect instance specification information.
InvalidParameterValue.IllegalZone Incorrect AZ ID.
InvalidParameterValue.SecurityGroupIdIsIllegal Invalid security group ID.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.VpcNotExist VPC not found.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback