使用 CycleCloud REST API

CycleCloud 提供了一个 REST API ，用于添加自动化和编程的群集管理。 自定义自动缩放和自定义计划程序集成需要一个工具来评估工作负荷队列并启动虚拟机（VM），以满足工作负荷需求。 CycleCloud REST API 是此类工具的适当终结点，支持工作负荷要求，这些要求可能包括高吞吐量或紧密耦合的 VM 排列。

确定群集状态

可以查询 CycleCloud 以确定群集状态。 状态显示每个群集配置中的 VM 可用性。

curl --location --request GET '${CC-URL}/clusters/${CLUSTER}/status' \
--header 'Authorization: Basic ****************************'

响应如以下示例所示。 响应包含一组完整的节点属性，但为了简单起见，此处省略了许多节点属性。

{
  "state": "Started",
  "targetState": "Started",
  "maxCount": 100,
  "maxCoreCount": 10000,
  "nodearrays": [
    {
      "name": "ondemand",
      "maxCount": 100,
      "maxCoreCount": 500,
      "buckets": [
        {
        "bucketId": "cd56af52-abcd-1234-a4e7-e6a91ca519a2",
        "definition": {
            "machineType": "Standard_Fs32_v2"
          },
          "maxCount": 3,
          "maxCoreCount": 96,
          "activeCount": 0,
          "activeCoreCount": 0,
          "availableCount": 3,
          "availableCoreCount": 96,
          "quotaCount": 3,
          "quotaCoreCount": 100,
          "consumedCoreCount": 0,
          "maxPlacementGroupSize": 40,
          "maxPlacementGroupCoreSize": 1280,
          "valid": true,
          "placementGroups": [],
          "virtualMachine": {
            "vcpuCount": 32,
            "memory": 64.0,
            "infiniband": false
          }
          },
        {
        "bucketId": "d81e001a-abcd-1234-9754-79815cb7b225",
        "definition": {
            "machineType": "Standard_Hc44rs"
          },
          "maxCount": 11,
          "maxCoreCount": 484,
          "activeCount": 0,
          "activeCoreCount": 0,
          "availableCount": 11,
          "availableCoreCount": 484,
          "quotaCount": 200,
          "quotaCoreCount": 8800,
          "consumedCoreCount": 44,
          "maxPlacementGroupSize": 40,
          "maxPlacementGroupCoreSize": 1760,
          "valid": true,
          "placementGroups": [],
          "virtualMachine": {
            "vcpuCount": 44,
            "memory": 327.83,
            "infiniband": true
          }
        }
    ]
}

创建节点

启动节点时，API 提供极大的灵活性。 创建节点的唯一必需属性是 nodearray 和 count。 使用这些最低必需属性的调用将继承所有现有节点配置。 节点位于满足请求的第一个存储桶中。

curl --location --request POST '${CC-URL}/clusters/${CLUSTER}/nodes/create' \
--header 'Authorization: Basic ****************************' \
--header 'Content-Type: text/plain' \
--data-raw '{ "requestId" : "463270ca-abcd-1234-98d6-431ee3ef8ed5",
    "sets" : [
        {
            "count" : 1,
            "nodearray" : "ondemand"
        }
    ]
}'

对此调用的响应提供操作ID。

{
  "operationId": "3b53d621-abcd-1234-8876-6ec1158897ac",
  "sets": [
    {
      "added": 1
    }
  ]
}

可以使用 操作API 跟踪操作状态。 设置参数 request_id 以筛选 GET 节点响应。 此筛选器提供使用创建请求创建的所有节点的详细信息。

curl --location --request GET '${CC-URL}/clusters/${CLUSTER}/nodes?request_id=463270ca-abcd-1234-98d6-431ee3ef8ed5' \

添加紧密耦合节点

可以在列表中定义具有多个有效计算机类型的 CycleCloud 节点数组。 假设ondemand节点数组同时定义了Standard_F32s_v2_和Standard_Hc44rs。 群集状态 API 为此节点数组显示至少两个 buckets，每个 VM 大小一个。 Standard_Hc44rs 桶指示 infiniband 服务可用。 某些定量软件跨节点横向扩展，并利用节点之间的低延迟连接。

假设你正在运行这样的工作负载，并且作业调用由 Azure InfiniBand 网络技术连接的四个节点。 为确保这四个节点最终处于同一个放置组，从而处于同一个 InfiniBand 网络上，需要使用创建节点 API 调用和 placementGroupId。

curl --location --request POST '${CC-URL}/clusters/${CLUSTER}/nodes/create' \
--header 'Authorization: Basic ****************************' \
--header 'Content-Type: text/plain' \
--data-raw '{ "requestId" : "463270ca-abcd-1234-98d6-431ee3ef8ed5",
    "sets" : [
        {
            "count" : 4,
            "nodearray" : "ondemand",
            "placementGroupId" : "pg0",
            "definition" : { "machineType" : "Standard_Hc44rs" }
        }
    ]
}'

placementGroupId 可能引用一个已存在的放置组，也可能不引用。 CycleCloud 将此 ID 用于逻辑组。 如果请求指定不存在的放置组，CycleCloud 将创建新的放置组。 可以在额外的创建节点请求中将更多 VM 添加到同一放置组。

删除节点

在某些时候，管理器服务需要终止它创建的 节点 。

curl --location --request POST '${CC-URL}/clusters/${CLUSTER}/nodes/terminate' \
--header 'Authorization: Basic ****************************' \
--header 'Content-Type: text/plain' \
--data-raw '{
 "ids" : ["62a1b116-abcd-1234-b290-b54ea23f1b68"]
}'

{
  "operationId": "15aaa844-abcd-1234-9591-8904c546028d",
  "nodes": [
    {
      "name": "ondemand-3",
      "id": "62a1b116-abcd-1234-b290-b54ea23f1b68",
      "status": "OK"
    }
  ]
}