작업

  • 아티클

클러스터 노드 가져오기

GET /clusters/{cluster}/nodes

매개 변수

Type Name Description 스키마
Path cluster
필수		 쿼리할 클러스터 문자열
쿼리 operation
선택 사항		 지정된 경우 이 작업 ID에 대한 노드만 반환하고 본문에 작업 특성을 포함합니다. 문자열
쿼리 request_id
선택 사항		 지정된 경우 이 요청 ID로 식별된 작업에 대한 노드만 반환합니다.
및 에는 본문의 작업 특성이 포함됩니다.		 문자열

응답

HTTP 코드 Description 스키마
200 정상 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을 반환합니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 추가할 클러스터 문자열
본문 노드
필수		 만들 노드 집합 NodeCreationRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드의 할당을 취소할 클러스터 문자열
본문 action
필수		 할당을 취소할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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/remove

Description

이 작업은 클러스터의 노드를 제거합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다. 기본적으로 노드는 종료될 때 제거됩니다(노드가 고정됨을 true로 설정하지 않은 경우). 이 경우 이 호출은 종료와 다르지 않습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 제거할 클러스터 문자열
본문 action
필수		 제거할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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/shutdown

Description

이 작업은 각 노드의 ShutdownPolicy 특성이 각각 Terminate(기본값) 또는 할당 취소인지에 따라 클러스터의 노드를 종료하거나 할당을 취소합니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 종료할 클러스터 문자열
본문 action
필수		 종료할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 시작할 클러스터 문자열
본문 action
필수		 시작할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 종료할 클러스터 문자열
본문 action
필수		 종료할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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}/scale/{nodearray}

Description

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

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 추가할 클러스터 문자열
Path nodearray
필수		 노드를 추가할 nodearray 문자열
쿼리 totalCoreCount
선택 사항		 이미 생성된 노드를 포함하여 이 nodearray에 포함할 총 코어 수 integer
쿼리 totalNodeCount
선택 사항		 이미 만든 노드를 포함하여 이 nodearray에 포함할 총 머신 수 integer

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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에 대한 유효한 버킷은 사용자의 클러스터 정의에 의해 결정되지만 제한은 클라우드 공급자에 의해 부분적으로 결정됩니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 쿼리할 클러스터 문자열
쿼리 노드
선택 사항		 true이면 노드 및 노드 참조가 응답에 반환됩니다. boolean

응답

HTTP 코드 Description 스키마
200 정상 ClusterStatus

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/status

예제 HTTP 응답

응답 200

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

작업의 상태 Lists

GET /operations/

매개 변수

Type Name Description 스키마
쿼리 request_id
선택 사항		 작업에 대한 요청 ID입니다. 이 항목이 제공되면 목록에는 0개 또는 1개 요소만 포함됩니다. 문자열

응답

HTTP 코드 Description 스키마
200 정상 <OperationStatus> 배열
400 잘못된 요청 내용 없음
404 찾을 수 없음 내용 없음

HTTP 요청 예제

요청 경로

/operations/

예제 HTTP 응답

응답 200

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

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

GET /operations/{id}

매개 변수

Type Name Description 스키마
Path id
필수		 작업 ID 문자열

응답

HTTP 코드 Description 스키마
200 정상 OperationStatus
404 찾을 수 없음 내용 없음

HTTP 요청 예제

요청 경로

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

예제 HTTP 응답

응답 200

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

클러스터 노드 가져오기

GET /clusters/{cluster}/nodes

매개 변수

Type Name Description 스키마
Path cluster
필수		 쿼리할 클러스터 문자열
쿼리 operation
선택 사항		 지정된 경우 이 작업 ID에 대한 노드만 반환하고 본문에 작업 특성을 포함합니다. 문자열
쿼리 request_id
선택 사항		 지정된 경우 이 요청 ID로 식별된 작업에 대한 노드만 반환합니다.
및 에는 본문의 작업 특성이 포함됩니다.		 문자열

응답

HTTP 코드 Description 스키마
200 정상 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을 반환합니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 추가할 클러스터 문자열
본문 노드
필수		 만들 노드 집합 NodeCreationRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드의 할당을 취소할 클러스터 문자열
본문 action
필수		 할당을 취소할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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/remove

Description

이 작업은 클러스터의 노드를 제거합니다. 노드 이름, 노드 ID 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다. 기본적으로 노드는 종료될 때 제거됩니다(노드에 고정됨이 true로 설정되어 있지 않은 경우). 이 경우 이 호출은 종료와 다르지 않습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 제거할 클러스터 문자열
본문 action
필수		 제거할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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/shutdown

Description

이 작업은 각 노드의 ShutdownPolicy 특성이 각각 Terminate(기본값) 또는 할당 취소인지에 따라 클러스터의 노드를 종료하거나 할당을 취소합니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 종료할 클러스터 문자열
본문 action
필수		 종료할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 시작할 클러스터 문자열
본문 action
필수		 시작할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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 또는 필터를 비롯한 여러 가지 방법으로 노드를 식별할 수 있습니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 에서 노드를 종료할 클러스터 문자열
본문 action
필수		 종료할 노드에 대한 설명 NodeManagementRequest

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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}/scale/{nodearray}

Description

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

매개 변수

Type Name Description 스키마
Path cluster
필수		 노드를 추가할 클러스터 문자열
Path nodearray
필수		 노드를 추가할 nodearray 문자열
쿼리 totalCoreCount
선택 사항		 이미 만든 노드를 포함하여 이 nodearray에 포함할 코어의 총 수 integer
쿼리 totalNodeCount
선택 사항		 이미 만든 노드를 포함하여 이 nodearray에 포함할 총 컴퓨터 수 integer

응답

HTTP 코드 Description 스키마
202 수락됨
헤더 :
Location (string) : 작업의 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에 대한 유효한 버킷은 사용자의 클러스터 정의에 의해 결정되지만 제한은 클라우드 공급자에 의해 부분적으로 결정됩니다.

매개 변수

Type Name Description 스키마
Path cluster
필수		 쿼리할 클러스터 문자열
쿼리 노드
선택 사항		 true이면 노드 및 노드 참조가 응답에 반환됩니다. boolean

응답

HTTP 코드 Description 스키마
200 정상 ClusterStatus

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/status

예제 HTTP 응답

응답 200

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

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

GET /clusters/{cluster}/usage

Description

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

매개 변수

Type Name Description 스키마
Path cluster
필수		 에 대한 사용량 현황 데이터를 반환할 클러스터 문자열
쿼리 timeframe
선택 사항		 지정된 경우 쿼리에 사용할 시간 범위를 지정합니다. monthToDate는 현재 월의 사용량을 반환하고 lastMonth는 이전 달의 사용량을 반환합니다. weekToDate는 현재 주의 사용량을 반환합니다(일요일 시작). 사용자 지정을 사용하려면 쿼리 매개 변수를 'from' 및 'to'으로 지정해야 합니다. 기본값은 MonthToDate입니다. 모든 시간은 UTC입니다. enum(monthToDate, lastMonth, weekToDate, custom)
쿼리 from
선택 사항		 사용자 지정 기간의 경우 ISO-8601 형식의 기간 시작입니다. 가장 가까운 시간 또는 일로 반올림됩니다. 문자열
쿼리 to
선택 사항		 사용자 지정 기간의 경우 ISO-8601 형식으로 된 기간의 끝입니다. 가장 가까운 시간 또는 일로 반올림됩니다. 문자열
쿼리 세분성
선택 사항		 시간별, 매일 또는 단일 숫자로 데이터를 집계하는 방법을 지정합니다. 이 기본값은 매일입니다. enum(합계, 일별, 시간별)

응답

HTTP 코드 Description 스키마
200 정상 ClusterUsage

HTTP 요청 예제

요청 경로

/clusters/CLUSTER_NAME/usage

예제 HTTP 응답

응답 200

{
  "usage" : [ "object" ]
}

작업의 상태 Lists

GET /operations/

매개 변수

Type Name Description 스키마
쿼리 request_id
선택 사항		 작업에 대한 요청 ID입니다. 이 항목이 제공되면 목록에는 0개 또는 1개 요소만 포함됩니다. 문자열

응답

HTTP 코드 Description 스키마
200 정상 <OperationStatus> 배열
400 잘못된 요청 내용 없음
404 찾을 수 없음 내용 없음

HTTP 요청 예제

요청 경로

/operations/

HTTP 응답 예제

응답 200

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

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

GET /operations/{id}

매개 변수

Type Name Description 스키마
Path id
필수		 작업 ID 문자열

응답

HTTP 코드 Description 스키마
200 정상 OperationStatus
404 찾을 수 없음 내용 없음

HTTP 요청 예제

요청 경로

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

HTTP 응답 예제

응답 200

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

리소스

ClusterStatus

클러스터의 상태

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

nodearrays

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

양동이

Name Description 스키마
activeCoreCount
필수		 이 nodearray에서 이 버킷에 사용 중인 코어 수
예 : 40		 integer
activeCount
필수		 이 nodearray에서 이 버킷에 사용 중인 노드 수입니다. 여기에는 여전히 VM을 획득하는 노드가 포함됩니다.
예 : 10		 integer
activeNodes
선택 사항		 이 nodearray에서 이 버킷에 사용 중인 노드 이름입니다. 여기에는 여전히 VM을 획득하는 노드가 포함됩니다. 이는 nodes=true가 쿼리에 있는 경우에만 포함됩니다.
예 : [ "string" ]		 < 문자열 > 배열
availableCoreCount
필수		 이 nodearray에서 이 버킷에 만들 수 있는 추가 코어 수입니다. 항상 availableCount의 배수입니다.
예 : 8		 integer
availableCount
필수		 이 nodearray에서 이 버킷에 만들 수 있는 추가 노드 수입니다. maxCount는 전역적으로 제한될 수 있으므로 maxCount 및 usedCount에서 암시한 것보다 적을 수 있습니다.
예 : 2		 integer
bucketId
필수		 이 버킷의 식별자입니다. 클러스터가 삭제되지 않는 한 항상 nodearray의 지정된 버킷에 대해 동일한 값을 갖습니다.
예 : "00000000-0000-0000-0000-000000000000"		 문자열
consumedCoreCount
필수		 전체 지역에서 이미 사용 중인 이 제품군의 코어 수입니다.
예 : 2		 integer
정의
선택 사항		 이 버킷에서 노드를 만드는 데 사용되는 이 버킷의 속성입니다. create-nodes API는 속성 bucket 에서 이 정의를 사용합니다.
예 : "object"		 정의
familyConsumedCoreCount
선택 사항		 전체 지역에서 이미 사용 중인 이 제품군의 코어 수입니다.
예 : 2		 integer
familyQuotaCoreCount
선택 사항		 이 지역에서 이 제품군에 대해 시작할 수 있는 총 코어 수입니다. quotaCount의 정수 배수가 아닐 수 있습니다.
예 : 16		 integer
familyQuotaCount
선택 사항		 시작할 수 있는 총 인스턴스 수(familyQuotaCoreCount가 지정됨)
예 : 4		 integer
invalidReason
필수		 valid가 false이면 버킷이 잘못된 이유가 포함됩니다. 현재 NotActivated 및 DisabledMachineType이 유일한 이유입니다.
예 : "DisabledMachineType"		 문자열
maxCoreCount
필수		 전역 및 노드 배열 제한을 포함하여 이 버킷에 있을 수 있는 최대 코어 수입니다. 항상 maxCount의 배수입니다.
예 : 16		 integer
maxCount
필수		 전역 및 노드 배열 제한을 포함하여 이 버킷에 있을 수 있는 최대 노드 수
예 : 4		 integer
maxPlacementGroupCoreSize
필수		 이 버킷의 배치 그룹에 있을 수 있는 최대 코어 수입니다. 항상 maxPlacementGroupSize의 배수입니다.
예 : 64		 integer
maxPlacementGroupSize
필수		 이 버킷의 배치 그룹에 있을 수 있는 최대 총 인스턴스 수
예 : 16		 integer
placementGroups
필수		 이 nodearray에 사용 중인 배치 그룹(있는 경우)입니다.
예 : [ "object" ]		 <placementGroups> 배열
quotaCoreCount
필수		 지역 할당량 코어 수를 고려하여 이 지역에서 이 제품군에 대해 시작할 수 있는 총 코어 수입니다. quotaCount의 정수 배수가 아닐 수 있습니다.
예 : 16		 integer
quotaCount
필수		 시작할 수 있는 총 인스턴스 수(quotaCoreCount 지정)
예 : 4		 integer
regionalConsumedCoreCount
선택 사항		 전체 지역에서 이미 사용 중인 코어 수입니다.
예 : 2		 integer
regionalQuotaCoreCount
선택 사항		 이 지역에서 시작할 수 있는 총 코어 수입니다. 지역QuotaCount의 정수 배수가 아닐 수 있습니다.
예 : 16		 integer
regionalQuotaCount
선택 사항		 시작할 수 있는 총 인스턴스 수(regionalQuotaCoreCount가 지정됨)
예 : 4		 integer
유효한
필수		 true이면 이 버킷은 새 노드에 사용할 현재 유효한 버킷을 나타냅니다. false이면 이 버킷은 기존 노드만 나타냅니다.
예 : true		 boolean
virtualMachine
필수		 이 버킷에서 시작된 가상 머신의 속성
예 : "object"		 virtualMachine

정의

Name Description 스키마
machineType
필수		 가상 머신의 VM 크기
예 : "A2"		 string

placementGroups

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

virtualMachine

Name Description 스키마
gpuCount
필수		 이 컴퓨터 유형에 포함된 GPU 수
예 : 2		 integer
Infiniband
필수		 이 가상 머신이 InfiniBand 연결을 지원하는 경우
예 : true		 boolean
memory
필수		 이 가상 머신의 RAM(GB)
예 : 7.5		 number
pcpuCount
필수		 이 컴퓨터 유형에 포함된 실제 CPU 수
예 : 16		 integer
vcpuCount
필수		 이 컴퓨터 형식의 가상 CPU 수
예 : 32		 integer

노드

노드 레코드

형식 : 개체

NodeCreationRequest

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

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

설정

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

정의

Name Description 스키마
machineType
선택 사항		 예 : "A2" string

NodeCreationResult

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

설정

Name Description 스키마
추가
필수		 이 집합에서 시작된 노드 수
예 : 1		 integer
message
선택 사항		 요청된 모든 노드를 추가할 수 없는 이유(있는 경우)를 나타냅니다.
예 : "string"		 string

NodeList

노드 검색 결과

Name Description 스키마
노드
필수		 반환된 노드
예 : [ "[node](#node)" ]		 <노드> 배열
operation
선택 사항		 쿼리에 작업 ID가 포함된 경우 해당 작업의 상태
예 : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

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

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

NodeManagementResult

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

노드

Name Description 스키마
error
선택 사항		 상태 Error이면 오류 메시지가 포함됩니다.
예 : "This node must be terminated before it can be removed"		 string
id
필수		 노드의 ID
예 : "id1"		 string
name
필수		 노드의 이름
예 : "name1"		 string
status
선택 사항		 확인 또는 오류 중 하나
예 : "Error"		 열거형(확인, 오류)

OperationStatus

이 노드 작업의 상태

Name Description 스키마
action
필수		 예 : "string" enum(만들기)
startTime
필수		 이 작업이 제출된 경우
예 : "2020-01-01T12:34:56Z"		 string (date-time)

ClusterStatus

클러스터의 상태

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

nodearrays

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

양동이

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

정의

Name Description 스키마
machineType
필수		 가상 머신의 VM 크기
예 : "A2"		 string

placementGroups

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

virtualMachine

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

ClusterUsage

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

Name Description 스키마
usage
필수		 시간 간격별 사용량 목록
예 : [ "object" ]		 <사용> 배열

사용

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

ClusterUsageItem

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

세부 정보

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

노드

노드 레코드

형식 : 개체

NodeCreationRequest

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

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

설정

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

정의

Name Description 스키마
machineType
선택 사항		 예 : "A2" string

NodeCreationResult

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

설정

Name Description 스키마
추가
필수		 이 집합에서 시작된 노드 수
예 : 1		 integer
message
선택 사항		 요청된 모든 노드를 추가할 수 없는 이유(있는 경우)를 나타냅니다.
예 : "string"		 string

NodeList

노드 검색 결과

Name Description 스키마
노드
필수		 반환된 노드
예 : [ "[node](#node)" ]		 <노드> 배열
operation
선택 사항		 쿼리에 작업 ID가 포함된 경우 해당 작업의 상태
예 : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

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

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

NodeManagementResult

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

노드

Name Description 스키마
error
선택 사항		 상태 Error이면 오류 메시지가 포함됩니다.
예 : "This node must be terminated before it can be removed"		 string
id
필수		 노드의 ID
예 : "id1"		 string
name
필수		 노드의 이름
예 : "name1"		 string
status
선택 사항		 확인 또는 오류 중 하나
예 : "Error"		 열거형(확인, 오류)

OperationStatus

이 노드 작업의 상태

Name Description 스키마
action
필수		 예 : "string" enum(만들기)
startTime
필수		 이 작업이 제출된 경우
예 : "2020-01-01T12:34:56Z"		 string (date-time)