Configuring a Feature for a Gateway¶
Function¶
This API is used to configure a feature for a gateway.
For details about the supported features and configuration examples, see "Appendix" > "Supported Features" in this document.
URI¶
POST /v2/{project_id}/apigw/instances/{instance_id}/features
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Gateway ID, which can be obtained from the gateway information on the APIG console. |
Request 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 token. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | Yes | String | Feature name. Minimum: 1 Maximum: 64 |
enable | Yes | Boolean | Indicates whether to enable the feature. |
config | No | String | Parameter configuration. |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
id | String | Feature ID. |
name | String | Feature name. Minimum: 1 Maximum: 64 |
enable | Boolean | Indicates whether to enable the feature. |
config | String | Parameter configuration. |
instance_id | String | Gateway ID. |
update_time | String | Feature update time. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 403
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 404
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
Enabling the app_api_key switch
{
"name" : "app_api_key",
"config" : "on",
"enable" : true
}
Example Responses¶
Status code: 201
Created
{
"config" : "on",
"enable" : true,
"id" : "db9a9260cd3e4a16a9b5747a65d3ffaa",
"instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
"name" : "app_api_key",
"update_time" : "2020-08-24T01:17:31.041984021Z"
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2000",
"error_msg" : "unrecognized feature app-api-key"
}
Status code: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Status code: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Status code: 404
Not Found
{
"error_code" : "APIG.3030",
"error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
201 | Created |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.