接口功能介绍
此接口提供云搜索服务如何通过OpenAPI开通实例。
接口约束
1.选择多可用区后必须选择专属master节点
2.专属协调节点和冷数据节点，数量是选择的可用区整数倍
3.可用区数量最多3个
4.西南1的资源池可用区只能选2个，其它资源池可用区只能1或3个
5.调用API请求参数时，参数需按请求体示例类型等要求传递
URI
POST /os/openapi/v1/order/new
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| available_zone_id | 是 | String | 可用区ID，允许选择多个，选择多个时用逗号隔开 |
cn-huadong1-jsnj1A-public-ctcloud,cn-huadong1-jsnj2A-public-ctcloud,cn-huadong1-jsnj3A-public-ctcloud | |
| cluster_name | 是 | String | 实例名称，由大小写字母、数字、下划线（）或连字符（-）组成，且不以下划线（）或连字符（-）开头，长度是1-32位 | Test | |
| cycle_cnt | 是 | Integer | 订购周期，当cycle_type为2时，取值范围是1-11；cycle_type为3时，取值范围是1-5 | 1 | |
| pay_type | 是 | Integer | 付费类型 ，1：包年包月 | 1 | |
| cycle_type | 是 | Integer | 订购周期，2代表按月购买，3代表按年购买 | 2 | |
| region_id | 是 | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 | |
| vpc_id | 是 | String | vpcId | vpc-8p9hpn4o8g | |
| subnet_id | 是 | String | 子网id | subnet-mp6a3hce8q | |
| security_group_Id | 是 | String | 安全组id | sg-mkritasxrd | |
| enable_ipv6 | 是 | String | 开启IPv6：开启:OPEN 关闭:CLOSE | OPEN | |
| component_pwd | 是 | String | 组件密码 ，密码应为数字、大写字母、小写字母、特殊符号（@$!%*#_~?）的组合，长度在12－26位 | kY$2@Li%90M1P | ||
| cluster_type | 是 | Integer | 集群类型： 1：OpenSearch，2：Elasticsearch |
1 | |
| node_details | 是 | Array of Objects | 节点组详情 | 表node_detail |
表 node_details
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| host_num | 是 | Integer | 节点数： MASTER 最小为3，最大为6； EXCLUSIVE_MASTER 最大为3； COORDINATE 最大为6； COLD 最大为6； |
３ | |
| io_type | 是 | String | IO类型： SSD-genric（通用型SSD）、SAS（高IO）、SSD（超高IO MASTER 节点可选：SSD-genric、SAS、SSD EXCLUSIVE_MASTER 节点可选：SSD-genric、SSD COORDINATE 节点可选：SSD-genric、SSD COLD 节点可选：SSD-genric、SAS、SSD |
SSD-genric | |
| volume | 是 | Integer | 存储容量： MASTER 节点可选：40 - 500 GB EXCLUSIVE_MASTER 节点可选：固定 40 GB COORDINATE 节点可选：固定 40 GB COLD 节点可选：40 - 500 GB |
40 | |
| iaas_vm_spec_code | 是 | String | 实例规格code | s7.2xlarge.4 | |
| node_group_type | 是 | String | 节点组类型： MASTER/EXCLUSIVE_MASTER/COORDINATE/COLD |
MASTER |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| error | String | 错误码，请求成功时，不返回该字段 | OS_400000 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| returnObj | Object | 返回结果 | 表 returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orderNo | String | 订单号 | 20250320140632454041 |
枚举参数
无
请求示例
请求url
https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/order/new
请求头header
无
请求体body
{
"available_zone_id": "cn-huadong1-jsnj1A-public-ctcloud",
"cluster_name": "test-aaa",
"cycle_type": 2,
"cycle_cnt": 1,
"pay_type": 1,
"region_id": "bb9fdb42056f11eda1610242ac110002",
"vpc_id": "vpc-8p9hpn4o8g",
"subnet_id": "subnet-mp6a3hce8q",
"security_groups_id": "sg-mkritasxrd",
"enable_ipv6": "OPEN",
"component_pwd": "kY$2@Li%90M1P",
"cluster_type": 2,
"node_details": [{
"host_num": 3,
"io_type": "SSD-genric",
"volume": 40,
"iaas_vm_spec_code": "s7.xlarge.4",
"node_group_type": "MASTER"
},
{
"host_num": 3,
"io_type": "SSD-genric",
"volume": 40,
"iaas_vm_spec_code": "s7.xlarge.4",
"node_group_type": "EXCLUSIVE_MASTER"
},
{
"host_num": 3,
"io_type": "SSD",
"volume": 40,
"iaas_vm_spec_code": "s7.xlarge.4",
"node_group_type": "COORDINATE"
},
{
"host_num": 3,
"io_type": "SSD-genric",
"volume": 40,
"iaas_vm_spec_code": "s7.xlarge.4",
"node_group_type": "COLD"
}]
}
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"orderNo": "20250320145809599253"
}
}
请求失败示例：
{
"statusCode": 500,
"error": "OS_400000",
"message": "请求失败"
}
ak 传错示例：
{
"statusCode": "CTAPI_10002",
"returnObj": {
},
"code": "10002",
"message": "ctyun-EOP: Invalid APP ID in request",
"error": "10002",
"requestId": "b0747f9e5ef24a7e95ad9324dbe6d885",
"eopErrCode": "10002"
}
sk传错示例:
{
"statusCode": "CTAPI_10009",
"returnObj": {
},
"code": "10009",
"message": "ctyun-EOP: signature verification failed",
"error": "10009",
"requestId": "ee133410bed24812b8f70cc27299401b",
"eopErrCode": "10009"
}
实名认证失败示例：
{
"statusCode": 500,
"error": "OS_401009",
"message": "账号未进行实名认证"
}
请求参数类型错误示例：
{
"statusCode": 500,
"error": "OS_401001",
"message": "请求参数类型错误",
"returnObj": "{"cluster_Name": "应为字符串"}"
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数类型错误",
"returnObj": "{"cluster_Name": "不能为空"}"
}
状态码
请参考 状态码
错误码
请参考 错误码
