调用DescribeApm，获取指定APM Server实例详情。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
instanceId String Path 是 apm-cn-2r42fhp5****

实例ID。

返回数据

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

请求ID。
Result Object

请求结果。
apmServerDomain String apm-cn-i7m2fuae****.apm.elasticsearch.aliyuncs.com:8200

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

创建时间。
deployedReplica Long 1

已发布的副本数。
description String APMtest

实例名称。
endTime Long 4792752000000

实例到期时间。
instanceId String apm-cn-i7m2fuae****

实例ID。
nodeAmount Long 1

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

关联的Elasticsearch实例。
outputESUserName String elastic

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

用户账号ID。
paymentType String postpaid

付费方式，取值如下：

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

地域。
replica Integer 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/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****"
  }
}

错误码

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