查询IDE实例对插件的授权情况
功能介绍
查询IDE实例对插件的授权情况,同意授权的插件能在ide实例内携带登录用户的token调用第三方服务。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/extension/authorization
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
extension_version |
是 |
String |
参数解释: 插件版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
identifier |
是 |
String |
参数解释: 插件标识(发布者.插件名)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: CodeArts IDE Online实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Sdk-Date |
否 |
String |
参数解释: 请求发起时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
host |
否 |
String |
参数解释: 请求host地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
x-security-token |
否 |
String |
参数解释: IAM5.0鉴权token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
Authorization |
否 |
String |
参数解释: AK/SK签名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Object |
返回值 |
|
status |
String |
参数解释: 请求响应的状态,表明请求是否成功。 取值范围:
|
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
|
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
|
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:406
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
|
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:500
请求示例
查询插件实例授权
GET https://{endpoint}/v2/extension/authorization?instance_id=***&identifier=redhat.java&extension_version=1
响应示例
状态码:200
OK
{
"result" : {
"identifier" : "redhat.java",
"instance_id" : "***",
"extension_version" : "1.0.1",
"status" : "AGREE"
},
"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 |
错误码
请参见错误码。