Modifying an App¶

Function¶

This API is used to modify the information about an app. Only the name and remark parameters can be modified. If the function of customizing keys and secrets is enabled, app_key and app_secret can also be modified.

Calling Method¶

For details, see Calling APIs.

URI¶

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}

**Table 1** Path Parameters¶
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.
app_id	Yes	String	App ID.

Request Parameters¶

**Table 2** Request header 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.

**Table 3** Request body parameters¶
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

**Table 4** Response body parameters¶
Parameter	Type	Description
id	String	ID.
name	String	Name.
remark	String	Description.
creator	String	Creator of the app. USER: The app is created by an API user. MARKET: The app is allocated by KooGallery. The value MARKET is currently not supported. Enumeration values: USER MARKET
update_time	String	Update time.
app_key	String	AppKey.
app_secret	String	AppSecret.
register_time	String	Registration time.
status	Integer	Status. 1: valid Enumeration values: 1
app_type	String	App type. apig: APIG app, which is not recommended. roma: ROMA integration application. The default value is apig. Other types are not supported currently. Enumeration values: apig roma
roma_app_type	String	ROMA application type. subscription: subscription application integration: integration application Currently, this parameter is not supported.

Status code: 400

**Table 5** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests¶

Modifying an app

{
  "name" : "app_demo",
  "remark" : "Demo app"
}

Example Responses¶

Status code: 201

{
  "creator" : "USER",
  "update_time" : "2020-08-03T13:21:48.381148828Z",
  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
  "name" : "app_demo",
  "remark" : "Demo app",
  "id" : "356de8eb7a8742168586e5daf5339965",
  "app_secret" : "416************ab8",
  "register_time" : "2020-08-03T13:09:13",
  "status" : 1,
  "app_type" : "apig"
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:id. 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: 404

Not Found

{
  "error_code" : "APIG.3002",
  "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes¶

Status Code	Description
201	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:54 UTC - commit: 0a62e5dc1182b13184917e7aa490e164e6eb655a