:Operações de stack

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackName

String

Yes

MyStack

Nome da stack.

O nome pode ter até 255 caracteres e conter dígitos, letras, hifens (-) e sublinhados (_). Deve começar com um dígito ou letra.

--TimeoutInMinutes

Long

Yes

10

Tempo limite para criação da stack.

• Valor padrão: 60.

• Unidade: minutos.

--Parameters.N.ParameterKey

String

No

InstanceId

Nome do parâmetro N. Se você não especificar o nome e o valor de um parâmetro, o Resource Orchestration Service (ROS) usará o nome e o valor padrão definidos no modelo.

Valor máximo de N: 200.

--Parameters.N.ParameterValue

String

No

i-xxxxxx

Valor do parâmetro N.

Valor máximo de N: 200.

--DisableRollback

Boolean

No

false

Define se o rollback deve ser desativado quando a criação da stack falhar.

• true

• false (padrão)

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Estrutura que contém o corpo do modelo. O corpo do modelo deve ter entre 1 e 524.288 bytes.

Se o tamanho do corpo do modelo exceder o limite superior, recomendamos adicionar parâmetros ao corpo da solicitação HTTP POST para evitar falhas causadas por URLs excessivamente longas.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL do arquivo que contém a política da stack. A URL deve apontar para uma política localizada em um servidor web HTTP ou HTTPS, ou em um bucket do Object Storage Service (OSS), como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O arquivo de política pode ter até 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

A URL pode ter até 1.350 bytes.

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Estrutura que contém o corpo da política da stack. O corpo da política deve ter entre 1 e 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

--NotificationURLs.N

RepeatList

No

http://example.com/ros-event

URL de callback para receber o evento N da stack. Apenas HTTP POST é suportado.

• Valor máximo de N: 5.

• Cada URL pode ter até 1.024 bytes.

Quando o status de uma stack muda, o ROS envia uma notificação para a URL especificada. Quando o rollback está ativado para a stack, as notificações são enviadas se a stack estiver no estado CREATE_ROLLBACK ou ROLLBACK, mas não são enviadas se a stack estiver no estado CREATE_FAILED, UPDATE_FAILED ou IN_PROGRESS.

O ROS envia notificações independentemente da configuração da seção Outputs. O código de exemplo a seguir mostra o conteúdo de uma notificação:

{
    "Outputs": [
        {
            "Description": "No description given",
            "OutputKey": "InstanceId",
            "OutputValue": "i-xxx"
        }
    ],
    "StackId": "80bd6b6c-e888-4573-ae3b-93d29113****",
    "StackName": "test-notification-url",
    "Status": "CREATE_COMPLETE"
}

--TemplateURL

String

No

oss://ros-template/demo

URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. O corpo do modelo pode ter até 524.288 bytes.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

Token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o token, mas certifique-se de que ele seja único entre diferentes solicitações.

O token pode ter até 64 caracteres e conter apenas letras, dígitos, hifens (-) e sublinhados (_).

Para obter mais informações, consulte Garantir idempotência.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackName.N

RepeatList

No

MyStack

Nome da stack N.

O nome pode ter até 255 caracteres e conter dígitos, letras, hifens (-) e sublinhados (_). Deve começar com um dígito ou letra. Há suporte para pesquisa difusa com o caractere curinga (*).

Valores válidos de N: 1 a 5.

--Status.N

RepeatList

No

CREATE_COMPLETE

Estado da stack N.

Valores válidos:

• CREATE_IN_PROGRESS

• CREATE_FAILED

• CREATE_COMPLETE

• UPDATE_IN_PROGRESS

• UPDATE_FAILED

• UPDATE_COMPLETE

• DELETE_IN_PROGRESS

• DELETE_FAILED

• DELETE_COMPLETE

• ROLLBACK_IN_PROGRESS

• ROLLBACK_FAILED

• ROLLBACK_COMPLETE

• CHECK_IN_PROGRESS

• CHECK_FAILED

• CHECK_COMPLETE

• REVIEW_IN_PROGRESS

--ParentStackId

String

No

fgce558a-bdd6-d52j-555b-63755971****

ID da stack pai.

--ShowNestedStack

Boolean

No

true

Define se stacks aninhadas devem ser retornadas.

--PageNumber

Long

No

1

Número da página.

• A paginação começa na página 1.

• Valor padrão: 1.

--PageSize

Long

No

10

Número de entradas por página.

• Valor máximo: 100.

• Valor padrão: 10.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID da stack.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

Token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o token, mas certifique-se de que ele seja único entre diferentes solicitações.

O token pode ter até 64 caracteres e conter apenas letras, dígitos, hifens (-) e sublinhados (_).

Para obter mais informações, consulte Garantir idempotência.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-beijing

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID da stack.

--Parameters.N.ParameterKey

String

No

InstanceId

Nome do parâmetro N. Se você não especificar o nome e o valor de um parâmetro, o ROS usará o nome e o valor padrão definidos no modelo.

Valor máximo de N: 200.

--Parameters.N.ParameterValue

String

No

i-xxxxxx

Valor do parâmetro N.

Valor máximo de N: 200.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

Token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o token, mas certifique-se de que ele seja único entre diferentes solicitações.

O token pode ter até 64 caracteres e conter apenas letras, dígitos, hifens (-) e sublinhados (_).

Para obter mais informações, consulte Garantir idempotência.

--StackPolicyDuringUpdateBody

String

No

{"Statement":[{"Effect": "Allow", "Action": "Update:", "Principal": "", "Resource": "*"}]}

Estrutura que contém o corpo da política de substituição temporária da stack. O corpo da política deve ter entre 1 e 16.384 bytes.

Para atualizar recursos protegidos, especifique uma política de substituição temporária durante a atualização. Caso contrário, a política existente associada à stack será usada.

Este parâmetro só tem efeito quando o conjunto de alterações é do tipo UPDATE. Especifique apenas um dos seguintes parâmetros:

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

--TimeoutInMinutes

Long

No

10

Tempo limite para atualização da stack.

• Valor padrão: 60.

• Unidade: minutos.

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Estrutura que contém o corpo do modelo. O corpo do modelo deve ter entre 1 e 524.288 bytes.

Se o tamanho do corpo do modelo exceder o limite superior, recomendamos adicionar parâmetros ao corpo da solicitação HTTP POST para evitar falhas causadas por URLs excessivamente longas.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL do arquivo que contém a política da stack. A URL deve apontar para uma política localizada em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O arquivo de política pode ter até 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

A URL pode ter até 1.350 bytes.

--StackPolicyDuringUpdateURL

String

No

oss://ros-stack-policy/demo

URL do arquivo que contém a política de atualização da stack. A URL deve apontar para uma política localizada em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O arquivo de política pode ter até 16.384 bytes.

A URL pode ter até 1.350 bytes.

Para atualizar recursos protegidos, especifique uma política de substituição temporária durante a atualização. Caso contrário, a política existente associada à stack será usada. Este parâmetro só tem efeito quando o conjunto de alterações é do tipo UPDATE. Especifique apenas um dos seguintes parâmetros:

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Estrutura que contém o corpo da política da stack. O corpo da política deve ter entre 1 e 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

--UsePreviousParameters

Boolean

No

true

Define se os valores especificados na solicitação anterior devem ser usados para os parâmetros não especificados na solicitação atual.

--DisableRollback

Boolean

No

false

Define se o rollback deve ser desativado quando a atualização da stack falhar. Valores válidos:

• true

• false (padrão)

--TemplateURL

String

No

oss://ros-template/demo

URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. O corpo do modelo pode ter até 524.288 bytes.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

A URL pode ter até 1.024 bytes.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-beijing

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackName

String

Yes

MyStack

Nome da stack.

O nome pode ter até 255 caracteres e conter dígitos, letras, hifens (-) e sublinhados (_). Deve começar com um dígito ou letra. Há suporte para pesquisa difusa com o caractere curinga (*).

--TimeoutInMinutes

Long

Yes

10

Tempo limite para criação da stack.

• Valor padrão: 60.

• Unidade: minutos.

--Parameters.N.ParameterValue

String

No

ecs.cm4.6xlarge

Valor do parâmetro N.

Valor máximo de N: 200.

--Parameters.N.ParameterKey

String

No

InstanceType

Nome do parâmetro N. Se você não especificar o nome e o valor de um parâmetro, o ROS usará o nome e o valor padrão definidos no modelo.

Valor máximo de N: 200.

--DisableRollback

Boolean

No

false

Define se o rollback deve ser desativado quando a criação da stack falhar.

• true

• false (padrão)

--TemplateBody

String

No

{ "ROSTemplateFormatVersion": "2015-09-01" }

Estrutura que contém o corpo do modelo. O corpo do modelo deve ter entre 1 e 524.288 bytes.

Se o tamanho do corpo do modelo exceder o limite superior, recomendamos adicionar parâmetros ao corpo da solicitação HTTP POST para evitar falhas causadas por URLs excessivamente longas.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

--StackPolicyURL

String

No

oss://ros-stack-policy/demo

URL do arquivo que contém a política da stack. A URL deve apontar para uma política localizada em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. O arquivo de política pode ter até 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

A URL pode ter até 1.350 bytes.

--StackPolicyBody

String

No

{"Statement": [{"Action": "Update:", "Resource": "", "Effect": "Allow", "Principal": "*"}]}

Estrutura que contém o corpo da política da stack. O corpo da política deve ter entre 1 e 16.384 bytes.

Especifique StackPolicyBody ou StackPolicyURL, mas não ambos simultaneamente.

--TemplateURL

String

No

oss://ros-template/demo

URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP ou HTTPS, ou em um bucket OSS, como oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. O corpo do modelo pode ter até 524.288 bytes.

Especifique TemplateBody ou TemplateURL, mas não ambos simultaneamente.

--ClientToken

String

No

123e4567-e89b-12d3-a456-42665544****

Token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o token, mas certifique-se de que ele seja único entre diferentes solicitações.

O token pode ter até 64 caracteres e conter apenas letras, dígitos, hifens (-) e sublinhados (_).

Para obter mais informações, consulte Garantir idempotência.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff

ID da stack.

--RetainAllResources

Boolean

No

false

Define se os recursos da stack devem ser mantidos.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID da stack.

--CancelType

String

No

Safe

Método para cancelar a atualização da stack. Recomendamos definir DisableRollback como true. Valores válidos:

• Quick: cancela a atualização da stack o mais rápido possível.

• Safe: cancela a atualização da stack da forma mais segura possível.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID da stack.

--RecreatingResources.N

RepeatList

No

WebServer

Recurso N que o ROS continua a criar após a falha na criação do recurso.

Adicione novos recursos à lista de recursos que o ROS continua a criar. O ROS também criará todas as dependências dos novos recursos.

Parameter

Type

Required

Example

Description

--RegionId

String

Yes

cn-hangzhou

ID da região da stack. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

--StackId

String

Yes

4a6c9851-3b0f-4f5f-b4ca-a14bf691****

ID da stack.

--Status.N

RepeatList

No

CREATE_IN_PROGRESS

Estado do recurso N. Valores válidos:

• CREATE_COMPLETE

• CREATE_FAILED

• CREATE_IN_PROGRESS

• DELETE_FAILED

• DELETE_IN_PROGRESS

• ROLLBACK_COMPLETE

• ROLLBACK_FAILED

• ROLLBACK_IN_PROGRESS

--ResourceType.N

RepeatList

No

ALIYUN::ECS::Instance

Tipo de recurso N.

Valor máximo de N: 200.

--PageNumber

Long

No

1

Número da página.

• A paginação começa na página 1.

• Valor padrão: 1.

--PageSize

Long

No

10

Número de entradas por página.

• Valor máximo: 100.

• Valor padrão: 10.