Method: status
Stay organized with collections
Save and categorize content based on your preferences.
Checks the status of a Key Access Control List Service (KACLS) to assess whether
it's active and properly configured.
Internal self checks, like checking KMS accessibility or logging system health,
can also be performed.
HTTP request
GET https://KACLS_URL/status
Replace KACLS_URL with the Key Access Control List Service (KACLS)
URL.
Path parameters
None.
Request body
None.
Response body
The response body contains data with the following structure:
| JSON representation |
{
"name": string,
"vendor_id": string,
"version": string,
"server_type": string,
"operations_supported": string array
}
|
| Fields |
name |
string (UTF-8)
An optional instance name.
|
operations_supported |
string array
List of operations supported by the service. The name of the operation is defined by its URL path.
|
server_type |
string (UTF-8)
Must be KACLS.
|
vendor_id |
string (UTF-8)
The KACLS vendor name.
|
version |
string (UTF-8)
The software version.
|
Example
This example provides a sample response for the status
method.
Response
{
"server_type": "KACLS",
"vendor_id": "Test",
"version": "demo",
"name": "K8 reference",
"operations_supported": [
"wrap", "unwrap", "privilegedunwrap",
"privatekeydecrypt", "privatekeysign", "privilegedprivatekeydecrypt"
]
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 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 }"]]
