Updated on 2024-10-09 GMT+08:00

Creating an Order Quota by HSS

Function

The billing mode can only be yearly/monthly when an order quota is created by HSS.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/quotas/orders

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 0

Maximum: 512

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

Minimum: 0

Maximum: 128

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a user token.

Minimum: 0

Maximum: 4096

Content-Type

No

String

Default value: application/json; charset=utf-8

Minimum: 0

Maximum: 128

region

Yes

String

Region ID

Minimum: 0

Maximum: 32

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

resource_spec_code

Yes

String

Specifications

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

Minimum: 0

Maximum: 128

period_type

Yes

Integer

Subscription period type.

  • 2: month

  • 3: year

Minimum: 0

Maximum: 100

period_num

Yes

Integer

Number of subscription periods

Minimum: 0

Maximum: 1000

is_auto_renew

No

Boolean

Whether to support auto renewal. The options are true (yes) and false (no). The default value is false.

is_auto_pay

No

Boolean

whether to support automatic payment. The options are true (yes) and false (no). The default value is false.

subscription_num

Yes

Integer

Subscription quantity

Minimum: 0

Maximum: 500

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

order_id

String

Order ID

Minimum: 0

Maximum: 256

Example Requests

Create an order of HSS enterprise edition quota. The order information is as follows. The billing mode is yearly/monthly. The quantity is 1. The subscription period is 1. The subscription period type is monthly. Automatic renewal is disabled. The order will be automatically paid.

POST https://{endpoint}/v5/{project_id}/quotas/orders

{
  "resource_spec_code" : "hss.version.enterprise",
  "subscription_num" : 1,
  "period_num" : 1,
  "period_type" : 2,
  "is_auto_renew" : false,
  "is_auto_pay" : false
}

Example Responses

Status code: 200

Subscription information

{
  "order_id" : "CS2404171642AAAAA"
}

SDK Sample Code

The SDK sample code is as follows.

Create an order of HSS enterprise edition quota. The order information is as follows. The billing mode is yearly/monthly. The quantity is 1. The subscription period is 1. The subscription period type is monthly. Automatic renewal is disabled. The order will be automatically paid.

 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
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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class CreateQuotasOrderSolution {

    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);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateQuotasOrderRequest request = new CreateQuotasOrderRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        CreateQuotasOrderRequestInfo body = new CreateQuotasOrderRequestInfo();
        body.withSubscriptionNum(1);
        body.withIsAutoPay(false);
        body.withIsAutoRenew(false);
        body.withPeriodNum(1);
        body.withPeriodType(2);
        body.withResourceSpecCode("hss.version.enterprise");
        request.withBody(body);
        try {
            CreateQuotasOrderResponse response = client.createQuotasOrder(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());
        }
    }
}

Create an order of HSS enterprise edition quota. The order information is as follows. The billing mode is yearly/monthly. The quantity is 1. The subscription period is 1. The subscription period type is monthly. Automatic renewal is disabled. The order will be automatically paid.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateQuotasOrderRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.body = CreateQuotasOrderRequestInfo(
            subscription_num=1,
            is_auto_pay=False,
            is_auto_renew=False,
            period_num=1,
            period_type=2,
            resource_spec_code="hss.version.enterprise"
        )
        response = client.create_quotas_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)

Create an order of HSS enterprise edition quota. The order information is as follows. The billing mode is yearly/monthly. The quantity is 1. The subscription period is 1. The subscription period type is monthly. Automatic renewal is disabled. The order will be automatically paid.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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 := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateQuotasOrderRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	isAutoPayCreateQuotasOrderRequestInfo:= false
	isAutoRenewCreateQuotasOrderRequestInfo:= false
	request.Body = &model.CreateQuotasOrderRequestInfo{
		SubscriptionNum: int32(1),
		IsAutoPay: &isAutoPayCreateQuotasOrderRequestInfo,
		IsAutoRenew: &isAutoRenewCreateQuotasOrderRequestInfo,
		PeriodNum: int32(1),
		PeriodType: int32(2),
		ResourceSpecCode: "hss.version.enterprise",
	}
	response, err := client.CreateQuotasOrder(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

Subscription information

Error Codes

See Error Codes.