创建插件webide工作空间。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:CreatePluginWorkspace |
none |
*全部资源
|
无 | 无 |
请求语法
POST /v1/plugin-workspaces HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求参数。 |
|
| organizationId |
string |
是 |
Codeup 组织 ID(云效 DevOps 组织,前端从 ListPluginRepositories 解析或自建组织后取得) |
664f1e2xxxx |
| repoName |
string |
是 |
仓库名(同时作为插件英文 ID)。后端不校验格式;前端限制 /^(?![-.])[a-z0-9.-]{1,20}(?<![-.])$/,即 1-20 位小写字母/数字/点/连字符,不能以 . 或 - 开头结尾 |
my-custom-plugin |
| workspaceName |
string |
否 |
工作空间名称(插件中文名)。注意:本参数实际为必填项;省略时,API 返回 400 InvalidParameter.IsEmpty。 |
my-plugin |
| gatewayType |
string |
否 |
网关类型,缺省时服务端默认 API |
AI |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
01A02219-8028-57D8-9D60-2D167FF9118E |
| code |
string |
响应状态码。 |
200 |
| message |
string |
响应消息。 |
success |
| data |
object |
响应数据。 |
|
| workspaceId |
string |
工作空间 ID |
plw-xxxxxxxx |
| repoId |
string |
Codeup 仓库 ID(数字字符串) |
12345678 |
示例
正常返回示例
JSON格式
{
"requestId": "01A02219-8028-57D8-9D60-2D167FF9118E",
"code": "200",
"message": "success",
"data": {
"workspaceId": "plw-xxxxxxxx",
"repoId": "12345678"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.IsEmpty | Parameter workspaceName should not be empty. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。