首页 计算巢服务 开发参考 用户侧API参考 API目录 服务实例 UpdateServiceInstanceSpec - 变配服务实例

UpdateServiceInstanceSpec - 变配服务实例

更新时间: 2024-12-25 16:46:52

当服务实例的参数值或套餐设置不满足您的要求时,调用UpdateServiceInstanceSpec对服务实例执行变配操作。

接口说明

前提条件

请先确认服务商在创建服务时开启变配功能并完成变配参数设置。

调试

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

授权信息

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

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

请求参数

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

服务实例 ID。

您可以通过调用ListServiceInstances - 查询服务实例列表获取服务实例 ID。

si-d6ab3a63ccbb4b17****
PredefinedParametersNamestring

服务实例套餐名称。

当服务商在添加变配操作时设置变更类型套餐变更,您可以设置该参数。

您可以通过查看GetService - 查询服务详细信息接口中返回参数 DeployMetadataPredefinedParameters 属性获取服务设置的套餐名称。

套餐一
Parametersobject

服务实例变更参数。

当服务商在添加变配操作时设置变更类型参数变更,您可以设置该参数。

说明
  • 您可以通过查看GetService - 查询服务详细信息接口中返回参数 OperationMetadataModifyParametersConfig 属性获取服务设置的变更参数。
  • 您还可以通过计算巢控制台服务实例变更页面查看服务设置的变更参数。
  • 例如,如果服务设置了 ECS 实例规格升配,此时您需要输入比原来服务实例更高的实例规格配置。

    { "InstanceType": "ecs.g8ise.2xlarge" }
    DryRunboolean

    是否对此次创建请求执行预检,包括权限、实例状态校验等操作。

    取值:

    • true:发送请求,不创建服务实例。

    • false:发送请求,检查通过后创建服务实例。

    true
    EnableUserPrometheusboolean

    用户侧是否启用 Prometheus 监控。

    取值:

    true:启用。

    false:不启用。

    true
    OperationNamestring

    变配操作名称。

    您可以通过查看GetService - 查询服务详细信息接口中返回参数 OperationMetadataModifyParametersConfig 属性获取服务设置的变配操作名称和变配操作内容。

    套餐变配
    ClientTokenstring

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

    123e4567-e89b-12d3-a456-42665544****
    Commodityobject

    云市场购买订单信息,服务未上云市场或按量计费不必传。

    AutoPayboolean

    是否自动支付。

    取值:

    • true(默认值):自动支付。您需要确保账户余额充足。

    • false:只生成订单不扣费。如果您的支付方式余额不足,可以将参数 AutoPay 设置为 false,此时会生成未支付订单,您可以登录 RDS 管理控制台自行支付。

    true

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    06BF8F22-02DC-4750-83DF-3FFC11C065EA
    OrderIdstring

    订单 ID。

    23396265896****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "06BF8F22-02DC-4750-83DF-3FFC11C065EA",
      "OrderId": "23396265896****"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-12-24OpenAPI 描述信息更新查看变更详情
    上一篇: RestartServiceInstance - 重启服务实例 下一篇: ListServiceInstanceUpgradeHistory - 查询服务实例升级历史
    阿里云首页 计算巢服务 相关技术圈