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 segredo/ Gerenciamento das tags de segredos/ Consulta de uma instância de segredo

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

Ver PDF

Consulta de uma instância de segredo

Função

Essa API é usada para consultar uma instância de segredo. Você pode consultar um segredo por tag.

URI

POST /{version_id}/{project_id}/csms/{resource_instances}/action

**Tabela 1** Parâmetros de URI
Parâmetro	Obrigatório	Tipo	Descrição
resource_instances	Sim	String	Instância do recurso. Seu valor é resource_instances.
project_id	Sim	String	ID do projeto.
version_id	Sim	String	Versão da API

Parâmetros de solicitação

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

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
limit	Não	String	Número de registros em uma consulta. Se action for definida como count, não será necessário definir esse parâmetro. Se action for definida como filter, o valor padrão desse parâmetro é 10. O intervalo de valores é de 1 a 1000.
offset	Não	String	Localização do índice. A consulta começa a partir da próxima parte dos dados indexados por esse parâmetro. Quando os dados em uma página são consultados, o valor no corpo da resposta da página anterior é transferido para esse parâmetro. (Se action for count, você não precisa definir este parâmetro.) Se o valor da action for filter, o valor padrão será 0. O valor deve ser um numeral e não pode ser um número negativo.
action	Não	String	Tipo de operação. Pode ser: filter: filtrar registros. count: contar todos os registros.
tags	Não	Array of Tag objects	Lista de tags, incluindo chaves de tags e valores de tags. A key indica a chave da tag. Um segredo pode ter no máximo 10 chaves, e cada uma delas deve ser única e não pode estar vazia. Uma chave não pode ter valores duplicados. O valor da key contém no máximo 36 caracteres. Um resultado de consulta contém todas as chaves em tags pesquisadas. O value indica o valor da tag. Cada valor de tag pode conter no máximo 43 caracteres. Um resultado de consulta não contém todos os valores em tags pesquisadas.
matches	Não	Array of TagItem objects	Campo de pesquisa. A key é um campo de correspondência exata. Atualmente, seu valor só pode ser resource_name. O value é um campo de correspondência difusa. Pode conter no máximo 255 caracteres. Se este parâmetro não for especificado, um valor vazio será retornado.
sequence	Não	String	Número de série de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff

**Tabela 4** Tag
Parâmetro	Obrigatório	Tipo	Descrição
key	Não	String	Chave. O valor contém no máximo 36 caracteres Unicode. O valor da key não pode estar vazio. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas (\) ou sinais de igual (=).
values	Não	Array of strings	Conjunto de valores de tag

**Tabela 5** TagItem
Parâmetro	Obrigatório	Tipo	Descrição
key	Não	String	Chave. O valor contém no máximo 36 caracteres Unicode. O valor da key não pode estar vazio. Ele não pode conter caracteres ASCII (0–31), asteriscos (*), colchetes angulares (< e >), barras invertidas (\) ou sinais de igual (=).
value	Não	String	Valor. Cada valor contém no máximo 43 caracteres Unicode e pode ser uma cadeia vazia. Não pode conter caracteres ASCII (0-31), asteriscos (*), colchetes angulares (< e >), barras invertidas (\), e sinais de igual (=).

Parâmetros de resposta

Código de status: 200

**Tabela 6** Parâmetros de corpo da resposta
Parâmetro	Tipo	Descrição
resources	Array of ActionResources objects	Lista de instâncias de recurso.
total_count	Integer	Número total de recursos.

**Tabela 7** ActionResources
Parâmetro	Tipo	Descrição
resource_id	String	ID do recurso
resource_detail	Secret object	Segredo
resource_name	String	Nome do recurso. Este parâmetro é uma cadeia vazia por padrão.
tags	Array of TagItem objects	Lista de tag. Se não houver nenhuma tag na lista, uma matriz vazia é retornada.

**Tabela 8** Segredo
Parâmetro	Tipo	Descrição
id	String	ID do segredo
name	String	Nome de segredo
state	String	Status de segredo. Seu valor pode ser: ENABLED DISABLED PENDING_DELETE FROZEN
kms_key_id	String	ID da CMK do KMS usado para criptografar valores do segredo
description	String	Descrição de um segredo
create_time	Long	Tempo de criação do segredo. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
update_time	Long	Hora em que um segredo foi atualizado pela última vez. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970).
scheduled_delete_time	Long	Hora em que um segredo será excluído conforme programado. O carimbo de data/hora indica o total de segundos após o início da data da época (1º de janeiro de 1970). Se um segredo não estiver no estado Pending deletion, o valor deste parâmetro é null.

**Tabela 9** TagItem
Parâmetro	Tipo	Descrição
key	String	Chave. O valor contém no máximo 36 caracteres Unicode. O valor da key não pode estar vazio. Não pode conter caracteres ASCII (0-31), asteriscos (*), colchetes angulares (< e >), barras invertidas (\), e sinais de igual (=).
value	String	Valor. Cada valor contém no máximo 43 caracteres Unicode e pode ser uma cadeia vazia. Não pode conter caracteres ASCII (0-31), asteriscos (*), colchetes angulares (< e >), barras invertidas (\), e sinais de igual (=).

Código de status: 400

**Tabela 10** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

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

Código de status: 401

**Tabela 12** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

**Tabela 13** 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 14** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

**Tabela 15** 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 16** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

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

Código de status: 500

**Tabela 18** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

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

Código de status: 502

**Tabela 20** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

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

Código de status: 504

**Tabela 22** Parâmetro do corpo da resposta
Parâmetro	Tipo	Descrição
error	ErrorDetail object	-

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

Exemplo de solicitação

Nenhum

Exemplo de resposta

Nenhum

Código de status

Código de status	Descrição
200	O pedido foi bem-sucedido.
400	Parâmetros de solicitação inválidos.
401	Nome de usuário e senha são necessários para acessar a página solicitada.
403	Autenticação falhou.
404	O recurso solicitado não existe ou não foi encontrado.
500	Erro de serviço interno.
502	Falhou ao concluir a solicitação. O servidor recebe uma resposta inválida do servidor upstream.
504	Gateway expirou o tempo limite.