Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Data Encryption Workshop> Referência de API> APIs> APIs de gerenciamento de chaves> Gerenciamento de autorização> Consulta de concessões que podem ser retiradas

Atualizado em 2023-02-28 GMT+08:00

Ver PDF

Consulta de concessões que podem ser retiradas

Função

Essa API permite que você consulte concessões que podem ser retiradas.

URI

POST /v1.0/{project_id}/kms/list-retirable-grants

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatoriedade	Tipo	Descrição
project_id	Sim	String	ID do projeto.

Parâmetros de solicitação

**Tabela 2** Parâmetros de cabeçalho de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta).

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
limit	Não	String	Número de registros retornados de concessão que podem ser retiradas. Se o número de resultados recuperados for maior que esse valor, true será retornado para o parâmetro de resposta truncado, indicando que várias páginas de resultados foram recuperadas. O valor não pode exceder o número máximo de concessões. Exemplo: 100
marker	Não	String	Posição inicial da consulta de paginação. Se truncado for verdadeiro na resposta, você poderá enviar solicitações consecutivas para obter mais registros. Defina marcador para o valor de next_marker na resposta. Exemplo: 10
sequence	Não	String	Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
grants	Array of Grants objects	Lista de concessão.
next_marker	String	Valor do marcador utilizado para a obtenção da próxima página de resultados. Se truncado for falso, next_marker será deixado em branco.
truncated	String	Se há uma próxima página de resultados: verdadeiro: há uma página seguinte. falso: esta é a última página.

**Tabela 5** Subsídios
Parâmetro	Tipo	Descrição
key_id	String	ID de CMK.
grant_id	String	ID da concessão, que contém 64 bytes.
grantee_principal	String	ID do beneficiário, que contém de 1 a 64 bytes e corresponde à expressão regular ^[a-zA-Z0-9]{1, 64}$. Exemplo: 0d0466b00d0466b00d0466b00d0466b0
grantee_principal_type	String	Tipo de concessão. Valores: user, domain.
operations	Array of strings	Lista de operações concedidas. Valores: create-datakey, create-datakey-without-plaintext, encrypt-datakey, decrypt-datakey, describe-key, create-grant, retire-grant, encrypt-data, decrypt-data. Um valor que contém apenas create-grant é inválido.
issuing_principal	String	ID do concedente, que contém de 1 a 64 bytes e corresponde à expressão regular ^[a-zA-Z0-9]{1, 64}$. Exemplo: 0d0466b00d0466b00d0466b00d0466b0
creation_date	String	Tempo de criação. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). Exemplo: 1497341531000
name	String	Nome de concessão. O valor é uma cadeia de 1 a 255 caracteres e corresponde à expressão regular ^[a-zA-Z0-9:/_-]{1,255}$.
retiring_principal	String	ID do usuário que pode retirar uma concessão. Ele contém de 1 a 64 bytes e corresponde à expressão regular ^[a-zA-Z0-9]{1, 64}$. Exemplo: 0d0466b00d0466b00d0466b00d0466b0

Código de status: 400

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 7** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 403

**Tabela 8** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 9** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Código de status: 404

**Tabela 10** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
error	Object	Mensagem de erro.

**Tabela 11** ErrorDetail
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Informação de erro.

Exemplo de solicitações

{
  "limit" : "1000"
}

Exemplo de respostas

Código de status: 200

Processamento da solicitação bem-sucedido.

{
  "grants" : [ {
    "operations" : [ "create-datakey", "describe-key" ],
    "issuing_principal" : "8b961fb414344d59825ba0c8c008c815",
    "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e",
    "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8",
    "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8",
    "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8",
    "creation_date" : "1597062260000",
    "grantee_principal_type" : "user"
  } ],
  "next_marker" : "",
  "total" : 1,
  "truncated" : "false"
}

Código de status: 400

Parâmetros de solicitação inválidos.

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

Código de status: 403

Autenticação falhou.

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

Código de status: 404

O recurso solicitado não existe ou não foi encontrado.

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

Códigos de status

Código de status	Descrição
200	Processamento da solicitação bem-sucedido.
400	Parâmetros de solicitação inválidos.
403	Autenticação falhou.
404	O recurso solicitado não existe ou não foi encontrado.