文档

GetRumApps - 获取RUM应用列表

更新时间:

获取RUM应用列表。

接口说明

用户体验监控目前仅在杭州、新加坡、硅谷提供服务,请选择正确的 Endpoint。

调试

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

授权信息

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

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

请求参数

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

应用 ID。

b590lhguqs@28f515462******
AppGroupstring

应用分组。

default
AppNamestring

应用名称,仅支持传单个名称。

test-app
ResourceGroupIdstring

资源组 ID。

rg-acfmxyexli2****
Tagsarray<object>

标签。

object

标签。

Keystring

标签键。

TestKey
Valuestring

标签值。

TestValue
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

70675725-8F11-4817-8106-CFE0AD71****
Codeinteger

状态码。返回 200 代表成功。

200
Successboolean

操作是否成功:

  • true:成功。
  • false:失败。
true
Messagestring

调用失败时返回的信息。

内部错误,请联系客服。
HttpStatusCodeinteger

HTTP 状态码。

200
AppListarray<object>

应用列表。

object

应用详情。

CreateTimeany

创建时间的时间戳

1685686960872
Namestring

应用名称。

门户首页。
Pidstring

应用 ID。

xxxxx@cc08bdxxxx20b15
Typestring

应用类型,此字段为固定值 RUM。

RUM
NickNamestring

应用别名。

Williamtag
RegionIdstring

地域 ID。

cn-hangzhou
AppTypestring

应用类型,web:Web&H5,miniapp:小程序,ios:iOS,android:Android。

web
Statusstring

应用状态,created:已创建,running:运行中,stopped:停止数据上报。

running
ResourceGroupIdstring

资源组 ID。

rg-acfmzaq3ypaqkdy
Tagsarray<object>

标签列表。

object

标签。

Keystring

标签键。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。

tag1
Valuestring

标签值。

ok
IsSubscriptionboolean

是否收藏,true:收藏,false:未收藏。

true
Descriptionstring

应用描述信息。

测试
PackageNamestring

Android 应用的包名。

com.zy.yxws
Endpointstring

应用数据的上报 endpoint。

xxxxxxxx-default-cn.rum.aliyuncs.com
SlsProjectstring

存储应用数据的 SLS Project 名称。

proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou
SlsLogstorestring

存储应用数据的 SLS Logstore 名称。

logstore-rum
ServiceDomainConfigsarray<object>

服务域名配置列表(当前仅支持移动端应用)

object

服务域名配置

Domainstring

域名或 IP

example.com
Descriptionstring

描述

测试
Tracingstring

是否启用链路追踪(需要开通可观测链路 OpenTelemetry 版),取值:

  • true:启用链路追踪(开启后,将会在该域名请求中插入相关 Header)。

  • false:不启用链路追踪。

true
PropagatorTypesarray

Trace 透传协议列表,开启链路追踪时必传

string

Trace 透传协议,当前仅支持 Skywalking V2、V3,分别对应:sw6、sw8

sw8

示例

正常返回示例

JSON格式

{
  "RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
  "Code": 200,
  "Success": true,
  "Message": "内部错误,请联系客服。",
  "HttpStatusCode": 200,
  "AppList": [
    {
      "CreateTime": "1685686960872",
      "Name": "门户首页。",
      "Pid": "xxxxx@cc08bdxxxx20b15",
      "Type": "RUM",
      "NickName": "Williamtag",
      "RegionId": "cn-hangzhou",
      "AppType": "web",
      "Status": "running",
      "ResourceGroupId": "rg-acfmzaq3ypaqkdy",
      "Tags": [
        {
          "Key": "tag1",
          "Value": "ok"
        }
      ],
      "IsSubscription": true,
      "Description": "测试",
      "PackageName": "com.zy.yxws",
      "Endpoint": "xxxxxxxx-default-cn.rum.aliyuncs.com",
      "SlsProject": "proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou",
      "SlsLogstore": "logstore-rum",
      "ServiceDomainConfigs": [
        {
          "Domain": "example.com",
          "Description": "测试",
          "Tracing": "true",
          "PropagatorTypes": [
            "sw8"
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-12API 内部配置变更,不影响调用查看变更详情