接口功能介绍

此接口提供云搜索服务实例信息分页查询功能。

接口约束

1.入参必填字段必须按请求body参数传入
2.入参类型必须按请求body参数表格传入
3.本接口不支持Logstash类型实例查询

URI

POST /os/openapi/v1/cluster/selectInstancePage

路径参数 无

Query参数 无

请求参数

请求头header参数 无

请求体body参数

响应参数

枚举参数

无

请求示例

请求url

https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/cluster/selectInstancePage

请求头header

无

请求体body

{
    "regionId":"bb9fdb42056f11eda1619242ac110002",
    "pageIndex":1,
    "pageSize":10,
    "clusterType": 1,
}

响应示例

请求成功示例：
{
    "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",
                "projectId": "0",
                "projectName": "default"
            }
        ],
        "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": {}
}

状态码

请参考 状态码

错误码

请参考 错误码