All Products
Search
Document Center

Resource Orchestration Service:SetStackPolicy

Last Updated:Feb 22, 2024

Configures a stack policy for a stack.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ros:SetStackPolicyWRITE
  • stack
    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}
    none
none

Request syntax

POST /V2/SetStackPolicy

GET /V2/SetStackPolicy

Request parameters

ParameterTypeRequiredDescriptionExample
StackIdstringYes

The ID of the stack.

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

The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
StackPolicyBodystringNo

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":"*"}]}
StackPolicyURLstringNo

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B288A0BE-D927-4888-B0F7-B35EF84B6E6F
Error codeError messageHTTP status codeDescription
StackValidationFailed{reason}.400The error message returned because the stack validation failed. reason indicates the specific reason.
StackNotFoundThe Stack ({name}) could not be found.404The error message returned because the specified stack does not exist. name indicates the name or ID of the stack.

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history