Operations

Azure CycleCloud 클러스터, 노드 및 관련 리소스를 프로그래밍 방식으로 관리하기 위한 REST API를 제공합니다. 이러한 API 작업을 사용하여 클러스터 상태를 쿼리하고, 노드를 만들고 관리하고, 장기 실행 작업을 추적합니다. 이 참조는 CycleCloud 클러스터 관리를 자동화하고 워크플로에 통합하는 데 도움이 되는 사용 가능한 엔드포인트, 매개 변수 및 응답 형식을 나열합니다.

클러스터 노드 가져오기

GET /clusters/{cluster}/nodes

Parameters

Type Name Description Schema
Path cluster
required		 쿼리할 클러스터 string
Query operation
optional		 지정된 경우 이 작업 ID에 대한 노드만 반환하고 본문에 작업 특성을 포함합니다. string
Query request_id
optional		 지정된 경우 이 요청 ID로 식별된 작업에 대한 노드만 반환하고 본문에 작업 특성을 포함합니다. string

Responses

HTTP 코드 Description Schema
200 OK NodeList
400 잘못된 사양 콘텐츠 없음
404 없습니다. 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes

HTTP 응답 예제

응답 200

{
  "nodes" : [ { } ],
  "operation" : {
    "action" : "string",
    "startTime" : "2020-01-01T12:34:56Z"
  }
}

클러스터 노드 만들기

POST /clusters/{cluster}/nodes/create

Description

이 작업은 nodearray의 새 노드를 클러스터에 추가합니다. 단일 호출에서 여러 노드 정의를 허용합니다. 작업의 상태를 추적하는 데 사용할 수 있는 작업에 대한 URL을 반환합니다.

Parameters

Type Name Description Schema
Path cluster
required		 노드를 추가할 클러스터 string
Body nodes
required		 만들 노드 집합 NodeCreationRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeCreationResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/create

요청 메시지 본문

{
  "requestId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

HTTP 응답 예제

응답 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

클러스터 노드 할당 취소

POST /clusters/{cluster}/nodes/deallocate

Description

이 작업은 클러스터의 노드 할당을 취소합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 노드의 할당을 취소할 클러스터 string
Body action
required		 할당 취소할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/deallocate

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드 이미지 다시 설치

POST /clusters/{cluster}/nodes/reimage

Description

이 작업은 클러스터의 노드를 이미지로 다시 설치합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 노드를 이미지로 다시 설치할 클러스터 string
Body action
required		 이미지로 다시 설치할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/reimage

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드 종료 및 제거

POST /clusters/{cluster}/nodes/remove

Description

이 작업은 클러스터의 노드를 제거합니다. 노드 이름, 노드 ID 또는 필터를 사용하여 노드를 식별할 수 있습니다. 기본적으로 CycleCloud는 종료할 때 노드를 제거하므로 이 호출은 종료처럼 동작합니다. 고정 특성이 true로 설정된 노드는 종료 시 제거되지 않습니다.

Parameters

Type Name Description Schema
Path cluster
required		 에서 노드를 제거할 클러스터 string
Body action
required		 제거할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/remove

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드 다시 시작

POST /clusters/{cluster}/nodes/restart

Description

이 작업은 클러스터의 노드를 다시 시작합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 에서 노드를 다시 시작할 클러스터 string
Body action
required		 다시 시작할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/restart

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드 종료 또는 할당 취소

POST /clusters/{cluster}/nodes/shutdown

Description

이 호출은 클러스터의 노드를 종료합니다. 각 노드의 ShutdownPolicy 특성은 종결(기본값) 또는 할당 취소 작업을 결정합니다.

Parameters

Type Name Description Schema
Path cluster
required		 에서 노드를 종료할 클러스터 string
Body action
required		 종료할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/shutdown

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

할당 취소 또는 종료된 클러스터 노드 시작

POST /clusters/{cluster}/nodes/start

Description

이 작업은 클러스터에서 노드를 시작합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 노드를 시작할 클러스터 string
Body action
required		 시작할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/start

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드 종료

POST /clusters/{cluster}/nodes/terminate

Description

이 작업은 클러스터의 노드를 종료합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 에서 노드를 종료할 클러스터 string
Body action
required		 종료할 노드에 대한 설명 NodeManagementRequest

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeManagementResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/terminate

요청 메시지 본문

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

HTTP 응답 예제

응답 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

클러스터 노드에 대한 게스트 상태 보고서 제출

POST /clusters/{cluster}/nodes/{node}/ghr

Description

상태 문제가 있는 노드에 대한 상태 보고서 제출

Parameters

Type Name Description Schema
Path cluster
required		 보고할 노드가 포함된 클러스터 string
Path node
required		 보고할 노드 string
Query category
optional		 영향에 대한 게스트 상태 보고서 범주 string
Query 묘사
optional		 실패 또는 컨텍스트를 설명하는 사용자 지정 메시지 string

Responses

HTTP 코드 Description Schema
202 수락됨 콘텐츠 없음
400 잘못된 입력 콘텐츠 없음
404 찾을 수 없음 콘텐츠 없음
409 충돌 - 이 노드에 대해 이미 제출된 게스트 상태 보고서 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/string/ghr

클러스터 노드에 대한 게스트 상태 보고서 가져오기

GET /clusters/{cluster}/nodes/{node}/ghr

Description

상태 문제가 있는 노드의 워크로드 영향을 반환하므로 상태 보고 엔드포인트에 제출할 수 있습니다.

Parameters

Type Name Description Schema
Path cluster
required		 보고할 노드가 포함된 클러스터 string
Path node
required		 보고할 노드 string
Query category
optional		 영향에 대한 게스트 상태 보고서 범주 string
Query 묘사
optional		 실패 또는 컨텍스트를 설명하는 사용자 지정 메시지 string

Responses

HTTP 코드 Description Schema
200 그래 콘텐츠 없음
400 잘못된 입력 콘텐츠 없음
404 찾을 수 없음 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/nodes/string/ghr

클러스터 크기를 조정합니다.

POST /clusters/{cluster}/scale/{nodearray}

Description

이 작업은 노드 배열에 필요에 따라 노드를 추가하여 총 개수에 도달합니다. 요청은 한 번 처리되며 지정된 번호를 유지하기 위해 나중에 노드를 다시 추가하지 않습니다. (총 CPU 코어) 또는 totalNodeCount (총 VM)를 사용하여 totalCoreCount 대상 크기를 지정하지만 둘 다 동일한 요청에는 지정하지 않습니다. 상태를 추적하는 데 사용할 수 있는 작업에 대한 URL을 반환합니다.

Parameters

Type Name Description Schema
Path cluster
required		 노드를 추가할 클러스터 string
Path nodearray
required		 노드를 추가할 nodearray string
Query totalCoreCount
optional		 이미 생성된 노드를 포함하여 이 nodearray에 포함할 총 코어 수 integer
Query totalNodeCount
optional		 이미 만든 노드를 포함하여 이 nodearray에 포함할 총 컴퓨터 수 integer

Responses

HTTP 코드 Description Schema
202 허용
헤더 :
Location (문자열): 작업의 URL입니다.		 NodeCreationResult
409 잘못된 입력 콘텐츠 없음

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

HTTP 응답 예제

응답 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

클러스터 상태 가져오기

GET /clusters/{cluster}/status

Description

이 작업에는 지정된 클러스터의 노드 및 nodearray에 대한 정보가 포함됩니다. 각 nodearray에 대해 사용 가능한 각 할당 "버킷"의 상태를 반환합니다. 상태에는 버킷의 현재 노드 수와 추가할 수 있는 노드 수가 포함됩니다. 각 버킷은 지정된 고객 계정 등에서 지정된 위치에 만들 수 있는 지정된 하드웨어 프로필의 가능한 VM 집합입니다. 사용자의 클러스터 정의는 nodearray에 대한 유효한 버킷을 결정하지만 클라우드 공급자는 부분적으로 제한을 결정합니다.

Parameters

Type Name Description Schema
Path cluster
required		 쿼리할 클러스터 string
Query nodes
optional		 true이면 노드 및 노드 참조가 응답에 반환됩니다. boolean

Responses

HTTP 코드 Description Schema
200 OK ClusterStatus

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/status

HTTP 응답 예제

응답 200

{
  "maxCoreCount" : 16,
  "maxCount" : 4,
  "nodearrays" : [ "object" ],
  "nodes" : [ { } ],
  "state" : "Starting",
  "targetState" : "Started"
}

클러스터에 대한 사용량 및 선택적 비용 정보 가져오기

GET /clusters/{cluster}/usage

Description

이 작업은 클러스터에 대한 전체 사용량 데이터(코어 시간) 및 비용 데이터(사용 가능한 경우) 및 노드별 분석을 반환합니다. 기본적으로 현재 월의 사용량을 반환합니다.

Parameters

Type Name Description Schema
Path cluster
required		 사용량 현황 데이터를 반환할 클러스터 string
Query 기간
optional		 쿼리에 사용할 시간 범위입니다. 유효한 값: monthToDate (현재 월), lastMonth (이전 달), weekToDate (현재 주, 일요일 시작) 또는 custom (및 쿼리 매개 변수 필요 fromto ). 기본값은 monthToDate입니다. 모든 시간은 UTC입니다. enum(monthToDate, lastMonth, weekToDate, custom)
Query from
optional		 사용자 지정 기간의 경우 이 값은 ISO-8601 형식의 기간 시작입니다. 그것은 가장 가까운 시간 또는 하루에 반올림됩니다. string
Query to
optional		 사용자 지정 기간의 경우 이 값은 ISO-8601 형식으로 된 시간 범위의 끝입니다. 그것은 가장 가까운 시간 또는 하루에 반올림됩니다. string
Query 세분성
optional		 매시간, 매일 또는 단일 합계로 데이터를 집계하는 방법을 지정합니다. 기본 간격은 매일입니다. 열거형(합계, 일별, 매시간)

Responses

HTTP 코드 Description Schema
200 OK ClusterUsage

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/usage

HTTP 응답 예제

응답 200

{
  "usage" : [ "object" ]
}

작업 상태 나열

GET /operations/

Parameters

Type Name Description Schema
Query request_id
optional		 작업에 대한 요청 ID입니다. 이 값을 지정하면 목록에 0 또는 1 요소가 포함됩니다. string

Responses

HTTP 코드 Description Schema
200 OK < OperationStatus> 배열
400 잘못된 요청 콘텐츠 없음
404 없습니다. 콘텐츠 없음

HTTP 요청 예제

요청 경로

/operations/

HTTP 응답 예제

응답 200

[ {
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
} ]

ID별로 작업 상태를 가져옵니다.

GET /operations/{id}

Parameters

Type Name Description Schema
Path id
required		 작업 ID string

Responses

HTTP 코드 Description Schema
200 OK OperationStatus
404 없습니다. 콘텐츠 없음

HTTP 요청 예제

요청 경로

/operations/00000000-0000-0000-0000-000000000000

HTTP 응답 예제

응답 200

{
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
}

Resources

Azure CycleCloud 클러스터, 노드 배열, 노드 및 할당 상태를 설명하는 리소스 모델 집합을 정의합니다. 이러한 리소스는 REST API에서 반환되며 용량 제한, 사용량 및 클러스터 상태와 같은 세부 정보를 제공합니다. 이 참조를 사용하여 CycleCloud 클러스터를 프로그래밍 방식으로 관리하고 모니터링할 때 API 응답의 구조 및 속성을 이해합니다.

ClusterStatus

클러스터의 상태

Name Description Schema
maxCoreCount
required		 이 클러스터에 추가할 수 있는 최대 코어 수
예 : 16		 integer
maxCount
required		 이 클러스터에 추가할 수 있는 최대 노드 수
예 : 4		 integer
nodearrays
required		 예 : [ "object" ] < nodearrays> 배열
nodes
optional		 이 클러스터에 있는 노드의 선택적 목록으로, nodes=true가 쿼리에 있는 경우에만 포함됩니다.
예 : [ "[node](#node)" ]		 < 노드> 배열
state
optional		 하나 이상의 시작 후 사용할 수 있는 클러스터의 현재 상태입니다.
예 : "Starting"		 string
targetState
optional		 클러스터의 원하는 상태(예: 시작됨 또는 종료됨)
예 : "Started"		 string

nodearrays

Name Description Schema
양동이
required		 이 nodearray에 대한 할당의 각 버킷입니다. "코어 수" 설정은 항상 이 버킷에 대한 코어 수의 배수입니다.
예 : [ "object" ]		 < 양동이> 배열
maxCoreCount
required		 이 nodearray에 있을 수 있는 최대 코어 수
예 : 16		 integer
maxCount
required		 이 nodearray에 있을 수 있는 최대 노드 수
예 : 4		 integer
name
required		 nodearray의 이름입니다.
예 : "execute"		 string
nodearray
required		 이 nodearray의 특성
예 : "[node](#node)"		 Node

양동이

Name Description Schema
activeCoreCount
required		 이 nodearray에서 이 버킷에 사용 중인 코어 수
예 : 40		 integer
activeCount
required		 이 nodearray에서 이 버킷에 사용 중인 노드 수입니다. 이 수에는 여전히 VM을 획득하는 노드가 포함됩니다.
예 : 10		 integer
activeNodes
optional		 여전히 VM을 획득하는 노드를 포함하여 nodearray 내에서 이 버킷에 사용 중인 노드의 이름입니다. 쿼리에 nodes=true가 포함된 경우에만 반환됩니다.
예 : [ "string" ]		 < 문자열 > 배열
availableCoreCount
required		 이 nodearray에서 이 버킷에 만들 수 있는 추가 코어 수입니다. 항상 availableCount의 배수입니다.
예 : 8		 integer
availableCount
required		 nodearray 내에서 이 버킷에서 만들 수 있는 추가 노드 수입니다. 전역 제한으로 제한될 수 있으므로 maxCount 값은 빼 usedCount 기보다 maxCount 낮을 수 있습니다.
예 : 2		 integer
bucketId
required		 버킷의 고유 식별자입니다. 값은 클러스터의 수명 동안 nodearray의 지정된 버킷에 대해 동일하게 유지됩니다.
예 : "00000000-0000-0000-0000-000000000000"		 string
consumedCoreCount
required		 전체 지역에서 이미 사용 중인 이 제품군의 코어 수입니다.
예 : 2		 integer
definition
optional		 이 버킷에서 노드를 만드는 데 사용되는 속성입니다. create-nodes API는 해당 bucket 속성에서 이 정의를 사용합니다.
예 : "object"		 definition
familyConsumedCoreCount
optional		 전체 지역에서 이미 사용 중인 이 제품군의 코어 수입니다.
예 : 2		 integer
familyQuotaCoreCount
optional		 지역에서 이 VM 제품군에 대해 실행할 수 있는 총 코어 수입니다. 값이 반드시 .의 familyQuotaCount정수 배수인 것은 아닙니다.
예 : 16		 integer
familyQuotaCount
optional		 시작할 수 있는 총 인스턴스 수(familyQuotaCoreCount가 지정된 경우)
예 : 4		 integer
invalidReason
required		 버킷이 false일 때 valid 유효하지 않은 이유입니다. 현재 가능한 값은 다음과 같습니다 NotActivatedDisabledMachineType.
예 : "DisabledMachineType"		 string
lastCapacityFailure
required		 이 버킷에서 용량 오류가 발생한 이후의 시간(초)입니다. 음수 값은 절대로 처리되지 않습니다.
예 : 180.0		 number
maxCoreCount
required		 전역 및 nodearray 제한을 포함하여 이 버킷에 있을 수 있는 최대 코어 수입니다. 항상 maxCount의 배수입니다.
예 : 16		 integer
maxCount
required		 전역 및 nodearray 제한을 포함하여 이 버킷에 있을 수 있는 최대 노드 수
예 : 4		 integer
maxPlacementGroupCoreSize
required		 이 버킷의 배치 그룹에 있을 수 있는 최대 코어 수입니다. 항상 maxPlacementGroupSize의 배수입니다.
예 : 64		 integer
maxPlacementGroupSize
required		 이 버킷의 배치 그룹에 있을 수 있는 최대 총 인스턴스 수
예 : 16		 integer
placementGroups
required		 이 nodearray에 사용 중인 배치 그룹(있는 경우)입니다.
예 : [ "object" ]		 < placementGroups> 배열
quotaCoreCount
required		 지역 할당량 코어 수를 고려하여 지역에서 이 VM 제품군에 대해 실행할 수 있는 총 코어 수입니다. 값이 반드시 .의 quotaCount정수 배수인 것은 아닙니다.
예 : 16		 integer
quotaCount
required		 시작할 수 있는 총 인스턴스 수(quotaCoreCount가 지정됨)
예 : 4		 integer
regionalConsumedCoreCount
optional		 전체 지역에서 이미 사용 중인 코어 수입니다.
예 : 2		 integer
regionalQuotaCoreCount
optional		 지역에서 실행할 수 있는 총 코어 수입니다. 값이 반드시 .의 regionalQuotaCount정수 배수인 것은 아닙니다.
예 : 16		 integer
regionalQuotaCount
optional		 시작할 수 있는 총 인스턴스 수입니다(지역별QuotaCoreCount가 지정됨).
예 : 4		 integer
spotPlacementScore
required		 스폿 VM 가용성의 가능성을 나타내는 이 버킷의 스폿 배치 점수입니다. 높음, 보통, 낮음 또는 빈 문자열(해당되지 않은 경우)일 수 있습니다.
예 : "High"		 string
valid
required		 true이면 이 버킷은 새 노드에 사용할 현재 유효한 버킷을 나타냅니다. false이면 이 버킷은 기존 노드만 나타냅니다.
예 : true		 boolean
virtualMachine
required		 이 버킷에서 시작된 가상 머신의 속성
예 : "object"		 virtualMachine

정의

Name Description Schema
machineType
required		 가상 머신의 VM 크기
예 : "A2"		 string

placementGroups

Name Description Schema
activeCoreCount
required		 이 확장 집합에 있는 코어 수
예 : 16		 integer
activeCount
required		 이 확장 집합에 있는 노드 수
예 : 4		 integer
name
required		 이 배치 그룹의 고유 식별자
예 : "my-placement-group"		 string

virtualMachine

Name Description Schema
gpuCount
required		 이 컴퓨터 유형에 포함된 GPU 수
예 : 2		 integer
Infiniband
required		 이 가상 머신이 InfiniBand 연결을 지원하는 경우
예 : true		 boolean
memory
required		 이 가상 머신의 RAM(GB)
예 : 7.5		 number
pcpuCount
required		 이 컴퓨터 유형에 포함된 실제 CPU 수
예 : 16		 integer
vcpuCount
required		 이 컴퓨터 형식의 가상 CPU 수
예 : 32		 integer
vcpuQuotaCount
optional		 이 컴퓨터가 할당량에서 사용하는 vCPU 수
예 : 2		 integer

ClusterUsage

클러스터에 대한 사용량 및 선택적 비용 정보

Name Description Schema
usage
required		 시간 간격별 사용량 목록
예 : [ "object" ]		 < 사용> 배열

사용

Name Description Schema
고장
required		 "node" 및 "nodearray" 범주별 이 간격의 사용량 분석
예 : [ "[clusterusageitem](#clusterusageitem)" ]		 < ClusterUsageItem> 배열
end
required		 간격의 끝(배타적)
예 : "string"		 string
start
required		 간격의 시작 부분(포함)
예 : "string"		 string
total
required		 범주가 "클러스터"인 이 간격의 이 클러스터에 대한 전체 사용량
예 : "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

ClusterUsageItem

Name Description Schema
category
required		 전체 사용량에 대한 "cluster"; 단일 비 배열 헤드 노드에 대한 "node"; 전체 nodearray에 대한 "nodearray"
예 : "string"		 enum(클러스터, 노드, nodearray)
cost
optional		 이 사용량에 대해 청구되는 금액(미국 달러 및 소매 요율)입니다. 참고: 모든 비용 금액은 예상 금액이며 실제 청구서를 반영하지 않습니다.
예 : 0.0		 number
details
optional		 시간, core_count, 지역, 우선 순위 및 운영 체제를 포함하여 nodearray에서 사용하는 VM 크기에 대한 세부 정보입니다.
예 : [ "object" ]		 < 세부 정보> 배열
hours
required		 이 범주에 대한 사용량의 코어 시간 수
예 : 0.0		 number
node
optional		 사용할 노드 또는 nodearray의 이름입니다(클러스터 수준 데이터에는 없음).
예 : "string"		 string

세부 정보

Name Description Schema
core_count
optional		 이 VM 크기의 코어 수
예 : 0.0		 number
cost
optional		 이 VM 크기의 비용
예 : 0.0		 number
hours
optional		 이 VM 크기에 대한 사용량의 코어 시간 수
예 : 0.0		 number
os
optional		 운영 체제 유형
예 : "string"		 enum(Windows, Linux)
priority
optional		 VM SKU의 우선 순위
예 : "string"		 enum(Regular, Spot)
region
optional		 VM 크기가 인스턴스화된 지역
예 : "string"		 string
vm_size
optional		 VM SKU 크기
예 : "string"		 string

Node

노드 레코드

Type: 객체

NodeCreationRequest

클러스터에 노드를 추가하는 방법을 지정합니다.

Name Description Schema
requestId
optional		 네트워크 통신 오류가 있는 경우 중복 작업을 방지하기 위한 선택적 사용자 제공 고유 토큰입니다. 이 값이 포함되고 이전 요청 ID와 일치하는 경우 서버는 이 요청을 무시하고 409 오류를 반환합니다.
예 : "00000000-0000-0000-0000-000000000000"		 string
설정
required		 만들 노드 정의 목록입니다. 요청에는 하나 이상의 집합이 포함되어야 합니다. 각 집합은 다른 속성 집합을 지정할 수 있습니다.
예 : [ "object" ]		 < 설정> 배열

설정

Name Description Schema
count
required		 만들 노드 수
예 : 1		 integer
definition
optional		 클러스터 상태 API 호출에서 제공하는 사용할 버킷의 정의입니다. 상태 호출에 지정된 항목 중 일부가 누락되었거나 전체 버킷 속성이 누락된 경우 지정된 항목과 일치하는 첫 번째 버킷이 사용됩니다.
예 : "object"		 definition
nameFormat
optional		 지정된 경우 노드는 표준 "nodearray-%d" 형식 대신 이 명명 규칙을 사용합니다.
예 : "custom-name-%d"		 string
nameOffset
optional		 nameFormat과 함께 지정된 경우 새 노드에 대한 노드 인덱스를 오프셋합니다.
예 : 1		 integer
nodeAttributes
optional		 이 집합의 각 노드에서 설정할 추가 특성
예 : "[node](#node)"		 Node
nodearray
required		 노드를 시작할 nodearray의 이름입니다.
예 : "execute"		 string
placementGroupId
optional		 지정된 경우 groupId에 대해 동일한 값을 가진 노드는 모두 동일한 배치 그룹에서 시작됩니다.
예 : "string"		 string

정의

Name Description Schema
machineType
optional		 예 : "A2" string

NodeCreationResult

Name Description Schema
operationId
required		 이 작업의 ID
예 : "00000000-0000-0000-0000-000000000000"		 string
설정
required		 요청과 동일한 순서로 집합 배열
예 : [ "object" ]		 < 설정> 배열

설정

Name Description Schema
추가
required		 이 집합에서 시작된 노드 수
예 : 1		 integer
message
optional		 요청된 모든 노드를 추가할 수 없는 이유(있는 경우)를 나타냅니다.
예 : "string"		 string

NodeList

노드 검색 결과

Name Description Schema
nodes
required		 반환된 노드
예 : [ "[node](#node)" ]		 < 노드> 배열
operation
optional		 쿼리에 작업 ID가 포함된 경우 작업의 상태입니다.
예 : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

클러스터의 노드에서 작업을 수행하는 방법을 지정합니다. 노드를 지정하는 방법에는 여러 가지가 있으며, 둘 이상의 방법이 포함된 경우 공용 구조체로 처리됩니다.

Name Description Schema
filter
optional		 노드와 일치하는 필터 식입니다. 식의 문자열을 제대로 따옴표로 묶어야 합니다.
예 : "State === \"Started\""		 string
호스트
optional		 관리할 짧은 호스트 이름 목록(도메인 없음)
예 : [ "hostname1", "hostname2" ]		 < 문자열 > 배열
Id
optional		 관리할 노드 ID 목록
예 : [ "id1", "id2" ]		 < 문자열 > 배열
ip_addresses
optional		 관리할 IP 주소 목록
예 : [ "10.0.1.1", "10.1.1.2" ]		 < 문자열 > 배열
names
optional		 관리할 노드 이름 목록
예 : [ "name1", "name2" ]		 < 문자열 > 배열
requestId
optional		 네트워크 통신 오류가 있는 경우 중복 작업을 방지하기 위한 선택적 사용자 제공 고유 토큰입니다. 이 값이 포함되고 이전 요청 ID와 일치하는 경우 서버는 이 요청을 무시하고 409 오류를 반환합니다.
예 : "00000000-0000-0000-0000-000000000000"		 string

NodeManagementResult

Name Description Schema
nodes
required		 관리 요청의 필터와 일치하는 각 노드에 대한 정보 배열입니다. 각 노드의 상태는 요청이 영향을 받았는지 여부를 나타냅니다.
예 : [ "object" ]		 < 노드> 배열
operationId
required		 이 작업의 ID
예 : "00000000-0000-0000-0000-000000000000"		 string

노드

Name Description Schema
error
optional		 오류 메시지(있는 경우 status )입니다 Error.
예 : "This node must be terminated before it can be removed"		 string
id
required		 노드의 ID
예 : "id1"		 string
name
required		 노드의 이름
예 : "name1"		 string
status
optional		 확인 또는 오류 중 하나
예 : "Error"		 enum(확인, 오류)

OperationStatus

이 노드 작업의 상태입니다.

Name Description Schema
action
required		 예 : "string" enum(만들기)
startTime
required		 이 작업이 제출된 경우
예 : "2020-01-01T12:34:56Z"		 string(date-time)
  • Last updated on