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 rotação/Consulta do status de rotação de uma CMK
Atualizado em 2023-02-28 GMT+08:00
Ver PDF
Compartilhar

Consulta do status de rotação de uma CMK

Função

Essa API permite que você consulte o status de rotação de uma CMK.

URI

POST /v1.0/{project_id}/kms/get-key-rotation-status

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

key_id

Sim

String

ID de CMK. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f

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

key_rotation_enabled

Boolean

Status de rotação da chave. O valor padrão é false, indicando que a rotação da chave está desativada.

rotation_interval

String

Intervalo de rotação. O valor é um número inteiro no intervalo de 30 a 365. Defina o intervalo com base na frequência com que uma CMK é usada. Se for usado com frequência, defina um intervalo curto; caso contrário, defina um longo.

last_rotation_time

String

Tempo de rotação da última chave. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).

number_of_rotations

Integer

Número de rotações de chaves.

Código de status: 400

Tabela 5 Parâmetros de corpo da resposta

Parâmetro

Tipo

Descrição

error

Object

Mensagem de erro.

Tabela 6 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 7 Parâmetros de corpo da resposta

Parâmetro

Tipo

Descrição

error

Object

Mensagem de erro.

Tabela 8 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 9 Parâmetros de corpo da resposta

Parâmetro

Tipo

Descrição

error

Object

Mensagem de erro.

Tabela 10 ErrorDetail

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Informação de erro.

Exemplo de solicitações

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}

Exemplo de respostas

Código de status: 200

Processamento da solicitação bem-sucedido.

{
  "key_rotation_enabled" : true,
  "rotation_interval" : 30,
  "last_rotation_time" : "1501578672000",
  "number_of_rotations" : 3
}

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.

Códigos de erro

Consulte Códigos de erro.

Tópico principal:Gerenciamento de rotação