通過OpenAPI創建變更。
適用版本 | 企業標準版 |
服務接入點與授權信息
獲取服務接入點，替換 API 請求語法中的 <domain> ：服務接入點（domain）。
獲取個人訪問令牌，具體操作，請參見獲取個人訪問令牌。
產品 | 資源 | 所需權限 |
應用交付 | 變更 | 讀寫 |
請求語法
POST https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/changeRequests請求頭
參數 | 類型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 個人訪問令牌。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 示例值 |
appName | string | path | 是 | 應用名。 | my-web-service |
organizationId | string | path | 是 | 組織 ID。 | ec766e63aee3437d9a51f334d6exxxxx |
- | object | body | 否 | 創建變更請求。 | |
appCodeRepoSn | string | body | 是 | 應用代碼倉庫標識符。 | cebf021afe6848578c97a1f6a253xxxx |
autoDeleteBranchWhenEnd | boolean | body | 是 | 變更結束時候是否自動刪除分支。 | false |
branchName | string | body | 是 | 應用代碼分支名稱。 | master |
createBranch | boolean | body | 是 | 是否創建分支。 | false |
ownerId | string | body | 否 | 變更負責人。 | 1c83bd48e254405fb27297ee1fb8xxxx |
title | string | body | 是 | 變更標題。 | title-xxxx |
請求示例
curl -X 'POST' \
'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exxxxx/apps/my-web-service/changeRequests' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"appCodeRepoSn": "cebf021afe6848578c97a1f6a253xxxx",
"autoDeleteBranchWhenEnd": false,
"branchName": "master",
"createBranch": false,
"ownerId": "1c83bd48e254405fb27297ee1fb8xxxx",
"title": "title-xxxx"
}'返回參數
參數 | 類型 | 描述 | 示例值 |
- | object | 變更信息。 | |
appCodeRepoSn | string | 代碼倉庫唯一標識。 | cebf021afe6848578c97a1f6a253xxxx |
appName | string | 應用名。 | my-web-service |
autoDeleteBranchWhenEnd | boolean | 結束后是否自動刪除分支。 | true |
branch | string | 變更代碼分支。 | master |
creatorId | string | 創建者云效 id。 | creator-id-xxx |
gmtCreate | string | 創建時間。 | 2024-09-01 00:00:00 |
gmtModified | string | 修改時間。 | 2024-09-01 00:00:00 |
name | string | 變更名稱。 | name-xxx |
originBranch | string | 代碼分支源分支。 | master |
originBranchRevisionSha | string | 代碼分支源分支版本。 | c229f22024535638af41838daa43af1e6d46xxxx |
ownerId | string | 擁有者 ID。 | 1c83bd48e254405fb27297ee1fb8xxxx |
sn | string | 唯一標識符。 | eb4aee827214408e8d2dda49f0c0xxxx |
state | string | 狀態：INIT 初始化, WAIT 等待中, AUDITING 審核中, PASS 審核通過, FAILED 審核不通過, CANCELED 已取消, NO_NEED 無需審核。 | INIT |
type | string | 變更類型：APP。 | APP |
返回示例
{
"appCodeRepoSn": "cebf021afe6848578c97a1f6a253xxxx",
"appName": "my-web-service",
"autoDeleteBranchWhenEnd": true,
"branch": "master",
"creatorId": "creator-id-xxx",
"gmtCreate": "2024-09-01 00:00:00",
"gmtModified": "2024-09-01 00:00:00",
"name": "name-xxx",
"originBranch": "master",
"originBranchRevisionSha": "c229f22024535638af41838daa43af1e6d46xxxx",
"ownerId": "1c83bd48e254405fb27297ee1fb8xxxx",
"sn": "eb4aee827214408e8d2dda49f0c0xxxx",
"state": "INIT",
"type": "APP"
}錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。