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

DescribeProject

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

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

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

使用说明

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

URI

请求方法
GET

URI

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

传输协议

HTTPS

URI 请求参数

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

ProjectId

String

必选

f********

日志项目的 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 TagInfo

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

日志项目下的标签信息。详细信息请参考 TagInfo

示例

请求示例

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"
        }
    ]
}

错误码

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

InvalidArgument

400

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

无效请求参数。

ErrProjectNotExists

404

Project does not exist.

日志项目不存在。

InternalServerError

500

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

服务器内部错误。

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