DescribeComponentList - Security Center - Alibaba Cloud Documentation Center

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

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note Call the DescribePlaybooks operation to get this parameter.	b724d2b0-3c3b-4223-9bfd-xxxxx
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	B0A255B3-495C-56FB-8B6B-DB073F80388A
Components	string	The component information. The value is a string in the format of a JSON array.	[ { "actions": [ { "description": "mysql component", "name": "storeIdb", "parameters": [ { "description": "update the mysql db", "name": "updateSql", "required": false } ] } ], "basic": { "description": "mysq sql component for 5.6", "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg", "name": "Mysql" } } ]

The Components parameter is in JSON format and includes the following fields:

actions: The executable actions of the component. This parameter is a JSON array that contains the following fields:
- description: The description of the action.
- name: The name of the action.
- parameters: The input parameters for the action. This parameter is a JSON object that contains the following fields:
  - description: The description of the input parameter.
  - name: The name of the input parameter.
  - required: Specifies whether the input parameter is required. A value of true indicates that the parameter is required. A value of false indicates that the parameter is optional.
basic: The basic information about the component. This parameter contains the following fields:
description: The description of the component.
logo: The URL of the component logo.
name: The name of the component.

Examples

Success response

JSON format

{
  "RequestId": "B0A255B3-495C-56FB-8B6B-DB073F80388A",
  "Components": "[\n    {\n        \"actions\": [\n            {\n                \"description\": \"mysql component\",\n                \"name\": \"storeIdb\",\n                \"parameters\": [\n                    {\n                        \"description\": \"update the mysql db\",\n                        \"name\": \"updateSql\",\n                        \"required\": false\n                    }\n                ]\n            }\n        ],\n        \"basic\": {\n            \"description\": \"mysq sql component for 5.6\",\n            \"logo\": \"https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg\",\n            \"name\": \"Mysql\"\n        }\n    }\n]"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.