Erste Schritte mit der REST-API von „ Code Engine “

Mit der IBM Cloud® Code Engine-API können Sie Code Engine-Entitäten erstellen und verwalten.

API-Umgebung einrichten

Richten Sie Ihre API-Umgebung ein, um mit der API zum Erstellen und Verwalten von Code Engine-Entitäten zu arbeiten.

Bevor Sie beginnen, laden Sie das Tool jq herunter und installieren Sie es, bei dem es sich um einen einfachen und flexiblen JSON-Befehlszeilenprozessor handelt. Dieses Tool erleichtert das Arbeiten mit JSON-Antworten, die Sie von der API Code Engine erhalten.

Legen Sie Werte für region, api_key und project_name fest, bevor Sie die Curl-Beispielbefehle in der API ausführen. Beispiel:
```
region=us-south
api_key=YOUR_IBM_CLOUD_API_KEY
project_name=MY_PROJECT_NAME
```
- Führen Sie den Befehl ibmcloud region aus, um die IBM Cloud-Region zu erkennen, bei der Sie angemeldet sind.
- Weitere Informationen zu API-Schlüsseln für „ IBM Cloud “ finden Sie unter „ Verwalten von Benutzer-API-Schlüsseln “.
- Weitere Informationen zu Code Engine-Projekten finden Sie unter Projekte verwalten.
Stellen Sie sicher, dass Sie über ein gültiges IBM Cloud® Identity and Access Management-Zugriffstoken (IAM) verfügen. Weitere Informationen zur IAM-API finden Sie unter „ Erstellen eines IAM-Zugriffstokens für eine Benutzer- oder Dienst-ID mithilfe eines API-Schlüssels “.
```
token=`curl -X POST "https://iam.cloud.ibm.com/identity/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  -d "apikey=${api_key}" \
  | jq .access_token -r`
```
Verwenden Sie das Authentifizierungstoken und die Variablen, die Sie in Schritt 1 definiert haben, um die Projekt-ID Ihres Projekts abzurufen. Verwenden Sie im folgenden Beispiel curl mit jq, um die Antwort der API Code Engine zu analysieren und die Projekt-ID in einer Variablen zu speichern. Beispiel:
```
project_id=`curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects" \
   -H "Authorization: ${token}" \
   | jq --arg project_name ${project_name} '.projects[] | select(.name == $project_name) | .id' -r`
```

Mit einer Code Engine-Anwendung in der API arbeiten

Jetzt, da Ihre Code Engine-API-Umgebung eingerichtet ist, können Sie mit Code Engine-Entitäten wie Anwendungen oder Jobs arbeiten. Im folgenden Szenario erstellen wir eine Anwendung, greifen auf sie zu und löschen dann die Anwendung.

Erstellen Sie eine App. Verwenden Sie die zuvor festgelegten Variablen und die Projekt-ID, um eine URL zu erstellen und eine Anforderung zum Erstellen der my-app-Anwendung zu senden. Beispiel:

curl -X POST "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "my-app", \
    "image_reference": "icr.io/codeengine/helloworld" \
  }'

Senden Sie eine GET-Anforderung, um Details zur my-app-Anwendung anzuzeigen. Achten Sie darauf, auf den Namen Ihrer App zu verweisen. Beachten Sie, dass die letzte Zeile von jq optional ist, obwohl sie die Ausgabe lesbarer macht.
```
curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  | jq .
```

Um die Anwendung zu löschen, senden Sie die Anforderung erneut, aber verwenden Sie diesmal die Methode DELETE anstelle der Methode GET.

curl -X DELETE "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json"

(Optional) Wenn Sie eine weitere GET-Anforderung zum Abrufen von Informationen zu my-app senden, erhalten Sie eine 404 error, da die Ressource nicht mehr vorhanden ist.

Beispielausgabe

{
  "errors": [
    {
      "code": "resource_not_found",
      "message": "Resource not found."
    }
  ],
  "trace": "codeengine-api-34dc0040429941de8c9e02f0f1200af1",
  "status_code": 404
}

Nächste Schritte

Nachdem Sie Ihre Umgebung eingerichtet und die ersten Schritte mit einer Code Engine-Anwendung mit der API ausgeführt haben, können Sie nun die API Code Engine weiter erkunden?

Weitere Informationen und Beispiele für Code Engine-SDKs in mehreren Sprachen finden Sie in der API-Dokumentation zuCode Engine.

Informationen zum Einstieg in die Arbeit mit Komponenten von Code Engine mit der API finden Sie in

IBM Cloud® Code Engine ist so konzipiert, dass Sie nicht mit der zugrundeliegenden Technologie interagieren müssen, auf der es basiert. Wenn Sie jedoch bereits über Tools verfügen, die auf „ Kubernetes “ oder „Knative“ basieren, können Sie diese weiterhin mit „ Code Engine “ nutzen. „ Code Engine “ unterstützt die Knative- und „ Kubernetes “-APIs sowie deren CLI-Befehle. Weitere Informationen finden Sie unter Kubernetes mit Code Engine und unter Knative mit Code Engine.