调用UpdateService更新服务_计算巢服务(Compute Nest)-阿里云帮助中心

升级服务。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
computenestsupplier:UpdateService	update	*Service `acs:computenestsupplier:{#regionId}:{#accountId}:service/{#ServiceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DeployType	string	否	部署类型。可能值： ros：通过 ROS 部署。 terraform：通过 Terraform 部署。 spi：调用 SPI 部署。 operation：代运维服务部署。 container：通过容器部署。 pkg：包服务。	ros
DeployMetadata	string	否	存储服务部署配置的信息。存储的信息与部署类型有关，不同的部署类型存储的数据格式不一样，因此使用 JSON String 格式进行数据存储。	{\"EstimateTime\":null,\"SupplierDeployMetadata\":{\"DeployTimeout\":7200},\"EnableVnc\":false}
AlarmMetadata	string	否	服务报警配置。说明当 PolicyNames 中配置了报警权限策略后，该配置才会生效。	{\"CmsTemplateId\":1162921,\"TemplateUrl\":\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/1760465342xxxxxx/template/c072ef50-6c03-4d9c-8f0e-d1c440xxxxxx.json\"}
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。	788E7CP0EN9D51P
ServiceId	string	是	服务 ID。	service-1dda29c3eca648xxxxxx
ServiceType	string	否	服务类型。可能的值： private：部署在用户账户下的服务实例。 managed：托管在服务商账户下的服务实例。 operation：代运维服务实例 poc：试用服务实例。	private
ServiceInfo	array<object>	否	服务详情。
	object	否	服务详情。
Locale	string	否	服务语言。可能的值： zh-CN：中文。 en-US：英文。	zh-CN
ShortDescription	string	否	服务概述。	B是A公司自主设计并研发的开源分布式的关系型数据库
Image	string	否	服务图标地址。	http://img.tidb.oss.url
Name	string	否	服务名称。	B数据库
LongDescriptionUrl	string	否	服务详细描述的地址。	http://description.tidb.oss.url
Agreements	array<object>	否	服务的协议文档信息。
	object	否	服务的协议文档信息。
Name	string	否	协议文档名称。	Name
Url	string	否	协议链接。	https://aliyun.com/xxxxxxxx.html
Softwares	array<object>	否	服务中用到的软件信息。
	object	否	服务中用到的软件信息。
Name	string	否	软件名称。	MySQL
Version	string	否	软件版本。	5.7
IsSupportOperated	boolean	否	是否代运维，默认为：false。可能的值： true：开启。 false：关闭。说明当 ServiceType 为 private 时需要填入该值。	false
PolicyNames	string	否	策略名称。单个策略名称长度不超过 128 个字符，多个名称使用英文逗号（,）分隔。暂时只支持代运维相关参数策略。	policyName1, policyName2
Duration	long	否	代运维时间。单位：秒。	259200
VersionName	string	否	版本名称。	Draft
UpgradeMetadata	string	否	升级元数据。	{\"Description\":\"xxx\",\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]}
TrialDuration	integer	否	试用时长。单位：天。试用时长的最长天数不超过 30 天。	7
ServiceVersion	string	否	服务版本。	1
TenantType	string	否	租户类型。可能的值： SingleTenant：单租户。 MultiTenant：多租户。	SingleTenant
LicenseMetadata	string	否	许可证元数据。	{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]}
OperationMetadata	string	否	代运维配置。	{\"PrometheusConfigMap\":{\"Custom_Image_Ecs\":{\"EnablePrometheus\":false}}}
LogMetadata	string	否	应用日志配置。	{ "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要，在YAML中配置 "FilePattern": "access.log*" # 对容器不需要，在YAML中配置 } ] }
Resellable	boolean	否	是否支持分销。可能的值： false：不支持。 true：支持。	false
UpdateOption	object	否	更新选项。
UpdateFrom	string	否	更新选项。可选值： CODE：代码。 PARAMETERS：参数。	PARAMETERS
UpdateArtifact	boolean	否	是否需要更新部署物	true
Commodity	object	否	绑定商品信息
SpecificationMappings	array<object>	否	商品规格与模板/套餐关系（云市场-包年包月场景使用）
	object	否	商品规格与模板/套餐关系（云市场-包年包月场景使用）
TemplateName	string	否	模板名称	模板1
SpecificationName	string	否	套餐名称	低配版
SpecificationCode	string	否	规格码	yuncode5767800001
MeteringEntityMappings	array<object>	否	模板/套餐与计量维度绑定关系（云市场-按量付费场景使用）
	object	否	模板/套餐与计量维度绑定关系（云市场-按量付费场景使用）
TemplateName	string	否	模板名称	模板1
SpecificationName	string	否	套餐名称	低配版
EntityIds	array	否	计量项 ID
	string	否	计量项 ID。	cmgj0006xxxx-Memory-1
MeteringEntityExtraInfos	array<object>	否	计量项配置信息（云市场-按量付费场景使用）
	object	否	计量项配置信息。
EntityId	string	否	计量项 ID。	cmgj0006xxxx-Memory-1
Type	string	否	类型，参考值： Custom ComputeNestBill ComputeNestPrometheus ComputeNestTime	Custom
MetricName	string	否	指标名称，当 Type 为 ComputeNestBill 或 ComputeNestPrometheus 填入	VirtualCpu/ecs.InstanceType
Promql	string	否	Prometheus 语句	avg_over_time(sum(rate(container_cpu_usage_seconds_total{namespace=~"ALIYUN::StackName"}[2m]))[1h:10s])
ComponentsMappings	array<object>	否	此参数不对外开放
	object	否	此参数不对外开放
TemplateName	string	否	此参数不对外开放	此参数不对外开放
Mappings	object	否	此参数不对外开放
	string	否	此参数不对外开放	此参数不对外开放
SaasBoostConfig	string	否	SaaS Boost 配置信息	{}
ShareType	string	否	共享类型。可能的值： Public：公开的，正式部署和试用部署都不受限。 Restricted：受限的，正式部署和试用部署都受限。 OnlyFormalRestricted：仅正式部署受限。 OnlyTrailRestricted：仅试用部署受限。 Hidden：隐藏的，不可见且不可申请部署权限。	Public
ApprovalType	string	否	服务使用申请审批类型。可能的值： Manual：收到审批。 AutoPass：自动通过。	Manual
DryRun	boolean	否	是否对此次请求执行预检，包括权限、实例状态校验等。可能的值： true：发送请求，不更新服务。 false：发送请求，检查通过后更新服务。
ComplianceMetadata	object	否	合规检查元数据。
CompliancePacks	array	否	选择的合规包。
	string	否	选择的合规包。	VpcDataRisk

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	DF0F666F-FBBC-55C3-A368-C955DE7B4839
DryRunResult	object	校验结果。仅在 DryRun 为 true 时返回。
RolePolicy	object	部署角色的权限策略。
Policy	string	部署角色需要的权限策略。	{ "Statement": [{ "Action": ["oos:CancelExecutions", "oos:DeleteExecutions", "oos:GetTemplate", "oos:ListExecutions", "oos:ListTemplates", "oos:NotifyExecution", "oos:StartExecution"], "Effect": "Allow", "Resource": "" }, { "Action": ["ram:PassRole"], "Effect": "Allow", "Resource": "" }, { "Action": ["ros:CreateStack", "ros:GetStack", "ros:UpdateStack", "ros:ListStackEvents", "ros:ListStackResources", "ros:ListStackResources", "ros:DeleteStack", "ram:GetRole"], "Effect": "Allow", "Resource": "*" }], "Version": "1" }
MissingPolicy	array<object>	部署角色缺少的权限策略。
MissingPolicy	object	部署角色缺少的权限策略。
ServiceName	string	权限策略中的服务名称。	ecs
Resource	string	权限策略中的资源。	*
Action	array	权限策略中的操作。
Action	string	权限策略中的操作。	CreateStack

示例

正常返回示例

JSON格式

{
  "RequestId": "DF0F666F-FBBC-55C3-A368-C955DE7B4839",
  "DryRunResult": {
    "RolePolicy": {
      "Policy": "{\n\t\"Statement\": [{\n\t\t\"Action\": [\"oos:CancelExecutions\", \"oos:DeleteExecutions\", \"oos:GetTemplate\", \"oos:ListExecutions\", \"oos:ListTemplates\", \"oos:NotifyExecution\", \"oos:StartExecution\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}, {\n\t\t\"Action\": [\"ram:PassRole\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}, {\n\t\t\"Action\": [\"ros:CreateStack\", \"ros:GetStack\", \"ros:UpdateStack\", \"ros:ListStackEvents\", \"ros:ListStackResources\", \"ros:ListStackResources\", \"ros:DeleteStack\", \"ram:GetRole\"],\n\t\t\"Effect\": \"Allow\",\n\t\t\"Resource\": \"*\"\n\t}],\n\t\"Version\": \"1\"\n}",
      "MissingPolicy": [
        {
          "ServiceName": "ecs",
          "Resource": "*",
          "Action": [
            "CreateStack"
          ]
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-25	OpenAPI 入参发生变更	查看变更详情
2024-10-22	API 内部配置变更，不影响调用	查看变更详情
2024-08-23	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-05	API 内部配置变更，不影响调用	查看变更详情
2024-07-30	API 内部配置变更，不影响调用	查看变更详情
2024-07-15	OpenAPI 入参发生变更	查看变更详情
2024-06-20	OpenAPI 入参发生变更	查看变更详情
2024-05-10	OpenAPI 入参发生变更	查看变更详情
2024-03-22	API 内部配置变更，不影响调用	查看变更详情
2023-09-15	OpenAPI 入参发生变更	查看变更详情
2023-08-03	OpenAPI 入参发生变更	查看变更详情
2023-05-25	API 内部配置变更，不影响调用	查看变更详情