Instance Ordering
Function
This API is used to place an order based on the billing mode and billing period.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/period/order
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
charging_mode |
Yes |
Integer |
Billing mode. The options are as follows: 0: yearly/monthly; 1: pay-per-use; 2: one-off. |
cloud_service_type |
Yes |
String |
Cloud service type |
composite_product_id |
No |
String |
Package ID |
discount_id |
No |
String |
Discount ID |
is_auto_renew |
No |
Integer |
Auto-renewal |
period_num |
Yes |
Integer |
Subscription periods |
period_type |
Yes |
Integer |
Subscription period type. The options are as follows: 2: month; 3: year. |
product_infos |
Yes |
Array of ProductInfoBean objects |
Product information list |
promotion_activity_id |
No |
String |
Promotion ID |
promotion_info |
No |
String |
Promotion information |
region_id |
Yes |
String |
ID of the region where the current project is, for example, xx-xx-1. |
zone |
Yes |
String |
Country/Region |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
all_resource_names |
No |
Array of strings |
Resource list |
cloud_service_type |
Yes |
String |
Cloud service type |
display_id |
No |
String |
Display ID |
product_id |
Yes |
String |
Product ID |
product_spec_desc |
No |
String |
Product specification description |
resource_name |
No |
String |
Resource name |
resource_size |
Yes |
Integer |
Number of databases supported by the product or the number of OBS scans supported by the product |
resource_size_measure_id |
Yes |
Integer |
Resource capacity measurement ID. The example values are as follows: 15: mbps (used when bandwidth is purchased), 17: gb (used when EVS disks are purchased), 14: number/time. |
resource_spec_code |
Yes |
String |
Product code |
resource_type |
Yes |
String |
Resource type |
usage_factor |
No |
String |
Coefficient in use |
usage_measure_id |
No |
Integer |
Capacity measurement ID in use |
usage_value |
No |
Double |
Value in use |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
order_id |
String |
Order ID |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Purchase the hws.service.type.sdg cloud service instance for two months for the xxxxxxxxxxxx project in China. This product supports the scanning of XX database or OBS instances.
POST /v1/{project_id}/period/order { "charging_mode" : 0, "cloud_service_type" : "hws.service.type.sdg", "is_auto_renew" : 0, "period_num" : 1, "period_type" : 2, "region_id" : "xxxxxxxxxxxx", "zone" : "CH", "product_infos" : [ { "cloud_service_type" : "hws.service.type.sdg", "product_id" : "xxxxxxxxxxxx", "resource_size" : 30, "resource_size_measure_id" : 30, "resource_spec_code" : "base_professional", "resource_type" : "hws.resource.type.dsc.base" } ] }
Example Responses
Status code: 200
OK
{ "order_id" : "xxxxxxxxxxxx" }
Status code: 400
Invalid request.
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
SDK Sample Code
The SDK sample code is as follows.
Purchase the hws.service.type.sdg cloud service instance for two months for the xxxxxxxxxxxx project in China. This product supports the scanning of XX database or OBS instances.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateProductOrderSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); CreateProductOrderRequest request = new CreateProductOrderRequest(); PeriodOrderRequest body = new PeriodOrderRequest(); List<ProductInfoBean> listbodyProductInfos = new ArrayList<>(); listbodyProductInfos.add( new ProductInfoBean() .withCloudServiceType("hws.service.type.sdg") .withProductId("xxxxxxxxxxxx") .withResourceSize(30) .withResourceSizeMeasureId(30) .withResourceSpecCode("base_professional") .withResourceType("hws.resource.type.dsc.base") ); body.withZone("CH"); body.withRegionId("xxxxxxxxxxxx"); body.withProductInfos(listbodyProductInfos); body.withPeriodType(2); body.withPeriodNum(1); body.withIsAutoRenew(0); body.withCloudServiceType("hws.service.type.sdg"); body.withChargingMode(0); request.withBody(body); try { CreateProductOrderResponse response = client.createProductOrder(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Purchase the hws.service.type.sdg cloud service instance for two months for the xxxxxxxxxxxx project in China. This product supports the scanning of XX database or OBS instances.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateProductOrderRequest() listProductInfosbody = [ ProductInfoBean( cloud_service_type="hws.service.type.sdg", product_id="xxxxxxxxxxxx", resource_size=30, resource_size_measure_id=30, resource_spec_code="base_professional", resource_type="hws.resource.type.dsc.base" ) ] request.body = PeriodOrderRequest( zone="CH", region_id="xxxxxxxxxxxx", product_infos=listProductInfosbody, period_type=2, period_num=1, is_auto_renew=0, cloud_service_type="hws.service.type.sdg", charging_mode=0 ) response = client.create_product_order(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Purchase the hws.service.type.sdg cloud service instance for two months for the xxxxxxxxxxxx project in China. This product supports the scanning of XX database or OBS instances.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateProductOrderRequest{} var listProductInfosbody = []model.ProductInfoBean{ { CloudServiceType: "hws.service.type.sdg", ProductId: "xxxxxxxxxxxx", ResourceSize: int32(30), ResourceSizeMeasureId: int32(30), ResourceSpecCode: "base_professional", ResourceType: "hws.resource.type.dsc.base", }, } isAutoRenewPeriodOrderRequest:= int32(0) request.Body = &model.PeriodOrderRequest{ Zone: "CH", RegionId: "xxxxxxxxxxxx", ProductInfos: listProductInfosbody, PeriodType: int32(2), PeriodNum: int32(1), IsAutoRenew: &isAutoRenewPeriodOrderRequest, CloudServiceType: "hws.service.type.sdg", ChargingMode: int32(0), } response, err := client.CreateProductOrder(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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