GetServiceObservability - 获取应用可观测

获取应用可观测实例

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:GetServiceObservabilityget
*Workspace
acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}

请求语法

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

请求参数

名称类型必填描述示例值
workspacestring

CMS2.0 工作空间

my-test-ws
typestring

应用可观测类型

枚举值:
  • rum用户体验监控
  • apm应用性能监控
apm

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

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

应用可观测类型

枚举值:
  • rumrum
  • apmapm
apm
regionIdstring

区域

cn-hangzhou
workspacestring

工作空间名称

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

资源初始化状态

枚举值:
  • Running正常
Running
entryPointInfoobject

接入点以及认证信息

authTokenstring

上报数据的认证 Token

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

公网访问地址。

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

私网访问地址

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

SLS Project

proj-xtrace-xxxxx
feeTypestring

计费类型

arms=serverless;xtrace=serverless
settingsobject

系统配置

string

配置 KV 对

{"trace_aggregate":"enable"}
quotasobject

限额配置

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
    }
  }
}

错误码

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

settIngs 系统配置支持如下:

  • trace_aggregate : enable / disable,用于开源探针接入场景控制是否关闭指标生成