ListClusters - 查询实例列表_微服务引擎(MSE)-阿里云帮助中心

查询实例列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
PageNum	integer	否	页码	5
PageSize	integer	否	分页查询时每页的条目数	10
ClusterId	string	否	集群 ID	xxljob-d6a5243b6fa
ClusterName	string	否	集群名称	cluster-test

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码	200
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	39938688-0BAB-5AD8-BF02-F4910FAC7589
Message	string	错误信息	Parameter error: content is null.
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object
Records	array<object>
record	object
ClusterId	string	集群 ID	xxljob-c20f7ec9a78
ClusterName	string	集群名称	xxl-job-test-1730427510169
ClusterSpec	string	实例规格	scx.small.x2
ProductType	integer	产品版本 1 开发版 2 专业版 3 企业版	1
EngineType	string	引擎类型	xxljob
EngineVersion	string	引擎版本	2.0.0
Status	integer	集群状态 1：创建中 2：运行中 3：重启中 4：销毁中 5：创建失败 6：停机 99：删除	1
CreateTime	string	创建时间	2024-10-29 15:56:36
EndTime	string	过期时间	2024-10-29 15:56:36
IntranetDomain	string	内网域名	http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com
InternetDomain	string	公网域名说明暂不支持	暂无
ChargeType	string	付费方式。取值说明： PREPAY：包年包月。 POSTPAY：按量付费。	PREPAY
VpcId	string	VPC ID	vpc-bp1fxort6ag5h9752i305
VSwitches	array<object>	可用区交换机信息
vswitches	object	结果集
ZoneId	string	可用区	cn-hangzhou-h
VSwitchId	string	虚拟交换机 ID	vsw-8vbl54xzux86usy61r5zm
SpInstanceId	string	订单资产实例 ID	mse_schedulerxpost_public_cn-htq402sak02
Total	integer	总条数	30
PageNumber	integer	页码	1
PageSize	integer	每页记录数	50

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "39938688-0BAB-5AD8-BF02-F4910FAC7589",
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "Records": [
      {
        "ClusterId": "xxljob-c20f7ec9a78",
        "ClusterName": "xxl-job-test-1730427510169",
        "ClusterSpec": "scx.small.x2",
        "ProductType": 1,
        "EngineType": "xxljob",
        "EngineVersion": "2.0.0",
        "Status": 1,
        "CreateTime": "2024-10-29 15:56:36",
        "EndTime": "2024-10-29 15:56:36",
        "IntranetDomain": "http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com",
        "InternetDomain": "暂无",
        "ChargeType": "PREPAY",
        "VpcId": "vpc-bp1fxort6ag5h9752i305",
        "VSwitches": [
          {
            "ZoneId": "cn-hangzhou-h",
            "VSwitchId": "vsw-8vbl54xzux86usy61r5zm"
          }
        ],
        "SpInstanceId": "mse_schedulerxpost_public_cn-htq402sak02"
      }
    ],
    "Total": 30,
    "PageNumber": 1,
    "PageSize": 50
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-11-27	OpenAPI 返回结构发生变更	查看变更详情