查询API和APP - GetServiceAppAuthApiAuthInfo

功能介绍

查询服务授权的API、APP信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/services/{service_id}/api-auths

表1 路径参数
参数	是否必选	参数类型	描述
service_id	是	String	服务ID
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
workspace_id	否	String	参数解释：工作空间ID。获取方法请参见查询工作空间列表。约束限制：存在并使用的工作空间。取值范围：不涉及。默认取值：“0”。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
enable_app_auth	Boolean	APP是否已授权。
app_auth_api	AppAuthApiAuthInfo object	API已授权的APP的基本信息。

表5 AppAuthApiAuthInfo
参数	参数类型	描述
api_id	String	API编号。
authed_apps	Array of ApigAppDetailInfo objects	API已授权的APP的基本信息。

表6 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。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/services/{service_id}/api-auths

响应示例

状态码：200

{
  "enable_app_auth" : true,
  "app_auth_api" : {
    "api_id" : "string",
    "authed_apps" : [ {
      "app_codes" : [ "1f5f6cb703864cc580d1ba2cdfd77a271a74eee8e5a242e8b5adc009f77a8b2a" ],
      "app_id" : "54d9104db9e7418f9138980da63a857f",
      "app_key" : "151f1f4dfb20445b97326bde3db0c515",
      "app_name" : "app_for_9332aab245ea4d56871e75d6966aa274",
      "app_remark" : "app for user op_svc_modelarts_container0",
      "app_secret" : "0080fa74e6214d0c8d1b2cb01d9d7708",
      "app_type" : "APIG",
      "bounded_api_count" : 0,
      "created_at" : 1574946998167,
      "project_id" : "string",
      "updated_at" : 1574946998167,
      "user_id" : "9332aab245ea4d56871e75d6966aa274"
    } ]
  }
}