Obtaining the Backend Switch Control Information List

Function

This API is used to obtain the switch control information list of the current version.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/feature/config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain the value, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. For details, see Obtaining a User Token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
switch_info	SwitchInfo object	Status of service functions.
version_info	VersionInfo object	Status of instance edition functions.

**Table 4** SwitchInfo
Parameter	Type	Description
is_support_unibuy	Boolean	Whether unibuy is supported. true: yes false: no
is_support_float_ipv6	Boolean	Whether floating IPv6 addresses are supported. true: yes false: no
is_support_admin_login	Boolean	Whether administrator login is supported. true: yes false: no
is_support_update_ha	Boolean	Whether HA update is supported. true: yes false: no
is_support_tms	Boolean	Whether TMS is supported. true: yes false: no
is_support_eps	Boolean	Whether EPS is supported. true: yes false: no
is_support_iam_login	Boolean	Whether IAM login is supported. true: yes false: no
is_support_ipv6	Boolean	Whether IPv6 is supported. true: yes false: no
is_support_ha	Boolean	Whether HA is supported. true: yes false: no
is_support_reset	Boolean	Whether resetting is supported. true: yes false: no
is_support_upgrade_instance	Boolean	Whether the instance can be upgraded. true: yes false: no
is_support_change_security_group	Boolean	Whether security groups can be changed. true: yes false: no
is_support_manually_ip	Boolean	Whether the IP address can be manually configured. true: yes false: no
is_support_capacity_expantion	Boolean	Whether the capacity can be expanded. true: yes false: no
is_support_ha_expantion	Boolean	Whether HA expansion is supported. true: yes false: no
is_support_agency_authorize	Boolean	Whether the proxy authorization is supported. true: yes false: no
is_support_change_vpc	Boolean	Whether the VPC can be changed. true: yes false: no
is_support_cluster	Boolean	Whether clusters are supported. true: yes false: no
is_support_ondemand	Boolean	Whether pay-per-use is supported. true: yes false: no
is_support_period	Boolean	Whether monthly/yearly subscription is supported. true: yes false: no

**Table 5** VersionInfo
Parameter	Type	Description
require_eip	Boolean	Whether EIP is supported. true: yes false: no
iam_login	Boolean	Whether IAM login is supported. true: yes false: no
admin_login	Boolean	Whether administrator login is supported. true: yes false: no
float_ipv6	Boolean	Whether floating IPv6 addresses are supported. true: yes false: no

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Incorrect request parameters.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Failed to verify the token.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Permissions required.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

get switch config info Success

"switch_info:
   is_support_unibuy: false
   is_support_float_ipv6: true
   is_support_admin_login: true
   is_support_update_ha: true
   is_support_tms: true
   is_support_eps: true
   is_support_iam_login: true
   is_support_ipv6: true
   is_support_ha: true
   is_support_reset: true
   is_support_upgrade_instance: true
   is_support_change_security_group: true
   is_support_manually_ip: true
   is_support_capacity_expantion: true
   is_support_ha_expantion: true
   is_support_agency_authorize: true
   is_support_change_vpc: true
   is_support_cluster: true
   is_support_ondemand: false
   is_support_period: true
 version_info:
   require_eip: 3.3.2.0
   iam_login: 3.3.44.0
   admin_login: 3.3.52.1
   float_ipv6: 3.3.56.0
 "