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

Performs drift detection on a resource to determine whether the resource has drifted from its expected template configuration.

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 stack ID.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be globally unique. 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 DescribeRegions to query the most recent region list.	cn-hangzhou
LogicalResourceId	string	Yes	The resource name.	ScalingRuleName

Response elements

Element	Type	Description	Example
	object
LogicalResourceId	string	The logical ID of the resource, which is the resource name defined in the template.	ScalingRule
ResourceDriftStatus	string	The drift status of the resource. Valid values: DELETED: The resource differs from its expected template configuration because the resource has been deleted. MODIFIED: The resource differs from its expected template configuration. NOT_CHECKED: Resource Orchestration Service (ROS) has not checked whether the resource differs from its expected template configuration. IN_SYNC: The current configuration of the resource matches its expected template configuration.	MODIFIED
PropertyDifferences	array<object>	The property differences 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: A value has been added to a resource property whose data type is array or list. REMOVE: The property has been removed 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 as defined in the template.	test2
RequestId	string	The request ID.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PhysicalResourceId	string	The physical ID of the resource, which is the actual resource ID.	asr-2ze4zzc3kf9yz1kd****
ExpectedProperties	string	The resource properties defined in the template, in JSON format.	{"ScalingRuleName": "test2"}
DriftDetectionTime	string	The time when drift detection was performed on the resource, in the YYYY-MM-DDThh:mm:ss format.	2020-02-27T07:47:47
ResourceType	string	The resource type.	ALIYUN::ESS::ScalingRule
ActualProperties	string	The actual resource properties, in JSON format.	{"ScalingRuleName": "test1"}
StackId	string	The stack ID.	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.