UpdateStack - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Atualiza as informações de recursos de uma pilha criada.

Descrição da operação

Os valores de Parameters e UsePreviousParameters estão relacionados. Se um parâmetro definido no modelo não for especificado em Parameters:

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

ros:UpdateStack

update

*stack.

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

Modelo.

acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StackId	string	Sim	O ID da pilha.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Este valor de parâmetro é gerado pelo cliente e deve ser globalmente único.	123e4567-e89b-12d3-a456-42665544****
StackPolicyDuringUpdateBody	string	Não	A estrutura do corpo da política de substituição temporária da pilha. O valor deve ter de 1 a 16.384 bytes de comprimento.	{"Statement": [{"Effect": "Allow", "Action": "Update:", "Principal": "", "Resource": "*"}]}
TimeoutInMinutes	integer	Não	O período de tempo limite para atualizar a pilha.	10
TemplateBody	string	Não	A estrutura do corpo do modelo. O valor deve ter de 1 a 524.288 bytes de comprimento. Se o comprimento for grande, recomendamos que você use o método HTTP POST com o parâmetro no corpo da solicitação para evitar falhas na solicitação causadas por uma URL excessivamente longa.	{"ROSTemplateFormatVersion": "2015-09-01"}
StackPolicyURL	string	Não	A URL do arquivo que contém a política da pilha. A URL deve apontar para uma política localizada em um servidor web (HTTP ou HTTPS) ou em um bucket do Alibaba Cloud OSS, como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O tamanho máximo do arquivo é de 16.384 bytes. Se a região do OSS não for especificada, o valor do parâmetro RegionId será usado por padrão.	oss://ros-stack-policy/demo
StackPolicyDuringUpdateURL	string	Não	A URL do arquivo que contém a política da pilha para a atualização. A URL deve apontar para uma política localizada em um servidor web (HTTP ou HTTPS) ou em um bucket do Alibaba Cloud OSS, como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O tamanho máximo do arquivo é de 16.384 bytes.	oss://ros-stack-policy/demo
StackPolicyBody	string	Não	A estrutura do corpo da política da pilha. O valor deve ter de 1 a 16.384 bytes de comprimento.	{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}
UsePreviousParameters	boolean	Não	Especifica se devem ser usados os valores especificados anteriormente para parâmetros que não são passados na solicitação atual.	true
RegionId	string	Sim	O ID da região da pilha. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-beijing
DisableRollback `deprecated`	boolean	Não	[Deprecated] Este parâmetro não tem efeito.
TemplateURL	string	Não	A URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP (HTTP ou HTTPS) ou em um bucket do Alibaba Cloud OSS. O modelo deve ter de 1 a 524.288 bytes de comprimento. Exemplos de URL de bucket do OSS: oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Se a região do OSS não for especificada, o valor do parâmetro RegionId será usado por padrão.	oss://ros-template/demo
RamRoleName	string	Não	O nome da função RAM. O Resource Orchestration Service (ROS) assume a função para criar a pilha e usa as credenciais da função para chamar as APIs de cada serviço em nome do usuário.	test-role
ReplacementOption	string	Não	Especifica se deve ser usada a atualização por substituição. Se uma propriedade de recurso não suportar atualização por modificação, você poderá usar a atualização por substituição para alterar a propriedade do recurso. A atualização por substituição exclui o recurso e o recria. O ID físico do novo recurso é alterado.	Disabled
TemplateId	string	Não	O ID do modelo. Tanto modelos compartilhados quanto modelos privados são suportados.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	Não	A versão do modelo. Este parâmetro entra em vigor apenas quando TemplateId é especificado.	v1
Parameters	array<object>	Não	Os parâmetros.
	object	Não
ParameterKey	string	Sim	O nome do parâmetro. Se você não especificar o nome e o valor de um parâmetro, o ROS usará o valor padrão especificado no modelo.	Amount
ParameterValue	string	Sim	O valor do parâmetro. Valor máximo de N: 200.	12
Tags	array<object>	Não	As tags da pilha.
	object	Não
Key	string	Sim	A chave da tag da pilha.	usage
Value	string	Não	O valor da tag da pilha.	test
Parallelism	integer	Não	O número máximo de recursos simultâneos.	1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazb4ph6aiy****
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma validação. Valores válidos:	false
DryRunOptions	array	Não	A lista de opções de validação. Comprimento máximo da lista: 1.
	string	Não	A opção de validação. Valores válidos:	ParameterAnalysis.ConsiderCondition
TaintResources	array	Não	A lista de recursos a serem marcados como contaminados.
	string	Não	Para pilhas ROS, defina isso como o nome do recurso, como my_vpc.	my_vpc

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
StackId	string	O ID da pilha.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
DryRunResult	object	O resultado da validação. Este parâmetro é retornado apenas quando DryRun está definido como true.
ParametersAllowedToBeModified	array	Os parâmetros que podem ser modificados.
	string	O parâmetro que pode ser modificado. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, a modificação deste parâmetro não causará um erro de validação.	param1
ParametersConditionallyAllowedToBeModified	array	Os parâmetros que podem vir a ser permitidos para modificação.
	string	O parâmetro que pode vir a ser permitido para modificação. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se a modificação deste parâmetro causa um erro de validação depende do valor do parâmetro.	param2
ParametersUncertainlyAllowedToBeModified	array	Os parâmetros cuja permissão de modificação é incerta.
	string	O parâmetro cuja permissão de modificação é incerta. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se a modificação deste parâmetro causa um erro de validação só pode ser determinado em tempo de execução.	param3
ParametersNotAllowedToBeModified	array	Os parâmetros que não podem ser modificados.
	string	O parâmetro que não pode ser modificado. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, um erro de validação será sempre causado.	param4
ParametersCauseInterruptionIfModified	array	A lista de parâmetros que definitivamente causarão interrupção de recursos.
	string	O parâmetro que definitivamente causará interrupção de recursos. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, a interrupção de recursos será sempre causada.	param1
ParametersConditionallyCauseInterruptionIfModified	array	A lista de parâmetros que podem causar interrupção de recursos.
	string	O parâmetro que pode causar interrupção de recursos. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se a modificação deste parâmetro causa interrupção de recursos depende do valor do parâmetro e do comportamento de atualização do recurso.	param2
ParametersUncertainlyCauseInterruptionIfModified	array	A lista de parâmetros cuja probabilidade de causar interrupção de recursos é incerta.
	string	O parâmetro cuja probabilidade de causar interrupção de recursos é incerta. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se este parâmetro causa interrupção de recursos só pode ser determinado em tempo de execução.	param3
ParametersCauseReplacementIfModified	array	A lista de parâmetros que definitivamente causarão atualização por substituição de recursos.
	string	O parâmetro que definitivamente causará atualização por substituição de recursos. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, a atualização por substituição de recursos será sempre causada.	param5
ParametersConditionallyCauseReplacementIfModified	array	A lista de parâmetros que podem causar atualização por substituição de recursos.
	string	O parâmetro que pode causar atualização por substituição de recursos. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se a atualização por substituição de recursos é causada depende do valor do parâmetro.	param6
ParametersUncertainlyCauseReplacementIfModified	array	A lista de parâmetros cuja probabilidade de causar atualização por substituição de recursos é incerta.
	string	O parâmetro cuja probabilidade de causar atualização por substituição de recursos é incerta. Ao atualizar a pilha, se o modelo permanecer inalterado e apenas o valor do parâmetro for modificado, se este parâmetro causa atualização por substituição de recursos só pode ser determinado em tempo de execução.	param7

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
  "DryRunResult": {
    "ParametersAllowedToBeModified": [
      "param1"
    ],
    "ParametersConditionallyAllowedToBeModified": [
      "param2"
    ],
    "ParametersUncertainlyAllowedToBeModified": [
      "param3"
    ],
    "ParametersNotAllowedToBeModified": [
      "param4"
    ],
    "ParametersCauseInterruptionIfModified": [
      "param1"
    ],
    "ParametersConditionallyCauseInterruptionIfModified": [
      "param2"
    ],
    "ParametersUncertainlyCauseInterruptionIfModified": [
      "param3"
    ],
    "ParametersCauseReplacementIfModified": [
      "param5"
    ],
    "ParametersConditionallyCauseReplacementIfModified": [
      "param6"
    ],
    "ParametersUncertainlyCauseReplacementIfModified": [
      "param7"
    ]
  }
}

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.