Configure a stack policy using SetStackPolicy - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Operation description

In this example, a stack policy is configured for a stack deployed in the China (Hangzhou) region whose ID is 4a6c9851-3b0f-4f5f-b4ca-a14bf691****. The URL to the stack policy body is oss://ros/stack-policy/demo.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:SetStackPolicy

update

*stack

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

None

Request syntax

POST /V2/SetStackPolicy HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	Yes	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
StackPolicyBody	string	No	The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length. You can specify one of the StackPolicyBody and StackPolicyURL parameters, but you cannot specify both of them.	{"Statement":[{"Effect":"Allow","Action":"Update:","Principal":"","Resource":"*"}]}
StackPolicyURL	string	No	The URL for the file that contains the stack policy. The URL must point to a template located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. The template can be up to 16,384 bytes in length, and the URL can be up to 1,350 bytes in length. Note If the region of the OSS bucket is not specified, the RegionId value is used. You can specify one of the StackPolicyBody and StackPolicyURL parameters, but you cannot specify both of them.	oss://ros/stack-policy/demo

For more information about common parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F

Error code	Error message	HTTP status code	Description
StackValidationFailed	{reason}.	400	The error message returned because the stack validation failed. reason indicates the specific reason.
StackNotFound	The Stack ({name}) could not be found.	404	The error message returned because the specified stack does not exist. name indicates the name or ID of the stack.

Examples

Success response

JSON format

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.