查询指定项目(Project)的信息,包含基础信息,数据集(Dataset)和文件相关的统计信息等。
接口说明
查询项目信息支持实时获取文件统计信息,通过参数配置开启,详情请见请求参数一栏。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 项目名称。获取方式请参见创建项目。 | test-project |
WithStatistics | boolean | 否 | 是否需要进行文件统计。默认值false,不需要进行文档统计。
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "5A022F78-B9A8-4ACC-BB6B-B3597553",
"Project": {
"ProjectName": "immtest",
"ServiceRole": "AliyunIMMDefaultRole",
"TemplateId": "Official:AllFunction",
"CreateTime": "2021-06-29T14:50:13.011643661+08:00",
"UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
"Description": "测试项目",
"ProjectQueriesPerSecond": 100,
"EngineConcurrency": 100,
"ProjectMaxDatasetCount": 1000000000,
"DatasetMaxBindCount": 10,
"DatasetMaxFileCount": 100000000,
"DatasetMaxEntityCount": 10000000000,
"DatasetMaxRelationCount": 100000000000,
"DatasetMaxTotalFileSize": 90000000000000000,
"DatasetCount": 5,
"FileCount": 10,
"TotalFileSize": 100000
}
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | param_error | param error |
404 | not_found | The resource can not be found |
500 | internal_error | Internal error |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-06-15 | 新增 OpenAPI |