Release Notes
Product Announcements
Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to create business intelligence service instances (cloud disk).
A maximum of 20 requests can be initiated per second for this API.
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: CreateBusinessDBInstances. |
| 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. |
| Zone | Yes | String | Instance AZ, such as ap-guangzhou-1 (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through theDescribeZones API. |
| Memory | Yes | Integer | Instance memory size in GB |
| Storage | Yes | Integer | Instance disk size in GB |
| Cpu | Yes | Integer | The number of CPU cores of the instance you want to purchase. |
| MachineType | Yes | String | The host type of purchased instance. Valid values: CLOUD_PREMIUM (virtual machine with premium cloud disk), CLOUD_SSD (virtual machine with SSD). |
| ProjectId | No | Integer | Project ID |
| GoodsNum | No | Integer | Number of instances purchased this time. Default value: 1. |
| SubnetId | No | String | VPC subnet ID in the format of subnet-bdoe83fa. Both SubnetId and VpcId need to be set or unset at the same time. |
| VpcId | No | String | VPC ID in the format of vpc-dsp338hz. Both SubnetId and VpcId need to be set or unset at the same time. |
| DBVersion | No | String | - Supported versions of business intelligence server. Valid values: 201603 (SQL Server 2016 Integration Services), 201703 (SQL Server 2017 Integration Services), 201903 (SQL Server 2019 Integration Services). Default value: 201903. As the purchasable versions are region-specific, you can use the DescribeProductConfig API to query the information of purchasable versions in each region. |
| SecurityGroupList.N | No | Array of String | Security group list, which contains security group IDs in the format of sg-xxx. |
| 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. |
| ResourceTags.N | No | Array of ResourceTag | Tags associated with the instances to be created |
| Parameter Name | Type | Description |
|---|---|---|
| DealName | String | Order name |
| FlowId | Integer | Process ID Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceIdSet | Array of String | IDs of instances Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
This example shows you how to create a business intelligence service instance.
POST / HTTP/1.1Host: sqlserver.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateBusinessDBInstances<common request parameters>{ "Storage": 50, "Cpu": 1, "Zone": "ap-guangzhou-1", "Memory": 2, "ProjectId": 1, "GoodsNum": 1, "SubnetId": "subnet-xxxx", "VpcId": "vpc-xxxxxx", "DBVersion": "201703", "StartTime": "01:34", "Span": 4, "MachineType": "CLOUD_PREMIUM", "Weekly": [ 1, 5 ]}{
"Response": {
"DealName": "20200318114212",
"RequestId": "2b6f7e2a-e909-4753-84b7-0db3e6099877",
"FlowId": 100439,
"InstanceIdSet": [
"mssqlbi-sdjiej23"
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
피드백