調用UpdateArtifact更新部署物。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
computenestsupplier:UpdateArtifact | update | *Artifact acs:computenestsupplier:{#regionId}:{#accountId}:artifact/{#ArtifactId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ArtifactId | string | 是 | 部署物 ID。 您可以通過調用ListArtifacts - 查詢部署物列表獲取部署物 ID。 | artifact-eea08d1e2d3a43ae**** |
VersionName | string | 是 | 部署物版本名稱。 | v1 |
Description | string | 否 | 部署物描述。 | Redhat8_0鏡像 |
ArtifactProperty | object | 是 | 部署物內容。 | |
Url | string | 否 | 文件部署物 URL。 您可以通過對象存儲控制臺上傳并獲取文件 URL. | https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852865****/template/2e1ce8fc-****-481c-9e8e-789ba9db487d.json |
RegionId | string | 否 | 鏡像地域。 說明
該參數僅部署物為鏡像部署物時可設置。
| cn-hangzhou |
ImageId | string | 否 | m-0xij191j9cuev6uc**** | |
CommodityCode | string | 否 | cmjj00**** | |
CommodityVersion | string | 否 | V1.0 | |
RepoName | string | 否 | 指定鏡像倉庫名稱。 說明
該參數僅部署物為容器鏡像部署物和 HelmChart 部署物時可設置。
| wordpress |
RepoId | string | 否 | 鏡像倉庫 ID。 您可以通過調用ListAcrImageRepositories - 查看已上傳至 ACR 的鏡像列表獲取鏡像倉庫 ID。 說明
該參數僅部署物為容器鏡像部署物和 HelmChart 部署物時可設置。
| crr-d8o1nponyc2t**** |
Tag | string | 否 | 鏡像倉庫對應的版本。 您可以通過調用ListAcrImageTags - 查看鏡像倉庫中已上傳的鏡像版本獲取鏡像倉庫對應的版本。 說明
該參數僅部署物為容器鏡像部署物和 HelmChart 部署物時可設置。
| v1 |
RepoType | string | 否 | 倉庫權限類型,取值:
說明
該參數僅部署物為容器鏡像部署物和 HelmChart 部署物時可設置。
| Public |
SupportRegionIds | array | 否 | 支持鏡像分發的地域 ID。 | |
string | 否 | 支持鏡像分發的地域 ID。 說明
該參數僅部署物為 ECS 鏡像部署物時可設置。
| ["cn-hangzhou","cn-beijing"] | |
ArtifactBuildProperty | object | 否 | 部署物構建內容,用于托管構建部署物 | |
CommandType | string | 否 | 命令類型。取值范圍:
說明
該參數僅部署物為 ECS 鏡像部署物時可設置。
| RunShellScript |
CommandContent | string | 否 | 命令內容。 說明
該參數僅部署物為 ECS 鏡像部署物時可設置。
| echo "start run command" |
SourceImageId | string | 否 | 源鏡像 ID。支持兩種類型:
說明
該參數僅部署物為 ECS 鏡像部署物時可設置。
| 鏡像ID:m-t4nhenrdc38pe4***** ubuntu_22_04_x64_20G_alibase_20240926.vhd oos公共參數名稱:aliyun/services/computenest/images/aliyun_3_2104_python_3_11 |
RegionId | string | 否 | 源鏡像所在的地域 ID 說明
該參數僅部署物為 ECS 鏡像部署物時可設置。
| cn-hangzhou |
CodeRepo | object | 否 | 代碼倉庫地址。 說明
該參數僅 ArtifactBuildType 為 Dockerfile 或 Buildpacks 時可設置。
| |
Platform | string | 否 | 代碼倉庫所在平臺。取值范圍:
| github |
RepoName | string | 否 | 倉庫名稱。 | aliyun-computenest/quickstart-Lobexxx |
Owner | string | 否 | 代碼倉庫的擁有者。 說明
該參數僅代碼倉庫為私有倉庫時需填寫。
| aliyun-computenest |
Branch | string | 否 | 代碼倉庫分支名稱。 | main |
DockerfilePath | string | 否 | Dockerfile 文件在代碼倉庫中的相對地址。 默認值:Dockerfile 說明
該參數僅 ArtifactBuildType 為 Dockerfile 時可設置。
| ./file/Dockerfile |
BuildArgs | array<object> | 否 | 構建參數。 說明
該參數僅 ArtifactBuildType 為 Dockerfile 時可設置。
| |
object | 否 | 用于 docker build --build-arg | ||
ArgumentName | string | 否 | 構建參數的 name。 | ENV |
ArgumentValue | string | 否 | 構建參數的 value。 | nginx:latest |
SourceContainerImage | string | 否 | 源容器鏡像的拉取地址。 用于 docker pull ${SourceContainerImage} 說明
該參數僅 ArtifactBuildType 為 ContainerImage 時可設置。
| pytorch/pytorch:2.5.1-cuda12.4-cudnn9-devel |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。 | 10CM943JP0EN9D51H |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "9F350409-2ACC-5B61-ACD9-3C8995792F8F",
"ArtifactId": "artifact-eea08d1e2d3a43ae****",
"ArtifactType": "EcsImage",
"VersionName": "v1",
"ArtifactVersion": "2",
"Description": "Redhat8_0鏡像",
"GmtModified": "2022-10-20T02:19:55Z",
"Status": "Available",
"ArtifactProperty": "{\\\"CommodityCode\\\":\\\"cmjj0005****\\\",\\\"CommodityVersion\\\":\\\"V2022****\\\"}",
"SupportRegionIds": "[\n\t\t\t\"cn-beijing\",\n\t\t\t\"cn-hangzhou\",\n\t\t\t\"cn-shanghai\"\n\t\t]",
"ArtifactBuildProperty": "\"{\\\"RegionId\\\":\\\"xxx\\\", \\\"SourceImageId\\\":\\\"xxx\\\", \\\"\\\":\\\"xxx\\\", \\\"CommandType\\\":\\\"xxx\\\", \\\"CommandContent\\\":\\\"xxx\\\"}\"",
"StatusDetail": "\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\"\n",
"ArtifactBuildType": "\"{\\\"RegionId\\\":\\\"xxx\\\", \\\"SourceImageId\\\":\\\"xxx\\\", \\\"\\\":\\\"xxx\\\", \\\"CommandType\\\":\\\"xxx\\\", \\\"CommandContent\\\":\\\"xxx\\\"}\"\n"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-02 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-11-06 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-11-06 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2022-12-02 | 新增 OpenAPI | 查看變更詳情 |