获取扩展文件列表-GetExtensionFileList
功能介绍
A DRF ViewSet for Extensions.
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:simBatch:list
List
-
-
-
-
URI
GET https://{hostURL}/v2/{project_id}/sim/pm/extensions
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 查询偏移量。 约束限制: 不涉及 取值范围: 大于等于0 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 返回个数上限。 约束限制: 不涉及 取值范围: [0-100] 默认取值: 10 |
| ordering | 否 | String | 参数解释: 查询结果的排序方式。 约束限制: 不涉及 取值范围: 默认升序,-为降序 默认取值: 无 |
| search | 否 | String | 参数解释: 对拓展文件名称进行模糊搜索。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字组成的字符。 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 参数解释: 成员总量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| next | String | 参数解释: 下一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| previous | String | 参数解释: 上一页结果集资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| results | Array of ExtensionsListSrlz objects | 参数解释: 当前页结果集信息。 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 扩展文件资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| id | Integer | 参数解释: 扩展文件ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| status | Integer | 参数解释: 扩展文件状态信息。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及 |
| name | String | 参数解释: 资源名称。 约束限制: 不涉及。 取值范围: 长度为[1-256]个字符,只能包含数字、英文、中文、下划线、中划线、点,且不支持以点结尾。 默认取值: 不涉及 |
| filename | String | 参数解释: 拓展文件名称。 约束限制: 不涉及。 取值范围: 长度为[1-256]个字符,仅限[.py, .json, .zip, .trt, .tar]格式的拓展文件名称。 默认取值: 不涉及 |
| mount_path | String | 参数解释: 挂载目录,需绝对路径。 约束限制: 不涉及 取值范围: 最大长度256位,支持中文,字母,数字及下划线命名,不允许挂载系统目录[/opt, /boot, /dev, /etc, /lib, /proc, /sys, /usr]。 默认取值: 不涉及 |
请求示例
获取扩展文件列表
GET https://{endpoint}/v2/{project_id}/sim/pm/extensions?offset=0&limit=10 响应示例
状态码:200
{
"count" : 1,
"next" : null,
"previous" : null,
"results" : [ {
"url" : "/v2/my_project_id/sim/pm/extensions/46/",
"id" : 46,
"created_at" : 1.699954029767271E9,
"updated_at" : 1.699954030498088E9,
"status" : 0,
"name" : "my-extension-x1",
"filename" : "cus_extension.txt",
"mount_path" : "/home/sim/data"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建成功 |
错误码
请参见错误码。