"OpenStack API 문서"의 두 판 사이의 차이

 
(같은 사용자의 중간 판 18개는 보이지 않습니다)
1번째 줄: 1번째 줄:
==개요==
==개요==
[[분류: OpenStack]]
;OpenStack API Documentation
;OpenStack API Documentation
;OpenStack API 문서
;OpenStack API 문서
16번째 줄: 17번째 줄:
API 상태 값 및 버전 정보에 대한 자세한 내용은, [https://wiki.openstack.org/wiki/VersionDiscovery 버전 발견]을 참조하십시오.
API 상태 값 및 버전 정보에 대한 자세한 내용은, [https://wiki.openstack.org/wiki/VersionDiscovery 버전 발견]을 참조하십시오.


API 참조 링크 옆에 있는 '(마이크로버전)' 표시는, 해당 API가 리소스별로 작은, 문서화된 변경을 가능하게 하는 Compute 서비스에서 확립된 패턴을 따르고 있음을 나타냅니다.
API 참조 링크 옆에 있는 '(마이크로버전)' 표시는, 해당 API가 리소스별로 작은, 문서화된 변경을 가능하게 하는 [https://docs.openstack.org/api-guide/compute/microversions.html Compute 서비스에서 확립된 패턴]을 따르고 있음을 나타냅니다.
{{/NOTE}}


==현재 API 버전==
==현재 API 버전==
{{z컬럼2|
* [https://docs.openstack.org/api-ref/accelerator/ Acceleration API v2]
* [https://docs.openstack.org/api-ref/admin-logic/ Admin Logic API]
* [https://docs.openstack.org/api-ref/application-catalog/v1/ Application Catalog API v1]
* [https://docs.openstack.org/api-ref/application-container/ Application Container Service API] (마이크로버전)
* [https://docs.openstack.org/api-ref/backup/v1/ Backup API v1]
* [https://docs.openstack.org/api-ref/baremetal/ Bare Metal API v1] (마이크로버전)
* [https://docs.openstack.org/api-ref/block-storage/v3/ Block Storage API v3] (마이크로버전)
:{{NOTE}}Block Storage API v3는 기능적으로 Block Storage API v2와 동일합니다. API v3의 이후 마이크로버전(예: v3.1)부터는 API v2와 차이가 있습니다.{{/NOTE}}
* [https://docs.openstack.org/api-ref/clustering/ Clustering API v1]
* [https://docs.openstack.org/api-ref/compute/ Compute API] (마이크로버전)
* [https://docs.openstack.org/api-ref/container-infrastructure-management/ Container Infrastructure Management API] (마이크로버전)
* [https://docs.openstack.org/api-ref/data-processing/ Data Processing v1.1]
* [https://docs.openstack.org/api-ref/data-protection-orchestration/ Data Protection Orchestration v1]
* [https://docs.openstack.org/api-ref/database/ Database Service API v1.0]
* [https://docs.openstack.org/api-ref/dns/ Domain Name Server (DNS) API v2]
* [https://docs.openstack.org/api-ref/ec2-api/ EC2 API Service]
* [https://docs.openstack.org/api-ref/function-engine/ Function Engine]
* [https://docs.openstack.org/api-ref/identity/v3 Identity API v3]
* [https://docs.openstack.org/api-ref/identity/v3-ext Identity API v3 extensions]
* [https://docs.openstack.org/api-ref/image/v2 Image service API v2]
* [https://docs.openstack.org/barbican/latest/api/ Key Manager API v1]
* [https://docs.openstack.org/api-ref/load-balancer/v2 Load Balancer API v2]
* [https://docs.openstack.org/api-ref/message Messaging API v2]
* [https://docs.openstack.org/api-ref/network/v2 Networking API v2.0]
* [https://docs.openstack.org/api-ref/nfv-orchestration/v1/ NFV Orchestration API v1.0]
* [https://docs.openstack.org/api-ref/object-store Object Storage API v1]
* [https://docs.openstack.org/api-ref/orchestration/v1/ Orchestration API v1]
* [https://docs.openstack.org/api-ref/placement/ Placement API] (마이크로버전)
* [https://docs.openstack.org/api-ref/resource-optimization Resource Optimization API v1]
* [https://docs.openstack.org/api-ref/search Search API v1]
* [https://docs.openstack.org/api-ref/shared-file-system Shared File Systems API v2] (마이크로버전)
:{{NOTE}}Shared File Systems API v1은 Shared File Systems API v2와 기능적으로 동일합니다. API v2의 후속 마이크로버전(예: v2.1)은 API v1과 다릅니다.{{/NOTE}}
}}
==지원 API 버전==
==지원 API 버전==
==지원중단 API 버전==
==지원중단 API 버전==
* [https://docs.openstack.org/api-ref/block-storage/v2/ Block Storage API v2]
{{NOTE}}
블록 스토리지 API v3는 기능적으로 블록 스토리지 API v2와 동일합니다. API v3.1과 같은 이후의 API v3 마이크로 버전은 API v2와 다릅니다.
{{/NOTE}}
* [https://docs.openstack.org/api-ref/identity/v2-ext Identity API v2.0 extensions]
==API 빠른 시작 예제==
==API 빠른 시작 예제==
[https://www.openstack.org/software/start TryStack] OpenStack 설치에서는 여러 서비스가 설치 백그라운드에서 함께 작동하며, 이러한 예제들은 TryStack에서 작동합니다.
Identity를 통해 인증을 받은 후, 다른 OpenStack API를 사용하여 OpenStack 클라우드에서 리소스를 생성하고 관리할 수 있습니다. Compute API 또는 '''openstack''' 명령줄 클라이언트를 통해 이미지를 기반으로 인스턴스를 시작하고 인스턴스에 메타데이터를 할당할 수 있습니다.
API 요청을 보내기 위해 다음 방법 중 하나를 사용할 수 있습니다:
* '''cURL'''
:HTTP 요청을 보내고 응답을 받을 수 있는 명령줄 도구입니다. [https://docs.openstack.org/api-quick-start/api-quick-start.html#openstack-api-quick-guide OpenStack API] 섹션을 참조하십시오.
* '''OpenStack 명령줄 클라이언트'''
:OpenStack 프로젝트는 API에 접근할 수 있는 사용하기 쉬운 명령어를 제공하는 명령줄 클라이언트를 제공합니다. [https://docs.openstack.org/api-quick-start/api-quick-start.html#client-intro OpenStack 명령줄 클라이언트] 섹션을 참조하십시오.
* '''REST 클라이언트'''
:Mozilla와 Google은 REST를 위한 브라우저 기반의 그래픽 인터페이스를 제공합니다. Firefox의 경우 [https://addons.mozilla.org/en-US/firefox/addon/restclient/ RESTClient]를, Chrome의 경우 [https://code.google.com/archive/p/rest-client/ rest-client]를 참조하십시오.
* '''OpenStack Python 소프트웨어 개발 키트 (SDK)'''
:이 SDK를 사용하여 OpenStack 클라우드에서 리소스를 생성하고 관리하는 파이썬 자동화 스크립트를 작성할 수 있습니다. SDK는 OpenStack API에 대한 파이썬 바인딩을 구현하여 REST 호출을 직접 수행하는 대신 파이썬 객체에 대한 호출을 통해 자동화 작업을 수행할 수 있게 합니다. 모든 OpenStack 명령줄 도구는 파이썬 SDK를 사용하여 구현됩니다. OpenStack 최종 사용자 가이드의 [https://docs.openstack.org/user-guide/sdk.html OpenStack Python SDK]를 참조하십시오.
* [https://docs.openstack.org/api-quick-start/api-quick-start.html OpenStack API]
** [https://docs.openstack.org/api-quick-start/api-quick-start.html#authentication-and-api-request-workflow 인증 및 API 요청 워크플로우]
** [https://docs.openstack.org/api-quick-start/api-quick-start.html#authenticate 인증]
** [https://docs.openstack.org/api-quick-start/api-quick-start.html#send-api-requests API 요청 전송]
** [https://docs.openstack.org/api-quick-start/api-quick-start.html#openstack-command-line-clients OpenStack 명령줄 클라이언트]
==같이 보기==
* [[OpenStack API]]

2024년 6월 15일 (토) 16:18 기준 최신판

1 개요[ | ]

OpenStack API Documentation
OpenStack API 문서

OpenStack API를 사용하여 서버 인스턴스를 시작하고, 이미지를 생성하며, 인스턴스 및 이미지에 메타데이터를 할당하고, 스토리지 컨테이너 및 객체를 생성하는 등의 작업을 OpenStack 클라우드에서 수행할 수 있습니다.

Note

아래 링크는 서비스에서 엔드포인트의 상태를 반영하는 API 상태에 따라 그룹화되어 있습니다.

  • ‘현재’는 최신 버전으로, 최신 상태를 유지하며 향후 버전이 나올 수 있는 안정적인 버전을 나타냅니다. 이 엔드포인트는 다른 모든 것보다 우선적으로 사용해야 합니다.
  • ‘지원됨’은 서버에서 사용할 수 있는 안정적인 버전이지만, 최신 버전이 아닐 가능성이 높으며 업데이트되지 않거나 향후 사용 중단될 수 있습니다.
  • ‘지원중단됨’은 여전히 사용할 수 있는 안정적인 버전이지만, 지원중단되었으며 향후 제거될 수 있습니다.
  • ‘실험적’은 안정적인 버전이 아닙니다. 이 버전은 개발 중이거나 기능이 변경될 수 있습니다.

API 상태 값 및 버전 정보에 대한 자세한 내용은, 버전 발견을 참조하십시오.

API 참조 링크 옆에 있는 '(마이크로버전)' 표시는, 해당 API가 리소스별로 작은, 문서화된 변경을 가능하게 하는 Compute 서비스에서 확립된 패턴을 따르고 있음을 나타냅니다.

2 현재 API 버전[ | ]

Note

Block Storage API v3는 기능적으로 Block Storage API v2와 동일합니다. API v3의 이후 마이크로버전(예: v3.1)부터는 API v2와 차이가 있습니다.

Note

Shared File Systems API v1은 Shared File Systems API v2와 기능적으로 동일합니다. API v2의 후속 마이크로버전(예: v2.1)은 API v1과 다릅니다.

3 지원 API 버전[ | ]

4 지원중단 API 버전[ | ]

Note

블록 스토리지 API v3는 기능적으로 블록 스토리지 API v2와 동일합니다. API v3.1과 같은 이후의 API v3 마이크로 버전은 API v2와 다릅니다.

5 API 빠른 시작 예제[ | ]

TryStack OpenStack 설치에서는 여러 서비스가 설치 백그라운드에서 함께 작동하며, 이러한 예제들은 TryStack에서 작동합니다.

Identity를 통해 인증을 받은 후, 다른 OpenStack API를 사용하여 OpenStack 클라우드에서 리소스를 생성하고 관리할 수 있습니다. Compute API 또는 openstack 명령줄 클라이언트를 통해 이미지를 기반으로 인스턴스를 시작하고 인스턴스에 메타데이터를 할당할 수 있습니다.

API 요청을 보내기 위해 다음 방법 중 하나를 사용할 수 있습니다:

  • cURL
HTTP 요청을 보내고 응답을 받을 수 있는 명령줄 도구입니다. OpenStack API 섹션을 참조하십시오.
  • OpenStack 명령줄 클라이언트
OpenStack 프로젝트는 API에 접근할 수 있는 사용하기 쉬운 명령어를 제공하는 명령줄 클라이언트를 제공합니다. OpenStack 명령줄 클라이언트 섹션을 참조하십시오.
  • REST 클라이언트
Mozilla와 Google은 REST를 위한 브라우저 기반의 그래픽 인터페이스를 제공합니다. Firefox의 경우 RESTClient를, Chrome의 경우 rest-client를 참조하십시오.
  • OpenStack Python 소프트웨어 개발 키트 (SDK)
이 SDK를 사용하여 OpenStack 클라우드에서 리소스를 생성하고 관리하는 파이썬 자동화 스크립트를 작성할 수 있습니다. SDK는 OpenStack API에 대한 파이썬 바인딩을 구현하여 REST 호출을 직접 수행하는 대신 파이썬 객체에 대한 호출을 통해 자동화 작업을 수행할 수 있게 합니다. 모든 OpenStack 명령줄 도구는 파이썬 SDK를 사용하여 구현됩니다. OpenStack 최종 사용자 가이드의 OpenStack Python SDK를 참조하십시오.

6 같이 보기[ | ]

문서 댓글 ({{ doc_comments.length }})
{{ comment.name }} {{ comment.created | snstime }}