堡垒机不提供创建实例的接口。您可以通过调用阿里云交易和账单管理API提供的CreateInstance接口来创建堡垒机实例。
背景信息
阿里云交易和账单管理API是一套通用的管理阿里云资源的接口,可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口,请参见API概览。
您可以调用阿里云交易和账单管理API提供的CreateInstance接口,创建堡垒机实例。关于该接口的调用方式,请参见请求结构。
下文介绍了调用CreateInstance接口创建堡垒机实例的请求方法和示例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
ProductCode | string | 是 | 产品代码。设置为bastionhost,表示堡垒机产品。 | bastionhost |
ProductType | string | 否 | 产品类型。设置为bastionhost,表示堡垒机产品。 | bastionhost |
SubscriptionType | string | 是 | 付费类型。堡垒机为预付费类型,设置为Subscription。 | Subscription |
Period | integer | 否 | 预付费周期。单位为月,按年付费产品请输入12的整数倍。 说明 当创建预付费实例时,必须设置。 | 12 |
RenewalStatus | string | 否 | 自动续费状态,取值:
默认 ManualRenewal。 | ManualRenewal |
RenewPeriod | integer | 否 | 自动续费周期, 单位为月。 说明 当设置RenewalStatus为AutoRenewal时,必须设置。 | 12 |
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配置,堡垒机的版本类型,取值:
|
Parameter.4.Code | String | 是 | LicenseCode | 堡垒机的第4组属性的Code配置,设置为LicenseCode,表示设置堡垒机实例的套餐类型(即支持的资产数量)。 |
Parameter.4.Value | String | 是 | bhah_ult_5000_asset | 堡垒机的第4组属性的Value配置,堡垒机各版本支持的资产数量,取值:
|
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配置,设置为Bandwidth,表示设置堡垒机的带宽大小。 |
Parameter.6.Value | String | 是 | 10 | 堡垒机的第6组属性的Value配置,表示堡垒机的带宽大小。 取值范围为0 Mbps~150 Mbps,步长为5。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
Code | String | Success | 本次请求的状态码。 |
Data | Struct | 本次请求的返回信息。 | |
└InstanceId | String | bastionhost-cn-**** | 已创建的堡垒机实例的ID。 |
└OrderId | String | 20240**** | 创建成功的订单ID。 |
Message | String | Successful! | Code对应的状态码信息。 |
RequestId | String | 6000EE23-274B-4E07-A697-FF2E999520A4 | 本次请求的ID。 |
Success | Boolean | true | 本次请求是否成功。取值:
|
示例
正常返回示例
XML
格式
<CreateInstanceResponse>
<Message>Successful!</Message>
<RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>
<Success>true</Success>
<Code>Success</Code>
<Data>
<InstanceId>bastionhost-cn-****</InstanceId>
<OrderId>20240****</OrderId>
</Data>
</CreateInstanceResponse>
JSON
格式
{
"Message": "Successful!",
"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
"Success": true,
"Code": "Success",
"Data": {
"InstanceId": "bastionhost-cn-****",
"OrderId": "20240****"
}
}