GetService - 查询应用可观测服务

查询应用可观测服务

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetService

get

*Service

acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/service/{#ServiceId}

请求语法

GET /workspace/{workspace}/service/{serviceId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

workspace

string

工作空间名称。

workspace-test

serviceId

string

服务 ID。

cwzxvuc6uo@4bc6b15ad81f166174ffb

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

requestId

string

请求 ID

264C3E89-BE6E-5F82-A484-CE9C2196C7DC

service

object

服务对象。

serviceId

string

服务 ID。

cwzxvuc6uo@4bc6b15ad81f166174ffb

serviceName

string

服务名称

demo-app

createTime

string

创建时间

2025-05-13T03:32:55Z

serviceType

string

服务类型。

枚举值:

  • TRACE :

    TRACE

  • RUM :

    RUM

  • XTRACE :

    XTRACE

TRACE

serviceStatus

string

服务状态,仅当 serviceType=RUM 时有效。

Running

displayName

string

显示名称,仅当 serviceType=RUM 时有效。

demo应用

regionId

string

区域 ID

cn-heyuan

workspace

string

工作空间名称

default-cms-1106439496876715-cn-hangzhou

pid

string

兼容历史的 ARMS 应用 ID

by6rjzro2j@0fe8dfa799e5906

description

string

描述,仅当 serviceType=RUM 时有效。

test

attributes

string

扩展信息。

{"language":"java"}

示例

正常返回示例

JSON格式

{
  "requestId": "264C3E89-BE6E-5F82-A484-CE9C2196C7DC",
  "service": {
    "serviceId": "cwzxvuc6uo@4bc6b15ad81f166174ffb\n",
    "serviceName": "demo-app",
    "createTime": "2025-05-13T03:32:55Z",
    "serviceType": "TRACE",
    "serviceStatus": "Running",
    "displayName": "demo应用",
    "regionId": "cn-heyuan",
    "workspace": "default-cms-1106439496876715-cn-hangzhou",
    "pid": "by6rjzro2j@0fe8dfa799e5906",
    "description": "test",
    "attributes": "{\"language\":\"java\"}"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

404 InvalidService.NotFound The specified Service does not exist.

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

变更历史

更多信息,参考变更详情