You need to enable JavaScript to run this app.
导航

ListClusters

最近更新时间2024.01.04 09:53:14

首次发布时间2023.02.10 20:00:02

ListClusters

获取集群列表

接口说明

模块:集群管理
类型:open
场景:公有云

请求参数

参数名称类型是否必选示例值描述
ActionStringListClusters公共参数,本接口值:ListClusters
VersionString2021-03-04公共参数,本接口值:2021-03-04
PageNumberInteger1分页页码
PageSizeInteger10分页页长
FilterObject
ListClustersFilter
筛选条件

ListClustersFilter

参数名称类型是否必选示例值描述
IDsArray of String["ucxxxxxxxxxxxxxxxxxxx"]所查询集群ID列表
StatusArray of ClusterStatus["Running"]所查询集群状态
TypeArray of String["volc-vke"]所查询集群类型
PublicBooleanfalse是否是公共集群
KeywordStringtest-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"
    }
}

返回参数

参数名称类型示例值描述
ItemsArray of ClusterItem集群列表
PageNumberInteger1分页页码
PageSizeInteger10分页页长
TotalCountInteger100集群总数

ClusterItem

参数名称类型示例值描述
IDStringucxxxxxxxxxxxxxxxxxxx集群ID
NameStringname集群名称
StatusObject
ClusterStatus
Creating集群状态 Creating、CreateFailed、Running、Error、Deleting、DeleteFailed、Updating、Stopped
StartTimeObject
Timestamp
1673525239集群纳管开始时间
DescriptionStringdescription纳管集群描述
ErrorMessageStringerr message集群纳管过程中出现问题时的错误信息
BoundBooleanfalse是否存在绑定的工作空间
PublicBooleanfalse是否公共集群
VKEConfigObject
VKEConfig
vke 集群信息
ExternalConfigObject
ExternalConfig
外部集群信息
SharedConfigObject
SharedConfig
共享集群信息
StoppedTimeObject
Timestamp
1673525239欠费关停时间,Status为Stopped时有效

VKEConfig

参数名称类型示例值描述
ClusterIDStringccexxxxxxxxxxxxxxxxxxvke集群ID
StorageClassStringebs-ssdvke集群已安装的 StorageClass 的名称
VCIEnabledBooleanfalse是否运行VCI(仅用于回包,纳管集群时无需填写)

ExternalConfig

参数名称类型示例值描述
WESEndpointStringhttp://192.168.0.1:8002/ga4gh/wes/v1WES 地址
JupyterhubEndpointStringhttp://jupyterhub-hub:8081/jupyterhubjupyterhub 地址
JupyterhubJWTSecretStringhttp://jupyterhub-hub:8081/jupyterhubjupyterhub jwt secret, 作为响应时不返回
JupyterhubClusterKubeConfigStringkubeconfig yaml格式jupyterhub kubeconfig, 作为响应时不返回
JupyterhubUserNamespaceStringnotebook-serversjupyterhub user资源所在namespace, 作为响应时不返回
ResourceSchedulerStringSGE外部资源调度程序
FilesystemStringtos工作流计算引擎依赖的文件系统(tos, local)
ExecutionRootDirString/root工作流计算引擎执行根路径, 当且仅当工作流计算引擎依赖的文件系统为 local 时会有
S3ProxyConfigObject
S3ProxyConfig

S3ProxyConfig

参数名称类型示例值描述
EndpointStringhttp://192.168.0.3:8000访问地址
RegionStringcn-beijing区域
AccessKeyStringAKxxxx访问 s3proxy 的 AccessKey
SecretKeyStringxxxxxx访问 s3proxy 的 SecretKey
ForcePathStyleBooleantrue是否强制使用 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 状态码错误码错误信息描述
400ParamErr<透传错误内容>参数错误
500InternalErr<透传错误内容>内部错误