查询代码配置列表,支持分页、排序和按条件过滤。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
paicodesource:ListCodeSources | list |
|
| 无 |
请求语法
GET /api/v1/codesources HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DisplayName | string | 否 | 代码配置的显示名称,支持模糊匹配。 | MyDataSource |
PageNumber | integer | 否 | 代码配置列表的页码。起始值为 1,默认值为 1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。默认为 20。 | 10 |
SortBy | string | 否 | 用于排序的字段名,取值如下:
| GmtModifyTime |
Order | string | 否 | 分页查询时,对指定的排序字段进行升序或降序,取值如下:
枚举值:
| desc |
WorkspaceId | string | 否 | 工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。 | 1234 |
返回参数
示例
正常返回示例
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-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2021-09-16 | API 内部配置变更,不影响调用 | 查看变更详情 |