GetServiceObservability - 获取应用可观测

获取应用可观测实例

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetServiceObservability

get

*Workspace

acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}

请求语法

GET /workspace/{workspace}/service-observability/{type} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

workspace

string

CMS2.0 工作空间

my-test-ws

type

string

应用可观测类型

枚举值:

  • rum :

    用户体验监控

  • apm :

    应用性能监控

apm

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 ID

4852B9B5-345C-5CBC-A15F-786D83ECCBBA

type

string

应用可观测类型

枚举值:

  • rum :

    rum

  • apm :

    apm

apm

regionId

string

区域

cn-hangzhou

workspace

string

工作空间名称

default-cms-1654218***343050-cn-hangzhou

status

string

资源初始化状态

枚举值:

  • Running :

    正常

Running

entryPointInfo

object

接入点以及认证信息

authToken

string

上报数据的认证 Token

gaddp****@de20f2***1ce***

publicDomain

string

公网访问地址。

project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com

privateDomain

string

私网访问地址

project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com

project

string

SLS Project

proj-xtrace-xxxxx

feeType

string

计费类型

arms=serverless;xtrace=serverless

settings

object

系统配置

string

配置 KV 对

{"trace_aggregate":"enable"}

quotas

object

限额配置

string

限额配置项 Key。

{"arms_agent_hour": "48"}

示例

正常返回示例

JSON格式

{
  "requestId": "4852B9B5-345C-5CBC-A15F-786D83ECCBBA",
  "type": "apm",
  "regionId": "cn-hangzhou",
  "workspace": "default-cms-1654218***343050-cn-hangzhou",
  "status": "Running",
  "entryPointInfo": {
    "authToken": "gaddp****@de20f2***1ce***",
    "publicDomain": "project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com",
    "privateDomain": "project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com",
    "project": "proj-xtrace-xxxxx"
  },
  "feeType": "arms=serverless;xtrace=serverless",
  "settings": {
    "key": "{\"trace_aggregate\":\"enable\"}"
  },
  "quotas": {
    "key": "{\"arms_agent_hour\": \"48\"}"
  }
}

错误码

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

变更历史

更多信息,参考变更详情