调用 DescribeProjects 接口查看当前地域下所有日志项目信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PageNumber | Integer | 否 | 10 | 分页查询时的页码。默认为 1,即从第一页数据开始返回。 |
PageSize | Integer | 否 | 20 | 分页大小。默认为 20,最大为 100。 |
ProjectName | String | 否 | test | 日志项目名称,支持模糊匹配。 |
ProjectId | String | 否 | 1e2fd27e | 日志项目 ID,支持模糊匹配。 |
IsFullName | Boolean | 否 |
| 根据日志项目名称筛选时,是否精确匹配。
|
IamProjectName | String | 否 | default | 根据日志项目所属的 IAM 项目进行筛选。精确匹配。 |
Tags | String | 否 | [{\"key\":\"key2\",\"Value\":\"value1\"}] | 根据日志项目标签信息进行筛选。支持的筛选方式请参考根据标签筛选资源。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Projects | Array of ProjectInfo | / | 日志项目信息。 |
Total | Integer | 5 | 日志项目总数目。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Tags | Array of Tag |
| 日志项目标签信息。 |
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 | 私网连接域名。 |
ForbiddenProjectActionList | Array of String | 前端用来判断日志项目是否可创建仪表盘、定时sql等操作 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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. | 服务器内部错误。 |