DescribeProjects--日志服务-火山引擎

文档中心

立即注册

导航

DescribeProjects

最近更新时间：2024.11.22 15:02:50首次发布时间：2022.05.11 11:26:47

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

使用说明

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

请求说明

请求方式：GET
请求地址：https://tls-{Region}.ivolces.com/DescribeProjects

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
PageNumber	Integer	否	`10`	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	`20`	分页大小。默认为 20，最大为 100。
ProjectName	String	否	`test`	日志项目名称，支持模糊匹配。
ProjectId	String	否	`1e2fd27e`	日志项目 ID，支持模糊匹配。
IsFullName	Boolean	否	`true`	根据日志项目名称筛选时，是否精确匹配。 true：精确匹配。 false：（默认）模糊查询。
IamProjectName	String	否	`default`	根据日志项目所属的 IAM 项目进行筛选。精确匹配。
Tags	String	否	`[{\"key\":\"key2\",\"Value\":\"value1\"}]`	根据日志项目标签信息进行筛选。支持的筛选方式请参考根据标签筛选资源。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Projects	Array of ProjectInfo	`/`	日志项目信息。
Total	Integer	`5`	日志项目总数目。

ProjectInfo

参数	类型	示例值	描述
Tags	Array of Tag	`[{"Key":"key1","Value":"value1"}]`	日志项目标签信息。标签用于云资源的标识与分类，您可以将日志项目、日志主题通过标签进行归类，便于资源的搜索和资源聚合。详细说明请参考标签管理。
ProjectId	String	`f**********`	日志项目的 ID。
CreateTime	String	`2021-08-19 11:41:29`	日志项目创建时间。
TopicCount	Integer	`5`	当前日志项目下的日志主题数量。
Description	String	`This is a test project.`	日志项目的简单描述。
ProjectName	String	`test-project`	日志项目名称。
IamProjectName	String	`default`	日志项目所属的 IAM 项目。
InnerNetDomain	String	`tls-cn-beijing.ivolces.com`	私网连接域名。

Tag

参数	类型	示例值	描述
Key	String	`owner`	标签 Key 的值。设置规则请参考标签设置规则。
Value	String	`zhangsan`	标签 Value 的值。设置规则请参考标签设置规则。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeProjects?ProjectName=test&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
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	无效请求参数。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。