ComparePlaybooks - Security Center - Alibaba Cloud Documentation Center

Compares configurations between two versions of a published playbook.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:ComparePlaybooks	get	*Playbook `acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note You can call the DescribePlaybooks operation to query the UUIDs of playbooks.	f916b93e-e814-459f-9662-xxxxx
OldPlaybookReleaseId	integer	Yes	The ID of the first version. Note You can call the DescribePlaybookReleases operation to query the IDs of versions. The system automatically generates IDs for new versions.	sflk23423-e814-459f-9662-xxxxx
NewPlaybookReleaseId	integer	Yes	The ID of the second version. Note You can call the DescribePlaybookReleases operation to query the IDs of versions. The system automatically generates IDs for new versions.	sfdf2395-e814-459f-9662-xxxxx
Lang	string	No	The language of the content within the request and response. Valid values: zh (default): Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2EC05B06-BF3C-5F3E-8FE8-3B1FAD76087A
CompareResult	object	The comparison result.
Same	boolean	Indicates whether the configurations of the two versions are the same. Valid values: true false	false
New	boolean	Indicates whether the second version provides more information than the first version. Valid values: true false	true
Description	string	The description of the comparison result.	The first version adds one node compared to the second version

Examples

Sample success responses

JSONformat

{
  "RequestId": "2EC05B06-BF3C-5F3E-8FE8-3B1FAD76087A",
  "CompareResult": {
    "Same": false,
    "New": true,
    "Description": "The first version adds one node compared to the second version"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history