文档首页/ AI开发平台ModelArts/ API参考/ APP认证管理/ 获取API授权关系列表
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

获取API授权关系列表

功能介绍

获取指定的API与APP授权关系列表，API的认证方式必须是APP认证，管理员可以获取所有API的授权信息，普通用户只能获取自己有访问权限的服务下的API的授权信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/services/{service_id}/app-auth-apis/{api_id}/api-auths

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

service_id

是

String

服务ID。

api_id

是

String

API编号。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

分页展示时，一页展示多少项。默认为1000。

offset

否

String

分页展示时，从第几页开始。默认为0。

app_name

否

String

APP名称，支持模糊查找。

order

否

String

返回的APP列表排序方式，可选值包括asc、desc。默认为asc。

show_only

否

String

APP信息。枚举值如下：

  • AUTH：只显示已授权的APP信息。

  • UNAUTH：只显示未授权的APP信息。

    默认为空，即显示全部可见的APP信息。

sort_by

否

String

返回的APP列表按何属性排序。枚举值如下：

  • app_name：应用名称。

  • created_at：应用创建时间。

  • updated_at：应用更新时间。

    默认为app_name。

workspace_id

否

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

iphertext_enabled

否

Boolean

是否明文展示appsecret。

app_ids

否

Array of strings

明文展示的app_id集合。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

auths

Array of ApiAuthInfo objects

授权信息数组。

count

Integer

查询到的授权信息数量。

total_count

Integer

授权信息总数量。
表4 ApiAuthInfo

参数

参数类型

描述

app

ApigAppDetailInfo object

APP信息。

authed

Boolean

API是否已授权给APP。
表5 ApigAppDetailInfo

参数

参数类型

描述

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类型。枚举值如下：

  • APIC：该APP注册在roma connect网关上

  • APIG：该APP注册在共享API网关上

  • DEDICATE_APIG：该APP注册在专享API网关上

bounded_api_count

Integer

APP绑定API数量。

created_at

Long

APP创建时间。

project_id

String

项目ID。

updated_at

Long

APP更新时间。

user_id

String

APP创建用户ID。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

请求示例

GET https://{endpoint}/v1/{project_id}/services/{service_id}/app-auth-apis/{api_id}/api-auths

响应示例

状态码： 200

OK

{
  "auths" : [ {
    "app" : {
      "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" ],
      "created_at" : 1683173880900,
      "updated_at" : 1700531228874,
      "bounded_api_count" : 28
    },
    "authed" : true
  } ],
  "count" : 1,
  "total_count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： APP认证管理

相关文档