OpenStack API-Dokumentado

Uzu la OpenStack API por lanĉi servilajn instancojn, krei bildojn, asigni metadatojn al aperoj kaj bildoj, krei memorilajn kontenerojn kaj objektojn, kaj kompletigi aliajn agojn en via OpenStack-nubo.

Note

La ligiloj sube estas grupigitaj laŭ la API-statuso, kiu reflektas la staton de la finpunkto sur la servo.

  • ‘Nuna’ indikas stabilan version kiu estas ĝisdatigita, lastatempe, kaj eble ricevas estontajn versiojn. Ĉi tiu finpunkto devas esti prioritita super ĉiuj aliaj.

  • ‘Subtenita’ estas stabila versio kiu estas disponebla sur la servilo. Tamen, ĝi verŝajne ne estas la plej lastatempa havebla kaj eble ĝi ne estas ĝisdatigita aŭ povus esti ekskludita iamtempe en la estonteco.

  • ‘Evitinda’ estas stabila versio kiu ankoraŭ estas havebla sed estas evitinda kaj povus esti forigita en la estonteco.

  • ‘Eksperimenta’ ne estas stabila versio. Ĉi tiu versio estas evoluanta aŭ enhavas trajtojn, kiuj alie ŝanĝos.

Por pliaj informoj pri API-statusaj valoroj kaj versiaj informoj, vidu Version Discovery.

The notation ‘(microversions)’ next to the link to an API reference indicates that the API follows a pattern established by the Compute service to enable small, documented changes to the API on a resource-by-resource basis.

Aktualaj API versioj

Acceleration API v1

Admin Logic API

Application Catalog API v1

Application Container Service API (microversions)

Backup API v1

Bare Metal API v1 (microversions)

Block Storage API v3 (microversions)

Note

La Bloko-stokado API v3 estas funkcie identa al la Bloko-Stokado API v2. Sekvaj API-v3-mikroversioj, kiel v3.1, diferencas de API v2.

Clustering API v1

Compute API (microversions)

Container Infrastructure Management API (microversions)

Data Processing v1.1

Data Protection Orchestration v1

Database Service API v1.0

Domain Name Server (DNS) API v2

EC2 API Service

Function Engine

Identity API v3

Identity API v3 extensions

Image service API v2

Key Manager API v1

Load Balancer API v2

Messaging API v2

Networking API v2.0

NFV Orchestration API v1.0

Object Storage API v1

Orchestration API v1

Placement API (microversions)

Resource Optimization API v1

Search API v1

Shared File Systems API v2 (microversions)

Note

La Opuzaj dosieroj API v1 estas funkcie identa al la La Opuzaj dosieroj API v2. Sekvaj API v2-mikroversioj, kiel v2.1, diferencas de API v1.

Subtenitaj API-versioj

Evitindaj API-versioj

Block Storage API v2

Note

La Bloko-stokado API v3 estas funkcie identa al la Bloko-Stokado API v2. Sekvaj API-v3-mikroversioj, kiel v3.1, diferencas de API v2.

Identity API v2.0 extensions

API rapid-komencaj ekzemploj

With the TryStack OpenStack installation, these services work together in the background of the installation, and many of these examples work on TryStack.

Post kiam vi aŭtentigas tra Identeco, vi povas uzi la aliajn OpenStack-APIojn por krei kaj administri rimedojn en via OpenStack-nubo. Vi povas prezenti ekzemplojn de bildoj kaj asigni metadatojn al aperojn per la Komputila API aŭ la openstack komandlinia kliento.

Por komenci sendi API-petojn, uzu unu el la sekvaj metodoj:

  • cURL

    Komandlinia ilo ebligas sendi HTTP-petojn kaj ricevi respondojn. Vidu la sekcion nomita: ref: openstack_API_quick_guide.

  • OpenStack command-line client

    La projekto OpenStack provizas komandlinajn klienton kiu ebligas vin aliri la APIojn per facilaj komandoj. Vidu la sekcion nomita: ref: ‘client-intro`.

  • REST klientoj

    Both Mozilla and Google provide browser-based graphical interfaces for REST. For Firefox, see RESTClient. For Chrome, see rest-client.

  • OpenStack Python Software Development Kit (SDK)

    Uzu ĉi tiun SDK por skribi Python aŭtomatajn skriptojn, kiuj kreas kaj administras rimedojn en via OpenStack-nubo. La SDK realigas Python ligojn al la OpenStack API, kiu ebligas vin fari taskojn de aŭtomatigo en Python per alvokoj al Python objektoj prefere ol fari REST vokojn rekte. Ĉiuj OpenStack komandliniaj iloj estas efektivigitaj per la Python SDK. Vidu ‘OpenStack Python SDK <https://docs.openstack.org/user-guide/sdk.html> `__ en la OpenStack End User Guide.