获取集群列表
更新时间:
ListClusters
描述
获取集群列表。在集群数很大情况下,需要分批调用 API 才能查询出所有的集群列表,所以需要用户跟 BatchCompute 之间传入一个上下文marker。如果首次调用查询 API 传入的 marker 为空值,否则传入上一次调用 API 时返回的 marker 值。如果调用 API 返回的 Marker 的值为空,则表示没有更多的集群,无须再调用 API 查询。
请求语法
请求行:
GET /clusters?Marker={Marker}&MaxItemCount={MaxItemCount} HTTP/1.1请求方法为 GET,请求资源为 clusters,请求参数:
属性名称  | 类型  | 是否必须  | 描述  | 
|---|---|---|---|
Marker  | string  | 否  | 本页起始资源标识符。默认为空字符串。  | 
MaxItemCount  | int  | 否  | 一次返回最大资源数量。默认值50,最大值100。  | 
返回信息
成功
状态行:
HTTP/1.1 201 OK响应数据:
说明 
由于篇幅有限下面返回的 Items 仅列出一个值。
{
    "NextMarker": "cls-6ki3npokblk1091cbko00f",
    "Items":[{
        "Name": "clusterName1",
        "Id": "cls-6kir9pdp3lg6220g418002",
        "OwnerId": 123,
        "Description": "demo",
        "CreationTime": "2016-10-31T06:55:33.921897Z",
        "State": "Active",
        "ImageId": "img-ubuntu",
        "Notification": {
            "Topic": {
                "Name": "test-topic",
                "Endpoint": "http://[UserId].mns.[Region].aliyuncs.com/",
                "Events": [
                    "OnClusterDeleted",
                    "OnInstanceCreated",
                    "OnInstanceActive"
                ]
            }
        },
        "Configs": {
            "Disks": {
                "SystemDisk": {
                    "Type": "cloud",
                    "Size": 500
                },
                "DataDisk": {
                    "Type": "cloud",
                    "Size": 500,
                    "MountPoint": "/path/to/mount"
                }
            }
        },
        "Groups": {
            "group1": {
                "DesiredVMCount": 3,
                "ActualVMCount": 2,
                "InstanceType": "bcs.a2.large",
                "ResourceType": "OnDemand"
            }
        },
        "OperationLogs": ["[2016-10-31T06:55:33.921897Z][group]Creating instance group successfully","[2016-10-31T06:55:33.941897Z]Creating cluster successfully"],
        "Metrics": {
            "RunningCount": 1,
            "StartingCount": 0,
            "StoppingCount": 0,
            "StoppedCount": 0
        }
    }]
}属性说明:
属性名称  | 类型  | 是否必须  | 描述  | 
|---|---|---|---|
NextMarker  | string  | 是  | 下一页起始资源标识符。最后一页该值为空。  | 
Items  | array of Item  | 是  | 集群列表。Item 对象属性参阅 API 获取集群实例信息。  | 
错误
状态码  | 错误码  | 错误信息  | 语义  | 
|---|---|---|---|
400  | InvalidMaxItemCount  | Specified parameter MaxItemCount is not valid. Its type must be integer.  | MaxItemCount必须是一个integer。  | 
400  | InvalidMaxItemCount  | Specified parameter MaxItemCount is not valid. It must be in [0, 100].  | MaxItemCount的大小必须在0与100之间。  | 
该文章对您有帮助吗?