Méthode: status
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Vérifiez l'état d'un service de liste de contrôle d'accès aux clés (KACLS) pour déterminer si
qu'elle est active et
correctement configurée.
Autocontrôles internes, tels que la vérification de l'accessibilité de KMS ou la journalisation de l'état du système
peuvent également être effectuées.
Requête HTTP
GET https://KACLS_URL/status
Remplacez KACLS_URL par le service de liste de contrôle d'accès aux clés (KACLS).
URL.
Paramètres de chemin d'accès
Aucun
Corps de la requête
Aucun
Corps de la réponse
Le corps de la réponse contient des données présentant la structure suivante:
| Représentation JSON |
{
"name": string,
"vendor_id": string,
"version": string,
"server_type": string,
"operations_supported": string array
}
|
| Champs |
name |
string (UTF-8)
Nom d'instance facultatif.
|
operations_supported |
string array
Liste des opérations compatibles avec le service. Le nom de l'opération est défini par son chemin d'URL.
|
server_type |
string (UTF-8)
doit être KACLS
|
vendor_id |
string (UTF-8)
Nom du fournisseur KACLS.
|
version |
string (UTF-8)
Version logicielle.
|
Exemple
Cet exemple fournit un exemple de réponse pour status
.
Réponse
{
"server_type": "KACLS",
"vendor_id": "Test",
"version": "demo",
"name": "K8 reference",
"operations_supported": [
"wrap", "unwrap", "privilegedunwrap",
"privatekeydecrypt", "privatekeysign", "privilegedprivatekeydecrypt"
]
}
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThis endpoint (\u003ccode\u003eGET /status\u003c/code\u003e) checks the operational status and configuration of a Key Access Control List Service (KACLS).\u003c/p\u003e\n"],["\u003cp\u003eIt provides essential information about the KACLS instance, such as its name, vendor, version, server type, and supported operations.\u003c/p\u003e\n"],["\u003cp\u003eThe response confirms whether the KACLS is active and details the functionalities it offers.\u003c/p\u003e\n"],["\u003cp\u003eInternal self-checks within the KACLS, including KMS accessibility and logging system health, might also be conducted as part of the status check.\u003c/p\u003e\n"]]],["A `GET` request to the `/status` endpoint of a Key Access Control List Service (KACLS) URL checks its status. The response contains JSON data, including the KACLS's `server_type` (which must be \"KACLS\"), `vendor_id`, `version`, an optional `name`, and a `operations_supported` array. This method is also used for internal checks such as KMS accessibility and logging health. Example provided of how a successful response looks like.\n"],null,["# Method: status\n\nChecks the status of a Key Access Control List Service (KACLS) to assess whether\nit's active and properly configured.\n\nInternal self checks, like checking KMS accessibility or logging system health,\ncan also be performed.\n\n### HTTP request\n\n`GET https://`\u003cvar translate=\"no\"\u003eKACLS_URL\u003c/var\u003e`/status`\n\nReplace \u003cvar translate=\"no\"\u003eKACLS_URL\u003c/var\u003e with the Key Access Control List Service (KACLS)\nURL.\n\n### Path parameters\n\nNone.\n\n### Request body\n\nNone.\n\n### Response body\n\nThe response body contains data with the following structure:\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"vendor_id\": string, \"version\": string, \"server_type\": string, \"operations_supported\": string array } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `name` | `string (UTF-8)` An optional instance name. |\n| `operations_supported` | `string array` List of operations supported by the service. The name of the operation is defined by its URL path. |\n| `server_type` | `string (UTF-8)` Must be `KACLS`. |\n| `vendor_id` | `string (UTF-8)` The KACLS vendor name. |\n| `version` | `string (UTF-8)` The software version. |\n\n### Example\n\nThis example provides a sample response for the `status`\nmethod.\n\n#### Response\n\n {\n \"server_type\": \"KACLS\",\n \"vendor_id\": \"Test\",\n \"version\": \"demo\",\n \"name\": \"K8 reference\",\n \"operations_supported\": [\n \"wrap\", \"unwrap\", \"privilegedunwrap\",\n \"privatekeydecrypt\", \"privatekeysign\", \"privilegedprivatekeydecrypt\"\n ]\n }"]]
