VMware Aria Automation API 프로그래밍 가이드

VMware Aria®Automation™ 사용자 또는 고객은 REST API 서비스 호출을 사용하여

VMware Aria Automation Assembler

VMware Aria Automation Service Broker

VMware Aria Automation Pipelines

기능을 프로그래밍 방식으로 수행할 수 있습니다.

API 서비스

VMware Aria Automation

에는 다음 API가 포함됩니다. API 설명서는 제품에서 사용할 수 있습니다. 단일 랜딩 페이지에서 모든 Swagger 규격에 액세스하려면

https://<your_FQDN>/automation/api-docs

(으)로 이동하십시오. 여기서 your_FQDN은

VMware Aria Automation

장치의 FQDN입니다.

VMware Aria Automation
기본 서비스	서비스 이름 및 설명
ABX	ABX 작업 및 해당 버전을 생성하거나 관리합니다. 작업 및 흐름을 실행합니다.
Automation Service Broker	승인 요청이 프로비저닝되기 전에 배포 또는 2일차 작업에 필요한 승인을 제어하는 정책을 적용.
Automation Assembler	Blueprint Blueprint를 생성, 검증 및 프로비저닝합니다. API의 Blueprint는 제품의 Automation Assembler 템플릿입니다.
Automation Service Broker	카탈로그 Automation Service Broker 카탈로그 항목 및 카탈로그 소스(컨텐츠 공유 및 카탈로그 항목 요청 포함)에 액세스합니다.
CMX	CMX Kubernetes를 VMware Aria Automation 과(와) 함께 사용하는 경우 Kubernetes 클러스터 및 네임스페이스를 배포하고 관리합니다.
Automation Assembler	Content Gateway SCM(소스 코드 관리) 제공자와 같은 외부 컨텐츠 소스의 코드형 인프라(Infrastructure as Code) 컨텐츠에 연결합니다.
Automation Service Broker 및 Automation Assembler	사용자 지정 양식 Automation Service Broker 및 Automation Assembler 에서 동적 양식 렌더링 및 사용자 지정 동작을 정의합니다.
사용자 프로파일	사용자 지정 브랜딩 정보를 구성합니다.
Automation Service Broker	배포 시스템에 배포된 배포 개체와 플랫폼 또는 Blueprint에 액세스합니다. API의 Blueprint는 제품의 Automation Assembler 템플릿입니다.
Automation Service Broker	배포 메트릭 배포 개체에 대한 집계된 메트릭 값입니다.
ID	ID VMware Aria Automation 사용자의 권한 부여를 인증하고 관리합니다.
Automation Assembler	IaaS(Infrastructure as a Service) 리소스의 유효성 검사 및 프로비저닝을 포함한 인프라 설정 작업을 반복적으로 수행합니다.
마이그레이션	Migration Assistant 평가를 실행하고 마이그레이션 서비스에 액세스합니다. vRealize Automation 7.6 컨텐츠에 대한 마이그레이션과 NSX-V에서 NSX-T로의 마이그레이션을 지원합니다.
재배치	온보딩 관리 중인 클라우드에서 기존 VM을 가져오기 위한 정책 및 계획을 정의합니다.
Automation Orchestrator 클라이언트	Orchestrator 워크플로, 작업 및 정책을 설계, 관리하고 실행하여 복잡한 IT 작업을 자동화합니다.
Automation Orchestrator 클라이언트	Orchestrator 게이트웨이 워크플로 및 작업을 실행하여 복잡한 IT 작업을 자동화합니다.
Automation Pipelines	파이프라인 애플리케이션을 운영 환경에 지속적으로 제공하기 위한 파이프라인을 생성하고 실행합니다.
Automation Service Broker	정책 Automation Service Broker 에서 생성된 정책과 상호 작용합니다.
프로젝트	프로젝트 프로젝트 역할이 있는 사용자에게 프로비저닝된 리소스에 대한 가시성 및 격리 기능을 제공합니다. 플랫폼 및 RBAC 서비스에 대한 Swagger 문서는 프로젝트 서비스와 함께 제공됩니다.

VMware

은(는) 공용 API에 대해 호환성이 손상되는 변경인 경우 12개월의 수명 종료 알림을 고객에게 제공합니다. 호환성이 손상되는 변경 사항이 있으면

VMware Aria Automation

설명서에 포함된 릴리스 정보에 공지됩니다.

API 버전 관리

API 버전 관리를 사용하는 것이 좋지만 반드시 사용해야 하는 것은 아닙니다. API 버전 관리를 사용하면 API를 특정 값에 고정하고 새 API 버전으로 업그레이드하는 시기를 제어할 수 있습니다. API 버전 관리를 사용하지 않는 경우 API에 따라 기본 동작이 달라집니다.

IaaS API의 경우 최신 버전은

2021-07-15

입니다. 버전 관리 없이 IaaS API를 사용하거나

2021-07-15

이외의 값을 할당하는 경우 요청은 버전 2019-01-15를 사용합니다.

2021-07-15

에 할당된 apiVersion 쿼리 매개변수로 IaaS API 요청을 잠그는 것이 가장 좋습니다. 이렇게 하면 버전 2019-01-15가 수명이 종료되기 전에 최신 버전으로 원활하게 전환할 수 있습니다. Using Automation Assembler APIs to Build your Resource Infrastructure의 내용을 참조하십시오.

다른 API의 경우 apiVersion 쿼리 매개 변수에 원하는 날짜를 지정할 수 있습니다. 값을 지정하지 않은 상태로 두면 요청은 기본적으로 최신 API 버전을 사용합니다. 그러나 이전 버전과의 호환성은 유지되지 않으며 API가 변경되면 API 응답에서 예기치 않은 변경이 발생할 수 있습니다.

가장 좋은 방법은 API 요청에서 apiVersion 쿼리 매개 변수를 사용하고 API를 Swagger 규격에 나열된 최신 버전으로 잠그는 것입니다. 그러면 새 API 버전이 발표되면 apiVersion 쿼리 매개 변수를 새 버전 값으로 변경하여 해당 버전에 옵트인할 시기를 제어할 수 있습니다.

다음 예에서는 카탈로그 API에 대해 apiVersion 쿼리 매개 변수를 사용하는 방법을 보여줍니다. 카탈로그 API 버전은 2020-08-25, 2020-01-30, 2019-01-15입니다. 추가 apiVersion 쿼리 매개 변수를 포함하면 2020년 1월 30일부터 2020년 8월 24일까지 적용된 API 버전에 대한 호출이 잠깁니다.

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-01-30

2020-08-25 일자 버전으로 릴리스된 기능에 옵트인할 준비가 되면 apiVersion 쿼리 매개 변수의 값을 변경합니다.

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-08-25

apiVersion 쿼리 매개 변수를 최신 버전으로 설정하면 2020-08-25 이후에 발생하는 카탈로그 API도 업데이트됩니다. 그러나 새 버전이 발표되기 전까지는 호환성이 손상되는 변경은 발생하지 않으며 apiVersion 쿼리 매 개변수의 값을 새로운 버전이나 그 이후의 날짜로 변경하는 경우에만 이러한 변경 사항이 발생합니다.

API 버전은 모든

VMware Aria Automation

릴리스마다 변경되는 것이 아니며 모든 서비스에서 동일하지는 않습니다. 사용하는 서비스에 대한 API 버전을 확인하려면

https://<FQDN>/automation-ui/api-docs

(으)로 이동한 후 카드를 클릭하여 Swagger 규격을 엽니다.