文档

GetProject - 查询项目信息

更新时间:

查询指定项目(Project)的信息,包含基础信息,数据集(Dataset)和文件相关的统计信息等。

接口说明

查询项目信息支持实时获取文件统计信息,通过参数配置开启,详情请见请求参数一栏。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称。获取方式请参见创建项目

test-project
WithStatisticsboolean

是否需要进行文件统计。默认值 false,不需要进行文档统计。

  • 需要进行文件统计。返回 Project 结构体中的 FileCount 和 TotalFileSize 真实有效。

  • 不需要进行文件统计。返回 Project 结构体中的 FileCount 和 TotalFileSize 可能不正确也可能都为 0。

true

返回参数

名称类型描述示例值
object

响应结构体。

RequestIdstring

请求 ID。

5A022F78-B9A8-4ACC-BB6B-B3597553
ProjectProject

项目信息。

示例

正常返回示例

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,
    "Tags": [
      {
        "TagKey": "",
        "TagValue": ""
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
    删除错误码:503
2021-06-15新增 OpenAPI看变更集
  • 本页导读 (1)