最近更新时间:2024.01.04 09:53:14
首次发布时间:2023.02.10 20:00:02
获取集群列表
模块:集群管理
类型:open
场景:公有云
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListClusters | 公共参数,本接口值:ListClusters |
Version | String | 是 | 2021-03-04 | 公共参数,本接口值:2021-03-04 |
PageNumber | Integer | 否 | 1 | 分页页码 |
PageSize | Integer | 否 | 10 | 分页页长 |
Filter | Object ListClustersFilter | 否 | 筛选条件 |
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
IDs | Array of String | 否 | ["ucxxxxxxxxxxxxxxxxxxx"] | 所查询集群ID列表 |
Status | Array of ClusterStatus | 否 | ["Running"] | 所查询集群状态 |
Type | Array of String | 否 | ["volc-vke"] | 所查询集群类型 |
Public | Boolean | 否 | false | 是否是公共集群 |
Keyword | String | 否 | test-cluster | 模糊名称匹配 |
POST /?Action=ListClusters&Version=2021-03-04 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "IDs": ["ucxxxxxxxxxxxxxxxxxxx"], "Status": , "Type": ["volc-vke"], "Public": false, "Keyword": "test-cluster" } }
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of ClusterItem | 集群列表 | |
PageNumber | Integer | 1 | 分页页码 |
PageSize | Integer | 10 | 分页页长 |
TotalCount | Integer | 100 | 集群总数 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ID | String | ucxxxxxxxxxxxxxxxxxxx | 集群ID |
Name | String | name | 集群名称 |
Status | Object ClusterStatus | Creating | 集群状态 Creating、CreateFailed、Running、Error、Deleting、DeleteFailed、Updating、Stopped |
StartTime | Object Timestamp | 1673525239 | 集群纳管开始时间 |
Description | String | description | 纳管集群描述 |
ErrorMessage | String | err message | 集群纳管过程中出现问题时的错误信息 |
Bound | Boolean | false | 是否存在绑定的工作空间 |
Public | Boolean | false | 是否公共集群 |
VKEConfig | Object VKEConfig | vke 集群信息 | |
ExternalConfig | Object ExternalConfig | 外部集群信息 | |
SharedConfig | Object SharedConfig | 共享集群信息 | |
StoppedTime | Object Timestamp | 1673525239 | 欠费关停时间,Status为Stopped时有效 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ClusterID | String | ccexxxxxxxxxxxxxxxxxx | vke集群ID |
StorageClass | String | ebs-ssd | vke集群已安装的 StorageClass 的名称 |
VCIEnabled | Boolean | false | 是否运行VCI(仅用于回包,纳管集群时无需填写) |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
WESEndpoint | String | http://192.168.0.1:8002/ga4gh/wes/v1 | WES 地址 |
JupyterhubEndpoint | String | http://jupyterhub-hub:8081/jupyterhub | jupyterhub 地址 |
JupyterhubJWTSecret | String | http://jupyterhub-hub:8081/jupyterhub | jupyterhub jwt secret, 作为响应时不返回 |
JupyterhubClusterKubeConfig | String | kubeconfig yaml格式 | jupyterhub kubeconfig, 作为响应时不返回 |
JupyterhubUserNamespace | String | notebook-servers | jupyterhub user资源所在namespace, 作为响应时不返回 |
ResourceScheduler | String | SGE | 外部资源调度程序 |
Filesystem | String | tos | 工作流计算引擎依赖的文件系统(tos, local) |
ExecutionRootDir | String | /root | 工作流计算引擎执行根路径, 当且仅当工作流计算引擎依赖的文件系统为 local 时会有 |
S3ProxyConfig | Object S3ProxyConfig |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Endpoint | String | http://192.168.0.3:8000 | 访问地址 |
Region | String | cn-beijing | 区域 |
AccessKey | String | AKxxxx | 访问 s3proxy 的 AccessKey |
SecretKey | String | xxxxxx | 访问 s3proxy 的 SecretKey |
ForcePathStyle | Boolean | true | 是否强制使用 path style,还是使用 virtual style |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202211302208xxxx", "Action": "ListClusters", "Version": "2021-03-04", "Service": "bio", "Region": "cn-beijing" }, "Result": { "Items": [ { "ID": "ucxxxxxxxxxxxxxxxxxxx", "Name": "name", "Status": , "StartTime": , "Description": "description", "ErrorMessage": "err message", "Bound": false, "Public": false, "VKEConfig": { "ClusterID": "ccexxxxxxxxxxxxxxxxxx", "StorageClass": "ebs-ssd", "VCIEnabled": false }, "ExternalConfig": { "WESEndpoint": "http://192.168.0.1:8002/ga4gh/wes/v1", "JupyterhubEndpoint": "http://jupyterhub-hub:8081/jupyterhub", "JupyterhubJWTSecret": "http://jupyterhub-hub:8081/jupyterhub", "JupyterhubClusterKubeConfig": "kubeconfig yaml格式", "JupyterhubUserNamespace": "notebook-servers", "ResourceScheduler": "SGE", "Filesystem": "tos", "ExecutionRootDir": "/root", "S3ProxyConfig": { "Endpoint": "http://192.168.0.3:8000", "Region": "cn-beijing", "AccessKey": "AKxxxx", "SecretKey": "xxxxxx", "ForcePathStyle": true } }, "SharedConfig": , "StoppedTime": } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 100 } }
HTTP 状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParamErr | <透传错误内容> | 参数错误 |
500 | InternalErr | <透传错误内容> | 内部错误 |