文档中心

持续交付

部署资源

UpdateDeployResource

更新部署资源。

请求说明

为获得低延迟，建议您根据资源所在的地域选择对应的服务地址，详情参见服务地址。

请求方式：POST

请求地址：https://cp.cn-beijing.volcengineapi.com?Action=UpdateDeployResource&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateDeployResource	接口名称。当前 API 的名称为 UpdateDeployResource。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 2023-05-01。
Name	String	否	production-cluster	部署资源的名称，用于标识和区分不同的部署资源。
Id	String	是	cc5silumrsfekhkr****	部署资源的唯一标识 ID，用于指定需要更新的目标资源。
Source	String	否	VKE	部署资源的来源，用于筛选特定来源的部署资源。支持的取值如下所示。 VKE：火山引擎容器服务集群。 K8S：自建或第三方 K8S。
VkeClusterId	String	否	cc5silumrsfekh5h5****	部署资源对应的 VKE 集群 ID，当 Source 为 VKE 时需指定此字段。
Kubeconfig	String	否	YXBpVmVyc****Tl2ZENKOS4=	当部署资源来源为 K8S 时，需指定部署资源的基于 base64 编码的 Kubeconfig 信息。
Region	String	否	cn-beijing	部署资源对应集群所属的地域，用于标识集群所在的物理位置。
Description	String	否	Kubernetes cluster deployment resource for production environment	部署资源的描述信息，用于说明该资源的用途或特性。
OnlyForSpecifiedWorkspaces	Boolean	否	false	标识该部署资源是否仅对指定的工作区开放。 true ：需配合 SpecifiedWorkspaceIds 参数指定允许访问的工作区 ID 列表。 false：对所有工作区开放。
SpecifiedWorkspaceIds	Array of String	否	["18be9***a1aca409f5e19c**"]	当 OnlyForSpecifiedWorkspaces 为 true 时，需指定允许访问该部署资源的工作区 ID 列表。
Identifier	String	否	deploy-resource-123	部署资源的唯一标识符，用于在系统中唯一标识该部署资源。

请求示例

POST https://cp.cn-beijing.volcengineapi.com?Action=UpdateDeployResource&Version=2023-05-01 HTTP/1.1​
Content-Type: application/json​
{​
    "Name": "production-cluster",​
    "Id": "cc5silumrsfekhkr****",​
    "Source": "VKE",​
    "VkeClusterId": "cc5silumrsfekh5h5****",​
    "Kubeconfig": "YXBpVmVyc****Tl2ZENKOS4=",​
    "Region": "cn-beijing",​
    "Description": "Kubernetes cluster deployment resource for production environment",​
    "OnlyForSpecifiedWorkspaces": false,​
    "SpecifiedWorkspaceIds": [​
        "18be9*****a1aca409f5e19c****"​
    ],​
    "Identifier": "deploy-resource-123"​
}​

返回参数

本接口无特有的返回参数。

返回示例

HTTP/1.1 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****10023228002****",​
        "Action": "UpdateDeployResource",​
        "Version": "2023-05-01",​
        "Service": "cp",​
        "Region": "cn-beijing"​
    }​
}​

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.05.07 11:21:10

这个页面对您有帮助吗？

有用

无用