All Products
Search
Document Center

Resource Orchestration Service:ListStackResourceDrifts

Last Updated:Sep 12, 2024

The query token. Set this parameter to the NextToken value returned in the last API call.

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

Request parameters

ParameterTypeRequiredDescriptionExample
StackIdstringYes

The ID of the stack.

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

The physical ID of the resource.

cn-hangzhou
MaxResultslongNo

The time when the resource drift detection operation was initiated.

50
NextTokenstringNo

The type of the resource.

AAAAAdDWBF2****w==
ResourceDriftStatusarrayNo

The resource properties as defined in the template, in JSON format.

stringNo

The drift status of the resource. Valid values:

  • DELETED: The actual configuration of the resource differs from its expected template configuration because the resource had been deleted.
  • MODIFIED: The actual configuration of the resource differs from its expected template configuration.
  • NOT_CHECKED: 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

Response parameters

ParameterTypeDescriptionExample
object
ResourceDriftsarray<object>

The resource drifts.

object
LogicalResourceIdstring

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

ScalingRule
StackIdstring

The stack ID.

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

The physical ID of the resource.

asr-2ze4zzc3kf9yz1kd****
DriftDetectionTimestring

The time when the drift detection operation was performed on the resource.

2020-02-27T07:47:47
ResourceTypestring

The resource type.

ALIYUN::ESS::ScalingRule
ExpectedPropertiesstring

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

{"ScalingRuleName": "test2"}
ResourceDriftStatusstring

The drift state 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 value is added to a resource property whose data type is Array or List.
  • REMOVE: The property is deleted from the current resource configuration.
  • NOT_EQUAL: The current property value differs from the expected value that is 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
ActualPropertiesstring

The actual JSON-formatted resource properties.

{"ScalingRuleName": "test1"}
ModuleInfoobject

The information about the modules from which the resource was created. This parameter is returned only if the resource is created from modules.

LogicalIdHierarchystring

The concatenated logical IDs of one or more modules that contain the resource. The modules are listed from the outermost layer and separated by forward slashes (/).

In the following example, the resource is created from Module B nested within Parent Module A:

moduleA/moduleB

moduleA/moduleB
TypeHierarchystring

The concatenated types of one or more modules that contain the resource. The module types are listed from the outermost layer and separated by forward slashes (/).

In the following example, the resource is created from a module of the MODULE::ROS::Child::Example type that is nested within a parent module of the MODULE::ROS::Parent::Example type:

MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example

MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example
NextTokenstring

The query token returned in this call.

AAAAAdDWBF2****w==
RequestIdstring

The ID of the request.

B288A0BE-D927-4888-B0F7-B35EF84B6E6F

The drift status of the resource.

Examples

Sample success responses

JSONformat

{
  "ResourceDrifts": [
    {
      "LogicalResourceId": "ScalingRule",
      "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
      "PhysicalResourceId": "asr-2ze4zzc3kf9yz1kd****",
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "ResourceType": "ALIYUN::ESS::ScalingRule",
      "ExpectedProperties": "{\"ScalingRuleName\": \"test2\"}",
      "ResourceDriftStatus": "MODIFIED",
      "PropertyDifferences": [
        {
          "ActualValue": "test1",
          "DifferenceType": "NOT_EQUAL",
          "PropertyPath": "/ScalingRuleName",
          "ExpectedValue": "test2"
        }
      ],
      "ActualProperties": "{\"ScalingRuleName\": \"test1\"}",
      "ModuleInfo": {
        "LogicalIdHierarchy": "moduleA/moduleB",
        "TypeHierarchy": "MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example"
      }
    }
  ],
  "NextToken": "AAAAAdDWBF2****w==",
  "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
2023-05-10The response structure of the API has changedView Change Details