Call DetectStackResourceDrift to detect drift in stack resources - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Performs drift detection on resources in a stack to determine whether the resources have drifted from the expected configurations.

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

delete

*stack

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

None

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The value can be up to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (_). For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Yes	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LogicalResourceId	string	Yes	The name of the resource.	ScalingRuleName

Response elements

Element	Type	Description	Example
	object
LogicalResourceId	string	The logical ID of the resource that is defined in the template.	ScalingRule
ResourceDriftStatus	string	The drift status of the resource. Valid values: DELETED: The actual configuration of the resource differs from its expected template configuration because the resource is deleted. MODIFIED: The actual configuration of the resource differs from its expected template configuration. NOT_CHECKED: Resource Orchestration Service (ROS) has not checked whether the actual configuration of the resource differs from its expected template configuration. IN_SYNC: The actual configuration of the resource matches its expected template configuration.	MODIFIED
PropertyDifferences	array<object>	The property drifts of the resource.
	object
ActualValue	string	The actual value of the resource property.	test1
DifferenceType	string	The drift type of the resource property. Valid values: ADD: The property value has been added to a resource property whose data type was Array or List. REMOVE: The property has been deleted from the current resource configuration. NOT_EQUAL: The current property value differs from the expected value defined in the stack template.	NOT_EQUAL
PropertyPath	string	The path of the resource property.	/ScalingRuleName
ExpectedValue	string	The expected value of the resource property that is defined in the template.	test2
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PhysicalResourceId	string	The physical ID of the resource.	asr-2ze4zzc3kf9yz1kd****
ExpectedProperties	string	The JSON-formatted resource properties that are defined in the template.	{"ScalingRuleName": "test2"}
DriftDetectionTime	string	The time when the resource drift detection was initiated.	2020-02-27T07:47:47
ResourceType	string	The type of the resource.	ALIYUN::ESS::ScalingRule
ActualProperties	string	The actual JSON-formatted resource properties.	{"ScalingRuleName": "test1"}
StackId	string	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****

Examples

Success response

JSON format

{
  "LogicalResourceId": "ScalingRule",
  "ResourceDriftStatus": "MODIFIED",
  "PropertyDifferences": [
    {
      "ActualValue": "test1",
      "DifferenceType": "NOT_EQUAL",
      "PropertyPath": "/ScalingRuleName",
      "ExpectedValue": "test2"
    }
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "PhysicalResourceId": "asr-2ze4zzc3kf9yz1kd****",
  "ExpectedProperties": "{\"ScalingRuleName\": \"test2\"}",
  "DriftDetectionTime": "2020-02-27T07:47:47",
  "ResourceType": "ALIYUN::ESS::ScalingRule",
  "ActualProperties": "{\"ScalingRuleName\": \"test1\"}",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.