文档

ListCodeSources - 获取代码配置列表

更新时间:

查询代码配置列表,支持分页、排序和按条件过滤。

调试

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

授权信息

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

请求语法

GET /api/v1/codesources

请求参数

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

代码配置的显示名称,支持模糊匹配。

MyDataSource
PageNumberinteger

代码配置列表的页码。起始值为 1,默认值为 1。

1
PageSizeinteger

分页查询时设置的每页行数。默认为 20。

10
SortBystring

用于排序的字段名,取值如下:

  • GmtModifyTime:代码源修改时间。
  • DisplayName:展示名称。
  • CodeSourceId:代码源 ID。
  • GmtCreateTime(默认值):代码源创建时间。
GmtModifyTime
Orderstring

分页查询时,对指定的排序字段进行升序或降序,取值如下:

  • ASC(默认值):升序。
  • DESC:降序。
枚举值:
  • ascasc
  • descdesc
desc
WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

1234

返回参数

名称类型描述示例值
object

返回结构体。

CodeSourcesarray

代码源配置列表。

CodeSourceItem

代码配置详情。

TotalCountlong

符合过滤条件的代码源配置的总数量。

2
RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941

示例

正常返回示例

JSON格式

{
  "CodeSources": [
    {
      "CodeSourceId": "code-20210111103721-85qz78ia96lu",
      "DisplayName": "MyCodeSourceName1",
      "Description": "code source of dlc examples",
      "CodeRepo": "https://code.aliyun.com/pai-dlc/examples.git",
      "CodeBranch": "master",
      "CodeCommit": "44da109b59f8596152987eaa8f3b2487bb72ea63",
      "CodeRepoUserName": "user",
      "CodeRepoAccessToken": "",
      "Accessibility": "PUBLIC",
      "UserId": "1157290171663117",
      "WorkspaceId": "1234",
      "GmtCreateTime": "2021-01-18T12:52:15Z",
      "GmtModifyTime": "2021-01-18T12:52:15Z",
      "MountPath": "/root/code/"
    }
  ],
  "TotalCount": 2,
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-09API 内部配置变更,不影响调用查看变更详情
2021-09-16API 内部配置变更,不影响调用查看变更详情