Bastionhost does not provide an API operation to create a bastion host. However, you can call the CreateInstance operation supported by the transactions and bills management API to create a bastion host. This API is also called BSS API for short.

Background information

The BSS API is a set of common operations used to manage Alibaba Cloud resources. For example, you can call the operations to query service prices, manage instances, or obtain bills. For more information about the operations of the BSS API, see API Overview.

You can call the CreateInstance operation of the BSS API to create a bastion host. For more information about how to call the operation, see Request Structure.

This topic describes how to call the CreateInstance operation to create a bastion host and provides examples.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateInstance The operation that you want to perform. Set the value to CreateInstance.
Parameter.1.Code String Yes RegionId The code of the first attribute for the bastion host. Set the value to RegionId, which indicates the region in which the bastion host is deployed.
Parameter.1.Value String Yes cn-shanghai The value of the first attribute for the bastion host. Set the value to the ID of the region in which the bastion host is deployed. You can call the DescribeRegions operation to query the region IDs supported by Bastionhost.
Parameter.2.Code String Yes NetworkType The code of the second attribute for the bastion host. Set the value to NetworkType, which indicates the network type of the bastion host.
Parameter.2.Value String Yes vpc The value of the second attribute for the bastion host. Set the value to vpc, which indicates that the bastion host is deployed in a virtual private cloud (VPC).
Parameter.3.Code String Yes PlanCode The code of the third attribute for the bastion host. Set the value to PlanCode, which indicates the edition of the bastion host.
Parameter.3.Value String Yes cloudbastion The value of the third attribute for the bastion host. Set the value to the edition that you want to use. Valid values:
  • cloudbastion: Basic Edition
  • cloudbastion_ha: HA Edition
Parameter.4.Code String Yes LicenseCode The code of the fourth attribute for the bastion host. Set the value to LicenseCode, which indicates the plan of the bastion host. The plan determines the number of the assets that can be managed by the bastion host.
Parameter.4.Value String Yes bhah_ult_5000_asset The value of the fourth attribute for the bastion host. Set the value to the plan that you want to use. Valid values:
  • bhah_ent_50_asset: A total of 50 assets can be managed by a bastion host of the Basic Edition or HA Edition.
  • bhah_ent_100_asset: A total of 100 assets can be managed by a bastion host of the Basic Edition or HA Edition.
  • bhah_ent_200_asset: A total of 200 assets can be managed by a bastion host of the Basic Edition or HA Edition.
  • bhah_ult_500_asset: A total of 500 assets can be managed by a bastion host of the Basic Edition or HA Edition.
  • bhah_ult_1000_asset: A total of 1,000 assets can be managed by a bastion host of the HA Edition.
  • bhah_ult_2000_asset: A total of 2,000 assets can be managed by a bastion host of the HA Edition.
  • bhah_ult_5000_asset: A total of 5,000 assets can be managed by a bastion host of the HA Edition.
  • bhah_ult_10000_asset: A total of 10,000 assets can be managed by a bastion host of the HA Edition.
Parameter.5.Code String Yes Storage The code of the fifth attribute for the bastion host. Set the value to Storage, which indicates the storage capacity of the bastion host.
Parameter.5.Value String Yes 5 The value of the fifth attribute for the bastion host. Set the value to the storage capacity that you want to use. Valid values: 0 to 500. Unit: TB.
Parameter.6.Code String Yes Bandwidth The code of the sixth attribute for the bastion host. Set the value to Bandwidth, which indicates the bandwidth of the bastion host.
Parameter.6.Value String Yes 5 The value of the sixth attribute for the bastion host. Set the value to the bandwidth that you want to use. Valid values: 0 to 500. Unit: Mbit/s.
ProductCode String Yes bastionhost The service code of the bastion host. Set the value to bastionhost, which indicates Bastionhost.
SubscriptionType String Yes Subscription The billing method of the bastion host. Set the value to Subscription.
ProductType String No bastionhost The service type of the bastion host. Set the value to bastionhost, which indicates Bastionhost.
RenewPeriod Integer No 12

The auto-renewal period. Unit: months.

Note If you set the RenewalStatus parameter to AutoRenewal, this parameter is required.
Period Integer Yes 12 The subscription period. Unit: months. The value must be a multiple of 12.
Note If you want to create a subscription bastion host, this parameter is required.
RenewalStatus String No ManualRenewal The method that is used to renew the bastion host. Valid values:
  • AutoRenewal
  • ManualRenewal

Default value: ManualRenewal.

ClientToken String No JASIOFKVNVI**** The client token that is used to ensure the idempotence of the request. The server checks whether a request with the same client token has been received. If so, the server returns the query result of the last request.

Response parameters

Parameter Type Example Description
Code String Success The status code.
Data Struct The returned information.
└InstanceId String bastionhost-cn-**** The ID of the bastion host.
└OrderId String 20240**** The ID of the order.
Message String Successful! The message returned for Code.
RequestId String 6000EE23-274B-4E07-A697-FF2E999520A4 The ID of the request.
Success Boolean true Indicates whether the request is successful. Valid values:
  • true: The request is successful.
  • false: The request failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateInstance
&Parameter.1.Code=RegionId
&Parameter.1.Value=cn-shanghai
&Parameter.2.Code=NetworkType
&Parameter.2.Value=vpc
&Parameter.3.Code=PlanCode
&Parameter.3.Value=cloudbastion
&Parameter.4.Code=LicenseCode
&Parameter.4.Value=bhah_ult_5000_asset
&Parameter.5.Code=Storage
&Parameter.5.Value=5
&Parameter.6.Code=Bandwidth
&Parameter.6.Value=5
&ProductCode=bastionhost
&SubscriptionType=Subscription
&Period=12
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

For a list of error codes, visit the API Error Center.