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

文档中心

立即注册

导航

日志服务

DescribeProject

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

调用 DescribeProject 接口查询日志项目信息。

使用说明

本接口用于获取指定日志项目的基本信息。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
ProjectId	String	是	`f3e901c3-b17f-42fd-aa8c-dc91a6c7****`	日志项目的 ID。

返回参数

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

参数	类型	示例值	描述
ProjectName	String	`test-project`	日志项目名称。
ProjectId	String	`f********`	日志项目的 ID。
Description	String	`This is a test project.`	日志项目的描述信息。
CreateTime	String	`2021-08-19 11:41:29`	日志项目创建时间。
InnerNetDomain	String	`tls-cn-beijing.ivolces.com`	私网连接域名。
TopicCount	Integer	`5`	此日志项目下的日志主题数量。
IamProjectName	String	`default`	日志项目所属的 IAM 项目。
Tags	Array of Tag	`[{"Key":"key1","Value":"value1"}]`	日志项目下的标签信息。

Tag

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

请求示例

GET https://tls-{Region}.ivolces.com/DescribeProject?ProjectId=f3********* HTTP/1.1

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	无效请求参数。
404	ErrProjectNotExists	Project does not exist.	日志项目不存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。