Create Service - CreateTiDBService
Overview
Create TiDB Service
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CreateTiDBService. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project ID | Yes |
| Name | string | Service name, length does not exceed 64 | Yes |
| Password | string | Password for the root service account, not exceeding 32 in length | Yes |
| VPCId | string | VPC ID | Yes |
| SubnetId | string | Subnet ID | Yes |
| TikvMemoryHardTh | string | Instance Type: 0: Flagship Edition, 30: Experience Edition, 60: Lightweight Edition | No |
| Ip | string | ipv4 | No |
| Port | string | Port | No |
| DTType | string | Disaster Recovery Type: 10: Same Availability Zone, 20: Cross Availability Zone, the default is Same Availability Zone. | No |
| SecGroup | string | Whether to enable the security group: '1' to enable. '0' or leave it blank to disable. | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| Data | ServiceData | Service Data | No |
| ServiceId | string | Service ID | No |
Data Model
ServiceData
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| Id | string | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=CreateTiDBService
&Region=cn-zj
&Name=pIEIVhHC
&Password=pwGmuGAr
&AccessVPCId=fHryqwgY
&SubnetId=zqaEcBmm
&ProjectId=IsdeuBDd
&TikvMemoryHardTh=cxfMqVOa
&Ip=IchjnUte
&Port=6
&DTType=ATRPviKe
&SecGroup=mAICQrDKResponse Example
{
"Action": "CreateTiDBServiceResponse",
"Data": {},
"Message": "DqzmVrUE",
"RetCode": 0,
"ServiceId": "xVJLjxzc"
}