ListPluginsInstances - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the list of instances for plug-in installation, update, or uninstallation.

Operation description

The instance list retrieved by this operation contains only machines that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.

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

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
operation_type	string	Yes	Filters instances by plug-in installation status.	install
plugin_id	string	Yes	Specifies the agent ID to filter the instance list for the specified agent.	74a86327-3170-412c-8e67-da3389ec56a9
region	string	Yes	Filters instances by region.	cn-shenzhen
instance_id_name	string	No	Filters instances by instance ID or instance name. Fuzzy match is supported.	i-bpxx
instance_tag	string	No	Filters instances by instance tag.	{"key":"app","value":"sysom-aliyun-com"}
current	integer	No	The page number for paginated queries. This field indicates the current page.	5
pageSize	integer	No	The number of entries per page. Default value: 10.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
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.
	array<object>	The returned data.
instance_id	string	The instance ID.	i-bp118piqcio9tiwgh84b
instance_name	string	The component instance name.	allowed-repos-qmf8w
instance_tag	array<object>	The instance tags.
	object	The instance tags.
tag_key	string	The tag key.	test_tag_key
tag_value	string	The tag value.	test_tag_value
os_name	string	The operating system name of the instance.	Alibaba Cloud Linux 3.2104 LTS 64 bit
private_ip	string	The private IP address.	1.1.1.1
public_ip	string	The public IP address.	1.1.1.1
region	string	The region where the instance resides.	cn-hangzhou
resource_group_id	string	The resource group ID.	rg-xxxx
resource_group_name	string	The resource group name.	default resource group
message	string	The description.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
request_id	string	The request ID.	35F91AAB-5FDF-5A22-B211-C7C6B00817D0
total	integer	The total number of query results.	42

Examples

Success response

JSON format

{
  "code": "Success",
  "data": [
    {
      "instance_id": "i-bp118piqcio9tiwgh84b",
      "instance_name": "allowed-repos-qmf8w",
      "instance_tag": [
        {
          "tag_key": "test_tag_key",
          "tag_value": "test_tag_value"
        }
      ],
      "os_name": "Alibaba Cloud Linux  3.2104 LTS 64 bit",
      "private_ip": "1.1.1.1",
      "public_ip": "1.1.1.1",
      "region": "cn-hangzhou",
      "resource_group_id": "rg-xxxx",
      "resource_group_name": "default resource group"
    }
  ],
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.