Creating an Order Quota by HSS

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/quotas/orders

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
Content-Type	No	String	Definition Content type. Constraints N/A Range The value can contain 0 to 128 characters. Default Value application/json; charset=utf-8
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
resource_spec_code	Yes	String	Definition Resource specifications. Constraints N/A Range 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 Default Value N/A
period_type	Yes	Integer	Definition Subscription period type. Constraints N/A Range 2: month 3: year Default Value N/A
period_num	Yes	Integer	Definition Number of subscription periods. Constraints N/A Range An integer in the range 1 to 1000. Default Value N/A
is_auto_renew	No	Boolean	Definition Whether to support auto renewal. The options are true (yes) and false (no). Constraints N/A Range true/false Default Value false
is_auto_pay	No	Boolean	Definition Whether to support automatic payment. The options are true (yes) and false (no). Constraints N/A Range true/false Default Value false
subscription_num	Yes	Integer	Definition Subscription quantity. Constraints N/A Range An integer in the range 1 to 500. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
order_id	String	Definition Order ID Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

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
}