CodeArts IDE Online
CodeArts IDE Online
- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
-
IDE实例管理
- 查询IDE实例名是否重复 - CheckName
- 查询某个IDE实例 - ShowInstance
- 修改IDE实例 - UpdateInstance
- 删除IDE实例 - DeleteInstance
- 启动IDE实例 - StartInstance
- 停止IDE实例 - StopInstance
- 创建IDE实例 - CreateInstance
- 查询某个租户下的IDE实例列表 - ListOrgInstances
- 创建IDE实例 - CreateIDEInstance
- 创建Shell实例 - CreateShellInstance
- 查询IDE实例列表 - ListInstances
- 外部第三方集成商创建IDE实例 - CreateInstanceBy3rd
- 查询用户是否有权限访问某个IDE实例 - CheckInstanceAccess
- 查询用户是否有权限创建IDE实例 - CheckCreateInstancePermission
- 刷新IDE实例活跃状态 - UpdateInstanceActivity
- 查询某个IDE实例的状态 - ShowInstanceStatusInfo
- 分发实例给访问者 - AssociateInstance
- 技术栈管理
- 模板管理
- 帐号权限管理
- 插件管理
-
插件市场
- 获取指定文件下载地址 - DownloadExtensionFile
- 上传插件 - UploadExtensionFile
- 查询插件列表 - ListExtensions
- 查询插件详细信息 - ShowExtensionDetail
- 查询插件评价 - ShowExtensionEvaluation
- 查询插件评星 - ShowExtensionEvaluationStar
- 添加插件评论 - AddExtensionEvaluation
- 添加评论回复、回复评论回复 - AddExtensionEvaluationReply
- 举报评论,举报回复 - CheckMaliciousExtensionEvaluation
- 删除回复 - DeleteEvaluationReply
- 删除评论 - DeleteEvaluation
- 添加新评星 - AddExtensionStar
- 查询插件分类 - ShowCategoryList
- 获取当前用户下的发布商列表 - ListPublisher
- 文件上传归一化 - UploadFilePublisher
- 获取插件检测结果 - ShowExtensionTestingResult
- 插件发布 - PublishExtension
-
IDE实例管理
- 应用示例
- 权限策略和授权项
- 附录
- 历史API
- 文档修订记录
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
分发实例给访问者 - AssociateInstance
功能介绍
分发实例给访问者
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/instances/{instance_id}/visitor
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
CodeArtsIDEOnline实例id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Sdk-Date |
否 |
String |
请求发起时间。 |
host |
否 |
String |
请求host地址。 |
x-security-token |
否 |
String |
The security token that users must pass to the service API to use the temporary credentials. |
Authorization |
否 |
String |
AK/SK签名。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Boolean |
返回值 |
status |
String |
状态 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码:406
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
分发实例给访问者
GET https://{endpoint}/v2/instances/mqeizqalebc0k28/visitor
响应示例
状态码:200
OK
{
"result" : true,
"status" : "success"
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
403 |
Forbidden |
404 |
Not Found |
406 |
Not Acceptable |
错误码
请参见错误码。
父主题: IDE实例管理