Help Center/ Database Security Service/ API Reference/ API/ Enhanced O&M Management/ Buying a Yearly/Monthly Database O&M Instance
Updated on 2025-09-10 GMT+08:00

Buying a Yearly/Monthly Database O&M Instance

Function

Buying a Yearly/Monthly Database O&M Instance

URI

POST /v2/{project_id}/db-om/charge/period/order

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

** Parameter description**:

Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

** Restrictions**:

N/A

** Value range**:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

** Default value**:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

** Parameter description**:

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

** Restrictions**:

N/A

** Value range**:

Used by the IAM service to query the user token.

** Default value**:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

No

Array of ResourceTagInfoBean objects

Resource tags

asset_nums

Yes

Integer

Asset Quantity

availability_zone

Yes

String

AZ

charging_mode

Yes

Integer

Billing mode. The options are as follows:

cloud_service_type

Yes

String

Service Type

comment

No

String

Remarks.

composite_product_id

No

String

Package

deploy_mode

Yes

String

Instance deployment mode. The default value is cloud.

  • CLOUD: cloud

  • OUTSIDE: outside the cloud

discount_id

No

String

Discount ID.

enterprise_project_id

Yes

String

Enterprise project ID

flavor_ref

Yes

String

ECS flavor ID

hx_password

Yes

String

The password for logging in to the management console.

image_business_type

Yes

Integer

Mirroring Service Type

is_auto_renew

Yes

Integer

Self-paid renewal

  • 1: automatic

  • 0: no

name

Yes

String

Instance name

nics

Yes

Array of Nic objects

Network interface information.

outside_ins_config

No

OutsideInsConfig object

Cloud Instance Configuration

period_num

Yes

Integer

Number of subscription periods

period_type

Yes

Integer

Subscription period type.

product_infos

Yes

Array of ProductInfoBeanNew objects

Product list

promotion_activity_id

No

String

Promotion ID.

promotion_info

No

String

Discount information.

public_ip

No

PublicIp object

Elastic IP Address

region_id

No

String

Region ID.

security_groups

Yes

Array of SecurityGroup objects

Security group information

subscription_num

Yes

Integer

Subscription quantity. Currently, only one device is supported.

vpc_id

Yes

String

VPC ID

Table 4 ResourceTagInfoBean

Parameter

Mandatory

Type

Description

key

No

String

Tag key

value

Yes

String

Tag value

Table 5 Nic

Parameter

Mandatory

Type

Description

ip_address

No

String

IP address. If this parameter is left blank or is set to an empty string, the IP address is automatically allocated.

subnet_id

No

String

Subnet ID

Table 6 OutsideInsConfig

Parameter

Mandatory

Type

Description

master_node_ip

No

String

Primary Node IP Address

slave_node_ip

No

String

Slave node IP address

virtual_ip

No

String

Virtual IP address

Table 7 ProductInfoBeanNew

Parameter

Mandatory

Type

Description

all_resource_names

No

Array of strings

Names of all resources

cloud_service_type

No

String

Cloud Service Type

display_id

No

String

Display ID

product_id

No

String

Product ID

product_spec_desc

No

String

Specifies the description of product specifications.

resource_name

No

String

Resource name.

resource_spec_code

No

String

resource_spec

resource_type

No

String

Resource Type

Table 8 PublicIp

Parameter

Mandatory

Type

Description

eip

No

EIP object

EIP information.

id

No

String

IP Address ID

Table 9 EIP

Parameter

Mandatory

Type

Description

bandwidth

No

BandWidth object

Bandwidth parameters.

ipproductid

No

String

IP Product ID

iptype

No

String

EIP Type

Table 10 BandWidth

Parameter

Mandatory

Type

Description

chargemode

No

String

Specifies the billing mode.

productid

No

String

Product ID corresponding to the bandwidth.

sharetype

No

String

Share type. Currently, only PER is supported.

size

No

Integer

Bandwidth: 1-100 Mbit/s (pay-per-use); 1-300 Mbit/s (yearly/monthly)

Table 11 SecurityGroup

Parameter

Mandatory

Type

Description

id

No

String

Security group ID.

Response Parameters

Status code: 200

Table 12 Response body parameters

Parameter

Type

Description

code

String

Return code

description

String

Description

order_id

String

Order ID.

Status code: 400

Table 13 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 14 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

Table 15 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 16 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 17 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 18 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 19 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 20 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v2/{project_id}/db-om/charge/period/order

{
  "flavor_ref" : "s6.2xlarge.2",
  "name" : "DBSS-f5e1",
  "vpc_id" : "21f3dac4-f460-4173-ba5e-cb7a0d528605",
  "availability_zone" : "cn-north-7c,cn-north-7c",
  "nics" : [ {
    "subnet_id" : "cbed162e-045a-4afd-aa2b-0da11219989c"
  } ],
  "security_groups" : [ {
    "id" : "0070ec22-bae4-4df3-af3d-9f928297b3b7"
  } ],
  "cloud_service_type" : "hws.service.type.dbss",
  "charging_mode" : 0,
  "period_type" : 2,
  "period_num" : 1,
  "subscription_num" : 1,
  "is_auto_renew" : 0,
  "promotion_info" : "",
  "product_infos" : [ {
    "product_id" : "OFFI10097xxxxxxxxxxxx693761",
    "cloud_service_type" : "hws.service.type.dbss",
    "resource_type" : "hws.resource.type.dbss.opsmgmt",
    "resource_spec_code" : "dbss.opsmgmt.high",
    "product_spec_desc" : "{\"specDesc\":{\"zh-cn\":{\" Host name \":\"DBSS-f5e1\", \"Specifications\": \"Database Audit O&M Enhanced Edition\", \"VPC\": \"VPC-IPV4-Do not enable IPv6\", \"Subnet \":\"subnet-ipv4\"},\"en-us\":{\"Instance Name\":\"DBSS-f5e1\",\"Edition\": \"Database Audit O&M Enhanced Edition\", \"VPC\": \"VPC-IPV4-Do not enable ipv6\",\"Subnet\":\"subnet-ipv4\"}}}"
  } ],
  "region_id" : "cn-north-7",
  "hx_password" : "Firelxxxxxxx123!",
  "asset_nums" : 10,
  "image_business_type" : 1,
  "public_ip" : {
    "id" : "df0d32e1-671e-482b-bafd-413fa67d3add",
    "eip" : null
  },
  "enterprise_project_id" : "0"
}

Example Responses

Status code: 200

OK

{
  "description" : "Success",
  "code" : "0",
  "order_id" : "CS250825171489W7N"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.