ListInstancesEcsInfoList - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

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

get

*All Resource

*

None

Request syntax

GET /api/v1/am/instance/listInstancesEcsInfoList HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
region	string	Yes	The region used to filter instances.	cn-shenzhen
info_type	string	Yes	The type of information to retrieve.	ip
managed_type	string	No	The management status of the instance.	managed
instance_id	string	No	Specifies the instance ID to filter the Agent installation status of the specified instance.	i-bp118piqcio9tiwgh84b
plugin_id	string	No	Specifies the component ID to filter the instance information list for the corresponding component.	74a86327-3170-412c-8e67-da3389ec56a9

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The error code.	SysomOpenAPI.InvalidParameter
data	array<object>	The returned data.
	object	The returned results.
ip	string	The IP address of the machine.	11.193.52.91
tag_key	string	The tag name.	sysom
tag_value	string	The tag value.	diagnosis
type	string	The IP address type.	public
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error message.	""

Examples

Success response

JSON format

{
  "code": "SysomOpenAPI.InvalidParameter",
  "data": [
    {
      "ip": "11.193.52.91",
      "tag_key": "sysom",
      "tag_value": "diagnosis",
      "type": "public"
    }
  ],
  "message": "\"\""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.