接口功能介紹
此接口提供云搜索服務如何進行實例信息分頁查詢。
接口約束
1.入參必填字段必須按請求body參數傳入
2.入參類型必須按請求body參數表格傳入
3.本接口不支持Logstash類型實例查詢
URI
POST /os/openapi/v1/cluster/selectInstancePage
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 | |
| pageIndex | 是 | Integer | 當前頁，參數值需為正整數 | 1 | |
| pageSize | 是 | Integer | 每頁大小，參數值需為正整數 | 10 | |
| clusterName | 否 | String | 實例名稱 | ostest | |
| clusterType | 是 | Integer | 實例類型： 1：OpenSearch 2：Elasticsearch |
1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼，成功：200，失敗：500 | 200 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | OS_400000 | |
| message | String | 用來簡述當前接口調用狀態以及必要提示信息 | 請求成功 | |
| returnObj | Object | 返回結果 | 表 returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 總實例數量 | 23 | |
| records | Array of Objects | 集群列表 | 表records | |
| pageIndex | Integer | 當前頁，參數值需為正整數 | 1 | |
| pageSize | Integer | 每頁大小，參數值需為正整數 | 10 |
表 records
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| clusterId | String | 實例id | OpenSearch-UTLGQLHQPJNJSDCRPPJBP | |
| clusterName | String | 實例名稱 | ostest | |
| clusterState | String | 實例狀態 | 運行中 | |
| clusterStateType | Integer | 實例狀態類型： 1：創建中（CREATING） 2：運行中（RUNNING） 3：處理中（PROCESSING） 4：釋放中（FROZEN） 5：已銷毀（DESTROYED） 6：異常（TERMINATED） 7：處理中（重啟）（PROCESSING） 8：處理中（擴容）（PROCESSING） 10：已凍結（FROZEN） 11：處理中（重置密碼）（PROCESSING_RESET_PASSWORD） 12：處理中（配置變更）（PROCESSING_SETTINGS_UPDATE） 13：處理中（升配）（PROCESSING_UPGRADE） 14：處理中（磁盤擴容）（PROCESSING_DISK_UPDATE） 15：處理中（開啟備份）（PROCESSING_BACKUPS_UPDATE） 16：處理中（加裝Logstash）（PROCESSING_LOGSTASH_ADD） 17：處理中（Logstash退訂）（PROCESSING_LOGSTASH_REFUND） 18：處理中（開通云日志）（PROCESSING_OPEN_CLOUD） 19：處理中（關閉云日志）（PROCESSING_CLOSE_CLOUD） |
2 | |
| processType | Integer | 創建中的進度： 17：開通主機資源正在開通中，進度30% 18：資源正在開通中，進度50% 3：后端服務正在開通中，進度70% 4：云搜索服務正在開通中，進度90% |
||
| releaseVersion | String | 發布版本 | 云搜索-1.2.0 | |
| indexNum | String | 索引數量 | 2 | |
| storageUsage | String | 存儲總用量，-1時表示異常 | 1.86G | |
| storagePercent | String | 存儲百分比 | ０ | |
| clusterType | Integer | 實例類型： 1：表示OpenSearch 2：表示Elasticsearch |
1 | |
| clusterTypeName | String | 類型名稱 | Ostest | |
| clusterTypeVersion | String | 實例版本 | 2.9.0 | |
| payType | String | 付費類型 | 包年包月 | |
| clusterDueTime | Integer | 實例到期時間 | 1745033321000 | |
| createTime | Integer | 創建時間 | 1742353726000 | |
| componentUrl | String | 組件訪問鏈接 ：為空則未綁定公網 | ||
| ipv6ComponentUrl | String | 組件ipv6訪問鏈接：為空則為綁定 | ||
| clusterMessage | String | 錯誤原因 異常撤單的會有原因 | 實例開通失敗，已自動退單，失敗原因：后端服務部署失敗 | |
| enableIpv6 | String | OPEN： 開啟ipv6 CLOSE：關閉ipv6 NOT_DISPLAY：ipv6按鈕不在頁面展示 |
CLOSE | |
| componentName | String | 實例組件列表 | kibana,cerebro |
枚舉參數
無
請求示例
請求url
//ctcsx-global.ctapi.daliqc.cn/os/openapi/v1/cluster/selectInstancePage
請求頭header
無
請求體body
{
"regionId":"bb9fdb42056f11eda1619242ac110002",
"pageIndex":1,
"pageSize":10
}
響應示例
請求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"records": [
{
"clusterId": "Elasticsearch-CAQPBFJJLMKODRDPFH",
"clusterName": "test",
"clusterState": "運行中",
"clusterStateType": 2,
"releaseVersion": "云搜索-1.2.0",
"indexNum": "2",
"storageUsage": "1.86G",
"storagePercent": 0,
"clusterType": 2,
"clusterTypeName": "Elasticsearch",
"clusterTypeVersion": "7.10.2",
"payType": "包年包月",
"clusterDueTime": 1745033321000,
"createTime": 1742353726000,
"componentUrl": null,
"ipv6ComponentUrl": null,
"cerebroIpv4Url": null,
"cerebroIpv6Url": null,
"clusterMessage": null,
"enableIpv6": "OPEN",
"processType": null,
"componentName": "kibana,cerebro"
}
],
"total": 1,
"pageSize": 10,
"pageIndex": 1
}
}
請求失敗示例：
{
"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_401001",
? "message": "請求參數類型錯誤",
? "returnObj": "{"cluster_Name": "應為字符串"}"
}
請求參數值無效示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "請求參數值無效",
"returnObj": "{"regionId":"must not be blank"}"
}
資源池不存在示例:
{
"statusCode": 500,
"error": "OS_401003",
"message": "資源池id不存在",
"returnObj": {}
}
用戶無權限:
{
"statusCode": 500,
"error": "OS_401004",
"message": "非法操作",
"returnObj": {}
}
狀態碼
請參考
錯誤碼
請參考
