Querying Grants That Can Be Retired¶

Function¶

This API enables you to query grants that can be retired.

URI¶

URI format
POST /v1.0/{project_id}/kms/list-retirable-grants
Parameter description
Table 1 Parameter description¶
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Requests¶

**Table 2** Request parameters¶
Parameter	Mandatory	Type	Description
limit	No	String	This parameter specifies the number of entries returned. If the specified number is smaller than the actual number of existing entries, true will be returned for the response parameter truncated, indicating that the query results will be displayed in separate pages. The value is within the range of the maximum number of grants, for example, 100.
marker	No	String	This parameter marks the starting location in a pagination query. If the truncated value is true, you can send consecutive requests to obtain more record entries. The marker value must be set to the next_marker value in the response, for example, 10.
sequence	No	String	36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff

Responses¶

**Table 3** Response parameters¶
Parameter	Mandatory	Type	Description
grants	Yes	Array of objects	Grant list. For details, see Table 4.
next_marker	Yes	String	This parameter indicates the marker value required for obtaining the next page of query results. If the truncated value is false, the next_marker parameter is left blank.
truncated	Yes	String	This parameter indicates whether there are more results displayed in another page. If the value is true, there are more results. If the value is false, the current page is the last page.
total	Yes	Integer	This parameter indicates the total number of grants.

Examples¶

The following example describes how to query the list of grants that can be retired.

Example request
```
{
    "limit": "",
    "marker": ""
}
```

Example response

{
    "grants": [
     {"key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
      "grant_id": "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d",
      "operations":
      ["describe-key","create-datakey", "encrypt-datakey"],
      "grantee_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
      "retiring_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
      "issuing_principal":"e4hkeeea506ex3wgnzyhi656n8hx8xa3",
      "name":"my_grant",
      "creation_date":"1497341531000"
      }],
    "next_marker": "",
    "truncated": "false",
    "total":1
}

{
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

Status Codes¶

Table 4 lists the normal status code returned by the response.

**Table 4** Status codes¶
Status Code	Status	Description
200	OK	Request processed successfully.

Exception status code. For details, see Status Codes.

last updated: 2024-11-14 08:18 UTC - commit: f0fd1483bfd6512c888b2522513eb0be99f34c59