Use GetStackDriftDetectionStatus to query stack drift detection status - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Operation description

In this topic, the status of a drift detection operation whose ID is a7044f0d-6f2e-4128-a307-4524ef88**** is queried. The operation is performed in the China (Hangzhou) region.

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

get

*stack

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

None

Request syntax

POST /V2/GetStackDriftDetectionStatus HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the stack to be detected for drift. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DriftDetectionId	string	Yes	The ID of the drift detection operation. You can call the ListStackResourceDrifts operation to obtain the ID of the drift detection operation.	a7044f0d-6f2e-4128-a307-4524ef88****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
DriftDetectionTime	string	The time when the stack drift detection operation was initiated.	2020-02-27T07:47:47
DriftDetectionStatusReason	string	The reason why the stack drift detection operation has its current status.	Detect stack drift successfully
DriftedStackResourceCount	integer	The total number of stack resources that have drifted.	1
StackDriftStatus	string	The drift status of the stack. Valid values: DRIFTED: The actual configuration of the stack differs, or has drifted, from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. 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 current configuration of each supported resource matches its expected template configuration. A stack with no resources that support drift detection also has a status of IN_SYNC.	DRIFTED
DriftDetectionStatus	string	The drift detection status. Valid values: DETECTION_COMPLETE: The drift detection operation has been completed for all resources that support drift detection in the stack. DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. DETECTION_IN_PROGRESS: The stack drift detection operation is in progress.	DETECTION_COMPLETE
StackId	string	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
DriftDetectionId	string	The ID of the drift detection operation.	a7044f0d-6f2e-4128-a307-4524ef88****

HTTP status code	Error code	Error message	Description
404	StackDriftDetectionNotFound	The stack drift detection ({ID}) could not be found.	The error message returned because the drift detection does not exist. ID indicates the ID of the drift detection operation.

Examples

Success response

JSON format

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "DriftDetectionTime": "2020-02-27T07:47:47",
  "DriftDetectionStatusReason": "Detect stack drift successfully",
  "DriftedStackResourceCount": 1,
  "StackDriftStatus": "DRIFTED",
  "DriftDetectionStatus": "DETECTION_COMPLETE",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
  "DriftDetectionId": "a7044f0d-6f2e-4128-a307-4524ef88****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.