更新时间:2024-10-23 GMT+08:00
分享

查询APP的API认证信息

功能介绍

查询APP的API认证信息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

service_id

String

服务ID

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

apis

Array of AuthTypeApiBasicInfo objects

API认证信息列表。

count

Integer

查询数据个数。

total_count

Integer

数据总量。

表5 AuthTypeApiBasicInfo

参数

参数类型

描述

api_id

String

API编号。

api_method

String

请求方式包含GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY,固定返回ANY。

api_name

String

API名称。

api_remark

String

API描述。字符长度不超过255。

auth_type

String

API的认证方式。枚举值如下:

  • NONE:无认证

  • APP:APP认证

  • IAM:IAM认证

predict_url

String

预测地址。

service_id

String

服务编号。

service_name

String

服务名称。

support_app_code

Boolean

是否支持APP CODE。

请求示例

响应示例

状态码: 200

{
  "apis" : [ {
    "api_id" : "528087f0cfec48f7959db7834ee441cb",
    "api_method" : "ANY",
    "api_name" : "testNoneAuth",
    "api_remark" : "string",
    "auth_type" : "APP",
    "predict_url" : "https://3565150c2e5c45d0989be40350dd80ed.apig.xxxxxx.com/test",
    "service_id" : "bb149aac-5ff4-497c-bb73-acb751e20a11",
    "service_name" : "service-hutest",
    "support_app_code" : false
  } ],
  "count" : 1,
  "total_count" : 1
}

状态码

状态码

描述

200

错误码

请参见错误码

相关文档