调用ListApm，查询所有APM Server实例详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/apm HTTP/1.1

请求参数

名称类型位置是否必选示例值描述
名称 类型 位置 是否必选 示例值 描述
description String Query 否 APMtest

实例名称。
instanceId String Query 否 apm-cn-i7m2fuae****

实例ID。
output String Query 否 es-cn-i7m2fsfhc001x****

关联的Elasticsearch实例ID。
page Long Query 否 1

实例列表的页码。默认值：1。
size Long Query 否 10

分页查询时设置的每页条数。默认值：20。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
RequestId String 080D3399-76CF-519D-A540-2C44BC056EB7

请求ID。
Headers Object

消息头。
X-Total-Count Long 1

返回的记录数。
Result Array of object

返回结果。
createdAt String 2021-11-16T07:15:51.967Z

创建时间。
deployedReplica Long 1

已发布的副本数。
description String APMtest

实例名称。
instanceId String apm-cn-i7m2fuae****

实例ID。
nodeAmount Long 1

节点数量。
outputES String es-cn-i7m2fsfhc001x****

关联的Elasticsearch实例ID。
outputESUserName String elastic

关联的Elasticsearch实例用户名。
ownerId String 133071096032****

用户账号ID。
paymentType String postpaid

付费方式，取值如下：

  • postpaid：按量付费。
  • prepaid：包年包月。
region String cn-hangzhou

地域。
replica Long 1

副本数。
resourceSpec String C1M2

规格，取值如下：

  • C1M2（1核2 GB）
  • C2M4（2核4 GB）
status String active

生命周期状态，支持：

  • creating：创建中。
  • activating：生效中。
  • active：正常。
  • inactive：冻结。
  • invalid：失效。
version String 7.10.2

版本信息。
vpcId String vpc-bp1530vdhqkamm9s0****

专有网络ID。
vsArea String cn-hangzhou-i

交换机所在的可用区。
vswitchId String vsw-bp1j1mql6r9g5vfb4****

交换机ID。

示例

请求示例

GET /openapi/apm?description=APMtest&instanceId=apm-cn-i7m2fuae****&output=es-cn-i7m2fsfhc001x****&page=1&size=10 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****"
  } ]
}

错误码

访问错误中心查看更多错误码。