WorkspaceCodePublish - 工作空间代码部署

更新时间:
复制为 MD 格式

工作空间代码部署接口。这是个异步接口,请求返回一个key,请根据key查询 WorkspaceActionStatus接口获取状态

接口说明

发布工作空间的代码

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

部署操作的工作空间 ID(数字 ID)

12345678

Config

string

部署的配置,json string。 repos 列表为工作空间内的 git repo,主要是设置发布的 branch; exclude 指定哪些目录跳过

{"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

job

Key

string

会话回放历史的 Key

ws-xxxx-xxxxxx

Message

string

错误信息,在接口失败时,返回具体错误信息,成功时则为空

Failed to deploy,repo branch empty

RequestId

string

请求 ID

67E910F2-4B62-5B0C-ACA3-7547695C****

HttpStatusCode

integer

HTTP 状态码。

200

ErrorCode

string

错误码

UnknownError

Success

boolean

请求是否成功

true

示例

正常返回示例

JSON格式

{
  "Data": {
    "Key": "ws-xxxx-xxxxxx"
  },
  "Message": "Failed to deploy,repo branch empty",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情