文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据服务API/ API管理接口/ API授权操作(授权/取消授权/申请/续约)
更新时间：2024-11-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

API授权操作(授权/取消授权/申请/续约)

功能介绍

  • API主动授权： API审核人可发起，API主动授权成功后，在有效期内，APP即可访问该API。API授权包含授权和续约两部分功能。

    • 授权：授权会给予APP在有效期内访问API的权利。

    • 续约：续约会更新授权有效期，仅支持延长有效期，不能减少。

  • API解除授权： API审核人可发起，解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。API解除已授权的APP关系，需要为APP预留至少2天的准备时间。

  • APP解除授权： APP所有者可发起，解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。APP解除自己的授权关系，无需预留准备时间。

  • APP申请授权： APP所有者可发起，APP申请API后，待API的审核人完成审核，APP即可访问该API。授权会给予APP在有效期内访问API的权利，需要API审核。

  • APP申请续约： APP所有者可发起，续约会更新授权有效期，仅支持延长有效期，不能减少，需要API审核。

  • 申请自己的API推荐采用API主动授权/续约，无需审核。

  • 自己的应用推荐采用APP解除授权，无需预留准备时间。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/service/apis/authorize/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

Dlm-Type

否

String

数据服务的版本类型，指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

是

String

消息体的类型（格式），有Body体的情况下必选，没有Body体无需填写。如果请求消息体中含有中文字符，则需要通过charset=utf8指定中文字符集，例如取值为：application/json;charset=utf8。
表3 请求Body参数

参数

是否必选

参数类型

描述

api_id

否

String

API编号。

instance_id

否

String

集群ID编号。

app_id

否

String

APP编号。

apply_type

否

String

申请类型。

枚举值：

  • APPLY_TYPE_AUTHORIZE：API主动授权

  • APPLY_TYPE_API_CANCEL_AUTHORIZE：API取消授权

  • APPLY_TYPE_APP_CANCEL_AUTHORIZE：APP取消授权

  • APPLY_TYPE_APPLY：审核API

  • APPLY_TYPE_RENEW：续约API

time

否

String

截止时间。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

API主动授权/API解除授权/APP解除授权/APP申请授权/APP申请续约。

/v1/0833a5737480d53b2f250010d01a7b88/service/apis/authorize/action

{
  "api_id" : "47046fe7830c1be77cb0dc23bd86afa5",
  "instance_id" : "21398ikjdsjd9087122d4e",
  "app_id" : "908489209a320df61607355c57c82882",
  "apply_type" : "APPLY_TYPE_AUTHORIZE",
  "time" : "2021-01-01T10:00:00.000Z"
}

响应示例

无

状态码

状态码

描述

204

操作API成功。

400

BadRequest。
父主题： API管理接口

相关文档