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

Obtém um parâmetro comum ou um parâmetro público, incluindo o valor do parâmetro.

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:GetParameter

get

*parameter

acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}

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 (_), e não pode exceder 200 caracteres de comprimento.	MyParameter
ParameterVersion	integer	Não	O número da versão do parâmetro. Valores válidos: 1 a 100.	1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxsn4m*****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	BA326372-2A10-4C3B-BE3E-6439DB7557CC
Parameter	object	As informações do parâmetro.
Type	string	O tipo do parâmetro.	String
UpdatedDate	string	A hora em que o parâmetro foi atualizado pela última vez.	2020-09-01T08:01:43Z
UpdatedBy	string	O usuário que atualizou o parâmetro pela última vez.	root(130900000)
Tags	object	As tags.	{"k1":"v1","k2":"v2"}
Value	string	O valor do parâmetro.	parameter
Description	string	A descrição do parâmetro.	parameter
Constraints	string	As restrições do parâmetro.	'{''AllowedValues":["parameter"],"AllowedPattern":"parameter","MinLength":0,"MaxLength":20}'
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxsn4m*****
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-01T08:01:43Z
ParameterVersion	integer	O número da versão do parâmetro.	1
Name	string	O nome do parâmetro.	MyParameter
Id	string	O ID do parâmetro.	p-4c4b401cab6747xxxxxx
ShareType	string	O tipo de compartilhamento do parâmetro.	Private

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "BA326372-2A10-4C3B-BE3E-6439DB7557CC",
  "Parameter": {
    "Type": "String",
    "UpdatedDate": "2020-09-01T08:01:43Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "parameter",
    "Description": "parameter",
    "Constraints": "'{''AllowedValues\":[\"parameter\"],\"AllowedPattern\":\"parameter\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m*****",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T08:01:43Z",
    "ParameterVersion": 1,
    "Name": "MyParameter",
    "Id": "p-4c4b401cab6747xxxxxx",
    "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.