Creating an App¶
Function¶
An app is an identity for accessing an API. An app can call the APIs to which it has been authorized.
This API is used to create an app.
Calling Method¶
For details, see Calling APIs.
URI¶
POST /v2/{project_id}/apigw/instances/{instance_id}/apps
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 | App name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed. |
remark | No | String | App description. It cannot exceed 255 characters. |
app_key | No | String | AppKey, which can contain 8 to 200 characters, starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
app_secret | No | String | Secret, which can contain 8 to 128 characters, starting with a letter or digit. Only letters, digits, and the following special characters are allowed: _-!@#$% |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
id | String | ID. |
name | String | Name. |
remark | String | Description. |
creator | String | Creator of the app.
The value MARKET is currently not supported. Enumeration values:
|
update_time | String | Update time. |
app_key | String | AppKey. |
app_secret | String | AppSecret. |
register_time | String | Registration time. |
status | Integer | Status.
Enumeration values:
|
app_type | String | App type.
The default value is apig. Other types are not supported currently. Enumeration values:
|
roma_app_type | String | ROMA application type.
Currently, this parameter is not supported. |
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: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
Creating an app
{
"name" : "app_demo",
"remark" : "Demo app"
}
Example Responses¶
Status code: 201
Created
{
"creator" : "USER",
"update_time" : "2020-08-03T13:09:13.122211909Z",
"app_key" : "ee8f878c252747028f07eb116c2cd91b",
"name" : "app_demo",
"remark" : "Demo app",
"id" : "356de8eb7a8742168586e5daf5339965",
"app_secret" : "416************ab8",
"register_time" : "2020-08-03T13:09:13.122211659Z",
"status" : 1,
"app_type" : "apig"
}
Status code: 400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
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: 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 |
500 | Internal Server Error |
Error Codes¶
See Error Codes.