功能介绍
1.1.7 Edge 应用管理
1.1.7.3 查询应用列表
功能介绍
查询应用列表
URI
GET /v1/{project_id}/v2x-edge-apps
表1-55 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 参数说明:项目ID。获取方法请 参见 获取项目ID。
取值范围:仅支持数字,a到f的 小写字母组合,长度32。
正则匹配:^[0-9a-f]{32}$
表1-56 Query 参数
参数 是否必选 参数类型 描述
edge_app_id 否 String 参数说明:应用唯一ID。
取值范围:只允许字母、数字、
下划线(_)、连接符(-)、美 元符号($)的组合。
最小长度:1 最大长度:32
参数 是否必选 参数类型 描述
offset 否 Integer 参数说明:分页查询时的页码。
最小值:0 最大值:10000 缺省值:0
limit 否 Integer 参数说明:每页记录数。
最小值:1 最大值:100 缺省值:10
请求参数
表1-57 请求 Header 参数
参数 是否必选 参数类型 描述
Instance-Id 否 String 参数说明:实例ID。dris物理实 例的唯一标识。获取方法参见获
取Instance-Id。
取值范围:仅支持数字,小写字 母和连接符(-)的组合,长度 36。
正则匹配:^[a-z0-9-]{36}$
X-Auth-Token 否 String 参数说明:用户Token,Token 认证鉴权时必选。通过调用IAM 服务 获取IAM用户Token接口 获取,接口返回的响应消息头中
“X-Subject-Token”就是需要 获取的用户Token。简要的获取 方法样例请参见 Token认证。
最小长度:1 最大长度:20000
响应参数
状态码: 200
表1-58 响应 Body 参数
参数 参数类型 描述
count Long 参数说明:总记录数。
最小值:0
最大值:1000000 edge_apps Array of
QueryApplica tionBriefResp onseDTO objects
参数说明:列举每条记录。
表1-59 QueryApplicationBriefResponseDTO
参数 参数类型 描述
edge_app_id String 参数说明:用户自定义应用唯一ID。
取值范围:只允许字母、数字、下划线(_)、连 接符(-)、美元符号($)的组合。
最小长度:1 最大长度:32
description String 参数说明:应用描述。
取值范围:只允许中文、字母、数字、下划线
created_time String 参数说明:创建时间。
最小长度:0 最大长度:255 last_modified
_time String 参数说明:更新时间。
最小长度:0 最大长度:255 last_published
_version String 参数说明:最新发布版本。
最小长度:0 最大长度:64
请求示例
GET https://{endpoint}/v1/{project_id}/v2x-edge-apps?
edge_app_id=14729446815072419760762234026232&offset=0&limit=10 Content-Type:application/json
X-Auth-Token:********
Instance-Id:********
响应示例
状态码: 200 OK
{ "count" : 1, "edge_apps" : [ {
"edge_app_id" : "10691172132537970614092038885766", "description" : "this is a test app",
"created_time" : "2021-12-23T12:21:55", "last_modified_time" : "2021-12-23T12:21:55", "last_published_version" : null
} ] }
状态码
状态码 描述
200 OK
400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
405 Method Not Allowed 409 Conflict
429 Too Many Requests 500 Internal Server Error
错误码
请参见错误码。
URI
PUT /v1/{project_id}/v2x-edge-apps/{edge_app_id}
表1-60 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 参数说明:项目ID。获取方法请 参见 获取项目ID。
取值范围:仅支持数字,a到f的 小写字母组合,长度32。
正则匹配:^[0-9a-f]{32}$
edge_app_id 是 String 参数说明:用户自定义应用唯一 ID。
取值范围:只允许字母、数字、
下划线(_)、连接符(-)、美 元符号($)的组合。
最小长度:1 最大长度:32
请求参数
表1-61 请求 Header 参数
参数 是否必选 参数类型 描述
Instance-Id 否 String 参数说明:实例ID。dris物理实 例的唯一标识。获取方法参见获
取Instance-Id。
取值范围:仅支持数字,小写字 母和连接符(-)的组合,长度 36。
正则匹配:^[a-z0-9-]{36}$
X-Auth-Token 否 String 参数说明:用户Token,Token 认证鉴权时必选。通过调用IAM 服务 获取IAM用户Token接口 获取,接口返回的响应消息头中
“X-Subject-Token”就是需要 获取的用户Token。简要的获取 方法样例请参见 Token认证。
最小长度:1 最大长度:20000
表1-62 请求 Body 参数
参数 是否必选 参数类型 描述
description 否 String 参数说明:应用描述。
取值范围:只允许中文、字母、
数字、下划线(_)、中文分号
(;)、中文冒号(:)、中文 问号(?)、中文感叹号(!)
中文逗号(,)、中文句号
(。)、英文引号(;)、英文 冒号(:)、英文逗号(,)、英 文句号(.)、英文问号(?)、
英文感叹号(!)、顿号
(、)、连接符(-)的组合。
最小长度:0 最大长度:255
正则匹配:^[a-zA-Z0-9_;:?!,;:、,.?!。\-\s
\u4e00-\u9fa5]*$
响应参数
状态码: 200
表1-63 响应 Body 参数
参数 参数类型 描述
edge_app_id String 参数说明:用户自定义应用唯一ID。
取值范围:只允许字母、数字、下划线(_)、连 接符(-)、美元符号($)的组合。
最小长度:1 最大长度:32
description String 参数说明:应用描述。
取值范围:只允许中文、字母、数字、下划线
(_)、中文分号(;)、中文冒号(:)、中文 问号(?)、中文感叹号(!)中文逗号
(,)、中文句号(。)、英文引号(;)、英文 冒号(:)、英文逗号(,)、英文句号(.)、英 文问号(?)、英文感叹号(!)、顿号(、)、
连接符(-)的组合。
最小长度:0
参数 参数类型 描述
created_time String 参数说明:创建时间。
最小长度:0 最大长度:255 last_modified
_time String 参数说明:更新时间。
最小长度:0 最大长度:255 last_published
_version String 参数说明:最新发布版本。
最小长度:0 最大长度:64
请求示例
PUT https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}
Content-Type:application/json X-Auth-Token:********
Instance-Id:********
{ "description" : "this is a test app"
}
响应示例
状态码: 200 Ok
{ "edge_app_id" : "13125481330735066213121901779837", "description" : "this is a test app",
"created_time" : "2021-12-23T12:29:08",
"last_modified_time" : "2021-12-23T12:29:09.367", "last_published_version" : null
}
状态码
状态码 描述
200 Ok
400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
405 Method Not Allowed 409 Conflict
状态码 描述
429 Too Many Requests 500 Internal Server Error
错误码
请参见错误码。