All Products
Search

This Product

    Resource Orchestration Service:DetectStackGroupDrift

    Document Center

    Resource Orchestration Service:DetectStackGroupDrift

    Last Updated:Apr 25, 2024

    Performs drift detection on stack groups to check whether the stack groups have drifted from the expected template 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:DetectStackGroupDriftWRITE
    • stack
      acs:ros:{#regionId}:{#accountId}:stack/{#stackId}
    • stack_group
      acs:ros:{#regionId}:{#accountId}:stack_group/*
      none
    		none

    Request syntax

    POST /V2/DetectStackGroupDrift
    GET /V2/DetectStackGroupDrift

    Request parameters

    ParameterTypeRequiredDescriptionExample
    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 group. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    StackGroupNamestringYes

    The name of the stack group. The name must be unique in a region.

    The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.

    		MyStackGroup
    OperationPreferencesobjectNo

    The operation settings, in JSON format. The following fields are supported:

    • FailureToleranceCount

    The maximum number of stack group operation failures that can occur. In a stack group operation, if the total number of failures does not exceed the FailureToleranceCount value, the operation succeeds. Otherwise, the operation fails.

    If FailureToleranceCount is not specified, the default value 0 is used. You can specify one of FailureToleranceCount or FailureTolerancePercentage parameters, but you cannot specify both of them.

    Valid values: 0 to 20.

    • FailureTolerancePercentage

    The percentage of stack group operation failures that can occur. In a stack group operation, if the percentage of failures does not exceed the FailureTolerancePercentage value, the operation succeeds. Otherwise, the operation fails.

    You can specify one of FailureToleranceCount or FailureTolerancePercentage parameters, but you cannot specify both of them.

    Valid values: 0 to 100.

    • MaxConcurrentCount

    The maximum number of target accounts in which a drift detection operation can be performed at a time.

    You can specify one of MaxConcurrentCount or MaxConcurrentPercentage parameters, but you cannot specify both of them.

    Valid values: 1 to 20.

    • MaxConcurrentPercentage

    The maximum percentage of target accounts in which a drift detection operation can be performed at a time.

    You can specify one of MaxConcurrentCount or MaxConcurrentPercentage parameters, but you cannot specify both of them.

    Valid values: 1 to 100.

    		{"FailureToleranceCount": 1, "MaxConcurrentCount": 2}

    Response parameters

    ParameterTypeDescriptionExample
    object
    OperationIdstring

    The ID of the operation.

    		6da106ca-1784-4a6f-a7e1-e723863d****
    RequestIdstring

    The ID of the request.

    		B288A0BE-D927-4888-B0F7-B35EF84B6E6

    Examples

    Sample success responses

    JSONformat

    {
  "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****",
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-08-15The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.