1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取项目列表(实例创建的团队下的项目列表)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProjects。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Limit | 是 | Integer | 分页每页数目,整型 示例值:20 |
Offset | 是 | Integer | 分页页码,整型 示例值:1 |
Filters.N | 否 | Array of Filter | 过滤参数;demo模式传{"Name": "IsDemo", "Values":["1"]} |
IsDemo | 否 | Integer | 该参数已废弃,demo模式请在Filters内注明 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 列表总数 示例值:0 |
ProjectSet | Array of RumProject | 项目列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取 RUM 应用列表
获取 RUM 应用列表
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects
<公共请求参数>
{
"Limit": 20,
"Offset": 1
}
输出示例
{
"Response": {
"TotalCount": 0,
"ProjectSet": [],
"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
}
}
示例2 根据过滤条件获取 RUM 应用列表
根据过滤条件获取 RUM 应用列表
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects
<公共请求参数>
{
"Limit": 20,
"Filters": [
{
"Values": [
"'测试项目名2'",
"'测试项目名'"
],
"Name": "'Name'"
}
],
"Offset": 1
}
输出示例
{
"Response": {
"TotalCount": 0,
"ProjectSet": [],
"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.NoInstance | 实例不存在 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |