接口功能介绍
调用接口为某个实例创建一个只读实例。
接口约束
无
URI
POST /v1/open-api/order/read-order
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cycleCnt | 是 | Integer | 订购周期,取值范围:值需大于零,不超过384个月 | ||
cycleType | 是 | Integer | 取值范围:3表示按月订购,5表示按一年订购,6表示按两年订购、7表示按三年订购。cycleCnt属性为1,cycleType取值为3 表示订购1个月 | ||
cpuNum | 是 | Integer | cpu大小 | ||
memSize | 是 | Integer | 内存大小 | ||
regionId | 是 | String | 资源池Id | ||
volumeType | 是 | String | 磁盘类型,取值范围:SATA、SAS、SSD | ||
dbName | 是 | String | 实例名称 实例名称在4位-40位之间 | ||
dbPassword | 是 | String | 实例密码 密码必须长度在 8 到 20 个字符,且密码必须包含大写字母、小写字母、数字和特殊字符~!@#%^*_=+ base64加密 | ||
subnetId | 是 | String | 子网Id | ||
vpcId | 是 | String | VPCId | ||
secgroups | 是 | String | 安全组Id | ||
instanceCnt | 是 | Integer | 订购数量,取值范围:值需大于零且订购数量不能超过5台 | ||
diskSize | 是 | Integer | 磁盘大小100G-2T 步长10G | ||
networkCards | 是 | Array of Objects | 网卡 | networkCards | |
accessKey | 是 | String | 用户天翼云安全公钥 | ||
securityKey | 是 | String | 用户天翼云安全私钥 | ||
engineVersion | 是 | String | 引擎版本,5.7版本、8.0版本 | ||
parentProdInstId | 是 | String | 父实例ID |
表networkCards
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
subnetId | 是 | String | 子网Id | ||
master | 是 | Boolean | 是否绑定主网卡 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回结果信息 | returnObj |
表 returnObj
列表信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
orderNo | 是 | String | 订单号 |
请求示例
请求头header
无
请求体body
{
"accessKey": "160764472e5041b6a36d450d8e7f8de1",
"securityKey": "7df9be09eb254d628850c2322cdffe8a",
"cpuNum": 2,
"cycleCnt": 1,
"cycleType": 3,
"dbName": "str2ing",
"dbPassword": "YU0yQHVleWJtbg==",
"diskSize": 100,
"engineVersion": "5.7",
"instanceCnt": "1",
"memSize": 4,
"networkCards": [{
"master": true,
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4"
}],
"regionId": "100054c0416811e9a6690242ac110002",
"secgroups": "de418653-e4b0-4fde-a897-0a0e014bcc57",
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4",
"volumeType": "SATA",
"parentProdInstId": "e4d0dc01275c40cfb88ff8272228e9be",
"vpcId": "55b98533-fd84-4e2f-847d-711cea305a4d"
}
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"orderNo": "20221018153152727265"
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |