Viewing Details of an Update All Versions Operation
Use the post /v1/cckm/google/update-all-versions-jobs/{id}
API to view the details of an update all versions job with the given ID.
Syntax
curl -k '<IP>/api/v1/cckm/google/update-all-versions-jobs/{id}' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Here, {id}
represents the resource ID of the update all versions job on the CipherTrust Manager.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/google/update-all-versions-jobs/778a1024-dc18-49cb-833b-cfd6c000c090' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' --compressed
Example Response
{
"id": "778a1024-dc18-49cb-833b-cfd6c000c090",
"uri": "kylo:kylo:cckm:update_all_versions:778a1024-dc18-49cb-833b-cfd6c000c090",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2021-05-05T07:33:44.183784Z",
"updatedAt": "2021-05-05T07:33:48.323112Z",
"completed_at": "2021-05-05T07:33:48.322905Z",
"overall_status": "completed",
"detailed_status": {
"completed": [
"2",
"1"
],
"projects/gemalto-kyloeng/locations/global/keyRings/demo-key-ring/cryptoKeys/doc-test": "Successfully updated all key versions state."
},
"job_id": "778a1024-dc18-49cb-833b-cfd6c000c090",
"key_id": "ecc73bfb-7605-4263-abb8-84fe431d35fb",
"version_count": 2,
"operation": "disable",
"abort": false
}
The sample output displays details such as "overall_status"
, "detailed_status"
, "key_id"
, number of key versions ("version_count"
), and "operation"
of an update all versions job with the ID 778a1024-dc18-49cb-833b-cfd6c000c090
.
In the sample output above, the message "Successfully updated all key versions state."
indicates that the "disable"
operation is successfully "completed"
on two versions of a Google Cloud key.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.