You need to enable JavaScript to run this app.
导航

DescribeProjects

最近更新时间2023.11.13 16:31:26

首次发布时间2022.05.11 11:26:47

调用 DescribeProjects 接口查看当前地域下所有日志项目信息。

使用说明

本接口用于列举当前用户在当前地域的所有日志项目信息。支持分页查询、按偏移量查询、按日志项目名称和 ID 模糊查询。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeProjects

传输协议

HTTPS

URI 请求参数

参数
参数类型
是否必选
示例值

说明

PageNumber

Integer

可选

10

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Integer

可选

20

分页大小。默认为 20,最大为 100。

ProjectName

String

可选

test

日志主题名称,支持模糊匹配。

说明

不支持同时指定 ProjectName 和 ProjectId。

IsFullName

Boolean

可选

true

根据 ProjectName 筛选时,是否精确匹配。

  • true:精确匹配。
  • false:(默认)模糊查询。

ProjectId

String

可选

1e2fd27e

日志主题 ID,支持模糊匹配。

说明

不支持同时指定 ProjectName 和 ProjectId。

IamProjectName

String

可选

default

根据日志项目所属的 IAM 项目进行筛选。精确匹配。

Tags

Array of TagInfo

可选

[{"Key":"key1",
"Value":"value1"}]

根据日志主题标签信息进行筛选。详细信息请参考 TagInfo。支持的筛选方式请参考根据标签筛选资源

响应参数

参数
类型
示例值
描述

Projects

Array of ProjectInfo

/

日志项目信息。详细信息请参考 ProjectInfo

Total

Integer

5

日志项目总数目。

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeProjects?ProjectName=test&ProjectId=12345&PageNumber=1&PageSize=20&IsFullName=false&IamProjectName=default&Tags=[{"Key":"key1","Value":"value1"}]HTTP/1.1

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
...
{
    "Projects": [
        {
            "ProjectId": "a1*******",
            "ProjectName": "test1",
            "Description": "test1",
            "CreateTime": "2022-03-14 20:59:21",
            "TopicCount": 0,
            "InnerNetDomain": "tls-cn-beijing.ivolces.com",
            "IamProjectName":"default",
            "Tags":[
                {
                    "Key": "key1",
                    "Value": "value1"
                }
            ]
        }
    ],
    "Total": 1
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

无效请求参数。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码