GetSecretParametersByPath - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

Obtém parâmetros de criptografia por caminho. Certifique-se de ter permissão para chamar a operação da API GetSecretValue do KMS antes de chamar esta operação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

oos:GetSecretParametersByPath

get

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-hangzhou
Path	string	Sim	O caminho do parâmetro. O caminho deve ter menos de 200 caracteres. Por exemplo, para o parâmetro /secretParameter/mySecretParameter, o caminho é /secretParameter.	/secretParameter
Recursive	boolean	Não	Especifica se o caminho deve ser consultado recursivamente. Por exemplo, dados os parâmetros /secretParameter/mySecretParameter e /secretParameter/secretParameter1/mySecretParameter, valores válidos: true: Tanto /secretParameter/mySecretParameter quanto /secretParameter/secretParameter1/mySecretParameter são retornados. false: Apenas /secretParameter/mySecretParameter é retornado.	false
NextToken	string	Não	O token de paginação.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 1 a 10. Valor padrão: 10.	10
WithDecryption	boolean	Não	Especifica se o valor do parâmetro deve ser descriptografado. Valores válidos: true false (padrão)	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	O ID da solicitação.	25156E99-7437-4590-AA58-2ACA17DE405C
TotalCount	integer	O número total de parâmetros de criptografia retornados.	10
MaxResults	integer	O número de entradas por página.	10
Parameters	array<object>	As informações do parâmetro.
	object
Type	string	O tipo do parâmetro.	Secret
UpdatedDate	string	A hora em que o parâmetro foi atualizado pela última vez.	2020-10-21T06:22:48Z
UpdatedBy	string	O usuário que atualizou o parâmetro pela última vez.	root(130900000)
KeyId	string	O ID da chave.	090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex
Value	string	O valor do parâmetro.	secretParameter
Description	string	A descrição do parâmetro.	secretParameter
Constraints	string	As restrições do parâmetro.	{\"AllowedPattern\": \"^[a-g]*$\"}
CreatedBy	string	O usuário que criou o parâmetro.	root(130900000)
CreatedDate	string	A hora em que o parâmetro foi atualizado pela última vez.	2020-10-21T06:22:48Z
ParameterVersion	integer	O número da versão do parâmetro.	1
Name	string	O nome do parâmetro.	mySecretParameter
Id	string	O ID do parâmetro.	p-7cdc0000000000000000
ShareType	string	O tipo de compartilhamento do parâmetro.	Private

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
  "TotalCount": 10,
  "MaxResults": 10,
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-21T06:22:48Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
      "Value": "secretParameter",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedPattern\\\": \\\"^[a-g]*$\\\"}",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-21T06:22:48Z",
      "ParameterVersion": 1,
      "Name": "mySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.