ListPodsOfInstance - Alibaba Cloud Linux - 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

sysom:ListPodsOfInstance

list

*All Resource

*

None

Request syntax

GET /api/v1/am/instance/list_pod_of_instance 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. Default value: 10.	10
cluster_id	string	No	The cluster identifier.	c96e34d74eb6748f3b2a46552d5d653f6
instance	string	No	The instance ID.	i-wz9d00ut2ska3mlyhn6j

If only cluster_id is specified, all pod information in the cluster is queried. If the instance ID is specified, all pod information in the instance is queried.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	The error code.	Success
data	array<object>	The returned data.
	object	The returned data.
namespace	string	The namespace of the pod.	default
pod	string	The pod name.	test-pod
message	string	The error message. An empty value indicates that all data has been read.	instance not exists
total	integer	The maximum number of records returned in this request.	42

Examples

Success response

JSON format

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": [
    {
      "namespace": "default",
      "pod": "test-pod"
    }
  ],
  "message": "instance not exists",
  "total": 42
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.