文档

ListProjects - 查询所有项目信息

更新时间:

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

接口说明

支持分页查看返回数据:分页查询首页时,仅需设置 MaxResults 以限制返回信息的条目数,返回结果中的 NextToken 将作为查询后续页的凭证。查询后续页时,将 NextToken 参数设置为上一次返回结果中获取到的 NextToken 作为查询凭证,并设置 MaxResults 限制返回条目数。

调试

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

授权信息

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

请求参数

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

返回项目的最大个数,取值范围为 0~200。不设置此参数或者设置为 0 时,则默认值为 100。

100
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。从 NextToken 开始按字典序返回项目信息列表。第一次调用此接口时,设置为空。

MTIzNDU2Nzg6aW1tdGVzdDAx
Prefixstring

列出指定前缀的项目,长度限制为 0~128 字符。

immtest

返回参数

名称类型描述示例值
object

响应结构体。

NextTokenstring

当预期返回的项目总数大于设置的 MaxResults 时,将作为查询后续页的凭证。只有当项目未全部返回时,此参数才有值。

MTIzNDU2Nzg6aW1tdGVzdDAx
Projectsarray

由 Project 组成的数组格式,返回 Project 的信息。

Project

项目信息。

RequestIdstring

请求 ID。

4A7A2D0E-D8B8-4DA0-8127-EB32C660

示例

正常返回示例

JSON格式

{
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDAx",
  "Projects": [
    {
      "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": ""
        }
      ]
    }
  ],
  "RequestId": "4A7A2D0E-D8B8-4DA0-8127-EB32C660"
}

错误码

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

变更历史

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