文档

UpdateService - 更新服务

更新时间:

升级服务。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenestsupplier:UpdateServiceWrite
  • Service
    acs:computenestsupplier:{#regionId}:{#accountId}:service/{#ServiceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
DeployTypestring

部署类型。可能值:

  • ros:通过 ROS 部署。

  • terraform:通过 Terraform 部署。

  • spi:调用 SPI 部署。

  • operation:代运维服务部署。

  • container:通过容器部署。

  • pkg:包服务。

ros
DeployMetadatastring

存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 JSON String 格式进行数据存储。

{\"EstimateTime\":null,\"SupplierDeployMetadata\":{\"DeployTimeout\":7200},\"EnableVnc\":false}
AlarmMetadatastring

服务报警配置。

说明 PolicyNames 中配置了报警权限策略后,该配置才会生效。
{\"CmsTemplateId\":1162921,\"TemplateUrl\":\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/1760465342xxxxxx/template/c072ef50-6c03-4d9c-8f0e-d1c440xxxxxx.json\"}
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

788E7CP0EN9D51P
ServiceIdstring

服务 ID。

service-1dda29c3eca648xxxxxx
ServiceTypestring

服务类型。可能的值:

  • private:部署在用户账户下的服务实例。

  • managed:托管在服务商账户下的服务实例。

  • operation:代运维服务实例

  • poc:试用服务实例。

private
ServiceInfoarray<object>

服务详情。

object

服务详情。

Localestring

服务语言。可能的值:

  • zh-CN:中文。

  • en-US:英文。

zh-CN
ShortDescriptionstring

服务概述。

B是A公司自主设计并研发的开源分布式的关系型数据库
Imagestring

服务图标地址。

http://img.tidb.oss.url
Namestring

服务名称。

B数据库
LongDescriptionUrlstring

服务详细描述的地址。

http://description.tidb.oss.url
Agreementsarray<object>

服务的协议文档信息。

object

服务的协议文档信息。

Namestring

协议文档名称。

Name
Urlstring

协议链接。

https://aliyun.com/xxxxxxxx.html
IsSupportOperatedboolean

是否代运维,默认为:false。可能的值:

  • true:开启。

  • false:关闭。

说明 ServiceTypeprivate 时需要填入该值。
false
PolicyNamesstring

策略名称。单个策略名称长度不超过 128 个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。

policyName1, policyName2
Durationlong

代运维时间。单位:秒。

259200
VersionNamestring

版本名称。

Draft
UpgradeMetadatastring

升级元数据。

{\"Description\":\"xxx\",\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]}
TrialDurationinteger

试用时长。单位:天。试用时长的最长天数不超过 30 天。

7
ServiceVersionstring

服务版本。

1
TenantTypestring

租户类型。可能的值:

  • SingleTenant:单租户。

  • MultiTenant:多租户。

SingleTenant
LicenseMetadatastring

许可证元数据。

{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]}
OperationMetadatastring

代运维配置。

{\"PrometheusConfigMap\":{\"Custom_Image_Ecs\":{\"EnablePrometheus\":false}}}
LogMetadatastring

应用日志配置。

{ "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置 "FilePattern": "access.log*" # 对容器不需要,在YAML中配置 } ] }
Resellableboolean

是否支持分销。可能的值:

  • false:不支持。

  • true:支持。

false
UpdateOptionobject

更新选项。

UpdateFromstring

更新选项。可选值:

  • CODE:代码。

  • PARAMETERS:参数。

PARAMETERS
ShareTypestring

共享类型。可能的值:

  • Public:公开的,正式部署和试用部署都不受限。

  • Restricted:受限的,正式部署和试用部署都受限。

  • OnlyFormalRestricted:仅正式部署受限。

  • OnlyTrailRestricted:仅试用部署受限。

  • Hidden:隐藏的,不可见且不可申请部署权限。

Public
ApprovalTypestring

服务使用申请审批类型。可能的值:

  • Manual:收到审批。

  • AutoPass:自动通过。

Manual

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

DF0F666F-FBBC-55C3-A368-C955DE7B4839

示例

正常返回示例

JSON格式

{
  "RequestId": "DF0F666F-FBBC-55C3-A368-C955DE7B4839"
}

错误码

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

变更历史

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