接口功能介紹
此接口提供云搜索服務如何通過OpenAPI開通實例。
接口約束
1.選擇多可用區后必須選擇專屬master節點
2.專屬協調節點和冷數據節點，數量是選擇的可用區整數倍
3.選擇多可用區部署時需要選擇資源池下所有的可用區（最多選擇3個）
4.調用API請求參數時，參數需按請求體示例類型等要求傳遞
5.該接口暫不支持訂購Logstash類型實例
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 | |
| os_type | 是 | String | 操作系統類型，ctyun操作系統：CTyun、麒麟操作系統：Kylin | CTyun | |
| node_details | 是 | Array of Objects | 節點組詳情 | 表node_detail |
表 node_details
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| host_num | 是 | Integer | 節點數： MASTER 最小為3，最大為50； EXCLUSIVE_MASTER 最大為3； COORDINATE 最大為32； COLD 最大為50； |
３ | |
| io_type | 是 | String | IO類型： SSD-genric（通用型SSD）、SAS（高IO）、SSD（超高IO）、XSSD-0、XSSD-1 MASTER 節點可選：SSD-genric、SAS、SSD EXCLUSIVE_MASTER 節點可選：SSD-genric、SSD COORDINATE 節點可選：SSD-genric、SSD COLD 節點可選：SSD-genric、SAS、SSD 海光、飛騰類型的主機不支持超高IO磁盤 僅海光4、增強型主機可以使用XSSD系列磁盤 |
SSD-genric | |
| volume | 是 | Integer | 存儲容量： MASTER 節點可選：40 - 6144GB EXCLUSIVE_MASTER 節點可選：固定 40 GB COORDINATE 節點可選：固定 40 GB COLD 節點可選：40 - 6144GB |
40 | |
| iaas_vm_spec_code | 是 | String | 實例規格code 每個資源池可用區下可選擇的機型，參考訂購頁面展示的機型信息 規格code參考“概述”文檔中的 |
s7.2xlarge.4 | |
| node_group_type | 是 | String | 節點組類型： MASTER（數據節點）/EXCLUSIVE_MASTER（專屬master節點）/COORDINATE（專屬協調節點）/COLD（冷數據節點） |
MASTER |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼，成功：200，失敗：500 | 200 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | OS_400000 | |
| message | String | 用來簡述當前接口調用狀態以及必要提示信息 | 請求成功 | |
| returnObj | Object | 返回結果 | 表 returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| orderNo | String | 訂單號 | 20250320140632454041 |
枚舉參數
無
請求示例
請求url
//ctcsx-global.ctapi.daliqc.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,
"os_type":"CTyun",
"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": "不能為空"}"
}
狀態碼
請參考
錯誤碼
請參考
