资源编排偏差检查相关接口有什么？

调用UpdateStackTemplateByResources接口修正资源栈模板，消除资源栈的偏差。

调用该接口前，需要对资源栈执行过一次成功的偏差检查，并且资源栈处于偏差（DRIFTED）状态。建议设置DryRun为true，预览修改后的模板。如果符合预期，再设置DryRun为false，真正地执行修改。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UpdateStackTemplateByResources 要执行的操作，取值：UpdateStackTemplateByResources。

RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackId String 是 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

DryRun Boolean 否 false 此次请求是否只预览结果。取值：

true：返回修正后的资源栈的模板的内容，并不会修改资源栈的模板。与原模板比较分析后，再判断是否要执行修正。 false（默认）：会直接对资源栈的模板进行修正以消除偏差。 ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。 该值由客户端生成，并且必须是全局唯一的。

仅允许使用大写字母、小写字母、数字、短横线（-）和下划线（_），最多包含64个字符。

说明 更多详情，请参见如何保证幂等性。 TemplateFormat String 否 JSON 返回的模板格式，取值：

JSON（默认） YAML LogicalResourceId.N RepeatList 否 Vpc 资源名列表，用于过滤资源。修正模板时仅涉及列表中的资源。默认修正所有有偏差的资源。

如果被修正的列表中包含偏差状态为DELETED的资源，为了确保修正后模板的正确性，可能会对列表之外但引用了被删除资源的资源进行调整。

返回数据 名称 类型 示例值 描述 NewTemplateBody String 参见返回示例 修正后的模板的内容。

OldTemplateBody String 参见返回示例 修正前的模板的内容。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F 请求ID。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=UpdateStackTemplateByResources &RegionId=cn-hangzhou &StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691**** &<公共请求参数> 正常返回示例

XML 格式

B288A0BE-D927-4888-B0F7-B35EF84B6E6F {"ROSTemplateFormatVersion": "2015-09-01", "Resources": {"Vpc": {"Type": "ALIYUN::ECS::VPC", "Properties": {"VpcName": "test", "CidrBlock": "192.168.0.0/16", "Description": "test2"}}}, "Outputs": {"VpcId": {"Value": {"Fn::GetAtt": ["Vpc", "VpcId"]}}}} {"ROSTemplateFormatVersion": "2015-09-01", "Resources": {"Vpc": {"Type": "ALIYUN::ECS::VPC", "Properties": {"VpcName": "test", "CidrBlock": "192.168.0.0/16", "Description": "test1"}}}, "Outputs": {"VpcId": {"Value": {"Fn::GetAtt": ["Vpc", "VpcId"]}}}} JSON 格式

{ "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F", "NewTemplateBody": "{"ROSTemplateFormatVersion": "2015-09-01", "Resources": {"Vpc": {"Type": "ALIYUN::ECS::VPC", "Properties": {"VpcName": "test", "CidrBlock": "192.168.0.0/16", "Description": "test2"}}}, "Outputs": {"VpcId": {"Value": {"Fn::GetAtt": ["Vpc", "VpcId"]}}}}", "OldTemplateBody": "{"ROSTemplateFormatVersion": "2015-09-01", "Resources": {"Vpc": {"Type": "ALIYUN::ECS::VPC", "Properties": {"VpcName": "test", "CidrBlock": "192.168.0.0/16", "Description": "test1"}}}, "Outputs": {"VpcId": {"Value": {"Fn::GetAtt": ["Vpc", "VpcId"]}}}}" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HTTP

错误码

错误信息

描述

400

StackDriftDetectionNotAvailable

There is no complete drift detection for stack ({ID}).

资源栈没有成功完成过的偏差。ID为资源栈ID。

400

StackAlreadyInSync

This is not need to correct stack drifts, stack ({ID}) is already in sync.

没有必要对资源栈模板进行修正，因为没有偏差。ID为资源栈ID。

400

CorrectStackDriftsFailure

{reason}

无法对资源栈进行修正。reason为原因。

404

StackNotFound

The Stack ({name}) could not be found.

资源栈不存在。name为资源栈名称或ID。

404

ResourceNotFound

The Resource ({name}) could not be found in Stack {stack}.

资源栈中不存某资源。name为资源名，stack为资源栈名称或ID。

调用DetectStackDrift接口对资源栈进行偏差检查。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DetectStackDrift 系统规定参数。取值：DetectStackDrift。

RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackId String 是 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

LogicalResourceId.N RepeatList 否 ScalingRule 资源名列表，用于过滤资源。

ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。此参数值由客户端生成，并且必须是全局唯一的。仅允许ASCII字符，最多可包含64个字符。更多详情，请参见如何保证幂等性。

返回数据 名称 类型 示例值 描述 DriftDetectionId String a7044f0d-6f2e-4128-a307-4524ef88**** 偏差检查ID。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6 请求ID。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=DetectStackDrift &RegionId=cn-hangzhou &StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691**** &<公共请求参数> 正常返回示例

XML 格式

a7044f0d-6f2e-4128-a307-4524ef88**** B288A0BE-D927-4888-B0F7-B35EF84B6E6 JSON 格式

{ "DriftDetectionId": "a7044f0d-6f2e-4128-a307-4524ef88****", "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

404

StackNotFound

The Stack ({name}) could not be found.

资源栈不存在。name为资源栈名称或ID。

404

ResourceNotFound

The Resource ({name}) could not be found in Stack {stack}.

资源栈中不存某资源。name为资源名，stack为资源栈名称或ID。

409

ActionInProgress

Stack {name} already has an action ({action}) in progress.

资源栈在变更中。name为资源栈名称或ID，action为具体的变更操作。

调用DetectStackGroupDrift接口对资源栈组进行偏差检查。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DetectStackGroupDrift 系统规定参数。取值：DetectStackGroupDrift。

RegionId String 是 cn-hangzhou 资源栈组所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一，可以包含数字、英文字母（区分大小写）、连字符、下划线。必须以数字或英文字母开头，且长度不超过255个字符。

ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。此参数值由客户端生成，并且必须是全局唯一的。仅允许ASCII字符，最多可包含64个字符。更多详情，请参见如何保证幂等性。

OperationPreferences Json 否 {"FailureToleranceCount": 1, "MaxConcurrentCount": 2} 操作设置。类型为Json字典。可包含如下字段：

FailureToleranceCount 失败容错数。一个资源栈组操作中，若操作结果的失败总数不超过失败容错数，则操作成功，反之操作失败。

若不指定FailureToleranceCount，则默认为0。不能同时指定FailureToleranceCount和FailureTolerancePercentage。

取值范围：0~20。

FailureTolerancePercentage 失败容错百分比。一个资源栈组操作中，若操作结果的失败百分比不超过失败容错百分比，则操作成功，反之操作失败。

不能同时指定FailureToleranceCount和FailureTolerancePercentage。

取值范围：0~100。

MaxConcurrentCount 最大账号并发数。一个资源栈组操作中，最多能有多少个账号同时执行。

不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。

取值范围：1~20。

MaxConcurrentPercentage 最大账号并发百分比。一个资源栈组操作中，最多能有多少百分比的账号同时执行。

不能同时指定FailureToleranceCount和FailureTolerancePercentage。

取值范围：1~100。

返回数据 名称 类型 示例值 描述 OperationId String 6da106ca-1784-4a6f-a7e1-e723863d**** 操作ID。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6 请求ID。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=DetectStackGroupDrift &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

XML 格式

B288A0BE-D927-4888-B0F7-B35EF84B6E6 6da106ca-1784-4a6f-a7e1-e723863d**** JSON 格式

{ "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

404

StackGroupNotFound

The StackGroup ({name}) could not be found.

资源栈组不存在。name为资源栈组名称。

调用DetectStackResourceDrift接口对资源进行偏差检查。

同步接口。要求资源栈成功进行偏差检查。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DetectStackResourceDrift 系统规定参数。取值：DetectStackResourceDrift。

LogicalResourceId String 是 ScalingRuleName 资源名称。

RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackId String 是 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。此参数值由客户端生成，并且必须是全局唯一的。仅允许ASCII字符，最多可包含64个字符。更多详情，请参见如何保证幂等性。

返回数据 名称 类型 示例值 描述 ActualProperties String {"ScalingRuleName": "test1"} 实际的资源属性，JSON格式。

DriftDetectionTime String 2020-02-27T07:47:47 资源偏差检查时间。

ExpectedProperties String {"ScalingRuleName": "test2"} 模板中定义的资源属性，JSON格式。

LogicalResourceId String ScalingRule 资源逻辑ID，即模板中资源的名称。

PhysicalResourceId String asr-2ze4zzc3kf9yz1kd**** 资源物理ID，即实际资源ID。

PropertyDifferences Array 资源属性偏差。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F 请求ID。

ResourceDriftStatus String MODIFIED 资源偏差状态。取值范围：

DELETED：资源与预期的模板配置不同，因为资源已被删除。 MODIFIED：资源与预期的模板配置不同。 NOT_CHECKED：ROS未检查资源与预期的模板配置是否不同。 IN_SYNC：资源的当前配置与其预期的模板配置相匹配。 ResourceType String ALIYUN::ESS::ScalingRule 资源类型。

StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=DetectStackResourceDrift &LogicalResourceId=ScalingRuleName &RegionId=cn-hangzhou &StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691**** &<公共请求参数> 正常返回示例

XML 格式

{"ScalingRuleName": "test1"} 2020-02-27T07:47:47 {"ScalingRuleName": "test2"} ScalingRule asr-2ze4zzc3kf9yz1kd**** test1 NOT_EQUAL test2 /ScalingRuleName MODIFIED ALIYUN::ESS::ScalingRule 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** JSON 格式

{ "ActualProperties": "{"ScalingRuleName": "test1"}", "DriftDetectionTime": "2020-02-27T07:47:47", "ExpectedProperties": "{"ScalingRuleName": "test2"}", "LogicalResourceId": "ScalingRule", "PhysicalResourceId": "asr-2ze4zzc3kf9yz1kd****", "PropertyDifferences": [ { "ActualValue": "test1", "DifferenceType": "NOT_EQUAL", "ExpectedValue": "test2", "PropertyPath": "/ScalingRuleName" } ], "ResourceDriftStatus": "MODIFIED", "ResourceType": "ALIYUN::ESS::ScalingRule", "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

400

ResourceDriftDetectionProcessing

Drift detection of resource {name} is processing.

已经在对资源进行偏差检查。name为资源名。

400

ResourceDriftDetectionFailure

Fail to detect resource {name} drift: {reason}

资源偏差检查失败。name为资源名，reason为原因。

404

StackNotFound

The Stack ({name}) could not be found.

资源栈不存在。name为资源栈名称或ID。

404

ResourceNotFound

The Resource ({name}) could not be found in Stack {stack}.

资源栈中不存某资源。name为资源名，stack为资源栈名称或ID。

调用GetStackDriftDetectionStatus接口查询偏差检查的状态。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetStackDriftDetectionStatus 系统规定参数。取值：GetStackDriftDetectionStatus。

DriftDetectionId String 是 a7044f0d-6f2e-4128-a307-4524ef88**** 偏差检查ID。

RegionId String 是 cn-hangzhou 偏差检查关联的资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

返回数据 名称 类型 示例值 描述 DriftDetectionId String a7044f0d-6f2e-4128-a307-4524ef88**** 偏差检查ID。

DriftDetectionStatus String DETECTION_COMPLETE 偏差检查状态。取值范围：

DETECTION_COMPLETE：已经对支持偏差检查的资源栈中的所有资源成功完成了资源栈偏差检查。 DETECTION_FAILED：资源栈偏差检查对于资源栈中的至少一个资源失败。 DETECTION_IN_PROGRESS：资源栈偏差检测操作正在进行中。 DriftDetectionStatusReason String Detect stack drift successfully 偏差检查状态原因。

DriftDetectionTime String 2020-02-27T07:47:47 资源栈偏差检查时间。

DriftedStackResourceCount Integer 1 DRIFTED状态资源数。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F 请求ID。

StackDriftStatus String DRIFTED 资源栈偏差状态。取值范围：

DRIFTED：资源栈与预期的模板配置不同，或者已偏离。如果资源栈的一个或多个资源已偏离，则认为资源栈已偏离。 NOT_CHECKED：ROS没有检查资源栈是否与预期的模板配置不同。 IN_SYNC：每个受支持资源的当前配置与其预期的模板配置相匹配。不支持偏差检查资源的资源栈也将具有IN_SYNC状态。 StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=GetStackDriftDetectionStatus &DriftDetectionId=a7044f0d-6f2e-4128-a307-4524ef88**** &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例

XML 格式

a7044f0d-6f2e-4128-a307-4524ef88**** DETECTION_COMPLETE Detect stack drift successfully 2020-02-27T07:47:47 1 DRIFTED 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** JSON 格式

{ "DriftDetectionId": "a7044f0d-6f2e-4128-a307-4524ef88****", "DriftDetectionStatus": "DETECTION_COMPLETE", "DriftDetectionStatusReason": "Detect stack drift successfully", "DriftDetectionTime": "2020-02-27T07:47:47", "DriftedStackResourceCount": 1, "StackDriftStatus": "DRIFTED", "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

404

StackDriftDetectionNotFound

The stack drift detection ({ID}) could not be found.

偏差检查不存在。ID为偏差检查ID。调用ListStackResourceDrifts接口查询资源栈的资源偏差详情。

要求资源栈成功执行过偏差检查。

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListStackResourceDrifts 系统规定参数。取值：ListStackResourceDrifts。

RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackId String 是 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 资源栈ID。

MaxResults Long 否 50 使用NextToken方式查询时，每次最多返回的结果数。

取值范围：1~100。

默认值：50。

ResourceDriftStatus.N RepeatList 否 MODIFIED 资源偏差状态。取值范围：

DELETED：资源与预期的模板配置不同，因为资源已被删除。 MODIFIED：资源与预期的模板配置不同。 NOT_CHECKED：ROS没有检查资源是否与预期的模板配置不同。 IN_SYNC：资源的当前配置与其预期的模板配置相匹配。 NextToken String 否 AAAAAdDWBF2****w== 查询凭证（Token），取值为上一次API调用返回的NextToken参数值。

返回数据 名称 类型 示例值 描述 NextToken String AAAAAdDWBF2****w== 本次调用返回的查询凭证值。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F 请求ID。

ResourceDrifts Array 资源偏差。

示例 请求示例

http(s)://ros.aliyuncs.com/?Action=ListStackResourceDrifts &RegionId=cn-hangzhou &StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691**** &<公共请求参数> 正常返回示例

XML 格式

AAAAAdDWBF2 w== {"ScalingRuleName": "test1"} 2020-02-27T07:47:47 {"ScalingRuleName": "test2"} ScalingRule asr-2ze4zzc3kf9yz1kd test1 NOT_EQUAL test2 /ScalingRuleName MODIFIED ALIYUN::ESS::ScalingRule 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** 8625BB3E-2950-4F3E-A713-5458DB5CD874 JSON 格式

{ "NextToken": "AAAAAdDWBF2w==", "ResourceDrifts": [ { "ActualProperties": "{"ScalingRuleName": "test1"}", "DriftDetectionTime": "2020-02-27T07:47:47", "ExpectedProperties": "{"ScalingRuleName": "test2"}", "LogicalResourceId": "ScalingRule", "PhysicalResourceId": "asr-2ze4zzc3kf9yz1kd", "PropertyDifferences": [ { "ActualValue": "test1", "DifferenceType": "NOT_EQUAL", "ExpectedValue": "test2", "PropertyPath": "/ScalingRuleName" } ], "ResourceDriftStatus": "MODIFIED", "ResourceType": "ALIYUN::ESS::ScalingRule", "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****" } ], "RequestId": "8625BB3E-2950-4F3E-A713-5458DB5CD874" } 错误码 访问错误中心查看更多错误码。

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

400

StackDriftDetectionExpired

The stack drift detection of next token is expired, a new stack drift detection ({ID}) has already completed, please query from the very beginning again.

NextToken对应的偏差检查ID已经失效了，因为一个新的偏差检查已经完成，请重新进行查询。ID为偏差检查的ID。

400

StackDriftDetectionNotAvailable

There is no complete drift detection for stack ({ID}).

资源栈没有成功完成过的偏差。ID为资源栈ID。

404

StackNotFound

The Stack ({name}) could not be found.

资源栈不存在。name为资源栈名称或ID。