From 08c8a0d9e56568c5c276028026b4c004cfee820a Mon Sep 17 00:00:00 2001 From: chenjunjie Date: Fri, 13 Dec 2024 15:13:35 +0000 Subject: [PATCH] APIG API 20241115 version Reviewed-by: Topchii, Maria Co-authored-by: chenjunjie Co-committed-by: chenjunjie --- docs/apig/api-ref/ALL_META.TXT.json | 2 +- docs/apig/api-ref/CLASS.TXT.json | 2 +- docs/apig/api-ref/CreateEnvironmentV2.html | 256 ++++++------ .../api-ref/CreatePostPayResizeOrder.html | 4 +- docs/apig/api-ref/ListInstanceFeatures.html | 4 +- .../apig/api-ref/ShowDetailsOfInstanceV2.html | 163 +++++--- docs/apig/api-ref/UpdateAppV2.html | 380 +++++++++--------- docs/apig/api-ref/UpdateInstanceV2.html | 181 +++++---- docs/apig/api-ref/apig-api-180713215.html | 14 +- docs/apig/api-ref/apig-api-20200402.html | 2 +- 10 files changed, 541 insertions(+), 467 deletions(-) diff --git a/docs/apig/api-ref/ALL_META.TXT.json b/docs/apig/api-ref/ALL_META.TXT.json index 83a0e0eef..aa4a4ce89 100644 --- a/docs/apig/api-ref/ALL_META.TXT.json +++ b/docs/apig/api-ref/ALL_META.TXT.json @@ -289,7 +289,7 @@ "node_id":"createenvironmentv2.xml", "product_code":"apig", "code":"16", - "des":"API providers can publish an API in different environments, such as the development, test, and production environments.API information, such as the version, request addre", + "des":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address", "doc_type":"api", "kw":"Creating an Environment,Environment Management,API Reference", "search_title":"", diff --git a/docs/apig/api-ref/CLASS.TXT.json b/docs/apig/api-ref/CLASS.TXT.json index f7e029034..f613391f6 100644 --- a/docs/apig/api-ref/CLASS.TXT.json +++ b/docs/apig/api-ref/CLASS.TXT.json @@ -135,7 +135,7 @@ "code":"15" }, { - "desc":"API providers can publish an API in different environments, such as the development, test, and production environments.API information, such as the version, request addre", + "desc":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address", "product_code":"apig", "title":"Creating an Environment", "uri":"CreateEnvironmentV2.html", diff --git a/docs/apig/api-ref/CreateEnvironmentV2.html b/docs/apig/api-ref/CreateEnvironmentV2.html index 0c79bd217..964e7d7f6 100644 --- a/docs/apig/api-ref/CreateEnvironmentV2.html +++ b/docs/apig/api-ref/CreateEnvironmentV2.html @@ -1,331 +1,331 @@

Creating an Environment

-

Function

API providers can publish an API in different environments, such as the development, test, and production environments.

-

API information, such as the version, request address, and even request message, varies depending on the environment in which an API is published. For example, v1.0 of an API is published in the production environment, v1.1 in the test environment, and v1.2 in the development environment.

-

APIG provides environment management, enabling you to access APIG in different scenarios at minimal costs.

+

Function

API poviders can publish an API in different environments, such as the development, test, and production environments

+

API information, such as the version, request address, and even request message, varies depending on the environment in which an API is published. For example, v1.0 of an API is published in the production environment, v1.1 in the test environment, and v1.2 in the development environment.

+

APIG provides environment management, enabling you to access APIG in different scenarios at minimal costs.

-

Calling Method

For details, see Calling APIs.

+

Calling Method

For details, see Calling APIs.

-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/envs

+

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/envs

-
Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

+

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

+

Gateway ID, which can be obtained from the gateway information on the APIG console.
-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

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.

+

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

+
- - - - - - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

String

Environment name, which can contain letters, digits, and underscores (_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

+

Environment name, which can contain letters, digits, and underscores (_) and must start with a letter.

+

Minimum: 3

+

Maximum: 64

remark

+

remark

No

+

No

String

+

String

Description.

-

Maximum: 255

+

Description.

+

Maximum: 255
-

Response Parameters

Status code: 201

+

Response Parameters

Status code: 201

-
Table 4 Response body parameters

Parameter

+
- - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

create_time

+

create_time

String

+

String

Creation time.

+

Creation time.

name

+

name

String

+

String

Environment name.

+

Environment name.

remark

+

remark

String

+

String

Description.

+

Description.

id

+

id

String

+

String

Environment ID.

+

Environment ID.
-

Status code: 400

+

Status code: 400

-
Table 5 Response body parameters

Parameter

+
- - - - - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.
-

Status code: 401

+

Status code: 401

-
Table 6 Response body parameters

Parameter

+
- - - - - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.
-

Status code: 403

+

Status code: 403

-
Table 7 Response body parameters

Parameter

+
- - - - - - - -
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.
-

Status code: 500

+

Status code: 500

-
Table 8 Response body parameters

Parameter

+
- - - - - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.
-

Example Requests

Creating an environment

-
{
+
Example Requests
Creating an environment

+
{
   "name" : "DEV",
   "remark" : "Development environment"
 }

 

-
Example Responses
Status code: 201

-
Created

-
{
+
Example Responses
Status code: 201

+
Created

+
{
   "create_time" : "2020-07-31T06:41:43.511347628Z",
   "name" : "DEV",
   "remark" : "Development environment",
   "id" : "7a1ad0c350844ee69479b47df9a881cb"
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "APIG.2012",
   "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
 }

-
Status code: 401

-
Unauthorized

-
{
+
Status code: 401

+
Unauthorized

+
{
   "error_code" : "APIG.1002",
   "error_msg" : "Incorrect token or token resolution failed"
 }

-
Status code: 403

-
Forbidden

-
{
+
Status code: 403

+
Forbidden

+
{
   "error_code" : "APIG.1005",
   "error_msg" : "No permissions to request this method"
 }

-
Status code: 500

-
Internal Server Error

-
{
+
Status code: 500

+
Internal Server Error

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

 

-
Status Codes

-

-
diff --git a/docs/apig/api-ref/ListInstanceFeatures.html b/docs/apig/api-ref/ListInstanceFeatures.html
index 863617348..c44099e93 100644
--- a/docs/apig/api-ref/ListInstanceFeatures.html
+++ b/docs/apig/api-ref/ListInstanceFeatures.html
@@ -127,8 +127,8 @@
 
-
diff --git a/docs/apig/api-ref/ShowDetailsOfInstanceV2.html b/docs/apig/api-ref/ShowDetailsOfInstanceV2.html
index 66d50a44d..dfa2fe67b 100644
--- a/docs/apig/api-ref/ShowDetailsOfInstanceV2.html
+++ b/docs/apig/api-ref/ShowDetailsOfInstanceV2.html
@@ -180,6 +180,14 @@
 
  • elb

+
+
+
+
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
201

+
201

 
Created

+
Created

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/apig/api-ref/CreatePostPayResizeOrder.html b/docs/apig/api-ref/CreatePostPayResizeOrder.html
index edb8b1681..ab8d117df 100644
--- a/docs/apig/api-ref/CreatePostPayResizeOrder.html
+++ b/docs/apig/api-ref/CreatePostPayResizeOrder.html
@@ -206,7 +206,7 @@
   "spec_id" : "PROFESSIONAL"
 }
 

-
Example Responses
Status code: 200

+
Example Responses
Status code: 202

 
ACCEPTED

 
{
   "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
@@ -239,7 +239,7 @@
 

 

 
200

+
202

 		
 
ACCEPTED

 		
 
Array of strings

 
Supported features:

-
  • "resize_huge_flavor"
  • "health_check_in_instance_etcd"
  • "shubao_support_add_node"
  • "upgrade_uninterrupted"
  • "shubao_support_pp2"
  • "shubao_support_full_pp2"
  • "etcd_cert_update"
  • "scc_material_update"

+
Supported features (built-in and no need to configure):

+
  • "resize_huge_flavor": Change to higher specifications
  • "health_check_in_instance_etcd": Health check
  • "shubao_support_add_node": Capacity expansion
  • "upgrade_uninterrupted": Upgrade without service interruption.
  • "shubao_support_pp2": PP2
  • "shubao_support_full_pp2": IPv6 PP2
  • "etcd_cert_update": etcd_cert update
  • "scc_material_update": scc_material update

 
Features not displayed in the list are not supported by the gateway.

 		
 

 
 
cbc_operation_locks

+
Array of CbcOperationLock objects

+
Cloud operations restriction lock.

+
This parameter is not used currently.

+

 
description

 		
 
String

@@ -380,78 +388,107 @@
 

 

 
-
Table 4 EndpointService
Parameter

+

-
-
-
-
-
-
-
-
Table 4 CbcOperationLock
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
service_name

+
lock_scene

 
String

+
String

 
VPC endpoint service name.

+
Restriction scenarios:

+
  • TO_PERIOD_LOCK: Changing the billing mode from pay-per-use to yearly/monthly. In this scenario, deleting resources, changing specifications, and changing from pay-per-use to yearly/monthly are not allowed.
  • SPEC_CHG_LOCK: Changing specifications of the yearly/monthly billing mode. In this scenario, deleting resources and changing specifications are not allowed.

+
Enumeration values:

+
  • TO_PERIOD_LOCK
  • PEC_CHG_LOCK

 		
 
created_at

+
lock_source_id

 
String

+
String

 
Creation time.

+
ID of the object that initiates the restriction

 		
 

 
 

 

 
-
Table 5 NodeIps
Parameter

+

-
-
-
-
-
-
-
-
Table 5 EndpointService
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
livedata

+
service_name

 
Array of strings

+
String

 
LiveData node IP addresses.

+
VPC endpoint service name.

 		
 
shubao

+
created_at

 
Array of strings

+
String

 
Shubao node IP addresses.

+
Creation time.

 		
 

 
 

 

 
-
Table 6 IpDetails
Parameter

+

-
-
-
-
-
-
-
-
+
+
+
Table 6 NodeIps
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
ip_address

+
livedata

 
String

+
Array of strings

 
IP address.

+
LiveData node IP addresses.

 		
 
bandwidth_size

+
shubao

 
Integer

+
Array of strings

 
Bandwidth.

+
Shubao node IP addresses.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
@@ -459,26 +496,26 @@
 
Status code: 401

 
-
Table 7 IpDetails
Parameter

+
Type

+
Description

+
ip_address

+
String

+
IP address.

+
bandwidth_size

+
Integer

+
Bandwidth.

 		
 

 
 
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -486,26 +523,26 @@
 
Status code: 403

 
-
Table 8 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -513,26 +550,26 @@
 
Status code: 404

 
-
Table 9 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 9 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -540,26 +577,26 @@
 
Status code: 500

 
-
Table 10 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 10 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
diff --git a/docs/apig/api-ref/UpdateAppV2.html b/docs/apig/api-ref/UpdateAppV2.html
index 29e9c174c..409067472 100644
--- a/docs/apig/api-ref/UpdateAppV2.html
+++ b/docs/apig/api-ref/UpdateAppV2.html
@@ -1,387 +1,375 @@
 
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.

+
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.

+
Calling Method
For details, see Calling APIs.

 

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

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

 
-
Table 11 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
 
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID. For details about how to obtain it, see Obtaining a Project ID.

+
Project ID. For details about how to obtain it, see Obtaining a Project ID.

 		
 
instance_id

+
instance_id

 
Yes

+
Yes

 
String

+
String

 
Gateway ID, which can be obtained from the gateway information on the APIG console.

+
Gateway ID, which can be obtained from the gateway information on the APIG console.

 		
 
app_id

+
app_id

 
Yes

+
Yes

 
String

+
String

 
App ID.

+
App ID.

 		
 

 
 

 

 
-
Request Parameters

-
Table 2 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 2 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
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.

+
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

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 Request body parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
name

+
name

 
Yes

+
Yes

 
String

+
String

 
App name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

+
App name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

 		
 
remark

+
remark

 
No

+
No

 
String

+
String

 
App description. It cannot exceed 255 characters.

+
App description. It cannot exceed 255 characters.

 		
 
app_key

+
app_key

 
No

+
No

 
String

+
String

 
AppKey, which can contain 8 to 200 characters, starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.

+
AppKey, which can contain 8 to 200 characters, starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.

 		
 
app_secret

+
app_secret

 
No

+
No

 
String

+
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: _-!@#$%

+
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

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
id

+
id

 
String

+
String

 
ID.

+
ID.

 		
 
name

+
name

 
String

+
String

 
Name.

+
Name.

 		
 
remark

+
remark

 
String

+
String

 
Description.

+
Description.

 		
 
creator

+
creator

 
String

+
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
    
-

+
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

+
update_time

 
String

+
String

 
Update time.

+
Update time.

 		
 
app_key

+
app_key

 
String

+
String

 
AppKey.

+
AppKey.

 		
 
app_secret

+
app_secret

 
String

+
String

 
AppSecret.

+
AppSecret.

 		
 
register_time

+
register_time

 
String

+
String

 
Registration time.

+
Registration time.

 		
 
status

+
status

 
Integer

+
Integer

 
Status.

-
  • 1: valid
    
-

-
Enumeration values:

-
  • 1
    
-

+
Status.

+
  • 1: valid

+
Enumeration values:

+
  • 1

 		
 
app_type

+
app_type

 
String

+
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
    
-

+
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

+
roma_app_type

 
String

+
String

 
ROMA application type.

-
  • subscription: subscription application
    
-
  • integration: integration application
    
-

-
Currently, this parameter is not supported.

+
ROMA application type.

+
  • subscription: subscription application
  • integration: integration application

+
Currently, this parameter is not supported.

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 5 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 5 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 

 

-
Status code: 401

+
Status code: 401

 
-
Table 6 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 6 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 

 

-
Status code: 403

+
Status code: 403

 
-
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 7 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 

 

-
Status code: 404

+
Status code: 404

 
-
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 8 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 

 

-
Status code: 500

+
Status code: 500

 
-
Table 9 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 9 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 

 

 
-
Example Requests
Modifying an app

-
{
+
Example Requests
Modifying an app

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

 

-
Example Responses
Status code: 201

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "creator" : "USER",
   "update_time" : "2020-08-03T13:21:48.381148828Z",
   "app_key" : "ee8f878c252747028f07eb116c2cd91b",
@@ -393,79 +381,79 @@
   "status" : 1,
   "app_type" : "apig"
 }

-
Status code: 400

-
Bad Request

-
{
+
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

-
{
+
Status code: 401

+
Unauthorized

+
{
   "error_code" : "APIG.1002",
   "error_msg" : "Incorrect token or token resolution failed"
 }

-
Status code: 403

-
Forbidden

-
{
+
Status code: 403

+
Forbidden

+
{
   "error_code" : "APIG.1005",
   "error_msg" : "No permissions to request this method"
 }

-
Status code: 404

-
Not Found

-
{
+
Status code: 404

+
Not Found

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

-
Status code: 500

-
Internal Server Error

-
{
+
Status code: 500

+
Internal Server Error

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

 

-
Status Codes

-

+
+
+
+
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
201

+
200

 
OK

+
OK

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/apig/api-ref/UpdateInstanceV2.html b/docs/apig/api-ref/UpdateInstanceV2.html
index 560086db0..0fab14aa2 100644
--- a/docs/apig/api-ref/UpdateInstanceV2.html
+++ b/docs/apig/api-ref/UpdateInstanceV2.html
@@ -258,6 +258,14 @@
 
  • elb

 
 
cbc_operation_locks

+
Array of CbcOperationLock objects

+
Cloud operations restriction lock.

+
This parameter is not used currently.

+

 
description

 		
 
String

@@ -450,78 +458,107 @@
 

 

 
-
Table 5 EndpointService
Parameter

+

-
-
-
-
-
-
-
-
Table 5 CbcOperationLock
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
service_name

+
lock_scene

 
String

+
String

 
VPC endpoint service name.

+
Restriction scenarios:

+
  • TO_PERIOD_LOCK: Changing the billing mode from pay-per-use to yearly/monthly. In this scenario, deleting resources, changing specifications, and changing from pay-per-use to yearly/monthly are not allowed.
  • SPEC_CHG_LOCK: Changing specifications of the yearly/monthly billing mode. In this scenario, deleting resources and changing specifications are not allowed.

+
Enumeration values:

+
  • TO_PERIOD_LOCK
  • PEC_CHG_LOCK

 		
 
created_at

+
lock_source_id

 
String

+
String

 
Creation time.

+
ID of the object that initiates the restriction

 		
 

 
 

 

 
-
Table 6 NodeIps
Parameter

+

-
-
-
-
-
-
-
-
Table 6 EndpointService
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
livedata

+
service_name

 
Array of strings

+
String

 
LiveData node IP addresses.

+
VPC endpoint service name.

 		
 
shubao

+
created_at

 
Array of strings

+
String

 
Shubao node IP addresses.

+
Creation time.

 		
 

 
 

 

 
-
Table 7 IpDetails
Parameter

+

-
-
-
-
-
-
-
-
+
+
+
Table 7 NodeIps
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
ip_address

+
livedata

 
String

+
Array of strings

 
IP address.

+
LiveData node IP addresses.

 		
 
bandwidth_size

+
shubao

 
Integer

+
Array of strings

 
Bandwidth.

+
Shubao node IP addresses.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
@@ -529,26 +566,26 @@
 
Status code: 400

 
-
Table 8 IpDetails
Parameter

+
Type

+
Description

+
ip_address

+
String

+
IP address.

+
bandwidth_size

+
Integer

+
Bandwidth.

 		
 

 
 
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -556,26 +593,26 @@
 
Status code: 401

 
-
Table 9 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 9 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -583,26 +620,26 @@
 
Status code: 403

 
-
Table 10 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 10 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -610,26 +647,26 @@
 
Status code: 404

 
-
Table 11 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 11 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -637,26 +674,26 @@
 
Status code: 500

 
-
Table 12 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
Table 12 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
diff --git a/docs/apig/api-ref/apig-api-180713215.html b/docs/apig/api-ref/apig-api-180713215.html
index f222cfe8a..3a3723b2f 100644
--- a/docs/apig/api-ref/apig-api-180713215.html
+++ b/docs/apig/api-ref/apig-api-180713215.html
@@ -8,7 +8,19 @@
 
-
+
+
+
+
+
+
-
Table 13 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code.

+
Error code.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message.

+
Error message.

 		
 

 
 
 
2024-10-18

+
2024-12-13

+
This issue incorporates the following changes:

+
  • The example response status code of the API for modifying an app is changed from 201 to 200.
  • The response status code of the API for modifying the specifications of a pay-per-use gateway is changed from 200 to 202.

+
2024-12-10

+
This issue incorporates the following changes:

+
  • The response status code of the API for modifying an app is changed from 201 to 200.
  • The response body parameters table of the API for querying the supported features of a gateway is changed.

+
2024-10-18

 		
 
This issue incorporates the following changes:

 
diff --git a/docs/apig/api-ref/apig-api-20200402.html b/docs/apig/api-ref/apig-api-20200402.html
index d77ab2a19..466718846 100644
--- a/docs/apig/api-ref/apig-api-20200402.html
+++ b/docs/apig/api-ref/apig-api-20200402.html
@@ -444,7 +444,7 @@
 

 
xff_index

 
Sequence number of an IP address in the X-Forwarded-For header. The value of this parameter can be 0 or a positive or negative number. If the value is 0 or a positive number, the IP address of the corresponding index is obtained from the X-Forwarded-For header. If the value is a negative number, the IP address in reverse index order is obtained from the X-Forwarded-For header. For example, assume that the X-Forwarded-For header of a request received by API gateway contains three IP addresses: IP1, IP2, and IP3. If the value of xff_index is 0, IP1 is obtained. If the value of xff_index is 1, IP2 is obtained. If the value of xff_index is –1, IP3 is obtained.

+
Sequence number of an IP address in the X-Forwarded-For header. The value of this parameter can be 0 or a positive or negative number. If the value is 0 or a positive number, the IP address of the corresponding index is obtained from the X-Forwarded-For header. If the value is a negative number, the IP address in reverse index order is obtained from the X-Forwarded-For header. For example, assume that the X-Forwarded-For header of a request received by API gateway contains three IP addresses: IP1, IP2, and IP3. If the value of xff_index is 0, IP1 is obtained. If the value of xff_index is 1, IP2 is obtained. If the value of xff_index is –1, IP3 is obtained.

 		
 
-1