StyleBook-Konfiguration

Verwenden Sie APIs, um benutzerdefinierte StyleBooks zu importieren

Verwenden Sie die StyleBook-API, um benutzerdefinierte StyleBooks in NetScaler Console zu importieren. Verwenden Sie REST-APIs, um aus diesem StyleBook in einem beliebigen Tool wie dem cURL-Befehlszeilentool oder der Postman Chrome-Browsererweiterung ein Konfigurationspaket zu erstellen. Sie können beispielsweise ein StyleBook namens importieren, example-lb das verwendet werden kann, um eine Load Balancer-Konfiguration auf einer NetScaler-Instanz zu erstellen.

HTTP-Methode: POST

URL: https://<ADM-endpoint-name>/stylebook/nitro/v2/config/stylebooks/actions/import?mode=async

{
    "import": {
        "file_name": "add_dnssoarec.yaml",
        "source": "<base 64 encoded content of the sb definition>",
        "encoding": "base64"
    }
}
<!--NeedCopy-->

Dabei ist der Wert des source Attributs die Base64-Codierung des Inhalts Ihrer StyleBook-Datei. Sie können den YAML-Inhalt Ihrer StyleBook-Datei in ein Online-Tool einfügen. Verwenden Sie zum Beispiel, https://www.browserling.com/tools/file-to-base64 um die Base64-Zeichenfolge abzurufen, die Sie dann als Wert für das source Attribut verwenden können.

Mit diesem API-Aufruf können Sie auch eine komprimierte Tarball-Datei (.tgz-Datei) mit mehreren StyleBook-Dateien in einem API-Vorgang hochladen. Führen Sie folgende Schritte aus:

  • Ändern Sie das file_name Attribut in die .tgz-Datei
  • Ändern Sie das source Attribut auf die Base64-Kodierung des Inhalts Ihrer .tgz-Datei

Nachdem die API erfolgreich im Tool ausgeführt wurde, erhalten Sie eine Antwort mit einer Job-ID. Verwenden Sie diese Job-ID, um den Vorgang bis zum Abschluss zu verfolgen:

200 ACCEPTED
<!--NeedCopy-->

Antworttext:

{
    "job": {
        "job_id": "12345678"
    }
}
<!--NeedCopy-->

Verwenden Sie die Job-ID, um den Status des Vorgangs zu verfolgen:

HTTP-Methode: GET

URL: https://<ADM-endpoint-name>/stylebook/nitro/v2/config/jobs/<job-id>

Der Status des Jobs wird zurückgegeben:

200 OK
<!--NeedCopy-->

Antworttext:

{
    "job": {
        "job_id": "<job-id>",
        "progress_info": [
            {
                "is_last": "true",
                "message": "No job found",
                "status": "failed"
            }
        ],
        "status": "completed"
    }
}
<!--NeedCopy-->

Der Statuswert “completed” gibt an, dass das StyleBook erfolgreich importiert wurde. Bestätigen Sie den Status der Operationen, indem Sie Informationen zum StyleBook abrufen:

HTTP-Methode: GET

URL: https://<ADM-endpoint-name>/stylebook/nitro/v2/config/stylebooks/samples/1.0/demo-helper-object

Die Details des importierten StyleBook werden angezeigt:

200 OK
<!--NeedCopy-->

Antworttext:

{
    "stylebook": {
        "builtin_namespaces": {},
        "created_datetime": "2023-01-14 00:13:59",
        "custom": true,
        "dependencies": [],
        "deprecate": "false",
        "description": "This Stylebook is a test",
        "display_name": "Test StyleBooks",
        "encoding": "BASE64",
        "header": "Test StyleBooks",
        "icon": "''",
        "id": "demo575731aacbfc20b4ff00b3b60ea59855",
        "is_updatable": true,
        "name": "demo-helper-object",
        "namespace": "samples",
        "primary_keys": {},
        "private": false,
        "repository_name": "",
        "reverse_dependencies": [],
        "schema_version": "1.0",
        "source": "<base 64 encoded content of the stylebook definition>",
        "tenant_id": "1a45fd70-7ce3-4bff-8642-1bd7f7e97673",
        "username": "abc",
        "version": "1.0"
    }
}
<!--NeedCopy-->
Verwenden Sie APIs, um benutzerdefinierte StyleBooks zu importieren

In diesem Artikel