获取App SDK配置 - ShowRumAppSdkConfigJson
功能介绍
根据App应用ID获取SDK采集配置信息(原始接口名称为get-sdk-config-json,用于SDK配置下发)。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getService
Read
-
-
apm:apm2Service:get
-
URI
POST /v2/rum-app/apps/get-sdk-config-json/{app_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_id | 是 | String | 参数解释: App应用ID。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| author | 是 | String | 参数解释: SDK采集授权信息。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。获取方式请参见:获取Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态,成功时返回“success”。 取值范围: 不涉及。 |
| detail | Object | 参数解释: 详情内容,为SDK配置信息或堆栈详情等动态结构。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
/v2/rum-app/apps/get-sdk-config-json/app-xxxxxx?author=authorization
响应示例
状态码:200
{
"status" : "success",
"detail" : {
"logLevel" : "off",
"config" : {
"url" : "https://apm-access.cn-north-7.myhuaweicloud.com",
"appId" : "app-xxxxxx",
"authorization" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"region" : "cn-north-7",
"enableNetwork" : true,
"enableCrash" : true,
"enableLaunch" : true,
"enableANR" : true,
"enableError" : true,
"enableDevice" : true,
"enableEvent" : true,
"traceType" : "otel",
"cacheThreshold" : 30,
"timeInterval" : 60,
"reportLaunch" : false,
"reportBackground" : true,
"uid" : "",
"tag" : "",
"networkWhiteList" : [ ]
}
}
} 状态码:400
{
"error_code" : "apm2.00000005",
"error_msg" : "invalid parameter"
} 状态码:403
{
"error_code" : "apm2.00000004",
"error_msg" : "has no privilege"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 获取SDK配置成功。 |
| 400 | 非法请求,建议根据error_msg检查修改该请求。 |
| 403 | 请求被拒绝访问。 |
错误码
请参见错误码。