文档

ListProjects - 获取项目列表

更新时间:

获取项目列表,支持条件搜索。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/listProjects

请求参数

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

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
extraConditionsstring
  1. 全部项目的搜索条件为: {"conditionGroups":[[{"className":"user","fieldIdentifier":"users","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d...]}],[{"className":"string","fieldIdentifier":"scope","format":"list","operator":"CONTAINS","value":["public"]}]]}
  2. 我管理的项项目条件为: {"conditionGroups":[[{"className":"user","fieldIdentifier":"project.admin","format":"multiList","operator":"CONTAINS","value":["5f2bfdacb69d..."]}]]}
  3. 具体其他的搜索条件,可以参考页面上的项目列表中请求/project/search/list 的搜索参数。
附加过滤条件
conditionsstring

过滤条件

{ "conditionGroups": [ [] ] }
categorystring

项目类型,这里填 Project 即可

Project
nextTokenstring

第一页值不需要填写,后面每一页的值需要从前一次调用结果中获取到此字段,然后获取后面的分页数据

""
maxResultslong

每页最大返回数量,0-200,默认值 20

20
scopestring

公开类型,all/collect,分别代表所有的项目或者我收藏的

all

返回参数

名称类型描述示例值
object
totalCountlong

总数

10
nextTokenstring

分页 Token,没有下一页则为空

""
maxResultslong

每页数量

20
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

error
errorCodestring

错误码

Openapi.RequestError
successboolean

true 或者 false

true
projectsobject []

项目信息

creatorstring

创建人 aliyunPK

19xx7043xxxxxxx914
customCodestring

自定义编号,企业下唯一

OJAY
deleteTimelong

删除时间

null
descriptionstring

描述信息

xxx
gmtCreatelong

创建时间

1640778694000
iconstring

项目封面

https://xxxxxx.png
identifierstring

项目唯一标识符

e8bxxxxxxxxxxxxxxxx23
namestring

项目名称

xxxx
scopestring

公开还是私有

public
typeIdentifierstring

类型 id

null
statusStageIdentifierstring

状态阶段

null
logicalStatusstring

逻辑状态

null
categoryIdentifierstring

资源大类型

Project

示例

正常返回示例

JSON格式

{
  "totalCount": 10,
  "nextToken": "\"\"",
  "maxResults": 20,
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "projects": [
    {
      "creator": "19xx7043xxxxxxx914",
      "customCode": "OJAY",
      "deleteTime": 0,
      "description": "xxx",
      "gmtCreate": 1640778694000,
      "icon": "https://xxxxxx.png",
      "identifier": "e8bxxxxxxxxxxxxxxxx23",
      "name": "xxxx",
      "scope": "public",
      "typeIdentifier": "null",
      "statusStageIdentifier": "null",
      "logicalStatus": "null",
      "categoryIdentifier": "Project"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

  • 本页导读 (0)
文档反馈