文档首页/ CodeArts IDE Online/ API参考/ API/ 插件管理/ 设置ide实例对插件的授权
更新时间：2023-06-16 GMT+08:00
查看PDF
分享

设置ide实例对插件的授权

功能介绍

设置ide实例对插件的授权。同意、不同意、未知（下次重新询问）

调试

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

URI

POST /v2/extension/authorization/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

CodeArtsIDEOnline实例ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

extension_version

是

String

插件版本

identifier

是

String

插件标识(发布者.插件名)

instance_id

否

String

CodeArtsIDEOnline实例ID

status

是

String

插件状态。

  • AGREE 同意
  • REJECT 不同意
  • UNKNOWN 未知（下次重新询问）

枚举值：

  • AGREE
  • REJECT
  • UNKNOWN

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

Boolean

返回值

status

String

状态

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 406

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

设置插件标识为“redhat.java”，版本为“1.0.1”的插件同意授权。

POST https://{endpoint}/v2/extension/authorization/zhkfjt

{
  "extension_version" : "1.0.1",
  "identifier" : "redhat.java",
  "status" : "AGREE"
}

响应示例

状态码： 200

OK

{
  "result" : true,
  "status" : "success"
}

状态码： 403

Forbidden

{
  "error_msg" : "Instance does not belong to the user or tenant",
  "error_code" : "IDE.00010129"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal Server Error

错误码

请参见错误码。

父主题： 插件管理

相关文档