ModifyInstance-修改堡垒机实例

堡垒机不提供修改实例配置的接口。您可以通过调用阿里云交易和账单管理API提供的ModifyInstance接口来修改堡垒机实例的配置。

背景信息

阿里云交易和账单管理API是一套通用的管理阿里云资源的接口,可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口,请参见API概览

您可以调用阿里云交易和账单管理API提供的ModifyInstance接口,修改堡垒机实例的配置。关于该接口的调用方式,请参见请求结构

下文介绍了调用ModifyInstance接口修改堡垒机实例配置的请求方法和示例。

调试

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

请求参数

名称

类型

必填

描述

示例值

ProductCode

string

产品代码。

bastionhost

ProductType

string

产品类型。

bastionhost

SubscriptionType

string

付费类型。堡垒机为预付费类型,设置为Subscription

Subscription

ModifyType

string

变配类型,取值:

  • Upgrade:升级,表示升级堡垒机的配置。

  • Downgrade:降级,表示降低堡垒机的配置。

    说明

    功能灰度中,如有相关需求,请加入钉群(钉群号:33797269),联系产品技术人员咨询。

Upgrade

InstanceId

String

bastionhost-cn-****

要变更配置的实例ID。

ClientToken

string

客户端幂等参数,服务端会查询是否有相同 ClientToken 的请求,如果有,直接返回上次调用结果。

JASIOFKVNVIXXXXXX

Parameter

object []

模块列表

└Value

string

第 n 个模块属性 value 配置,n 的取值范围为(1~100)。

disk

└Code

string

第 n 个模块属性 code 配置,n 的取值范围为(1~100),如有多个模块属性参数,按照 n=1,2,3…n 的形式拼接多个参数。

InstanceType

Parameter参数设置

名称

类型

是否必选

示例值

描述

Parameter.1.Code

String

RegionId

堡垒机的第1组属性的Code配置,设置为RegionId,表示设置堡垒机实例的地域。

Parameter.1.Value

String

cn-shanghai

堡垒机的第1组属性的Value配置,表示堡垒机实例所在地域ID,可通过DescribeRegions接口获取。

Parameter.2.Code

String

NetworkType

堡垒机的第2组属性的Code配置,设置为NetworkType,表示设置堡垒机的网络。

Parameter.2.Value

String

vpc

堡垒机的第2组属性的Value配置,设置为vpc,表示堡垒机实例采用VPC网络类型。

Parameter.3.Code

String

PlanCode

堡垒机的第3组属性的Code配置,设置为PlanCode,表示设置堡垒机的版本。

Parameter.3.Value

String

cloudbastion

堡垒机的第3组属性的Value配置,堡垒机的版本类型,取值:

  • cloudbastion基础版

  • cloudbastion_ha企业双擎版

  • cloudbastion_sm:国密版。

Parameter.4.Code

String

LicenseCode

堡垒机的第4组属性的Code配置,设置为LicenseCode,表示设置堡垒机实例的套餐类型(即支持的资产数量)。

Parameter.4.Value

String

bhah_ult_5000_asset

堡垒机的第4组属性的Value配置,堡垒机各版本支持的资产数量,取值:

  • bhah_ent_50_asset:表示50资产,适用于基础版企业双擎版

  • bhah_ent_100_asset:表示100资产,适用于基础版企业双擎版

  • bhah_ent_200_asset:表示200资产,适用于基础版企业双擎版

  • bhah_ult_500_asset:表示500资产,适用于基础版企业双擎版

  • bhah_ult_1000_asset:表示1000资产,仅适用于企业双擎版

  • bhah_ult_2000_asset:表示2000资产,仅适用于企业双擎版

  • bhah_ult_5000_asset:表示5000资产,仅适用于企业双擎版

  • bhah_ult_10000_asset:表示10000资产,仅适用于企业双擎版

Parameter.5.Code

String

Storage

堡垒机的第5组属性的Code配置,设置为Storage,表示设置堡垒机的存储容量大小。

Parameter.5.Value

String

5

堡垒机的第5组属性的Value配置,表示堡垒机的存储容量大小。取值范围为0 TB~500 TB。

Parameter.6.Code

String

Bandwidth

堡垒机的第6组属性的Code配置,表示堡垒机的带宽大小。

取值范围为0 Mbps~150 Mbps,步长为5。

Parameter.6.Value

String

5

堡垒机的第6组属性的Value配置,表示堡垒机的带宽大小。

取值范围为0 Mbps~150 Mbps,步长为5。

返回参数

名称

类型

示例值

描述

Code

String

Success

本次请求的状态码。

Data

Struct

本次请求的返回信息。

└InstanceId

String

bastionhost-cn-****

变更配置的实例ID。

└OrderId

String

2026532523****

创建成功的订单ID。

Message

String

Successful!

本次请求的错误信息。

RequestId

String

6000EE23-274B-4E07-A697-FF2E999520A4

本次请求的ID。

Success

Boolean

true

本次请求是否成功。

示例

正常返回示例

XML 格式

<ModifyInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
      <Data>
            <OrderId>2026532523****</OrderId>
      </Data>
</ModifyInstanceResponse>

JSON 格式

{
    "Message": "Successful!",
    "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
    "Success": true,
    "Code": "Success",
    "Data": {
        "OrderId": "2026532523****"
    }
}