查询指定项目(Project)的信息,包含基础信息,数据集(Dataset)和文件相关的统计信息等。
接口说明
查询项目信息支持实时获取文件统计信息,通过参数配置开启,详情请见请求参数一栏。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:GetProject | get | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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,
"Tags": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-06-15 | 新增 OpenAPI | 查看变更详情 |