調(diào)用DescribeApm，獲取指定APM Server實例詳情。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

GET /openapi/apm/{instanceId} HTTP/1.1

請求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
instanceId String Path 是 apm-cn-2r42fhp5****

實例ID。

返回數(shù)據(jù)

名稱 類型 示例值 描述
RequestId String 97597D87-8066-5493-B692-5C50DA236D68

請求ID。
Result Object

請求結(jié)果。
apmServerDomain String apm-cn-i7m2fuae****.apm.elasticsearch.aliyuncs.com:8200

實例域名。
createdAt String 2021-11-16T07:15:51.967Z

創(chuàng)建時間。
deployedReplica Long 1

已發(fā)布的副本數(shù)。
description String APMtest

實例名稱。
endTime Long 4792752000000

實例到期時間。
instanceId String apm-cn-i7m2fuae****

實例ID。
nodeAmount Long 1

節(jié)點數(shù)。
outputES String es-cn-i7m2fsfhc001x****

關(guān)聯(lián)的Elasticsearch實例。
outputESUserName String elastic

關(guān)聯(lián)的Elasticsearch實例的用戶名。
ownerId String 133071096032****

用戶賬號ID。
paymentType String postpaid

付費方式，取值如下：

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

地域。
replica Integer 1

副本數(shù)。
resourceSpec String C1M2

規(guī)格，取值如下：

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

生命周期狀態(tài)，取值如下：

  • CREATING：創(chuàng)建中。
  • ACTIVATING：生效中。
  • ACTIVE：正常。
  • INACTIVE：凍結(jié)。
  • INVALID：失效。
version String 7.10.2

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

專有網(wǎng)絡(luò)ID。
vsArea String cn-hangzhou-i

交換機所在的可用區(qū)。
vswitchId String vsw-bp1j1mql6r9g5vfb4****

交換機ID。

示例

請求示例

GET /openapi/apm/apm-cn-2r42fhp5**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式 

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

{
  "RequestId" : "97597D87-8066-5493-B692-5C50DA236D68",
  "Result" : {
    "apmServerDomain" : "apm-cn-i7m2fuae****.apm.elasticsearch.aliyuncs.com:8200",
    "createdAt" : "2021-11-16T07:15:51.967Z",
    "deployedReplica" : 1,
    "description" : "APMtest",
    "endTime" : 4792752000000,
    "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****"
  }
}

錯誤碼

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