ListApm - APM实例列表

更新时间:
复制 MD 格式

查看APM实例列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /openapi/apm HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

description

string

否

实例名称。

APMtest

instanceId

string

否

实例 ID。

apm-cn-i7m2fuae****

output

string

否

关联的 Elasticsearch 实例 ID。

es-cn-i7m2fsfhc001x****

page

integer

否

实例列表的页码。默认值:1。

1

size

integer

否

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

10

返回参数

名称

类型

描述

示例值

object

实例信息。

RequestId

string

请求 ID。

080D3399-76CF-519D-A540-2C44BC056EB7

Headers

object

消息头。

X-Total-Count

integer

返回的记录数。

1

Result

array<object>

返回结果。

object

实例详细信息。

createdAt

string

创建时间。

2021-11-16T07:15:51.967Z

deployedReplica

integer

已发布的副本数。

1

description

string

实例名称。

APMtest

instanceId

string

实例 ID。

apm-cn-i7m2fuae****

nodeAmount

integer

节点数量。

1

outputES

string

关联的 Elasticsearch 实例 ID。

es-cn-i7m2fsfhc001x****

outputESUserName

string

关联的 Elasticsearch 实例用户名。

elastic

ownerId

string

用户账号 ID。

133071096032****

paymentType

string

付费方式,取值如下:

  • postpaid:按量付费。

  • prepaid:包年包月。

postpaid

region

string

地域。

cn-hangzhou

replica

integer

副本数。

1

resourceSpec

string

规格,取值如下:

  • C1M2(1 核 2 GB)

  • C2M4(2 核 4 GB)

C1M2

status

string

生命周期状态,支持:

  • creating:创建中。

  • activating:生效中。

  • active:正常。

  • inactive:冻结。

  • invalid:失效。

active

version

string

版本信息。

7.10.2

vpcId

string

专有网络 ID。

vpc-bp1530vdhqkamm9s0****

vsArea

string

交换机所在的可用区。

cn-hangzhou-i

vswitchId

string

交换机 ID。

vsw-bp1j1mql6r9g5vfb4****

示例

正常返回示例

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

错误码

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

变更历史

更多信息,参考变更详情。