All Products
Search
Document Center

Resource Orchestration Service:DetectStackResourceDrift

Last Updated:Sep 12, 2024

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

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:DetectStackResourceDriftdelete
  • stack
    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StackIdstringYes

The ID of the stack.

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

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****
RegionIdstringYes

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

cn-hangzhou
LogicalResourceIdstringYes

The name of the resource.

ScalingRuleName

Response parameters

ParameterTypeDescriptionExample
object
LogicalResourceIdstring

The logical ID of the resource that is defined in the template.

ScalingRule
ResourceDriftStatusstring

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
PropertyDifferencesarray<object>

The property drifts of the resource.

object
ActualValuestring

The actual value of the resource property.

test1
DifferenceTypestring

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
PropertyPathstring

The path of the resource property.

/ScalingRuleName
ExpectedValuestring

The expected value of the resource property that is defined in the template.

test2
RequestIdstring

The ID of the request.

B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PhysicalResourceIdstring

The physical ID of the resource.

asr-2ze4zzc3kf9yz1kd****
ExpectedPropertiesstring

The JSON-formatted resource properties that are defined in the template.

{"ScalingRuleName": "test2"}
DriftDetectionTimestring

The time when the resource drift detection was initiated.

2020-02-27T07:47:47
ResourceTypestring

The type of the resource.

ALIYUN::ESS::ScalingRule
ActualPropertiesstring

The actual JSON-formatted resource properties.

{"ScalingRuleName": "test1"}
StackIdstring

The ID of the stack.

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

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history