接口功能介紹

此接口提供根據實例id查詢實例信息功能，返回符合條件的實例詳細信息。

接口約束

1.入參字段必須按Query參數傳入。

URI

GET /os/openapi/v1/cluster/getClusterById

路徑參數
無

Query參數

請求參數

請求頭header參數
無

請求體body參數
無

響應參數

表 returnObj

表 routerHostInfo

表 dataHostInfos

表 exclusiveMasterHostInfos

表 coldHostInfos

枚舉參數

無

請求示例

請求url

//ctcsx-global.ctapi.daliqc.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": {

}

}

狀態碼

請參考

錯誤碼

請參考