文档首页/ CodeArts IDE Online/ API参考/ API/ IDE实例管理/ 分发实例给访问者
更新时间：2025-08-14 GMT+08:00
查看PDF
分享

分发实例给访问者

功能介绍

分发实例给访问者。

调试

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

URI

POST /v2/instances/{instance_id}/visitor

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

CodeArtsIDEOnline实例id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Sdk-Date

否

String

参数解释：

请求发起时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

host

否

String

参数解释：

请求host地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

x-security-token

否

String

参数解释：

IAM5.0鉴权token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Authorization

否

String

参数解释：

AK/SK签名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

Boolean

参数解释：

返回IDE实例名，查看实例名状态。

取值范围：

不涉及

status

String

参数解释：

请求响应的状态，表明请求是否成功。

取值范围：

  • success：请求响应成功。

  • error：请求响应失败。

状态码：403

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

状态码：404

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

状态码：406

表6 响应Body参数

参数

参数类型

描述

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实例管理

相关文档