ListClusterAgentInstallRecords - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the installation records of cluster components.

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

sysom:ListClusterAgentInstallRecords

list

*All Resource

*

None

Request syntax

GET /api/v1/am/agent/list_cluster_agent_install_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
current	integer	No	The current page number (starting from 1).	1
pageSize	integer	No	The number of entries per page.	10
cluster_id	string	No	Filters results by cluster ID. Note This cluster ID is not the ACK cluster ID. It is the `cluster_id` field returned by this operation or the `id` field returned by the ListCluster operation.	cbd80af02b9d6454ebdc579c5e022d0c8
plugin_id	string	No	Specifies the agent ID to filter the installation list. You can use this parameter together with the plugin_version parameter.	74a86327-3170-412c-8e67-da3389ec56a9
plugin_version	string	No	Cannot be used alone. Use this parameter together with plugin_id to filter the installation list by a specific agent version.	3.4.0-1
agent_config_id	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	array<object>	The returned result.
	object	The returned data.
agent_config_id	string
agent_config_name	string
cluster_id	string	The cluster ID. Note This cluster ID is not the ACK cluster ID.	cbf7a37bc905d4682a3338b3744810269
created_at	string	The creation time.	2024-12-25T15:08:19
grayscale_config	string	The grayscale configuration.	{}
plugin_id	string	The component ID.	74a86327-3170-412c-8e67-da3389ec56a9
plugin_version	string	The plug-in version.	3.4.0-1
updated_at	string	The update time.	2024-12-25T15:08:19
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	success
total	integer	The total number of query results.	42

Examples

Success response

JSON format

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": [
    {
      "agent_config_id": "",
      "agent_config_name": "",
      "cluster_id": "cbf7a37bc905d4682a3338b3744810269",
      "created_at": "2024-12-25T15:08:19",
      "grayscale_config": "{}",
      "plugin_id": "74a86327-3170-412c-8e67-da3389ec56a9",
      "plugin_version": "3.4.0-1",
      "updated_at": "2024-12-25T15:08:19"
    }
  ],
  "message": "\nsuccess",
  "total": 42
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.