調(diào)用DescribeApm,獲取指定APM Server實(shí)例詳情。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求頭
該接口使用公共請(qǐng)求頭,無(wú)特殊請(qǐng)求頭。請(qǐng)參見公共請(qǐng)求參數(shù)文檔。
請(qǐng)求語(yǔ)法
GET /openapi/apm/{instanceId} HTTP/1.1
請(qǐng)求參數(shù)
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
instanceId | String | Path | 是 | apm-cn-2r42fhp5**** |
實(shí)例ID。 |
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 97597D87-8066-5493-B692-5C50DA236D68 |
請(qǐng)求ID。 |
Result | Object |
請(qǐng)求結(jié)果。 |
|
apmServerDomain | String | apm-cn-i7m2fuae****.apm.elasticsearch.aliyuncs.com:8200 |
實(shí)例域名。 |
createdAt | String | 2021-11-16T07:15:51.967Z |
創(chuàng)建時(shí)間。 |
deployedReplica | Long | 1 |
已發(fā)布的副本數(shù)。 |
description | String | APMtest |
實(shí)例名稱。 |
endTime | Long | 4792752000000 |
實(shí)例到期時(shí)間。 |
instanceId | String | apm-cn-i7m2fuae**** |
實(shí)例ID。 |
nodeAmount | Long | 1 |
節(jié)點(diǎn)數(shù)。 |
outputES | String | es-cn-i7m2fsfhc001x**** |
關(guān)聯(lián)的Elasticsearch實(shí)例。 |
outputESUserName | String | elastic |
關(guān)聯(lián)的Elasticsearch實(shí)例的用戶名。 |
ownerId | String | 133071096032**** |
用戶賬號(hào)ID。 |
paymentType | String | postpaid |
付費(fèi)方式,取值如下:
|
region | String | cn-hangzhou |
地域。 |
replica | Integer | 1 |
副本數(shù)。 |
resourceSpec | String | C1M2 |
規(guī)格,取值如下:
|
status | String | active |
生命周期狀態(tài),取值如下:
|
version | String | 7.10.2 |
版本信息。 |
vpcId | String | vpc-bp1530vdhqkamm9s0**** |
專有網(wǎng)絡(luò)ID。 |
vsArea | String | cn-hangzhou-i |
交換機(jī)所在的可用區(qū)。 |
vswitchId | String | vsw-bp1j1mql6r9g5vfb4**** |
交換機(jī)ID。 |
示例
請(qǐng)求示例
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****"
}
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。