获取APP列表
功能介绍
获取APIG APP基本信息列表，用户只能获取自己创建的APP信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/app-auth/apps
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_name |
否 |
String |
APP名称。 |
|
limit |
否 |
String |
分页展示时，一页展示多少项。默认为1000。 |
|
offset |
否 |
String |
分页展示时，从第几页开始。默认为0。 |
|
order |
否 |
String |
返回的APP列表排序方式，可选值包括asc、desc。默认为asc。 |
|
sort_by |
否 |
String |
返回的APP列表按何属性排序，可选值包括app_name、created_at、updated_at。默认为name。 |
|
workspace_id |
否 |
String |
工作空间id。 |
|
iphertext_enabled |
否 |
Boolean |
是否明文展示appsecret。 |
|
app_ids |
否 |
Array |
需要明文展示的app_id集合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
消息体的类型。设置为text/plain，返回临时预览链接。设置为application/octet-stream，返回临时下载链接。 |
|
X-Auth-Token |
是 |
String |
用户token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apps |
Array of ApigAppDetailInfo objects |
APP基础信息数组，可能为空数组。 |
|
count |
Integer |
查询到的APP数量。 |
|
total_count |
Integer |
APP总数量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
app_codes |
Array of strings |
APP Code列表，当APP类型为APIC时，此参数为空。 |
|
app_id |
String |
APP编号。 |
|
app_key |
String |
APP的key。 |
|
app_name |
String |
APP名称。 |
|
app_remark |
String |
APP描述，默认为空。不超过200个字符。 |
|
app_secret |
String |
APP密钥。 |
|
app_type |
String |
APP类型。枚举值如下：
|
|
bounded_api_count |
Integer |
APP绑定API数量。 |
|
created_at |
Long |
APP创建时间。 |
|
project_id |
String |
项目ID。 |
|
updated_at |
Long |
APP更新时间。 |
|
user_id |
String |
APP创建用户ID。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
ModelArts错误码。 |
|
error_msg |
String |
具体错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
ModelArts错误码。 |
|
error_msg |
String |
具体错误信息。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
ModelArts错误码。 |
|
error_msg |
String |
具体错误信息。 |
请求示例
GET https://{endpoint}/v1/{project_id}/app-auth/apps
响应示例
状态码： 200
OK
{
"apps" : [ {
"app_id" : "fb1a9eadd87b48abbd74b8ba1755dffd",
"app_name" : "app_13e0",
"app_remark" : "ds",
"app_key" : "b11ae87581b04b5284aa92b0d4ae332c",
"app_secret" : "cb5d1b57368b4f129b635332a03bf0e3",
"user_id" : "04f258c8fb00d42a1f65c00df88cc4dc",
"project_id" : "04f258c84780d5a52f3bc00dc15aa5e7",
"app_type" : "APIG",
"app_codes" : [ "53a7c6de82be4671b93414adf98c1c507d5cef29fbdd48d88a4dddb668b0f0ad", "3b5930537438461b9a3e81e5f21d56b49eadbe1047174574b9d2dde859beec54", "55804013463d4344ac37775ff8f6e9d8343933f8f0be420cb2e87bb5aad4c6a3" ],
"created_at" : 1683173880900,
"updated_at" : 1703160524345,
"bounded_api_count" : 29
} ],
"count" : 1,
"total_count" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
