接口功能介绍
查询层列表
接口约束
无
URI
GET /openapi/v1/layers
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageIndex | 是 | Integer | 页码 | 1 | |
| pageSize | 是 | Integer | 分页大小 | 20 | |
| search | 是 | String | 模糊查询的关键字，默认为空 | ||
| orderBy | 是 | String | 排序字段名，需要排序的字段名，默认按名称 | ||
| order | 是 | String | ASC升序，DESC降序，默认降序 | ASC | |
| scope | 是 | String | all 代表所有层（包括公共层），custom 代表自定义层 | all |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | test |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码,0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码 | CF_0 | |
| message | String | 信息 | ||
| returnObj | Object | 返回实体 | Data |
表 ReturnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 分页数据 | Data | |
| pagination | Object | 分页信息 | Pagination |
表 Pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageIndex | Integer | 页码 | 1 | |
| pageSize | Integer | 每页大小 | 10 | |
| total | Integer | 总记录数 | 100 |
表 Data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| layerName | String | 层名 | ||
| acl | Integer | 0 表示私有层，1 表示官方层 | ||
| region | String | 资源池编号 | ||
| version | Integer | 版本 | ||
| description | String | 版本描述信息 | ||
| compatibleRuntime | Array of Strings | 版本运行时环境列表 | ||
| ctrn | String | 版本唯一标识 | ||
| code | Object | 版本代码配置 | Code | |
| codesize | Integer | 代码大小 | ||
| codeChecksum | String | 代码校验码 | ||
| createTime | String | 版本创建时间 | ||
| tenantId | Integer | 租户 ID |
表 Code
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ossBucketName | String | oss的bucket | ||
| ossObjectName | String | oss的name |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/layers
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"data": [
{
"acl": 0,
"region": "bb9fdb42056f11eda1610242ac110002",
"code": {
"ossBucketName": "faas-grey",
"ossObjectName": "layer/7000/4d422615-fda0-4ade-ac28-da282cb14c1b"
},
"codeChecksum": "\"2b10d2191b9fbf984148d678ef1df00e\"",
"codeSize": 537,
"compatibleRuntime": [
"python3.10"
],
"createTime": "2024-10-08T17:26:38.339568+08:00",
"description": "test",
"imageName": "faas/7000_OpenApitest:1",
"layerName": "OpenApitest",
"license": "",
"version": 1,
"ctrn": "ctrn:cf:bb9fdb42056f11eda1610242ac110002:5f0fcf217f174c6ca837701f954fb902:layers/OpenApitest/versions/1",
"tenantId": 7000
},
{
"acl": 0,
"region": "bb9fdb42056f11eda1610242ac110002",
"code": {
"ossBucketName": "faas-grey",
"ossObjectName": "layer/7000/274c2180-03fb-4ae8-b076-e3a82dedd18a"
},
"codeChecksum": "\"0d31275c61c64ee51a6ca9a3bbffbf21\"",
"codeSize": 29719379,
"compatibleRuntime": [
"java11"
],
"createTime": "2024-09-26T20:16:36.742944+08:00",
"description": "heddfdf",
"imageName": "faas/7000_dfsfds:1",
"layerName": "dfsfds",
"license": "",
"version": 1,
"ctrn": "ctrn:cf:bb9fdb42056f11eda1610242ac110002:5f0fcf217f174c6ca837701f954fb902:layers/dfsfds/versions/1",
"tenantId": 7000
}
],
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 2
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
