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

錯誤碼

訪問錯誤中心查看更多錯誤碼。