Updated on 2024-03-05 GMT+08:00

Querying Service Specifications

Function

This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created. For example, to create a master/standby DCS Redis 3.0 instance in pay-per-use mode, locate the record in the response message in which the value of charging_type is Hourly and the value of spec-code is dcs.master_standby. Then, the value of product_id is the product ID that should be configured for the DCS instance.

URI

GET /v1.0/products

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 1 describes the response parameters.
Table 1 Parameter description

Parameter

Type

Description

products

Array

List of specifications of the DCS service to which you can subscribe.

Table 2 products parameter description

Parameter

Type

Description

product_id

String

Product ID used to differentiate DCS specifications.

NOTE:

When obtaining the product ID from the product specifications, ensure that the billing mode specified in the product ID is the same as the selected billing mode. For example, to buy a master/standby DCS Redis 3.0 instance billed in pay-per-use mode, you can search for the product ID corresponding to the record whose charging_type is Hourly and spec_code is dcs.master_standby in the response message.

spec_code

String

DCS instance specification code.

  • dcs.single_node
  • dcs.master_standby
  • dcs.cluster

cache_mode

String

DCS instance type. Options:

  • single: single-node
  • ha: master/standby
  • cluster: Redis Cluster
  • proxy: Proxy Cluster
  • ha_rw_split: read/write splitting

product_type

String

Edition of DCS for Redis.

cpu_type

String

CPU architecture.

storage_type

String

Storage type.

details

Array

Details of the specifications. Table 3 describes the parameters in this array.

engine

String

Cache engine.

engine_versions

String

Cache engine version.

spec_details

String

DCS specifications. The value subjects to the returned specifications.

spec_details2

String

Detailed DCS specifications, including the maximum number of connections and maximum memory size.

charging_type

String

Billing mode. Value: Hourly.

price

doubule

Price of the DCS service to which you can subscribe. (This parameter has been abandoned.)

currency

String

Currency.

prod_type

String

Product type.

Options: instance and obs_space.

cloud_service_type_code

String

Cloud service type code.

cloud_resource_type_code

String

Cloud resource type code.

flavors

Array

AZs with available resources. Table 4 describes the parameters in this array.

billing_factor

String

Billing item.

Table 3 details parameter description

Parameter

Type

Description

capacity

String

Specification (total memory) of the DCS instance.

max_bandwidth

String

Maximum bandwidth supported by the specification.

max_clients

String

Maximum number of clients supported by the specification, which is usually equal to the maximum number of connections.

max_connections

String

Maximum number of connections supported by the specification.

max_in_bandwidth

String

Maximum inbound bandwidth supported by the specification, which is usually equal to the maximum bandwidth.

max_memory

String

Maximum available memory.

tenant_ip_count

String

Number of tenant IP addresses corresponding to the specifications.

sharding_num

String

Number of shards supported by the specifications.

proxy_num

String

Number of proxies supported by Proxy Cluster instances of the specified specifications. If the instance is not a Proxy Cluster instance, the value of this parameter is 0.

db_number

String

Number of DBs of the specifications.

Table 4 flavors parameter description

Parameter

Type

Description

capacity

String

Specification (total memory) of the DCS instance.

unit

String

Memory unit.

available_zones

Array

AZ ID.

Example response

	{
		"product_id": "dcs.master_standby-h",
		"spec_code": "dcs.master_standby",
		"cache_mode": "ha",
		"product_type": "generic",
		"cpu_type": "x86_64",
		"storage_type": "DRAM",
		"details": {
			"capacity": 2,
			"max_memory": 1.5,
			"max_connections": 10000,
			"max_clients": 5000,
			"max_bandwidth": 512,
			"max_in_bandwidth": 42,
			"tenant_ip_count": 3,
			"sharding_num": 1,
			"proxy_num": 0,
			"db_number": 256
		},
		"engine": "redis",
		"engine_versions": "3.0",
		"spec_details": "[{\"mem\":\"2,4,8,16,32,64\"}]",
		"spec_details2": "[{\"capacity\":2,\"max_memory\":1.5,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":512,\"max_in_bandwidth\":42,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":4,\"max_memory\":3.2,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":8,\"max_memory\":6.4,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":16,\"max_memory\":12.8,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":32,\"max_memory\":25.6,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":64,\"max_memory\":51.2,\"max_connections\":12000,\"max_clients\":5000,\"max_bandwidth\":5120,\"max_in_bandwidth\":128,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256}]",
		"charging_type": "Hourly",
		"price": 0.0,
		"currency": "",
		"prod_type": "instance",
		"cloud_service_type_code": "hws.service.type.dcs",
		"cloud_resource_type_code": "hws.resource.type.dcs",
		"flavors": [{
			"capacity": "2",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		},
		{
			"capacity": "4",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		},
		{
			"capacity": "8",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		},
		{
			"capacity": "16",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		},
		{
			"capacity": "32",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		},
		{
			"capacity": "64",
			"unit": "GB",
			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
			"ae04cf9d61544df3806a3feeb401b204",
			"d573142f24894ef3bd3664de068b44b0"]
		}],
		"billing_factor": "Duration"
	}

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 5 Status code

Status Code

Description

200

Service specifications queried successfully.