ListApm-Elasticsearch(ES)-阿里云帮助中心

Queries the list of APM instances.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /openapi/apm HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
description	string	No	The instance name.	APMtest
instanceId	string	No	The instance ID.	apm-cn-i7m2fuae****
output	string	No	The instance ID of the associated Elasticsearch instance.	es-cn-i7m2fsfhc001x****
page	integer	No	The page number of the instance list. Default value: 1.	1
size	integer	No	The paging Settings for the number of entries per page in a paged query. Default value: 20.	10

Response elements

Element	Type	Description	Example
	object	The instance information.
RequestId	string	The request ID.	080D3399-76CF-519D-A540-2C44BC056EB7
Headers	object	The HTTP headers.
X-Total-Count	integer	The number of returned records.	1
Result	array<object>	The result.
	object	The instance details.
createdAt	string	The creation time.	2021-11-16T07:15:51.967Z
deployedReplica	integer	The number of deployed replicas.	1
description	string	The instance name.	APMtest
instanceId	string	The instance ID.	apm-cn-i7m2fuae****
nodeAmount	integer	The number of nodes.	1
outputES	string	The instance ID of the associated Elasticsearch instance.	es-cn-i7m2fsfhc001x****
outputESUserName	string	The username of the associated Elasticsearch instance.	elastic
ownerId	string	The user account ID.	133071096032****
paymentType	string	The billing method. Valid values: postpaid: Pay-as-you-go. prepaid: Subscription.	postpaid
region	string	The region.	cn-hangzhou
replica	integer	The number of replicas.	1
resourceSpec	string	The instance specifications. Valid values: C1M2 (1 vCPU and 2 GB) C2M4 (2 vCPUs and 4 GB)	C1M2
status	string	The lifecycle status. Valid values: creating: Creating. activating: Activating. active: Normal. inactive: Frozen. invalid: Invalid.	active
version	string	The version information.	7.10.2
vpcId	string	The VPC ID.	vpc-bp1530vdhqkamm9s0****
vsArea	string	The zone of the vSwitch.	cn-hangzhou-i
vswitchId	string	The vSwitch ID.	vsw-bp1j1mql6r9g5vfb4****

Examples

Success response

JSON format

{
  "RequestId": "080D3399-76CF-519D-A540-2C44BC056EB7",
  "Headers": {
    "X-Total-Count": 1
  },
  "Result": [
    {
      "createdAt": "2021-11-16T07:15:51.967Z",
      "deployedReplica": 1,
      "description": "APMtest",
      "instanceId": "apm-cn-i7m2fuae****",
      "nodeAmount": 1,
      "outputES": "es-cn-i7m2fsfhc001x****",
      "outputESUserName": "elastic",
      "ownerId": "133071096032****",
      "paymentType": "postpaid",
      "region": "cn-hangzhou",
      "replica": 1,
      "resourceSpec": "C1M2",
      "status": "active",
      "version": "7.10.2",
      "vpcId": "vpc-bp1530vdhqkamm9s0****",
      "vsArea": "cn-hangzhou-i",
      "vswitchId": "vsw-bp1j1mql6r9g5vfb4****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.