接口功能介绍

此接口提供根据实例id查询实例信息功能，返回符合条件的实例详细信息。

接口约束

1.入参字段必须按Query参数传入。

URI

GET /os/openapi/v1/cluster/getClusterById

路径参数
无

Query参数

请求参数

请求头header参数
无

请求体body参数
无

响应参数

表 returnObj

表 routerHostInfo

表 dataHostInfos

表 exclusiveMasterHostInfos

表 coldHostInfos

枚举参数

无

请求示例

请求url

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

请求头header

无

请求体body

无

响应示例

请求成功示例：
{
    "success": true,
    "code": 200,
    "message": "请求成功",
    "data": {
        "clusterId": "Elasticsearch-NIAHLNJLMKALGRIPHI",
        "clusterName": "openapi-test-cq-2009",
        "state": "GREEN",
        "regionId": "bb9fdb42056f11eda1610242ac110002",
        "regionName": "华东1",
        "azName": "可用区1",
        "availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
        "vpcName": "vpc-yss-test",
        "vpcId": "vpc-69rrwc5fsg",
        "subnetName": "subnet-6a5a",
        "enableIpv6": "CLOSE",
        "subnetId": "subnet-uucezj0vwp",
        "securityGroupId": "sg-a0k8e4nvre",
        "securityGroupnName": "Default-Security-Group",
        "clusterType": 2,
        "clusterTypeName": "Elasticsearch",
        "clusterTypeVersion": "7.10.2",
        "payType": "包年包月",
        "clusterDueTime": 1755867311000,
        "createTime": 1753187978000,
        "userName": "root",
        "componentName": "kibana,cerebro",
        "loadBalancerName": null,
        "targetGroupName": null,
        "routerHostInfo": {
            "availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
            "hostIp": "192.168.3.223",
            "state": "RUNNING",
            "stateType": 8,
            "ipv6HostIp": "",
            "iaasVmSpecCode": "esearch-2c4g",
            "iaasVmTypeName": "通用型",
            "ioTypeName": "通用型SSD",
            "cpuNum": 2,
            "memory": 4,
            "diskVolumn": 40
        },
        "cpuInfo": "x86",
        "osType": "CTyun",
        "logstashHostInfos": null,
        "dataHostInfos": [
            {
                "availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
                "hostIp": "192.168.3.225",
                "state": "RUNNING",
                "stateType": 8,
                "ipv6HostIp": "",
                "iaasVmSpecCode": "esearch-8c16g",
                "iaasVmTypeName": "通用型",
                "ioTypeName": "超高IO",
                "cpuNum": 8,
                "memory": 16,
                "diskVolumn": 40
            },
            {
                "availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
                "hostIp": "192.168.3.226",
                "state": "RUNNING",
                "stateType": 8,
                "ipv6HostIp": "",
                "iaasVmSpecCode": "esearch-8c16g",
                "iaasVmTypeName": "通用型",
                "ioTypeName": "超高IO",
                "cpuNum": 8,
                "memory": 16,
                "diskVolumn": 40
            },
            {
                "availableZoneId": "cn-huadong1-jsnj1A-public-ctcloud",
                "hostIp": "192.168.3.224",
                "state": "RUNNING",
                "stateType": 8,
                "ipv6HostIp": "",
                "iaasVmSpecCode": "esearch-8c16g",
                "iaasVmTypeName": "通用型",
                "ioTypeName": "超高IO",
                "cpuNum": 8,
                "memory": 16,
                "diskVolumn": 40
            }
        ],
        "exclusiveMasterHostInfos": [],
        "coordinateHostInfos": [],
        "coldHostInfos": []
    }
}
请求失败示例：

{

"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_401002",

"message": "请求参数值无效",

"returnObj": "{"clusterId":"不能为空"}"

}
资源池不存在示例:

{

"statusCode": 500,

"error": "OS_401005",

"message": "该实例不存在",

"returnObj": {}

}
用户无权限:

{

"statusCode": 500,

"error": "OS_401004",

"message": "非法操作",

"returnObj": {

}

}

状态码

请参考 状态码

错误码

请参考 错误码