CLI Command Reference
Product Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cloud Service Types | hcloud BSS ListServiceTypes | This API is used to query cloud service types on the customer self-built platform. | |
| Querying Resource Types | hcloud BSS ListResourceTypes | This API is used to query the resource types on the customer self-built platform. | |
| Querying Resources by Cloud Service Type | hcloud BSS ListServiceResources | This API is used to query the resource type code and name by associated cloud service on the self-built platform and to query the price of a pay-per-use or yearly/monthly product. | |
| Querying Usage Types | hcloud BSS ListUsageTypes | This API is used to query resource usage types on the customer self-built platform. | |
| Querying Measurement Units | hcloud BSS ListMeasureUnits | This API is used to query the resource usage, measurement unit for the duration and amount of a yearly/monthly resource, as well as the measurement unit type on the self-built platform. | |
| Querying the Measurement Unit Number System | hcloud BSS ListConversions | This API is used to query the measurement unit number system on the self-built platform. | |
| Querying Resource Specifications of a Cloud Service Type | hcloud BSS ListResourceSpecs | This API is used to query resource specifications of a cloud service type on the customer self-built platform. | |
| Querying the Price of a Pay-per-Use Product | hcloud BSS ListOnDemandResourceRatings | This API is used to query the price of a pay-per-use product by criteria on the customer self-built platform. | |
| Querying Prices of Yearly/Monthly Products | hcloud BSS ListRateOnPeriodDetail | This API is used to query prices of yearly/monthly products for new subscriptions on the customer self-built platform. | |
| Querying the Renewal Price of a Yearly/Monthly Resource | hcloud BSS ListRenewRateOnPeriod | This API is used to query the renewal price of a yearly/monthly resource by criteria on the customer self-built platform. |
Account Management
Transaction Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Coupons | hcloud BSS ListSubCustomerCoupons | This API is used to query customers' coupon information. | |
| Querying Orders | hcloud BSS ListCustomerOrders | After a customer purchases yearly/monthly resources, it can query the orders in different statuses, such as in the pending approval, processing, canceled, completed, and pending payment statuses. | |
| Querying Order Details | hcloud BSS ShowCustomerOrderDetails | This API is used to view order details on the customer self-built platform. | |
| Querying Available Discounts of an Order | hcloud BSS ListOrderDiscounts | This API is used to query available discounts when a customer pays an order on the self-built platform. | |
| Paying Yearly/Monthly Product Orders | hcloud BSS PayOrders | This API is used to pay yearly/monthly product orders in the pending payment status. | |
| Canceling Orders in the Pending Payment Status | hcloud BSS CancelCustomerOrder | This API is used to cancel orders in the pending payment status. | |
| Querying Refunds for Orders | hcloud BSS ShowRefundOrderDetails | A customer can query the resource type and order of the refund amount of an unsubscription or specification downgrade order on the customer sales platform. | |
| Querying Yearly/Monthly Resources | hcloud BSS ListPayPerUseCustomerResources | This API is used to query one or all yearly/monthly resources on the self-built platform. | |
| Renewing Subscription to Yearly/Monthly Resources | hcloud BSS RenewalResources | This API is used to renew subscription to yearly/monthly resources on the self-built platform. This API is used to renew subscription to yearly/monthly resources on the partner sales platform. | |
| Unsubscribing from Yearly/Monthly Resources | hcloud BSS CancelResourcesSubscription | If a customer has subscribed to a yearly/monthly resource, the customer can use this API to unsubscribe from the resource, including the renewed part and currently used part. The customer cannot use the resources after unsubscription. | |
| Enabling Automatic Renewal for Yearly/Monthly Resources | hcloud BSS AutoRenewalResources | This API is used to enable automatic renewal for long-term yearly/monthly resources to prevent the resources from being deleted when they are expired. | |
| Disabling Automatic Renewal for Yearly/Monthly Resources | hcloud BSS CancelAutoRenewalResources | A customer can disable automatic subscription renewal when needed. After disabling this function, the customer needs to manually renew the subscription to the resources before they expire. | |
| Enabling/Canceling the Change from Yearly/Monthly to Pay-per-Use upon Expiration | hcloud BSS UpdatePeriodToOnDemand | A customer can change the billing mode of resources from yearly/monthly to pay-per-use after the resources expire. The pay-per-use mode takes effect upon a yearly/monthly expiration. | |
| Setting a Deduction Date for Auto-Renewal of Yearly/Monthly Resources and a Same Expiration Date for Renewed Resources | hcloud BSS SetResourcesRenewConfig | This API can be used to set a deduction date for auto-renewal of yearly/monthly resources and a same expiration date for renewed resources. | |
| Querying Resource Packages | hcloud BSS ListFreeResourceInfos | This API is used to query the resource package list on the self-built platform. | |
| Querying Resource Package Usage | hcloud BSS ListFreeResourceUsages | This API can be used to query the resource package usage by resource on the self-built platform. | |
| Querying Details of Resource Usage | hcloud BSS ListFreeResourcesUsageRecords | This API is used to query the resource package usage details on the self-built platform. |
Bill Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Bill Summary | hcloud BSS ShowCustomerMonthlySum | This API can be used by customers to query their expenditure summaries on the self-built platform. The expenditure data is summarized by month. | |
| Viewing Resource Usage Details | hcloud BSS ListCustomerselfResourceRecordDetails | This API can be used to query usage details of each resource for a customer on the self-built platform. | |
| Viewing Resource Expenditures | hcloud BSS ListCustomerselfResourceRecords | This API can be used to query expenditures of each resource for a customer on the self-built platform. |
Cost Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cost Data | hcloud BSS ListCosts | This API is used to query the cost data on the self-built platform. |
Enterprise Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Enabling Enterprise Project Management | hcloud BSS CreateEnterpriseProjectAuth | This API is used to enable the enterprise project management on the self-built platform. | |
| Querying Enterprise Member Accounts | hcloud BSS ListEnterpriseSubCustomers | This API can be used by an enterprise master account to query member accounts on the self-built platform. |
Invoice Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Invoices | hcloud BSS ListInvoices | This API is used to query the invoice list. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
