DescribePlaybookReleases - Security Center - Alibaba Cloud Documentation Center

Queries a list of published versions of a playbook.

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

yundun-sas:DescribePlaybookReleases

get

*Playbook

acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook.	ac343acc-1a61-4084-9a1c-xxxx
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
PageSize	integer	No	The number of entries per page. Default value: 20. If you do not specify this parameter, 10 entries are returned. Note Specify a value for this parameter.	10
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	3DFBE11C-6EB6-5166-92D6-3397796AFE1E
Records	array<object>	A list of playbook versions.
	object	The version information.
Id	integer	The record ID.	80xxx
GmtCreate	integer	The time when the version was created. This is a 13-digit UNIX timestamp.	1655277397000
GmtModified	integer	The time when the version was last modified. This is a 13-digit UNIX timestamp.	1691460804000
Creator	string	The ID of the Alibaba Cloud account that published the version.	145xxxx985
Description	string	The description of the version.	This is a new version
TaskflowMd5	string	The MD5 hash of the playbook configuration for the published version.	be0a4ef084dd174abe47xxxxx
Page	object	The pagination information.
TotalCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10

Examples

Success response

JSON format

{
  "RequestId": "3DFBE11C-6EB6-5166-92D6-3397796AFE1E",
  "Records": [
    {
      "Id": 0,
      "GmtCreate": 1655277397000,
      "GmtModified": 1691460804000,
      "Creator": "145xxxx985",
      "Description": "This is a new version",
      "TaskflowMd5": "be0a4ef084dd174abe47xxxxx"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.