解除API对APP的授权 - DeleteApiAppAuth

功能介绍

解除指定的API对APP的授权，请求用户对API所属服务必须有更新权限。同URL：/v1/{project_id}/app-auth/{service_id}/apis/{api_id}/auths

调试

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

授权信息

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

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID。获取方法请参见获取项目ID和名称。
service_id	是	String	API所属的服务ID。
api_id	是	String	API编号。

表2 Query参数
参数	是否必选	参数类型	描述
workspace_id	否	String	工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户token。

表4 请求Body参数
参数	是否必选	参数类型	描述
apps	是	Array of Apps objects	app列表。
workspace_id	否	String	工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

表5 Apps
参数	是否必选	参数类型	描述
app_id	否	String	APP的编号，可通过查询APP列表获取。

响应参数

状态码：200

表6 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

表7 响应Body参数
参数	参数类型	描述
unauth_result	Array of AppAuthResultInfo objects	取消授权结果。

表8 AppAuthResultInfo
参数	参数类型	描述
api_id	String	API的编号。
app_id	String	APP的编号，可通过查询APP列表获取。
auth_id	String	授权编号，授权失败时为空。
reason	String	授权或者取消授权失败原因，授权成功时为空。
success	Boolean	授权或者取消授权是否成功。

状态码：401

表9 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

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

状态码：403

**表11** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

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

请求示例

解除指定的API对APP的授权。

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

{
  "apps" : [ {
    "app_id" : "fb1a9eadd87b48abbd74b8ba1755dffd"
  } ]
}

响应示例

状态码：200

{
  "unauth_result" : [ {
    "api_id" : "logic-api-fe84e858-49ec-41c6-80d7-a34fc22435c2",
    "app_id" : "logic-app-9b9acb40-6df6-4623-9f87-e0dae781d867",
    "success" : true
  } ]
}