DocsICP FilingConsole
官方文档
首页

GetCluster

更新时间：
复制 MD 格式
产品详情
我的收藏

Obtains the details of a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
ClusterId

string

Yes

The cluster ID.

xxljob-d6a5243b6fa

Response elements

Element

Type

Description

Example

object

Schema of Response

Code

integer

The response code.

200
RequestId

string

The request ID. The value is a unique identifier that Alibaba Cloud generates for the request and can be used to troubleshoot issues.

D0DE9C33-992A-580B-89C4-B609A292748D
Message

string

The error message.

Parameter error: content is null.
Success

boolean

Indicates whether the call was successful.

  • true: The call was successful.

  • false: The call failed.

true
Data

object

ClusterId

string

The cluster ID.

xxljob-e0d018c6df8
ClusterName

string

The cluster name.

xxl-job-test-1730427575152
ClusterSpec

string

The cluster specification. Valid values:

  • scx.dev.x1.

  • scx.small.x1.

  • scx.small.x2.

  • scx.medium.x1.

  • scx.medium.x2.

scx.small.x2
ProductType

integer

The product edition.

  • 1: Developer Edition.

  • 2: Professional Edition.

  • 3: Enterprise Edition.

2
EngineType

string

The engine type. Valid value: xxljob.

xxljob
EngineVersion

string

The engine version.

2.0.0
Status

integer

The cluster status.

  • 1: Being created.

  • 2: Running.

  • 3: Restarting.

  • 4: Being released.

  • 5: Creation failed.

  • 6: Stopped.

  • 99: Deleted.

2
CreateTime

string

The time when the cluster was created.

2024-10-29 15:56:36
EndTime

string

The expiration time.

2024-10-29 15:56:36
IntranetDomain

string

The internal endpoint.

http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com
InternetDomain

string

The public endpoint.

Note

Currently not supported.

暂无
ChargeType

string

The billing method. Valid values:

  • PREPAY: subscription.

  • POSTPAY: pay-as-you-go.

POSTPAY
KubeConfig

string

The configuration of the Kubernetes server.

{ "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

The maximum number of jobs for the current specification.

100
WorkerNum

integer

The number of workers.

10
VSwitches

array<object>

The vSwitch information of zones.

object

ZoneId

string

The zone ID.

cn-hangzhou-k
VSwitchId

string

The vSwitch ID.

vsw-8vbf1n216nshvfjdyff8a
VpcId

string

The VPC ID.

vpc-bp1fiz967u39lt8yuxcs0
MaxJobNum

integer

The maximum number of jobs for the current specification.

1000
Spm

integer

The peak number of scheduling operations per minute.

10
Zones

array

The list of zones.

string

The zone.

cn-hangzhou-i
VersionLifecycle

string

MaxWorkflowNum

integer

The maximum number of workflows supported.

100
WorkflowNum

integer

The current number of workflows.

20
IpWhitelist

string

192.168.1.0/24
Tags

object

ClusterType

integer

1
Source

string

Examples

Success response

JSON format

{
  "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": "",
    "MaxWorkflowNum": 100,
    "WorkflowNum": 20,
    "IpWhitelist": "192.168.1.0/24",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ClusterType": 1,
    "Source": ""
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter Parameter error: %s. Parameter error: %s
401 IllegalRequest IllegalRequest: %s. Illegal request:%s
500 InternalError InternalError: %s. System Internal Error: %s
403 NoPermission No permission to perform this operation: %s. No permission to perform this operation: %s
404 NotFound Not found: %s. The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.