1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取符号制品上传临时凭证。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSymbolArtifactUploadCredential。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Kind | 是 | String | 制品类型。取值:js_sourcemap、ios_dsym、macos_dsym、windows_pdb、android_mapping、android_native、system_symbol。 示例值:js_sourcemap |
| FileName | 是 | String | 上传文件名。 示例值:demo.min.js |
| AppId | 否 | String | 应用 ID。应用级制品必填;system_symbol 不传。 示例值:** |
| ProjectId | 否 | String | 兼容别名,未传 AppId 时使用。 示例值:** |
| Release | 否 | String | 保留字段,请勿传入。 示例值:npm-demo-1.0.6-ip202 |
| Dist | 否 | String | 保留字段,请勿传入。 示例值:* |
| MinifiedUrl | 否 | String | 保留字段,请勿传入。 示例值:http://127.0.0.1:4173/demo.min.js |
| FileType | 否 | String | 保留字段,请勿传入。 示例值:minified |
| DebugId | 否 | String | 保留字段,请勿传入。 示例值:ab-12 |
| BuildId | 否 | String | 保留字段,请勿传入。 示例值:abc-123 |
| AppVersion | 否 | String | 保留字段,请勿传入。 示例值:1.0.6 |
| Platform | 否 | String | 保留字段,请勿传入。 示例值:Windows |
| OS | 否 | String | 系统名称。 示例值:Windows |
| OSVersion | 否 | String | 系统版本。 示例值:11.0.1 |
| StorePath | 否 | String | 保留字段,请勿传入。 示例值:a.txt |
| ContentType | 否 | String | 文件内容类型,如 application/json。 示例值:application/json |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 上传临时凭证,JSON 格式字符串。 示例值:{"bucket":"*","cos_key":"*","cos_url":"*","expiration":"*","expired_time":0,"region":"*","session_token":"*","start_time":0,"sts_request_id":"*","tmp_secret_id":"*","tmp_secret_key":"*"} |
| ErrorMsg | String | 错误信息 示例值:{"Code":"InvalidParameter","Message":"Kind native_symbol is closed; use ios_dsym / macos_dsym / windows_pdb"} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取上传凭证
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSymbolArtifactUploadCredential
<公共请求参数>
{
"Kind": "js_sourcemap",
"FileName": "demo.min.js",
"AppId": "******",
"Release": "npm-demo-1.0.6-ip202",
"MinifiedUrl": "http://127.0.0.1:4173/demo.min.js",
"FileType": "minified",
"ContentType": "application/json",
"ProjectId": "******"
}
输出示例
{
"Response": {
"Result": "{\"bucket\":\"***************\",\"cos_key\":\"sourcemaps/146683/npm************ip202/_/dbff70a41************41998988***************\",\"cos_url\":\"https://*********************************************/sourcemaps/**************************************************************************\",\"expiration\":\"2026-07-09T07:27:12Z\",\"expired_time\":1783582032,\"region\":\"ap-guangzhou\",\"session_token\":\"Ei1QfCjWZztAZjAQ5rCjGh3UhKCuOXEac820d4ce2306e4254c91e150f5f4d86agyNg2CfPAt14Y8ptEsPGv5IlhYPGDMDhR3k6x42eaCbnTWE7NH2ywBHGj8tAwbEDl4i4xP26mo_yA3PlHOldoG6mI-RsqaKl70lYMDk3f2bjFbiYuXs3e-mEo4VA-28u97axxVo_kdBjTSzTzV1EJgfmXlf1wsOHel2889OoFoNX4J9phsQXR0K2HCdkRshVKtiod6isuqYKQ0UEhPasRzK38bykpgRt_CS3LgWwlIwSEdyOtlnW8L5nVBgpcYfLVqwF2YflB_unCTjSIrgvAUSQxSzOH08VaLcUhUlns1LeAO3OO4DOMnxovOlGcKUXBbXsC0IYTwWgvZjSGa6QpOwNewq_14mygI7oKHXkxOjIT7PahynTGnxFjBXxomz9gyPPpD0ebmvt5mjOofL_8RyJFWm89eVzzBkU2nHiRxxFnQbx8m8p9L2aOaMOvN_GWhHVZySnkyn8PfE5mLz3FSsVERgULcK4iVYgW5Lfd8qrx9u3Nc1IroWHaemYXNGUBQGseutONRoNUyvGdivNpHCKXxhH_rQ7n6wZn5_WsimzYlJyNdXtjxt_H4_XIXonDEzTqK5sXXkgfDNq8IThGkOp9gH_BwwjGxzktRgOzMeGt8FAj_7QEDW1SFRPlvyr2F9_WeMDQZEKByDKIqA2vF8v5xWrOQc_OAISp1LQ5Wbsb21GC-zyOVGi6BEKLL1RktxwAE1RDtk0ZZVWA8hOSg\",\"start_time\":1783581132,\"sts_request_id\":\"d8d12df1-40c4-4ad8-9187-041cfae1b8f7\",\"tmp_secret_id\":\"********************************************************************\",\"tmp_secret_key\":\"********************************************\"}",
"RequestId": "7101c383-3be4-4cd1-85d3-5d8f94e59882"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未CAM授权 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ChargeNoBalance | 计费相关 - 账户余额不足。 |
| FailedOperation.ChargeNoPayRight | 计费相关 - 账户没有付费权限。 |
| FailedOperation.ChargeParamInvalid | 计费相关 - 计费参数无效。 |
| FailedOperation.ClsCallFail | CLS调用失败 |
| FailedOperation.DataBaseException | 数据操作异常 |
| FailedOperation.InfrastructureError | 第三方依赖异常。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.NoInstance | 实例不存在 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |