GetCluster - 获取集群详细信息_微服务引擎(MSE)-阿里云帮助中心

获取集群详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-d6a5243b6fa

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码。	200
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	D0DE9C33-992A-580B-89C4-B609A292748D
Message	string	错误信息。	Parameter error: content is null.
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object
ClusterId	string	集群 ID。	xxljob-e0d018c6df8
ClusterName	string	集群名称。	xxl-job-test-1730427575152
ClusterSpec	string	集群规格，可选规格如下： scx.dev.x1。 scx.small.x1。 scx.small.x2。 scx.medium.x1。 scx.medium.x2。	scx.small.x2
ProductType	integer	产品版本。 1：开发版。 2：专业版。 3：企业版。	2
EngineType	string	引擎类型，可选类型：xxljob。	xxljob
EngineVersion	string	引擎版本。	2.0.0
Status	integer	集群状态。 1：创建中。 2：运行中。 3：重启中。 4：销毁中。 5：创建失败。 6：停机。 99：删除。	2
CreateTime	string	创建时间。	2024-10-29 15:56:36
EndTime	string	过期时间。	2024-10-29 15:56:36
IntranetDomain	string	内网域名。	http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com
InternetDomain	string	公网域名。说明暂不支持	暂无
ChargeType	string	付费方式。取值说明： PREPAY：包年包月。 POSTPAY：按量付费。	POSTPAY
KubeConfig	string	K8s 服务器的配置信息。	{ "vSwitchIdList": [ "xxx", "xxx" ], "cpu": xxx, "cpuUnit": "xxx", "diskCapacity": xxx, "memoryCapacity": xxx, "zoneIds": [ "xxx", "xxx" ], "securityGroupList": [ "xxx" ], "eniCrossZone": "xxx", "regionId": "xxx", "instanceCount": xxx, "vpcId": "xxx", "memoryUnit": "xxx", "diskType": "xxx", "appClusterId": "xxx" }
JobNum	integer	该规格下最大任务数。	100
WorkerNum	integer	执行器数量。	10
VSwitches	array<object>	可用区交换机信息。
vswitches	object
ZoneId	string	可用区 ID。	cn-hangzhou-k
VSwitchId	string	虚拟交换机 ID。	vsw-8vbf1n216nshvfjdyff8a
VpcId	string	VPC ID。	vpc-bp1fiz967u39lt8yuxcs0
MaxJobNum	integer	该规格下最大任务数。	1000
Spm	integer	每分钟调度峰值。	10
Zones	array	可用区列表。
zones	string	可用区。	cn-hangzhou-i

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "D0DE9C33-992A-580B-89C4-B609A292748D",
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "ClusterId": "xxljob-e0d018c6df8",
    "ClusterName": "xxl-job-test-1730427575152",
    "ClusterSpec": "scx.small.x2",
    "ProductType": 2,
    "EngineType": "xxljob",
    "EngineVersion": "2.0.0",
    "Status": 2,
    "CreateTime": "2024-10-29 15:56:36",
    "EndTime": "2024-10-29 15:56:36",
    "IntranetDomain": "http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com",
    "InternetDomain": "暂无",
    "ChargeType": "POSTPAY",
    "KubeConfig": "{\n  \"vSwitchIdList\": [\n    \"xxx\",\n    \"xxx\"\n  ],\n  \"cpu\": xxx,\n  \"cpuUnit\": \"xxx\",\n  \"diskCapacity\": xxx,\n  \"memoryCapacity\": xxx,\n  \"zoneIds\": [\n    \"xxx\",\n    \"xxx\"\n  ],\n  \"securityGroupList\": [\n    \"xxx\"\n  ],\n  \"eniCrossZone\": \"xxx\",\n  \"regionId\": \"xxx\",\n  \"instanceCount\": xxx,\n  \"vpcId\": \"xxx\",\n  \"memoryUnit\": \"xxx\",\n  \"diskType\": \"xxx\",\n  \"appClusterId\": \"xxx\"\n}\n",
    "JobNum": 100,
    "WorkerNum": 10,
    "VSwitches": [
      {
        "ZoneId": "cn-hangzhou-k",
        "VSwitchId": "vsw-8vbf1n216nshvfjdyff8a"
      }
    ],
    "VpcId": "vpc-bp1fiz967u39lt8yuxcs0",
    "MaxJobNum": 1000,
    "Spm": 10,
    "Zones": [
      "cn-hangzhou-i"
    ],
    "VersionLifecycle": "",
    "Tags": {
      "test": "test",
      "test2": 1
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s
500	InternalError	InternalError: %s.	系统内部错误：%s

访问错误中心查看更多错误码。