全部产品
阿里云办公

获取集群列表

更新时间:2018-11-18 12:13:59

ListClusters

描述

获取集群列表。 在集群数很大情况下,需要分批调用 API 才能查询出所有的集群列表,所以需要用户跟BatchCompute 之间传入一个上下文 marker。如果首次调用查询 API 传入的 marker 为空值,否则传入上一次调用 API 时返回的 marker 值。如果调用 API 返回的 Marker 的值为空,则表示没有更多的集群,无须再调用 API 查询。

请求语法

请求行:

  1. GET /clusters?Marker={Marker}&MaxItemCount={MaxItemCount} HTTP/1.1

请求方法为 GET,请求资源为 clusters,请求参数:

属性名称 类型 是否必须 描述
Marker string 本页起始资源标识符。默认为空字符串。
MaxItemCount int 一次返回最大资源数量。默认值50,最大值100。

返回信息

成功

状态行:

  1. HTTP/1.1 201 OK

响应数据:

由于篇幅有限下面返回的 Items 仅列出一个值。

  1. {
  2. "NextMarker": "cls-6ki3npokblk1091cbko00f",
  3. "Items":[{
  4. "Name": "clusterName1",
  5. "Id": "cls-6kir9pdp3lg6220g418002",
  6. "OwnerId": 123,
  7. "Description": "demo",
  8. "CreationTime": "2016-10-31T06:55:33.921897Z",
  9. "State": "Active",
  10. "ImageId": "img-ubuntu",
  11. "Notification": {
  12. "Topic": {
  13. "Name": "test-topic",
  14. "Endpoint": "http://[UserId].mns.[Region].aliyuncs.com/",
  15. "Events": [
  16. "OnClusterDeleted",
  17. "OnInstanceCreated",
  18. "OnInstanceActive"
  19. ]
  20. }
  21. },
  22. "Configs": {
  23. "Disks": {
  24. "SystemDisk": {
  25. "Type": "cloud",
  26. "Size": 500
  27. },
  28. "DataDisk": {
  29. "Type": "cloud",
  30. "Size": 500,
  31. "MountPoint": "/path/to/mount"
  32. }
  33. }
  34. },
  35. "Groups": {
  36. "group1": {
  37. "DesiredVMCount": 3,
  38. "ActualVMCount": 2,
  39. "InstanceType": "bcs.a2.large",
  40. "ResourceType": "OnDemand"
  41. }
  42. },
  43. "OperationLogs": ["[2016-10-31T06:55:33.921897Z][group]Creating instance group successfully","[2016-10-31T06:55:33.941897Z]Creating cluster successfully"],
  44. "Metrics": {
  45. "RunningCount": 1,
  46. "StartingCount": 0,
  47. "StoppingCount": 0,
  48. "StoppedCount": 0
  49. }
  50. }]
  51. }

属性说明:

属性名称 类型 是否必须 描述
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之间。