Deployment Manager API를 사용하여 장기 실행 작업 관리

Deployment Manager에 API를 요청하면 Deployment Manager는 다른 Google Cloud API에 상응하는 요청을 합니다. 예를 들어 Compute Engine 인스턴스가 포함된 배포를 만들면 Deployment Manager는 Compute Engine API에 instances.insert 요청을 전송합니다.

배포를 생성, 업데이트 또는 삭제하거나 완료하는 데 몇 분 이상 걸릴 수 있는 다른 API 메서드를 사용하는 경우 Deployment Manager에 대한 API 요청은 장기 실행 작업을 반환합니다.

이 페이지에서는 Deployment Manager API를 사용하여 장기 실행 작업을 관리하기 위한 가이드라인을 설명합니다.

시작하기 전에

장기 실행 작업을 시작할 수 있는 메서드에는 다음이 포함됩니다.

이러한 요청에서 응답은 다음 예와 같이 작업 리소스입니다.

{
 "kind": "deploymentmanager#operation",
 "id": "7123423453456654321",  # generated ID
 "name": "operation-11233234311678-587af2c0xyz9c-0987fa54-baccd59f",  # generated name
 "operationType": "insert",
 "targetLink": "https://www.googleapis.com/deploymentmanager/v2/projects/example-project/global/deployments/wordpress-1",
 "targetId": "5123321654456321123",
 "status": "DONE",  # possible values: RUNNING, PENDING, DONE
 "user": "example@example.com",
 "progress": 100,
 "insertTime": "2019-04-29T11:08:32.190-07:00",
 "startTime": "2019-04-29T11:08:32.200-07:00",
 "endTime": "2019-04-29T11:09:38.176-07:00",
 "selfLink": "https://www.googleapis.com/deploymentmanager/v2/projects/example-project/global/operations/operation-11233234311678-587af2c0xyz9c-0987fa54-baccd59f"
}

작업 상태 가져오기

작업 상태를 확인하려면 작업의 name 필드를 사용하여 operations.get() 요청을 실행하고 작업의 status 또는 progress를 확인합니다.

status가 DONE이고 progress가 100이고 error 객체가 비어 있으면 배포가 완료되고 리소스를 사용할 수 있습니다.

작업 중에 오류가 발생하면 error 객체에 다음 형식으로 표시됩니다.

"error": {
  "errors": [
    {
      "code": "error code"  # string,
      "location": "location of the error"  # string,
      "message": "error message"   # string
    },
    ...
  ]
}

권장사항에 따라 지수 백오프로 작업 상태를 폴링하는 것이 좋습니다. 예를 들어 첫 번째 요청은 5초 후에, 다음 요청은 10초 후에, 세 번째 요청은 20초 후에 실행합니다. 최대 백오프 시간을 몇 분으로 설정하는 것이 좋습니다. 최대 백오프 시간에 도달한 후에는 백오프 시간을 계속 늘릴 필요가 없습니다.