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

Obtém um parâmetro criptografado, incluindo seu valor. 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:GetSecretParameter

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
Name	string	Sim	O nome do parâmetro. O nome pode conter letras, dígitos, hifens (-) e sublinhados (_). O nome pode ter até 180 caracteres e não pode começar com ALIYUN, ACS, ALIBABA, ALICLOUD ou OOS.	MySecretParameter
ParameterVersion	integer	Não	O número da versão do parâmetro. Valores válidos: 1 a 100.	1
WithDecryption	boolean	Não	Especifica se o valor do parâmetro deve ser descriptografado. O campo value na resposta é preenchido apenas quando este parâmetro é definido como true. Caso contrário, o campo value fica vazio.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações sobre o parâmetro criptografado.
RequestId	string	O ID da solicitação.	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameter	object	As informações do parâmetro criptografado.
Type	string	O tipo do parâmetro.	Secret
UpdatedDate	string	A hora da última atualização do parâmetro.	2020-09-01T09:35:17Z
UpdatedBy	string	O usuário que atualizou o parâmetro pela última vez.	root(130900000)
KeyId	string	O ID da chave do KMS usada para criptografia.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	As tags.	{"k1": "v1", "k2": "v2"}
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.	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxsn4m4******
CreatedBy	string	O usuário que criou o parâmetro.	root(130900000)
CreatedDate	string	A hora em que o parâmetro foi criado.	2020-09-01T09:28:47Z
ParameterVersion	integer	O número da versão do parâmetro.	1
Name	string	O nome do parâmetro criptografado.	MySecretParameter
Id	string	O ID do parâmetro criptografado.	p-14ed150fdcd048xxxxxx
ShareType	string	O tipo de compartilhamento do parâmetro.	Private
DKMSInstanceId	string	O ID da instância do KMS.	kst-hzz****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:35:17Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "SecretParameter",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:28:47Z",
    "ParameterVersion": 1,
    "Name": "MySecretParameter",
    "Id": "p-14ed150fdcd048xxxxxx",
    "ShareType": "Private",
    "DKMSInstanceId": "kst-hzz****"
  }
}

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.