diff --git a/docs/apig/api-ref/ALL_META.TXT.json b/docs/apig/api-ref/ALL_META.TXT.json index 2edfccc6..83a0e0ee 100644 --- a/docs/apig/api-ref/ALL_META.TXT.json +++ b/docs/apig/api-ref/ALL_META.TXT.json @@ -3,136 +3,46 @@ "dockw":"API Reference" }, { - "uri":"apig-en-api-180713001.html", - "node_id":"apig-en-api-180713001.xml", + "uri":"apig-api-190529263.html", + "node_id":"apig-api-190529263.xml", "product_code":"apig", "code":"1", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.This", "doc_type":"api", - "kw":"Before You Start", + "kw":"Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Before You Start", "githuburl":"" }, { - "uri":"apig-api-190529263.html", - "node_id":"apig-api-190529263.xml", + "uri":"apig-api-0001.html", + "node_id":"apig-api-0001.xml", "product_code":"apig", "code":"2", - "des":"API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.This", + "des":"Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", "doc_type":"api", - "kw":"Overview,Before You Start,API Reference", + "kw":"API Usage,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], - "title":"Overview", + "title":"API Usage", "githuburl":"" }, { - "uri":"apig-api-190529264.html", - "node_id":"apig-api-190529264.xml", + "uri":"apig-api-180713003.html", + "node_id":"apig-api-180713003.xml", "product_code":"apig", "code":"3", - "des":"APIG supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", - "doc_type":"api", - "kw":"API Calling,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" - } - ], - "title":"API Calling", - "githuburl":"" - }, - { - "uri":"apig-api-190529265.html", - "node_id":"apig-api-190529265.xml", - "product_code":"apig", - "code":"4", - "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support.", - "doc_type":"api", - "kw":"Endpoints,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" - } - ], - "title":"Endpoints", - "githuburl":"" - }, - { - "uri":"apig-api-190529266.html", - "node_id":"apig-api-190529266.xml", - "product_code":"apig", - "code":"5", - "des":"The number of APIG resources that you can create is determined by your quota. To increase your quota, contact technical support.For more constraints, see API description.", - "doc_type":"api", - "kw":"Constraints,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" - } - ], - "title":"Constraints", - "githuburl":"" - }, - { - "uri":"apig-api-190529267.html", - "node_id":"apig-api-190529267.xml", - "product_code":"apig", - "code":"6", - "des":"AccountAn account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It c", - "doc_type":"api", - "kw":"Concepts,Before You Start,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" - } - ], - "title":"Concepts", - "githuburl":"" - }, - { - "uri":"apig-en-api-180713003.html", - "node_id":"apig-en-api-180713003.xml", - "product_code":"apig", - "code":"7", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Calling APIs", @@ -140,31 +50,25 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Calling APIs", "githuburl":"" }, { - "uri":"apig-en-api-180713011.html", - "node_id":"apig-en-api-180713011.xml", + "uri":"apig-api-180713011.html", + "node_id":"apig-api-180713011.xml", "product_code":"apig", - "code":"8", - "des":"This section describes the structure of a REST API request, and uses the APIG API for creating an API group (dedicated gateways) as an example to demonstrate how to call ", + "code":"4", + "des":"This section describes the structure of a REST API request, and uses the APIG API for creating an API group as an example to demonstrate how to call an API.A request URI ", "doc_type":"api", "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Making an API Request", @@ -174,18 +78,15 @@ "uri":"apig-api-190529268.html", "node_id":"apig-api-190529268.xml", "product_code":"apig", - "code":"9", - "des":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au", + "code":"5", + "des":"Requests for calling an API can be authenticated using either of the following methods:AK/SK-based authentication: Requests are authenticated by encrypting the request bo", "doc_type":"api", "kw":"Authentication,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Authentication", @@ -195,7 +96,7 @@ "uri":"apig-api-190529269.html", "node_id":"apig-api-190529269.xml", "product_code":"apig", - "code":"10", + "code":"6", "des":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", "doc_type":"api", "kw":"Response,Calling APIs,API Reference", @@ -203,10 +104,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Response", @@ -216,7 +114,7 @@ "uri":"apig-phapi-20070101.html", "node_id":"apig-phapi-20070101.xml", "product_code":"apig", - "code":"11", + "code":"7", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Dedicated Gateway APIs (V2)", @@ -224,20 +122,17 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Dedicated Gateway APIs (V2)", "githuburl":"" }, { - "uri":"ApiGroupManagement_1.html", - "node_id":"apigroupmanagement_1.xml", + "uri":"ApiGroupManagement.html", + "node_id":"apigroupmanagement.xml", "product_code":"apig", - "code":"12", + "code":"8", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Group Management", @@ -252,10 +147,10 @@ "githuburl":"" }, { - "uri":"CreateApiGroupV2_1.html", - "node_id":"createapigroupv2_1.xml", + "uri":"CreateApiGroupV2.html", + "node_id":"createapigroupv2.xml", "product_code":"apig", - "code":"13", + "code":"9", "des":"This API is used to create an API group. An API group is an API management unit and the entry to a service. A subdomain name is returned as the access entry when an API g", "doc_type":"api", "kw":"Creating an API Group,API Group Management,API Reference", @@ -272,11 +167,11 @@ "githuburl":"" }, { - "uri":"UpdateApiGroupV2_1.html", - "node_id":"updateapigroupv2_1.xml", + "uri":"UpdateApiGroupV2.html", + "node_id":"updateapigroupv2.xml", "product_code":"apig", - "code":"14", - "des":"This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.PUT /v2/{project_id}/apigw/instances/{insta", + "code":"10", + "des":"This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.For details, see Calling APIs.PUT /v2/{proj", "doc_type":"api", "kw":"Modifying an API Group,API Group Management,API Reference", "search_title":"", @@ -292,10 +187,10 @@ "githuburl":"" }, { - "uri":"DeleteApiGroupV2_1.html", - "node_id":"deleteapigroupv2_1.xml", + "uri":"DeleteApiGroupV2.html", + "node_id":"deleteapigroupv2.xml", "product_code":"apig", - "code":"15", + "code":"11", "des":"This API is used to delete an API group.If the group to delete contains APIs, take the APIs offline and delete them.All resources (independent domain names and SSL certif", "doc_type":"api", "kw":"Deleting an API Group,API Group Management,API Reference", @@ -312,11 +207,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfApiGroupV2_1.html", - "node_id":"showdetailsofapigroupv2_1.xml", + "uri":"ShowDetailsOfApiGroupV2.html", + "node_id":"showdetailsofapigroupv2.xml", "product_code":"apig", - "code":"16", - "des":"This API is used to query the details of an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}Status code: 200Status code: 400Status code:", + "code":"12", + "des":"This API is used to query the details of an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}Status code: 2", "doc_type":"api", "kw":"Querying API Group Details,API Group Management,API Reference", "search_title":"", @@ -332,11 +227,11 @@ "githuburl":"" }, { - "uri":"ListApiGroupsV2_1.html", - "node_id":"listapigroupsv2_1.xml", + "uri":"ListApiGroupsV2.html", + "node_id":"listapigroupsv2.xml", "product_code":"apig", - "code":"17", - "des":"This API is used to query API groups.You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.GET /v2/{", + "code":"13", + "des":"This API is used to query the API group list.You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.F", "doc_type":"api", "kw":"Querying API Groups,API Group Management,API Reference", "search_title":"", @@ -352,10 +247,30 @@ "githuburl":"" }, { - "uri":"EnvManagement_1.html", - "node_id":"envmanagement_1.xml", + "uri":"CheckApiGroupsV2.html", + "node_id":"checkapigroupsv2.xml", "product_code":"apig", - "code":"18", + "code":"14", + "des":"This API is used to check whether the API group name exists.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/checkStatus code:", + "doc_type":"api", + "kw":"Verifying an API Group Name,API Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CheckApiGroupsV2" + } + ], + "title":"Verifying an API Group Name", + "githuburl":"" + }, + { + "uri":"EnvManagement.html", + "node_id":"envmanagement.xml", + "product_code":"apig", + "code":"15", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Environment Management", @@ -370,10 +285,10 @@ "githuburl":"" }, { - "uri":"CreateEnvironmentV2_1.html", - "node_id":"createenvironmentv2_1.xml", + "uri":"CreateEnvironmentV2.html", + "node_id":"createenvironmentv2.xml", "product_code":"apig", - "code":"19", + "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", "doc_type":"api", "kw":"Creating an Environment,Environment Management,API Reference", @@ -390,11 +305,11 @@ "githuburl":"" }, { - "uri":"UpdateEnvironmentV2_1.html", - "node_id":"updateenvironmentv2_1.xml", + "uri":"UpdateEnvironmentV2.html", + "node_id":"updateenvironmentv2.xml", "product_code":"apig", - "code":"20", - "des":"This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.PUT /v2/{project_id}/apigw/instance", + "code":"17", + "des":"This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.For details, see Calling APIs.PUT /", "doc_type":"api", "kw":"Modifying an Environment,Environment Management,API Reference", "search_title":"", @@ -410,10 +325,10 @@ "githuburl":"" }, { - "uri":"DeleteEnvironmentV2_1.html", - "node_id":"deleteenvironmentv2_1.xml", + "uri":"DeleteEnvironmentV2.html", + "node_id":"deleteenvironmentv2.xml", "product_code":"apig", - "code":"21", + "code":"18", "des":"This API is used to delete an environment.This operation will cause the APIs published in the environment to become inaccessible to relevant apps and users. Ensure that y", "doc_type":"api", "kw":"Deleting an Environment,Environment Management,API Reference", @@ -430,11 +345,11 @@ "githuburl":"" }, { - "uri":"ListEnvironmentsV2_1.html", - "node_id":"listenvironmentsv2_1.xml", + "uri":"ListEnvironmentsV2.html", + "node_id":"listenvironmentsv2.xml", "product_code":"apig", - "code":"22", - "des":"This API is used to query environments.GET /v2/{project_id}/apigw/instances/{instance_id}/envsStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "code":"19", + "des":"This API is used to query environments.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/envsStatus code: 200Status code: 400Status code: 4", "doc_type":"api", "kw":"Querying Environments,Environment Management,API Reference", "search_title":"", @@ -450,10 +365,10 @@ "githuburl":"" }, { - "uri":"EnvVariableManagement_1.html", - "node_id":"envvariablemanagement_1.xml", + "uri":"EnvVariableManagement.html", + "node_id":"envvariablemanagement.xml", "product_code":"apig", - "code":"23", + "code":"20", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Environment Variable Management", @@ -468,10 +383,10 @@ "githuburl":"" }, { - "uri":"CreateEnvironmentVariableV2_1.html", - "node_id":"createenvironmentvariablev2_1.xml", + "uri":"CreateEnvironmentVariableV2.html", + "node_id":"createenvironmentvariablev2.xml", "product_code":"apig", - "code":"24", + "code":"21", "des":"Publishing an API in different environments may involve various variables, such as API service deployment address and request version.You can define environment variables", "doc_type":"api", "kw":"Creating a Variable,Environment Variable Management,API Reference", @@ -488,11 +403,11 @@ "githuburl":"" }, { - "uri":"DeleteEnvironmentVariableV2_1.html", - "node_id":"deleteenvironmentvariablev2_1.xml", + "uri":"DeleteEnvironmentVariableV2.html", + "node_id":"deleteenvironmentvariablev2.xml", "product_code":"apig", - "code":"25", - "des":"This API is used to delete an environment variable.DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Status code: 401Status code: 403St", + "code":"22", + "des":"This API is used to delete an environment variable.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Stat", "doc_type":"api", "kw":"Deleting a Variable,Environment Variable Management,API Reference", "search_title":"", @@ -508,11 +423,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfEnvironmentVariableV2_1.html", - "node_id":"showdetailsofenvironmentvariablev2_1.xml", + "uri":"ShowDetailsOfEnvironmentVariableV2.html", + "node_id":"showdetailsofenvironmentvariablev2.xml", "product_code":"apig", - "code":"26", - "des":"This API is used to query the details of an environment variable.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Status code: 200Status ", + "code":"23", + "des":"This API is used to query the details of an environment variable.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_varia", "doc_type":"api", "kw":"Querying Variable Details,Environment Variable Management,API Reference", "search_title":"", @@ -528,11 +443,11 @@ "githuburl":"" }, { - "uri":"ListEnvironmentVariablesV2_1.html", - "node_id":"listenvironmentvariablesv2_1.xml", + "uri":"ListEnvironmentVariablesV2.html", + "node_id":"listenvironmentvariablesv2.xml", "product_code":"apig", - "code":"27", - "des":"This API is used to query all environment variables under an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variablesStatus code: 200Status code: 400Sta", + "code":"24", + "des":"This API is used to query all environment variables under an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variablesStatu", "doc_type":"api", "kw":"Querying Environment Variables,Environment Variable Management,API Reference", "search_title":"", @@ -548,10 +463,30 @@ "githuburl":"" }, { - "uri":"ThrottlingPolicyManagement_1.html", - "node_id":"throttlingpolicymanagement_1.xml", + "uri":"UpdateEnvironmentVariableV2.html", + "node_id":"updateenvironmentvariablev2.xml", "product_code":"apig", - "code":"28", + "code":"25", + "des":"This API is used to modify an environment variable. If an environment variable is referenced by the backend service address of an API, modifying the environment variable ", + "doc_type":"api", + "kw":"Modifying a Variable,Environment Variable Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateEnvironmentVariableV2" + } + ], + "title":"Modifying a Variable", + "githuburl":"" + }, + { + "uri":"ThrottlingPolicyManagement.html", + "node_id":"throttlingpolicymanagement.xml", + "product_code":"apig", + "code":"26", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Request Throttling Policy Management", @@ -566,10 +501,10 @@ "githuburl":"" }, { - "uri":"CreateRequestThrottlingPolicyV2_1.html", - "node_id":"createrequestthrottlingpolicyv2_1.xml", + "uri":"CreateRequestThrottlingPolicyV2.html", + "node_id":"createrequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"29", + "code":"27", "des":"After an API goes online, the system attaches a request throttling policy to it by default. The API provider can change the request throttling policy based on the service", "doc_type":"api", "kw":"Creating a Request Throttling Policy,Request Throttling Policy Management,API Reference", @@ -586,11 +521,11 @@ "githuburl":"" }, { - "uri":"UpdateRequestThrottlingPolicyV2_1.html", - "node_id":"updaterequestthrottlingpolicyv2_1.xml", + "uri":"UpdateRequestThrottlingPolicyV2.html", + "node_id":"updaterequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"30", - "des":"This API is used to modify the information about a request throttling policy.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}Status code: 200Sta", + "code":"28", + "des":"This API is used to modify the information about a request throttling policy.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{t", "doc_type":"api", "kw":"Modifying a Request Throttling Policy,Request Throttling Policy Management,API Reference", "search_title":"", @@ -606,11 +541,11 @@ "githuburl":"" }, { - "uri":"DeleteRequestThrottlingPolicyV2_1.html", - "node_id":"deleterequestthrottlingpolicyv2_1.xml", + "uri":"DeleteRequestThrottlingPolicyV2.html", + "node_id":"deleterequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"31", - "des":"This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/thr", + "code":"29", + "des":"This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.For details, see Calling APIs.DELETE /v2/{project_id}/api", "doc_type":"api", "kw":"Deleting a Request Throttling Policy,Request Throttling Policy Management,API Reference", "search_title":"", @@ -626,11 +561,11 @@ "githuburl":"" }, { - "uri":"ListRequestThrottlingPolicyV2_1.html", - "node_id":"listrequestthrottlingpolicyv2_1.xml", + "uri":"ListRequestThrottlingPolicyV2.html", + "node_id":"listrequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"32", - "des":"This API is used to query all the request throttling policies.GET /v2/{project_id}/apigw/instances/{instance_id}/throttlesStatus code: 200Status code: 400Status code: 401", + "code":"30", + "des":"This API is used to query all the request throttling policies.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/throttlesStatus code: 200St", "doc_type":"api", "kw":"Querying Request Throttling Policies,Request Throttling Policy Management,API Reference", "search_title":"", @@ -646,11 +581,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfRequestThrottlingPolicyV2_1.html", - "node_id":"showdetailsofrequestthrottlingpolicyv2_1.xml", + "uri":"ShowDetailsOfRequestThrottlingPolicyV2.html", + "node_id":"showdetailsofrequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"33", - "des":"This API is used to query the details of a request throttling policy.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}Status code: 200Status code", + "code":"31", + "des":"This API is used to query the details of a request throttling policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_", "doc_type":"api", "kw":"Querying Details of a Request Throttling Policy,Request Throttling Policy Management,API Reference", "search_title":"", @@ -666,10 +601,10 @@ "githuburl":"" }, { - "uri":"ApiManagement_1.html", - "node_id":"apimanagement_1.xml", + "uri":"ApiManagement.html", + "node_id":"apimanagement.xml", "product_code":"apig", - "code":"34", + "code":"32", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Management", @@ -684,10 +619,10 @@ "githuburl":"" }, { - "uri":"CreateApiV2_1.html", - "node_id":"createapiv2_1.xml", + "uri":"CreateApiV2.html", + "node_id":"createapiv2.xml", "product_code":"apig", - "code":"35", + "code":"33", "des":"This API is used to create an API. An API is an interface that encapsulates a set of service capabilities.The definition of an API defines how the API is called by users ", "doc_type":"api", "kw":"Creating an API,API Management,API Reference", @@ -704,11 +639,11 @@ "githuburl":"" }, { - "uri":"UpdateApiV2_1.html", - "node_id":"updateapiv2_1.xml", + "uri":"UpdateApiV2.html", + "node_id":"updateapiv2.xml", "product_code":"apig", - "code":"36", - "des":"This API is used to modify the information about an API, including its backend information.PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 20", + "code":"34", + "des":"This API is used to modify the information about an API, including its backend information.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id", "doc_type":"api", "kw":"Modifying an API,API Management,API Reference", "search_title":"", @@ -724,10 +659,10 @@ "githuburl":"" }, { - "uri":"DeleteApiV2_1.html", - "node_id":"deleteapiv2_1.xml", + "uri":"DeleteApiV2.html", + "node_id":"deleteapiv2.xml", "product_code":"apig", - "code":"37", + "code":"35", "des":"This API is used to delete an API.This operation will delete all related resources and binding relationships of the API, such as publication records, backend services, an", "doc_type":"api", "kw":"Deleting an API,API Management,API Reference", @@ -744,10 +679,10 @@ "githuburl":"" }, { - "uri":"CreateOrDeletePublishRecordForApiV2_1.html", - "node_id":"createordeletepublishrecordforapiv2_1.xml", + "uri":"CreateOrDeletePublishRecordForApiV2.html", + "node_id":"createordeletepublishrecordforapiv2.xml", "product_code":"apig", - "code":"38", + "code":"36", "des":"This API is used to publish an API or take an API offline.An API can be called only in an environment where the API has been published. APIs that have not been published ", "doc_type":"api", "kw":"Publishing an API or Taking an API Offline,API Management,API Reference", @@ -764,11 +699,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfApiV2_1.html", - "node_id":"showdetailsofapiv2_1.xml", + "uri":"ShowDetailsOfApiV2.html", + "node_id":"showdetailsofapiv2.xml", "product_code":"apig", - "code":"39", - "des":"This API is used to query the details of an API.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 200Status code: 401Status code: 403Status cod", + "code":"37", + "des":"This API is used to query the details of an API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 200Status code:", "doc_type":"api", "kw":"Querying API Details,API Management,API Reference", "search_title":"", @@ -784,11 +719,11 @@ "githuburl":"" }, { - "uri":"ListApisV2_1.html", - "node_id":"listapisv2_1.xml", + "uri":"ListApisV2.html", + "node_id":"listapisv2.xml", "product_code":"apig", - "code":"40", - "des":"This API is used to query APIs to return details and publication information of the APIs. Backend information of the APIs will not be returned.GET /v2/{project_id}/apigw/", + "code":"38", + "des":"This API is used to query APIs to return their details and publication information. Backend and request parameter information of the APIs will not be returned.For details", "doc_type":"api", "kw":"Querying APIs,API Management,API Reference", "search_title":"", @@ -804,11 +739,31 @@ "githuburl":"" }, { - "uri":"DebugApiV2_1.html", - "node_id":"debugapiv2_1.xml", + "uri":"CheckApisV2.html", + "node_id":"checkapisv2.xml", "product_code":"apig", - "code":"41", - "des":"This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.POST /v2/{project_id}/apigw/instance", + "code":"39", + "des":"This API is used to verify the API definition, that is, whether the API path or name already exists.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{i", + "doc_type":"api", + "kw":"Verifying the API Definition,API Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CheckApisV2" + } + ], + "title":"Verifying the API Definition", + "githuburl":"" + }, + { + "uri":"DebugApiV2.html", + "node_id":"debugapiv2.xml", + "product_code":"apig", + "code":"40", + "des":"This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.For details, see Calling APIs.POST /", "doc_type":"api", "kw":"Debugging an API,API Management,API Reference", "search_title":"", @@ -824,11 +779,11 @@ "githuburl":"" }, { - "uri":"BatchPublishOrOfflineApiV2_1.html", - "node_id":"batchpublishorofflineapiv2_1.xml", + "uri":"BatchPublishOrOfflineApiV2.html", + "node_id":"batchpublishorofflineapiv2.xml", "product_code":"apig", - "code":"42", - "des":"This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.POST /v2/{project_id}/apigw/", + "code":"41", + "des":"This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.For details, see Calling API", "doc_type":"api", "kw":"Publishing APIs or Taking APIs Offline,API Management,API Reference", "search_title":"", @@ -844,11 +799,11 @@ "githuburl":"" }, { - "uri":"ListApiVersionsV2_1.html", - "node_id":"listapiversionsv2_1.xml", + "uri":"ListApiVersionsV2.html", + "node_id":"listapiversionsv2.xml", "product_code":"apig", - "code":"43", - "des":"This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.GET /v2/{project_id}/apigw/in", + "code":"42", + "des":"This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.For details, see Calling APIs", "doc_type":"api", "kw":"Querying Historical Versions of an API,API Management,API Reference", "search_title":"", @@ -864,10 +819,10 @@ "githuburl":"" }, { - "uri":"ChangeApiVersionV2_1.html", - "node_id":"changeapiversionv2_1.xml", + "uri":"ChangeApiVersionV2.html", + "node_id":"changeapiversionv2.xml", "product_code":"apig", - "code":"44", + "code":"43", "des":"This API is used to switch the version of an API. A version is generated based on the current definition of an API when the API is published. The version records the defi", "doc_type":"api", "kw":"Switching the Version of an API,API Management,API Reference", @@ -884,10 +839,10 @@ "githuburl":"" }, { - "uri":"ListApiRuntimeDefinitionV2_1.html", - "node_id":"listapiruntimedefinitionv2_1.xml", + "uri":"ListApiRuntimeDefinitionV2.html", + "node_id":"listapiruntimedefinitionv2.xml", "product_code":"apig", - "code":"45", + "code":"44", "des":"This API is used to query the runtime definition of an API in a specified environment. The runtime definition of an API in the RELEASE environment is queried if no enviro", "doc_type":"api", "kw":"Querying the Runtime Definition of an API,API Management,API Reference", @@ -904,11 +859,11 @@ "githuburl":"" }, { - "uri":"ListApiVersionDetailV2_1.html", - "node_id":"listapiversiondetailv2_1.xml", + "uri":"ListApiVersionDetailV2.html", + "node_id":"listapiversiondetailv2.xml", "product_code":"apig", - "code":"46", - "des":"This API is used to query the details of a specified API version.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_id}Status code: 200Status code:", + "code":"45", + "des":"This API is used to query the details of a specified API version.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_i", "doc_type":"api", "kw":"Querying API Version Details,API Management,API Reference", "search_title":"", @@ -924,11 +879,11 @@ "githuburl":"" }, { - "uri":"DeleteApiByVersionIdV2_1.html", - "node_id":"deleteapibyversionidv2_1.xml", + "uri":"DeleteApiByVersionIdV2.html", + "node_id":"deleteapibyversionidv2.xml", "product_code":"apig", - "code":"47", - "des":"This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.DELETE /v2/{project_id}/apigw/insta", + "code":"46", + "des":"This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.For details, see Calling APIs.DELET", "doc_type":"api", "kw":"Taking an API Version Offline,API Management,API Reference", "search_title":"", @@ -944,10 +899,10 @@ "githuburl":"" }, { - "uri":"SignatureKeyManagement_1.html", - "node_id":"signaturekeymanagement_1.xml", + "uri":"SignatureKeyManagement.html", + "node_id":"signaturekeymanagement.xml", "product_code":"apig", - "code":"48", + "code":"47", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Signature Key Management", @@ -962,10 +917,10 @@ "githuburl":"" }, { - "uri":"CreateSignatureKeyV2_1.html", - "node_id":"createsignaturekeyv2_1.xml", + "uri":"CreateSignatureKeyV2.html", + "node_id":"createsignaturekeyv2.xml", "product_code":"apig", - "code":"49", + "code":"48", "des":"It is a good practice to provide a protection mechanism for APIs to ensure access security. For example, authenticating API request sources and denying the access from un", "doc_type":"api", "kw":"Creating a Signature Key,Signature Key Management,API Reference", @@ -982,11 +937,11 @@ "githuburl":"" }, { - "uri":"UpdateSignatureKeyV2_1.html", - "node_id":"updatesignaturekeyv2_1.xml", + "uri":"UpdateSignatureKeyV2.html", + "node_id":"updatesignaturekeyv2.xml", "product_code":"apig", - "code":"50", - "des":"This API is used to modify the information about a signature key.PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}Status code: 200Status code: 400Status ", + "code":"49", + "des":"This API is used to modify the information about a signature key.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}Status co", "doc_type":"api", "kw":"Modifying a Signature Key,Signature Key Management,API Reference", "search_title":"", @@ -1002,11 +957,11 @@ "githuburl":"" }, { - "uri":"DeleteSignatureKeyV2_1.html", - "node_id":"deletesignaturekeyv2_1.xml", + "uri":"DeleteSignatureKeyV2.html", + "node_id":"deletesignaturekeyv2.xml", "product_code":"apig", - "code":"51", - "des":"This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.DELETE /v2/{project_id}/api", + "code":"50", + "des":"This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.For details, see Calling AP", "doc_type":"api", "kw":"Deleting a Signature Key,Signature Key Management,API Reference", "search_title":"", @@ -1022,11 +977,11 @@ "githuburl":"" }, { - "uri":"ListSignatureKeysV2_1.html", - "node_id":"listsignaturekeysv2_1.xml", + "uri":"ListSignatureKeysV2.html", + "node_id":"listsignaturekeysv2.xml", "product_code":"apig", - "code":"52", - "des":"This API is used to query all the signature keys.GET /v2/{project_id}/apigw/instances/{instance_id}/signsStatus code: 200Status code: 400Status code: 401Status code: 403S", + "code":"51", + "des":"This API is used to query all the signature keys.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/signsStatus code: 200Status code: 400Sta", "doc_type":"api", "kw":"Querying Signature Keys,Signature Key Management,API Reference", "search_title":"", @@ -1042,10 +997,10 @@ "githuburl":"" }, { - "uri":"SignatureKeyBindingManagement_1.html", - "node_id":"signaturekeybindingmanagement_1.xml", + "uri":"SignatureKeyBindingManagement.html", + "node_id":"signaturekeybindingmanagement.xml", "product_code":"apig", - "code":"53", + "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Binding/Unbinding Signature Keys", @@ -1060,10 +1015,10 @@ "githuburl":"" }, { - "uri":"AssociateSignatureKeyV2_1.html", - "node_id":"associatesignaturekeyv2_1.xml", + "uri":"AssociateSignatureKeyV2.html", + "node_id":"associatesignaturekeyv2.xml", "product_code":"apig", - "code":"54", + "code":"53", "des":"A signature key takes effect only after being bound to an API.When requesting the backend service, APIG uses the signature key to cryptographically sign requests. The bac", "doc_type":"api", "kw":"Binding a Signature Key,Binding/Unbinding Signature Keys,API Reference", @@ -1080,11 +1035,11 @@ "githuburl":"" }, { - "uri":"DisassociateSignatureKeyV2_1.html", - "node_id":"disassociatesignaturekeyv2_1.xml", + "uri":"DisassociateSignatureKeyV2.html", + "node_id":"disassociatesignaturekeyv2.xml", "product_code":"apig", - "code":"55", - "des":"This API is used to unbind a signature key from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id}Status code: 400Status code: ", + "code":"54", + "des":"This API is used to unbind a signature key from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id", "doc_type":"api", "kw":"Unbinding a Signature Key,Binding/Unbinding Signature Keys,API Reference", "search_title":"", @@ -1100,11 +1055,11 @@ "githuburl":"" }, { - "uri":"ListSignatureKeysBindedToApiV2_1.html", - "node_id":"listsignaturekeysbindedtoapiv2_1.xml", + "uri":"ListSignatureKeysBindedToApiV2.html", + "node_id":"listsignaturekeysbindedtoapiv2.xml", "product_code":"apig", - "code":"56", - "des":"This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.GET /v2/{project_id}", + "code":"55", + "des":"This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.For details, see Cal", "doc_type":"api", "kw":"Querying Signature Keys Bound to an API,Binding/Unbinding Signature Keys,API Reference", "search_title":"", @@ -1120,11 +1075,11 @@ "githuburl":"" }, { - "uri":"ListApisNotBoundWithSignatureKeyV2_1.html", - "node_id":"listapisnotboundwithsignaturekeyv2_1.xml", + "uri":"ListApisNotBoundWithSignatureKeyV2.html", + "node_id":"listapisnotboundwithsignaturekeyv2.xml", "product_code":"apig", - "code":"57", - "des":"This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.GET /v2/{project_id}/apigw/instances/{instance_id}/s", + "code":"56", + "des":"This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.For details, see Calling APIs.GET /v2/{project_id}/a", "doc_type":"api", "kw":"Querying APIs Not Bound with a Signature Key,Binding/Unbinding Signature Keys,API Reference", "search_title":"", @@ -1140,11 +1095,11 @@ "githuburl":"" }, { - "uri":"ListApisBindedToSignatureKeyV2_1.html", - "node_id":"listapisbindedtosignaturekeyv2_1.xml", + "uri":"ListApisBindedToSignatureKeyV2.html", + "node_id":"listapisbindedtosignaturekeyv2.xml", "product_code":"apig", - "code":"58", - "des":"This API is used to query the APIs to which a signature key has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apisStatus code: 200Sta", + "code":"57", + "des":"This API is used to query the APIs to which a signature key has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/", "doc_type":"api", "kw":"Querying APIs Bound with a Signature Key,Binding/Unbinding Signature Keys,API Reference", "search_title":"", @@ -1160,10 +1115,10 @@ "githuburl":"" }, { - "uri":"ThrottlingPolicyBinding_1.html", - "node_id":"throttlingpolicybinding_1.xml", + "uri":"ThrottlingPolicyBinding.html", + "node_id":"throttlingpolicybinding.xml", "product_code":"apig", - "code":"59", + "code":"58", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Binding/Unbinding Request Throttling Policies", @@ -1178,10 +1133,10 @@ "githuburl":"" }, { - "uri":"AssociateRequestThrottlingPolicyV2_1.html", - "node_id":"associaterequestthrottlingpolicyv2_1.xml", + "uri":"AssociateRequestThrottlingPolicyV2.html", + "node_id":"associaterequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"60", + "code":"59", "des":"The request throttling policy bound to an API will control access of all users to the API.If the number of API calls within a specified period reaches the limit, subseque", "doc_type":"api", "kw":"Binding a Request Throttling Policy,Binding/Unbinding Request Throttling Policies,API Reference", @@ -1198,11 +1153,11 @@ "githuburl":"" }, { - "uri":"DisassociateRequestThrottlingPolicyV2_1.html", - "node_id":"disassociaterequestthrottlingpolicyv2_1.xml", + "uri":"DisassociateRequestThrottlingPolicyV2.html", + "node_id":"disassociaterequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"61", - "des":"This API is used to unbind a request throttling policy from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_id}Status cod", + "code":"60", + "des":"This API is used to unbind a request throttling policy from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{", "doc_type":"api", "kw":"Unbinding a Request Throttling Policy,Binding/Unbinding Request Throttling Policies,API Reference", "search_title":"", @@ -1218,11 +1173,11 @@ "githuburl":"" }, { - "uri":"ListApisBindedToRequestThrottlingPolicyV2_1.html", - "node_id":"listapisbindedtorequestthrottlingpolicyv2_1.xml", + "uri":"ListApisBindedToRequestThrottlingPolicyV2.html", + "node_id":"listapisbindedtorequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"62", - "des":"This API is used to query the APIs to which a specified request throttling policy has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/bind", + "code":"61", + "des":"This API is used to query the APIs to which a specified request throttling policy has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{insta", "doc_type":"api", "kw":"Querying APIs Bound with a Request Throttling Policy,Binding/Unbinding Request Throttling Policies,A", "search_title":"", @@ -1238,11 +1193,11 @@ "githuburl":"" }, { - "uri":"ListApisUnbindedToRequestThrottlingPolicyV2_1.html", - "node_id":"listapisunbindedtorequestthrottlingpolicyv2_1.xml", + "uri":"ListApisUnbindedToRequestThrottlingPolicyV2.html", + "node_id":"listapisunbindedtorequestthrottlingpolicyv2.xml", "product_code":"apig", - "code":"63", - "des":"This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.GET /v2/{project_id}/apig", + "code":"62", + "des":"This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.For details, see Calling ", "doc_type":"api", "kw":"Querying APIs Not Bound with a Request Throttling Policy,Binding/Unbinding Request Throttling Polici", "search_title":"", @@ -1258,11 +1213,11 @@ "githuburl":"" }, { - "uri":"ListRequestThrottlingPoliciesBindedToApiV2_1.html", - "node_id":"listrequestthrottlingpoliciesbindedtoapiv2_1.xml", + "uri":"ListRequestThrottlingPoliciesBindedToApiV2.html", + "node_id":"listrequestthrottlingpoliciesbindedtoapiv2.xml", "product_code":"apig", - "code":"64", - "des":"This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.GET ", + "code":"63", + "des":"This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.For ", "doc_type":"api", "kw":"Querying Request Throttling Policies Bound to an API,Binding/Unbinding Request Throttling Policies,A", "search_title":"", @@ -1278,11 +1233,11 @@ "githuburl":"" }, { - "uri":"BatchDisassociateThrottlingPolicyV2_1.html", - "node_id":"batchdisassociatethrottlingpolicyv2_1.xml", + "uri":"BatchDisassociateThrottlingPolicyV2.html", + "node_id":"batchdisassociatethrottlingpolicyv2.xml", "product_code":"apig", - "code":"65", - "des":"This API is used to unbind request throttling policies from APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindingsStatus code: 200Status code: 400Statu", + "code":"64", + "des":"This API is used to unbind request throttling policies from APIs.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindingsStatus ", "doc_type":"api", "kw":"Unbinding Request Throttling Policies,Binding/Unbinding Request Throttling Policies,API Reference", "search_title":"", @@ -1298,10 +1253,10 @@ "githuburl":"" }, { - "uri":"SpecialThrottlingSetting_0.html", - "node_id":"specialthrottlingsetting_0.xml", + "uri":"SpecialThrottlingSetting.html", + "node_id":"specialthrottlingsetting.xml", "product_code":"apig", - "code":"66", + "code":"65", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Excluded Request Throttling Configuration", @@ -1316,10 +1271,10 @@ "githuburl":"" }, { - "uri":"CreateSpecialThrottlingConfigurationV2_0.html", - "node_id":"createspecialthrottlingconfigurationv2_0.xml", + "uri":"CreateSpecialThrottlingConfigurationV2.html", + "node_id":"createspecialthrottlingconfigurationv2.xml", "product_code":"apig", - "code":"67", + "code":"66", "des":"A request throttling policy controls the maximum number of times an API can be accessed within a specified period and the maximum numbers of times the API can be accessed", "doc_type":"api", "kw":"Creating an Excluded Request Throttling Configuration,Excluded Request Throttling Configuration,API ", @@ -1336,11 +1291,11 @@ "githuburl":"" }, { - "uri":"UpdateSpecialThrottlingConfigurationV2_0.html", - "node_id":"updatespecialthrottlingconfigurationv2_0.xml", + "uri":"UpdateSpecialThrottlingConfigurationV2.html", + "node_id":"updatespecialthrottlingconfigurationv2.xml", "product_code":"apig", - "code":"68", - "des":"This API is used to modify an excluded configuration of a request throttling policy.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-sp", + "code":"67", + "des":"This API is used to modify an excluded configuration of a request throttling policy.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throt", "doc_type":"api", "kw":"Modifying an Excluded Request Throttling Configuration,Excluded Request Throttling Configuration,API", "search_title":"", @@ -1356,11 +1311,11 @@ "githuburl":"" }, { - "uri":"DeleteSpecialThrottlingConfigurationV2_0.html", - "node_id":"deletespecialthrottlingconfigurationv2_0.xml", + "uri":"DeleteSpecialThrottlingConfigurationV2.html", + "node_id":"deletespecialthrottlingconfigurationv2.xml", "product_code":"apig", - "code":"69", - "des":"This API is used to delete an excluded configuration of a request throttling policy.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle", + "code":"68", + "des":"This API is used to delete an excluded configuration of a request throttling policy.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/th", "doc_type":"api", "kw":"Deleting an Excluded Request Throttling Configuration,Excluded Request Throttling Configuration,API ", "search_title":"", @@ -1376,11 +1331,11 @@ "githuburl":"" }, { - "uri":"ListSpecialThrottlingConfigurationsV2_0.html", - "node_id":"listspecialthrottlingconfigurationsv2_0.xml", + "uri":"ListSpecialThrottlingConfigurationsV2.html", + "node_id":"listspecialthrottlingconfigurationsv2.xml", "product_code":"apig", - "code":"70", - "des":"This API is used to query all excluded configurations of a request throttling policy.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-s", + "code":"69", + "des":"This API is used to query all excluded configurations of a request throttling policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/thro", "doc_type":"api", "kw":"Querying Excluded Request Throttling Configurations,Excluded Request Throttling Configuration,API Re", "search_title":"", @@ -1396,10 +1351,10 @@ "githuburl":"" }, { - "uri":"AppAuthoringManagement_1.html", - "node_id":"appauthoringmanagement_1.xml", + "uri":"AppAuthoringManagement.html", + "node_id":"appauthoringmanagement.xml", "product_code":"apig", - "code":"71", + "code":"70", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"App Authorization Management", @@ -1414,11 +1369,11 @@ "githuburl":"" }, { - "uri":"CreateAuthorizingAppsV2_1.html", - "node_id":"createauthorizingappsv2_1.xml", + "uri":"CreateAuthorizingAppsV2.html", + "node_id":"createauthorizingappsv2.xml", "product_code":"apig", - "code":"72", - "des":"An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.POST /v2/{project_id}/apigw/inst", + "code":"71", + "des":"An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.For details, see Calling APIs.PO", "doc_type":"api", "kw":"Authorizing Apps,App Authorization Management,API Reference", "search_title":"", @@ -1434,11 +1389,11 @@ "githuburl":"" }, { - "uri":"CancelingAuthorizationV2_1.html", - "node_id":"cancelingauthorizationv2_1.xml", + "uri":"CancelingAuthorizationV2.html", + "node_id":"cancelingauthorizationv2.xml", "product_code":"apig", - "code":"73", - "des":"This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.DELETE /v2/{project_id}/apigw/instan", + "code":"72", + "des":"This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.For details, see Calling APIs.DELETE", "doc_type":"api", "kw":"Canceling Authorization,App Authorization Management,API Reference", "search_title":"", @@ -1454,11 +1409,11 @@ "githuburl":"" }, { - "uri":"ListApisBindedToAppV2_1.html", - "node_id":"listapisbindedtoappv2_1.xml", + "uri":"ListApisBindedToAppV2.html", + "node_id":"listapisbindedtoappv2.xml", "product_code":"apig", - "code":"74", - "des":"This API is used to query the APIs to which a specified app has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apisStatus code: 200Status ", + "code":"73", + "des":"This API is used to query the APIs to which a specified app has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/bind", "doc_type":"api", "kw":"Querying APIs Bound with an App,App Authorization Management,API Reference", "search_title":"", @@ -1474,11 +1429,11 @@ "githuburl":"" }, { - "uri":"ListApisUnbindedToAppV2_1.html", - "node_id":"listapisunbindedtoappv2_1.xml", + "uri":"ListApisUnbindedToAppV2.html", + "node_id":"listapisunbindedtoappv2.xml", "product_code":"apig", - "code":"75", - "des":"This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.GET /v2/{project_id}/apigw/instances/{instance_id}/app-aut", + "code":"74", + "des":"This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.For details, see Calling APIs.GET /v2/{project_id}/apigw/i", "doc_type":"api", "kw":"Querying APIs Not Bound with an App,App Authorization Management,API Reference", "search_title":"", @@ -1494,11 +1449,11 @@ "githuburl":"" }, { - "uri":"ListAppsBindedToApiV2_1.html", - "node_id":"listappsbindedtoapiv2_1.xml", + "uri":"ListAppsBindedToApiV2.html", + "node_id":"listappsbindedtoapiv2.xml", "product_code":"apig", - "code":"76", - "des":"This API is used to query the apps that have been bound to a specified API.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-appsStatus code: 200Status ", + "code":"75", + "des":"This API is used to query the apps that have been bound to a specified API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/bind", "doc_type":"api", "kw":"Querying Apps Bound to an API,App Authorization Management,API Reference", "search_title":"", @@ -1514,10 +1469,10 @@ "githuburl":"" }, { - "uri":"ResourceQuery_1.html", - "node_id":"resourcequery_1.xml", + "uri":"ResourceQuery.html", + "node_id":"resourcequery.xml", "product_code":"apig", - "code":"77", + "code":"76", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Resource Query", @@ -1532,11 +1487,11 @@ "githuburl":"" }, { - "uri":"ListApiQuantitiesV2_1.html", - "node_id":"listapiquantitiesv2_1.xml", + "uri":"ListApiQuantitiesV2.html", + "node_id":"listapiquantitiesv2.xml", "product_code":"apig", - "code":"78", - "des":"This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.G", + "code":"77", + "des":"This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.F", "doc_type":"api", "kw":"Querying API Quantities,Resource Query,API Reference", "search_title":"", @@ -1552,11 +1507,11 @@ "githuburl":"" }, { - "uri":"ListApiGroupsQuantitiesV2_1.html", - "node_id":"listapigroupsquantitiesv2_1.xml", + "uri":"ListApiGroupsQuantitiesV2.html", + "node_id":"listapigroupsquantitiesv2.xml", "product_code":"apig", - "code":"79", - "des":"This API is used to query the number of API groups that have been listed on KooGallery and the number of API groups that have not been listed.GET /v2/{project_id}/apigw/i", + "code":"78", + "des":"This API is used to query the number of API groups.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groupsStatus code: 2", "doc_type":"api", "kw":"Querying API Group Quantities,Resource Query,API Reference", "search_title":"", @@ -1572,11 +1527,11 @@ "githuburl":"" }, { - "uri":"ListAppQuantitiesV2_1.html", - "node_id":"listappquantitiesv2_1.xml", + "uri":"ListAppQuantitiesV2.html", + "node_id":"listappquantitiesv2.xml", "product_code":"apig", - "code":"80", - "des":"This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.GET /v2/{pro", + "code":"79", + "des":"This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.For details,", "doc_type":"api", "kw":"Querying App Quantities,Resource Query,API Reference", "search_title":"", @@ -1592,10 +1547,10 @@ "githuburl":"" }, { - "uri":"DomainnameManagement_1.html", - "node_id":"domainnamemanagement_1.xml", + "uri":"DomainnameManagement.html", + "node_id":"domainnamemanagement.xml", "product_code":"apig", - "code":"81", + "code":"80", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Domain Name Management", @@ -1610,10 +1565,10 @@ "githuburl":"" }, { - "uri":"AssociateDomainV2_1.html", - "node_id":"associatedomainv2_1.xml", + "uri":"AssociateDomainV2.html", + "node_id":"associatedomainv2.xml", "product_code":"apig", - "code":"82", + "code":"81", "des":"A user-defined domain name takes effect only after an A record set has been added. For details, see section \"Adding an A Record Set\" in the Domain Name Service User Guide", "doc_type":"api", "kw":"Binding a Domain Name,Domain Name Management,API Reference", @@ -1630,10 +1585,10 @@ "githuburl":"" }, { - "uri":"AssociateCertificateV2_1.html", - "node_id":"associatecertificatev2_1.xml", + "uri":"AssociateCertificateV2.html", + "node_id":"associatecertificatev2.xml", "product_code":"apig", - "code":"83", + "code":"82", "des":"When you create an API to be accessed through HTTPS, you must add an SSL certificate to the independent domain name that has been bound to the group the API belongs to.Th", "doc_type":"api", "kw":"Adding a Certificate to a Domain Name,Domain Name Management,API Reference", @@ -1650,11 +1605,11 @@ "githuburl":"" }, { - "uri":"UpdateDomainV2_1.html", - "node_id":"updatedomainv2_1.xml", + "uri":"UpdateDomainV2.html", + "node_id":"updatedomainv2.xml", "product_code":"apig", - "code":"84", - "des":"This API is used to modify the configuration of a domain name bound to an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{doma", + "code":"83", + "des":"This API is used to modify the configuration of a domain name bound to an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-g", "doc_type":"api", "kw":"Modifying a Domain Name,Domain Name Management,API Reference", "search_title":"", @@ -1670,11 +1625,11 @@ "githuburl":"" }, { - "uri":"DisassociateDomainV2_1.html", - "node_id":"disassociatedomainv2_1.xml", + "uri":"DisassociateDomainV2.html", + "node_id":"disassociatedomainv2.xml", "product_code":"apig", - "code":"85", - "des":"This API is used to unbind a custom domain name from an API group.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}Status co", + "code":"84", + "des":"This API is used to unbind a custom domain name from an API group.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id", "doc_type":"api", "kw":"Unbinding a Domain Name,Domain Name Management,API Reference", "search_title":"", @@ -1690,11 +1645,31 @@ "githuburl":"" }, { - "uri":"DisassociateCertificateV2_1.html", - "node_id":"disassociatecertificatev2_1.xml", + "uri":"UpdateSlDomainSettingV2.html", + "node_id":"updatesldomainsettingv2.xml", + "product_code":"apig", + "code":"85", + "des":"This API is used to disable or enable the debugging domain name bound to an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api", + "doc_type":"api", + "kw":"Setting Accessibility of a Debugging Domain Name,Domain Name Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateSlDomainSettingV2" + } + ], + "title":"Setting Accessibility of a Debugging Domain Name", + "githuburl":"" + }, + { + "uri":"DisassociateCertificateV2.html", + "node_id":"disassociatecertificatev2.xml", "product_code":"apig", "code":"86", - "des":"This API is used to delete a certificate that is no longer needed or has expired.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{doma", + "des":"This API is used to delete a certificate that is no longer needed or has expired.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-g", "doc_type":"api", "kw":"Deleting the Certificate Bound to a Domain Name,Domain Name Management,API Reference", "search_title":"", @@ -1710,11 +1685,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfDomainNameCertificateV2_1.html", - "node_id":"showdetailsofdomainnamecertificatev2_1.xml", + "uri":"ShowDetailsOfDomainNameCertificateV2.html", + "node_id":"showdetailsofdomainnamecertificatev2.xml", "product_code":"apig", "code":"87", - "des":"This API is used to query the details of the certificate bound to a domain name.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_i", + "des":"This API is used to query the details of the certificate bound to a domain name.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-group", "doc_type":"api", "kw":"Querying Details of the Certificate Bound to a Domain Name,Domain Name Management,API Reference", "search_title":"", @@ -1730,8 +1705,8 @@ "githuburl":"" }, { - "uri":"AclPolicyManagement_1.html", - "node_id":"aclpolicymanagement_1.xml", + "uri":"AclPolicyManagement.html", + "node_id":"aclpolicymanagement.xml", "product_code":"apig", "code":"88", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1748,8 +1723,8 @@ "githuburl":"" }, { - "uri":"CreateAclStrategyV2_1.html", - "node_id":"createaclstrategyv2_1.xml", + "uri":"CreateAclStrategyV2.html", + "node_id":"createaclstrategyv2.xml", "product_code":"apig", "code":"89", "des":"This API is used to create an access control policy to allow or deny API access from certain IP addresses or tenants. The acl_value value of a domain is a tenant name rat", @@ -1768,11 +1743,11 @@ "githuburl":"" }, { - "uri":"UpdateAclStrategyV2_1.html", - "node_id":"updateaclstrategyv2_1.xml", + "uri":"UpdateAclStrategyV2.html", + "node_id":"updateaclstrategyv2.xml", "product_code":"apig", "code":"90", - "des":"This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.PUT /v2/{project_id}/apigw/instances/{instance_id}/", + "des":"This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.For details, see Calling APIs.PUT /v2/{project_id}/", "doc_type":"api", "kw":"Modifying an Access Control Policy,Access Control Policy Management,API Reference", "search_title":"", @@ -1788,11 +1763,11 @@ "githuburl":"" }, { - "uri":"DeleteAclV2_1.html", - "node_id":"deleteaclv2_1.xml", + "uri":"DeleteAclV2.html", + "node_id":"deleteaclv2.xml", "product_code":"apig", "code":"91", - "des":"This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{a", + "des":"This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/i", "doc_type":"api", "kw":"Deleting an Access Control Policy,Access Control Policy Management,API Reference", "search_title":"", @@ -1808,11 +1783,11 @@ "githuburl":"" }, { - "uri":"BatchDeleteAclV2_1.html", - "node_id":"batchdeleteaclv2_1.xml", + "uri":"BatchDeleteAclV2.html", + "node_id":"batchdeleteaclv2.xml", "product_code":"apig", "code":"92", - "des":"This API is used to delete multiple access control policies.Access control policies bound to APIs cannot be deleted.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl", + "des":"This API is used to delete multiple access control policies.Access control policies bound to APIs cannot be deleted.For details, see Calling APIs.PUT /v2/{project_id}/api", "doc_type":"api", "kw":"Deleting Multiple Access Control Policies,Access Control Policy Management,API Reference", "search_title":"", @@ -1828,11 +1803,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfAclPolicyV2_1.html", - "node_id":"showdetailsofaclpolicyv2_1.xml", + "uri":"ShowDetailsOfAclPolicyV2.html", + "node_id":"showdetailsofaclpolicyv2.xml", "product_code":"apig", "code":"93", - "des":"This API is used to query the details of an access control policy.GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}Status code: 200Status code: 400Status c", + "des":"This API is used to query the details of an access control policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}Status cod", "doc_type":"api", "kw":"Querying Details of an Access Control Policy,Access Control Policy Management,API Reference", "search_title":"", @@ -1848,11 +1823,11 @@ "githuburl":"" }, { - "uri":"ListAclStrategiesV2_1.html", - "node_id":"listaclstrategiesv2_1.xml", + "uri":"ListAclStrategiesV2.html", + "node_id":"listaclstrategiesv2.xml", "product_code":"apig", "code":"94", - "des":"This API is used to query all the access control policies.GET /v2/{project_id}/apigw/instances/{instance_id}/aclsStatus code: 200Status code: 400Status code: 401Status co", + "des":"This API is used to query all the access control policies.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/aclsStatus code: 200Status code", "doc_type":"api", "kw":"Querying Access Control Policies,Access Control Policy Management,API Reference", "search_title":"", @@ -1868,8 +1843,8 @@ "githuburl":"" }, { - "uri":"AclPolicyBinding_1.html", - "node_id":"aclpolicybinding_1.xml", + "uri":"AclPolicyBinding.html", + "node_id":"aclpolicybinding.xml", "product_code":"apig", "code":"95", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1886,8 +1861,8 @@ "githuburl":"" }, { - "uri":"CreateApiAclBindingV2_1.html", - "node_id":"createapiaclbindingv2_1.xml", + "uri":"CreateApiAclBindingV2.html", + "node_id":"createapiaclbindingv2.xml", "product_code":"apig", "code":"96", "des":"This API is used to bind an access control policy to a specified API.You can bind different access control policies to an API in different environments, but you can bind ", @@ -1906,11 +1881,11 @@ "githuburl":"" }, { - "uri":"DeleteApiAclBindingV2_1.html", - "node_id":"deleteapiaclbindingv2_1.xml", + "uri":"DeleteApiAclBindingV2.html", + "node_id":"deleteapiaclbindingv2.xml", "product_code":"apig", "code":"97", - "des":"This API is used to unbind an access control policy from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}Status code: 400Status", + "des":"This API is used to unbind an access control policy from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bind", "doc_type":"api", "kw":"Unbinding an Access Control Policy,Binding/Unbinding Access Control Policies,API Reference", "search_title":"", @@ -1926,11 +1901,11 @@ "githuburl":"" }, { - "uri":"BatchDeleteApiAclBindingV2_1.html", - "node_id":"batchdeleteapiaclbindingv2_1.xml", + "uri":"BatchDeleteApiAclBindingV2.html", + "node_id":"batchdeleteapiaclbindingv2.xml", "product_code":"apig", "code":"98", - "des":"This API is used to unbind multiple access control policies from APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindingsStatus code: 200Status code: 400Statu", + "des":"This API is used to unbind multiple access control policies from APIs.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindingsStatus ", "doc_type":"api", "kw":"Unbinding Access Control Policies,Binding/Unbinding Access Control Policies,API Reference", "search_title":"", @@ -1946,11 +1921,11 @@ "githuburl":"" }, { - "uri":"ListApisBindedToAclPolicyV2_1.html", - "node_id":"listapisbindedtoaclpolicyv2_1.xml", + "uri":"ListApisBindedToAclPolicyV2.html", + "node_id":"listapisbindedtoaclpolicyv2.xml", "product_code":"apig", "code":"99", - "des":"This API is used to query the APIs to which an access control policy has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apisStatus code", + "des":"This API is used to query the APIs to which an access control policy has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-b", "doc_type":"api", "kw":"Querying APIs Bound with an Access Control Policy,Binding/Unbinding Access Control Policies,API Refe", "search_title":"", @@ -1966,11 +1941,11 @@ "githuburl":"" }, { - "uri":"ListApisUnbindedToAclPolicyV2_1.html", - "node_id":"listapisunbindedtoaclpolicyv2_1.xml", + "uri":"ListApisUnbindedToAclPolicyV2.html", + "node_id":"listapisunbindedtoaclpolicyv2.xml", "product_code":"apig", "code":"100", - "des":"This API is used to query the published APIs to which an access control policy has not been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded", + "des":"This API is used to query the published APIs to which an access control policy has not been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{inst", "doc_type":"api", "kw":"Querying APIs Not Bound with an Access Control Policy,Binding/Unbinding Access Control Policies,API ", "search_title":"", @@ -1986,11 +1961,11 @@ "githuburl":"" }, { - "uri":"ListAclPolicyBindedToApiV2_1.html", - "node_id":"listaclpolicybindedtoapiv2_1.xml", + "uri":"ListAclPolicyBindedToApiV2.html", + "node_id":"listaclpolicybindedtoapiv2.xml", "product_code":"apig", "code":"101", - "des":"This API is used to query the access control policies that have been bound to a specified API.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-aclsS", + "des":"This API is used to query the access control policies that have been bound to a specified API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance", "doc_type":"api", "kw":"Querying Access Control Policies Bound to an API,Binding/Unbinding Access Control Policies,API Refer", "search_title":"", @@ -2006,8 +1981,8 @@ "githuburl":"" }, { - "uri":"CustomAuthorizerManagement_1.html", - "node_id":"customauthorizermanagement_1.xml", + "uri":"CustomAuthorizerManagement.html", + "node_id":"customauthorizermanagement.xml", "product_code":"apig", "code":"102", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2024,11 +1999,11 @@ "githuburl":"" }, { - "uri":"CreateCustomAuthorizerV2_1.html", - "node_id":"createcustomauthorizerv2_1.xml", + "uri":"CreateCustomAuthorizerV2.html", + "node_id":"createcustomauthorizerv2.xml", "product_code":"apig", "code":"103", - "des":"This API is used to create a custom authorizer.POST /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 201Status code: 400Status code: 401Status code:", + "des":"This API is used to create a custom authorizer.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 201Status code: 4", "doc_type":"api", "kw":"Creating a Custom Authorizer,Custom Authorizer Management,API Reference", "search_title":"", @@ -2044,11 +2019,11 @@ "githuburl":"" }, { - "uri":"UpdateCustomAuthorizerV2_1.html", - "node_id":"updatecustomauthorizerv2_1.xml", + "uri":"UpdateCustomAuthorizerV2.html", + "node_id":"updatecustomauthorizerv2.xml", "product_code":"apig", "code":"104", - "des":"This API is used to modify a custom authorizer.PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 200Status code: 401Status code: ", + "des":"This API is used to modify a custom authorizer.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 20", "doc_type":"api", "kw":"Modifying a Custom Authorizer,Custom Authorizer Management,API Reference", "search_title":"", @@ -2064,11 +2039,11 @@ "githuburl":"" }, { - "uri":"DeleteCustomAuthorizerV2_1.html", - "node_id":"deletecustomauthorizerv2_1.xml", + "uri":"DeleteCustomAuthorizerV2.html", + "node_id":"deletecustomauthorizerv2.xml", "product_code":"apig", "code":"105", - "des":"This API is used to delete a custom authorizer.DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 400Status code: 401Status cod", + "des":"This API is used to delete a custom authorizer.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code:", "doc_type":"api", "kw":"Deleting a Custom Authorizer,Custom Authorizer Management,API Reference", "search_title":"", @@ -2084,11 +2059,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfCustomAuthorizersV2_1.html", - "node_id":"showdetailsofcustomauthorizersv2_1.xml", + "uri":"ShowDetailsOfCustomAuthorizersV2.html", + "node_id":"showdetailsofcustomauthorizersv2.xml", "product_code":"apig", "code":"106", - "des":"This API is used to query the details of a custom authorizer.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 200Status code: 40", + "des":"This API is used to query the details of a custom authorizer.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}S", "doc_type":"api", "kw":"Querying Custom Authorizer Details,Custom Authorizer Management,API Reference", "search_title":"", @@ -2104,11 +2079,11 @@ "githuburl":"" }, { - "uri":"ListCustomAuthorizersV2_1.html", - "node_id":"listcustomauthorizersv2_1.xml", + "uri":"ListCustomAuthorizersV2.html", + "node_id":"listcustomauthorizersv2.xml", "product_code":"apig", "code":"107", - "des":"This API is used to query all the custom authorizers under a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 200Status code: 400Status ", + "des":"This API is used to query all the custom authorizers under a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus co", "doc_type":"api", "kw":"Querying Custom Authorizers,Custom Authorizer Management,API Reference", "search_title":"", @@ -2124,8 +2099,8 @@ "githuburl":"" }, { - "uri":"ApiImportExport_1.html", - "node_id":"apiimportexport_1.xml", + "uri":"ApiImportExport.html", + "node_id":"apiimportexport.xml", "product_code":"apig", "code":"108", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2142,8 +2117,8 @@ "githuburl":"" }, { - "uri":"ExportApiDefinitionsV2_1.html", - "node_id":"exportapidefinitionsv2_1.xml", + "uri":"ExportApiDefinitionsV2.html", + "node_id":"exportapidefinitionsv2.xml", "product_code":"apig", "code":"109", "des":"This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended field", @@ -2162,11 +2137,11 @@ "githuburl":"" }, { - "uri":"ImportApiDefinitionsV2_1.html", - "node_id":"importapidefinitionsv2_1.xml", + "uri":"ImportApiDefinitionsV2.html", + "node_id":"importapidefinitionsv2.xml", "product_code":"apig", "code":"110", - "des":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields, see section \"Import", + "des":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section", "doc_type":"api", "kw":"Importing APIs,API Import and Export,API Reference", "search_title":"", @@ -2182,8 +2157,8 @@ "githuburl":"" }, { - "uri":"VpcChannelManagement_1.html", - "node_id":"vpcchannelmanagement_1.xml", + "uri":"VpcChannelManagement.html", + "node_id":"vpcchannelmanagement.xml", "product_code":"apig", "code":"111", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2200,8 +2175,8 @@ "githuburl":"" }, { - "uri":"CreateVpcChannelV2_1.html", - "node_id":"createvpcchannelv2_1.xml", + "uri":"CreateVpcChannelV2.html", + "node_id":"createvpcchannelv2.xml", "product_code":"apig", "code":"112", "des":"This API is used to create a VPC channel from APIG to your private VPC resources. Afterwards, when creating an API, you can configure your backend service to use this VPC", @@ -2220,8 +2195,8 @@ "githuburl":"" }, { - "uri":"UpdateVpcChannelV2_1.html", - "node_id":"updatevpcchannelv2_1.xml", + "uri":"UpdateVpcChannelV2.html", + "node_id":"updatevpcchannelv2.xml", "product_code":"apig", "code":"113", "des":"This API is used to update the parameters of a VPC channel.If the VPC channel is overwritten with an empty backend instance list, all the existing backend instances will ", @@ -2240,11 +2215,11 @@ "githuburl":"" }, { - "uri":"DeleteVpcChannelV2_1.html", - "node_id":"deletevpcchannelv2_1.xml", + "uri":"DeleteVpcChannelV2.html", + "node_id":"deletevpcchannelv2.xml", "product_code":"apig", "code":"114", - "des":"This API is used to delete a VPC channel.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 400Status code: 401Status code: 4", + "des":"This API is used to delete a VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 400", "doc_type":"api", "kw":"Deleting a VPC Channel,VPC Channel Management,API Reference", "search_title":"", @@ -2260,11 +2235,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfVpcChannelV2_1.html", - "node_id":"showdetailsofvpcchannelv2_1.xml", + "uri":"ShowDetailsOfVpcChannelV2.html", + "node_id":"showdetailsofvpcchannelv2.xml", "product_code":"apig", "code":"115", - "des":"This API is used to query the details of a VPC channel.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 200Status code: 400Sta", + "des":"This API is used to query the details of a VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Statu", "doc_type":"api", "kw":"Querying VPC Channel Details,VPC Channel Management,API Reference", "search_title":"", @@ -2280,11 +2255,11 @@ "githuburl":"" }, { - "uri":"ListVpcChannelsV2_1.html", - "node_id":"listvpcchannelsv2_1.xml", + "uri":"ListVpcChannelsV2.html", + "node_id":"listvpcchannelsv2.xml", "product_code":"apig", "code":"116", - "des":"This API is used to query the VPC channels under a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channelsStatus code: 200Status code: 400Status code: 401", + "des":"This API is used to query the VPC channels under a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channelsStatus code: 200St", "doc_type":"api", "kw":"Querying VPC Channels,VPC Channel Management,API Reference", "search_title":"", @@ -2300,8 +2275,8 @@ "githuburl":"" }, { - "uri":"AddingBackendInstancesV2_1.html", - "node_id":"addingbackendinstancesv2_1.xml", + "uri":"AddingBackendInstancesV2.html", + "node_id":"addingbackendinstancesv2.xml", "product_code":"apig", "code":"117", "des":"This API is used to add backend instances to a VPC channel.If a backend instance with the specified address already exists, the instance information is updated. If the re", @@ -2320,11 +2295,11 @@ "githuburl":"" }, { - "uri":"ListBackendInstancesV2_1.html", - "node_id":"listbackendinstancesv2_1.xml", + "uri":"ListBackendInstancesV2.html", + "node_id":"listbackendinstancesv2.xml", "product_code":"apig", "code":"118", - "des":"This API is used to query the backend instances of a specified VPC channel.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/membersStatus ", + "des":"This API is used to query the backend instances of a specified VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{", "doc_type":"api", "kw":"Querying Backend Servers of a VPC Channel,VPC Channel Management,API Reference", "search_title":"", @@ -2340,8 +2315,8 @@ "githuburl":"" }, { - "uri":"UpdateBackendInstancesV2_1.html", - "node_id":"updatebackendinstancesv2_1.xml", + "uri":"UpdateBackendInstancesV2.html", + "node_id":"updatebackendinstancesv2.xml", "product_code":"apig", "code":"119", "des":"This API is used to update the backend instances of a specified VPC channel. During the update, the request parameters overwrite the backend instances of the correspondin", @@ -2360,11 +2335,11 @@ "githuburl":"" }, { - "uri":"DeleteBackendInstanceV2_1.html", - "node_id":"deletebackendinstancev2_1.xml", + "uri":"DeleteBackendInstanceV2.html", + "node_id":"deletebackendinstancev2.xml", "product_code":"apig", "code":"120", - "des":"This API is used to delete a backend instance from a specified VPC channel.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/{me", + "des":"This API is used to delete a backend instance from a specified VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channel", "doc_type":"api", "kw":"Removing a Backend Server,VPC Channel Management,API Reference", "search_title":"", @@ -2380,10 +2355,170 @@ "githuburl":"" }, { - "uri":"MonitoringInfoQuerying_1.html", - "node_id":"monitoringinfoquerying_1.xml", + "uri":"BatchEnableMembers.html", + "node_id":"batchenablemembers.xml", "product_code":"apig", "code":"121", + "des":"This API is used to enable backend servers of a VPC channel.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id", + "doc_type":"api", + "kw":"Enabling Backend Servers,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchEnableMembers" + } + ], + "title":"Enabling Backend Servers", + "githuburl":"" + }, + { + "uri":"BatchDisableMembers.html", + "node_id":"batchdisablemembers.xml", + "product_code":"apig", + "code":"122", + "des":"This API is used to disable backend servers of a VPC channel.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_i", + "doc_type":"api", + "kw":"Disabling Backend Servers,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchDisableMembers" + } + ], + "title":"Disabling Backend Servers", + "githuburl":"" + }, + { + "uri":"UpdateHealthCheck.html", + "node_id":"updatehealthcheck.xml", + "product_code":"apig", + "code":"123", + "des":"This API is used to modify the health check configuration of a VPC channel.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{", + "doc_type":"api", + "kw":"Modifying VPC Channel Health Check,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateHealthCheck" + } + ], + "title":"Modifying VPC Channel Health Check", + "githuburl":"" + }, + { + "uri":"CreateMemberGroup.html", + "node_id":"createmembergroup.xml", + "product_code":"apig", + "code":"124", + "des":"When creating a backend server group for a VPC channel, you can determine whether to associate backend instances with the group to facilitate backend server node manageme", + "doc_type":"api", + "kw":"Adding or Updating a Backend Server Group of a VPC Channel,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CreateMemberGroup" + } + ], + "title":"Adding or Updating a Backend Server Group of a VPC Channel", + "githuburl":"" + }, + { + "uri":"ListMemberGroups.html", + "node_id":"listmembergroups.xml", + "product_code":"apig", + "code":"125", + "des":"This API is used to query backend server groups of a VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channe", + "doc_type":"api", + "kw":"Querying Backend Server Groups of a VPC Channel,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListMemberGroups" + } + ], + "title":"Querying Backend Server Groups of a VPC Channel", + "githuburl":"" + }, + { + "uri":"ShowDetailsOfMemberGroup.html", + "node_id":"showdetailsofmembergroup.xml", + "product_code":"apig", + "code":"126", + "des":"This API is used to query a backend server group of a specified VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/", + "doc_type":"api", + "kw":"Querying a Backend Server Group of a VPC Channel,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowDetailsOfMemberGroup" + } + ], + "title":"Querying a Backend Server Group of a VPC Channel", + "githuburl":"" + }, + { + "uri":"DeleteMemberGroup.html", + "node_id":"deletemembergroup.xml", + "product_code":"apig", + "code":"127", + "des":"This API is used to delete a backend server group of a specified VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-chann", + "doc_type":"api", + "kw":"Deleting a Backend Server Group of a VPC Channel,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeleteMemberGroup" + } + ], + "title":"Deleting a Backend Server Group of a VPC Channel", + "githuburl":"" + }, + { + "uri":"UpdateMemberGroup.html", + "node_id":"updatemembergroup.xml", + "product_code":"apig", + "code":"128", + "des":"This API is used to update a backend server group of a VPC channel.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_chan", + "doc_type":"api", + "kw":"Updating a Backend Server Group of a VPC Channel,VPC Channel Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateMemberGroup" + } + ], + "title":"Updating a Backend Server Group of a VPC Channel", + "githuburl":"" + }, + { + "uri":"MonitoringInfoQuerying.html", + "node_id":"monitoringinfoquerying.xml", + "product_code":"apig", + "code":"129", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Monitoring Information Query", @@ -2398,10 +2533,10 @@ "githuburl":"" }, { - "uri":"ListLatelyApiStatisticsV2_1.html", - "node_id":"listlatelyapistatisticsv2_1.xml", + "uri":"ListLatelyApiStatisticsV2.html", + "node_id":"listlatelyapistatisticsv2.xml", "product_code":"apig", - "code":"122", + "code":"130", "des":"This API is used to query the number of times APIs in an API group are called within a period. The query is based on 1 minute. If the time range is within one hour, the s", "doc_type":"api", "kw":"Querying API Calls Within a Period,Monitoring Information Query,API Reference", @@ -2418,10 +2553,30 @@ "githuburl":"" }, { - "uri":"ListLatelyGroupStatisticsV2_1.html", - "node_id":"listlatelygroupstatisticsv2_1.xml", + "uri":"ListMetricData.html", + "node_id":"listmetricdata.xml", "product_code":"apig", - "code":"123", + "code":"131", + "des":"This API is used to query the monitoring metric data at a specified granularity in a specified period of time.For details, see Calling APIs.GET /v2/{project_id}/apigw/ins", + "doc_type":"api", + "kw":"Querying Monitoring Data,Monitoring Information Query,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListMetricData" + } + ], + "title":"Querying Monitoring Data", + "githuburl":"" + }, + { + "uri":"ListLatelyGroupStatisticsV2.html", + "node_id":"listlatelygroupstatisticsv2.xml", + "product_code":"apig", + "code":"132", "des":"This API is used to query the total number of times all APIs in an API group are called based on the API group ID. The query is based on 1 minute. If the time range is wi", "doc_type":"api", "kw":"Querying API Calls Under an API Group in the Last One Hour,Monitoring Information Query,API Referenc", @@ -2438,10 +2593,10 @@ "githuburl":"" }, { - "uri":"GroupResponseManagement_1.html", - "node_id":"groupresponsemanagement_1.xml", + "uri":"GroupResponseManagement.html", + "node_id":"groupresponsemanagement.xml", "product_code":"apig", - "code":"124", + "code":"133", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Group Response Management", @@ -2456,11 +2611,11 @@ "githuburl":"" }, { - "uri":"CreateGatewayResponseV2_1.html", - "node_id":"creategatewayresponsev2_1.xml", + "uri":"CreateGatewayResponseV2.html", + "node_id":"creategatewayresponsev2.xml", "product_code":"apig", - "code":"125", - "des":"This API is used to create a response for an API group.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responsesStatus code: 201Status c", + "code":"134", + "des":"This API is used to create a response for an API group.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-res", "doc_type":"api", "kw":"Creating a Group Response,Group Response Management,API Reference", "search_title":"", @@ -2476,11 +2631,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfGatewayResponseV2_1.html", - "node_id":"showdetailsofgatewayresponsev2_1.xml", + "uri":"ShowDetailsOfGatewayResponseV2.html", + "node_id":"showdetailsofgatewayresponsev2.xml", "product_code":"apig", - "code":"126", - "des":"This API is used to query the details of a response defined for an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{r", + "code":"135", + "des":"This API is used to query the details of a response defined for an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{", "doc_type":"api", "kw":"Querying Group Response Details,Group Response Management,API Reference", "search_title":"", @@ -2496,11 +2651,11 @@ "githuburl":"" }, { - "uri":"UpdateGatewayResponseV2_1.html", - "node_id":"updategatewayresponsev2_1.xml", + "uri":"UpdateGatewayResponseV2.html", + "node_id":"updategatewayresponsev2.xml", "product_code":"apig", - "code":"127", - "des":"This API is used to modify a response of an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}Status code:", + "code":"136", + "des":"This API is used to modify a response of an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-respo", "doc_type":"api", "kw":"Modifying a Group Response,Group Response Management,API Reference", "search_title":"", @@ -2516,11 +2671,11 @@ "githuburl":"" }, { - "uri":"DeleteGatewayResponseV2_1.html", - "node_id":"deletegatewayresponsev2_1.xml", + "uri":"DeleteGatewayResponseV2.html", + "node_id":"deletegatewayresponsev2.xml", "product_code":"apig", - "code":"128", - "des":"This API is used to delete a group response of an API group.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}Sta", + "code":"137", + "des":"This API is used to delete a group response of an API group.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gate", "doc_type":"api", "kw":"Deleting a Group Response,Group Response Management,API Reference", "search_title":"", @@ -2536,11 +2691,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfGatewayResponseTypeV2_1.html", - "node_id":"showdetailsofgatewayresponsetypev2_1.xml", + "uri":"ShowDetailsOfGatewayResponseTypeV2.html", + "node_id":"showdetailsofgatewayresponsetypev2.xml", "product_code":"apig", - "code":"129", - "des":"This API is used to query the response of an error type defined for an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-response", + "code":"138", + "des":"This API is used to query the response of an error type defined for an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-grou", "doc_type":"api", "kw":"Querying the Response of an Error Type,Group Response Management,API Reference", "search_title":"", @@ -2556,11 +2711,11 @@ "githuburl":"" }, { - "uri":"UpdateGatewayResponseTypeV2_1.html", - "node_id":"updategatewayresponsetypev2_1.xml", + "uri":"UpdateGatewayResponseTypeV2.html", + "node_id":"updategatewayresponsetypev2.xml", "product_code":"apig", - "code":"130", - "des":"This API is used to modify the response of an error type defined for an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-respons", + "code":"139", + "des":"This API is used to modify the response of an error type defined for an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-gro", "doc_type":"api", "kw":"Modifying the Response of an Error Type,Group Response Management,API Reference", "search_title":"", @@ -2576,11 +2731,11 @@ "githuburl":"" }, { - "uri":"DeleteGatewayResponseTypeV2_1.html", - "node_id":"deletegatewayresponsetypev2_1.xml", + "uri":"DeleteGatewayResponseTypeV2.html", + "node_id":"deletegatewayresponsetypev2.xml", "product_code":"apig", - "code":"131", - "des":"This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.DELETE /v", + "code":"140", + "des":"This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.For detai", "doc_type":"api", "kw":"Deleting the Response of an Error Type,Group Response Management,API Reference", "search_title":"", @@ -2596,11 +2751,11 @@ "githuburl":"" }, { - "uri":"ListGatewayResponsesV2_1.html", - "node_id":"listgatewayresponsesv2_1.xml", + "uri":"ListGatewayResponsesV2.html", + "node_id":"listgatewayresponsesv2.xml", "product_code":"apig", - "code":"132", - "des":"This API is used to query the responses of an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responsesStatus code: 200Status c", + "code":"141", + "des":"This API is used to query the responses of an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-res", "doc_type":"api", "kw":"Querying Group Responses,Group Response Management,API Reference", "search_title":"", @@ -2616,10 +2771,10 @@ "githuburl":"" }, { - "uri":"ApigTagManagement_1.html", - "node_id":"apigtagmanagement_1.xml", + "uri":"ApigTagManagement.html", + "node_id":"apigtagmanagement.xml", "product_code":"apig", - "code":"133", + "code":"142", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Tag Management", @@ -2634,11 +2789,11 @@ "githuburl":"" }, { - "uri":"ListTagsV2_1.html", - "node_id":"listtagsv2_1.xml", + "uri":"ListTagsV2.html", + "node_id":"listtagsv2.xml", "product_code":"apig", - "code":"134", - "des":"This API is used to query tags of a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/tagsStatus code: 200Status code: 400Status code: 401Status code: 403Status ", + "code":"143", + "des":"This API is used to query tags of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/tagsStatus code: 200Status code: 400Status co", "doc_type":"api", "kw":"Querying Tags,Tag Management,API Reference", "search_title":"", @@ -2654,10 +2809,10 @@ "githuburl":"" }, { - "uri":"InstanceFeatureManagement_1.html", - "node_id":"instancefeaturemanagement_1.xml", + "uri":"InstanceFeatureManagement.html", + "node_id":"instancefeaturemanagement.xml", "product_code":"apig", - "code":"135", + "code":"144", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Gateway Feature Management", @@ -2672,10 +2827,10 @@ "githuburl":"" }, { - "uri":"CreateFeatureV2_1.html", - "node_id":"createfeaturev2_1.xml", + "uri":"CreateFeatureV2.html", + "node_id":"createfeaturev2.xml", "product_code":"apig", - "code":"136", + "code":"145", "des":"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 d", "doc_type":"api", "kw":"Configuring a Feature for a Gateway,Gateway Feature Management,API Reference", @@ -2692,10 +2847,10 @@ "githuburl":"" }, { - "uri":"ListFeaturesV2_1.html", - "node_id":"listfeaturesv2_1.xml", + "uri":"ListFeaturesV2.html", + "node_id":"listfeaturesv2.xml", "product_code":"apig", - "code":"137", + "code":"146", "des":"This API is used to query the features of a gateway. If a gateway does not support the features listed in the following table, contact technical support to upgrade the ga", "doc_type":"api", "kw":"Querying Gateway Features,Gateway Feature Management,API Reference", @@ -2712,10 +2867,30 @@ "githuburl":"" }, { - "uri":"ConfigManagement_1.html", - "node_id":"configmanagement_1.xml", + "uri":"ListInstanceFeatures.html", + "node_id":"listinstancefeatures.xml", "product_code":"apig", - "code":"138", + "code":"147", + "des":"This API is used to query the supported features of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/instance-featuresStatus cod", + "doc_type":"api", + "kw":"Querying the Supported Features of a Gateway,Gateway Feature Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListInstanceFeatures" + } + ], + "title":"Querying the Supported Features of a Gateway", + "githuburl":"" + }, + { + "uri":"ConfigManagement.html", + "node_id":"configmanagement.xml", + "product_code":"apig", + "code":"148", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Configuration Management", @@ -2730,11 +2905,11 @@ "githuburl":"" }, { - "uri":"ListProjectCofigsV2_1.html", - "node_id":"listprojectcofigsv2_1.xml", + "uri":"ListProjectCofigsV2.html", + "node_id":"listprojectcofigsv2.xml", "product_code":"apig", - "code":"139", - "des":"This API is used to query the resource configurations and usage of a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/project/configsStatus code: 200Status code", + "code":"149", + "des":"This API is used to query the resource configurations and usage of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/project/conf", "doc_type":"api", "kw":"Querying Resource Configurations of a Gateway,Configuration Management,API Reference", "search_title":"", @@ -2750,11 +2925,11 @@ "githuburl":"" }, { - "uri":"ListInstanceConfigsV2_1.html", - "node_id":"listinstanceconfigsv2_1.xml", + "uri":"ListInstanceConfigsV2.html", + "node_id":"listinstanceconfigsv2.xml", "product_code":"apig", - "code":"140", - "des":"This API is used to query the gateway configurations.GET /v2/{project_id}/apigw/instance/configsStatus code: 200Status code: 400Status code: 401Status code: 403Status cod", + "code":"150", + "des":"This API is used to query the gateway configurations.For details, see Calling APIs.GET /v2/{project_id}/apigw/instance/configsStatus code: 200Status code: 400Status code:", "doc_type":"api", "kw":"Querying Gateway Configurations,Configuration Management,API Reference", "search_title":"", @@ -2770,10 +2945,10 @@ "githuburl":"" }, { - "uri":"ApicInstanceManagement_1.html", - "node_id":"apicinstancemanagement_1.xml", + "uri":"ApicInstanceManagement.html", + "node_id":"apicinstancemanagement.xml", "product_code":"apig", - "code":"141", + "code":"151", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Gateway Management", @@ -2788,11 +2963,11 @@ "githuburl":"" }, { - "uri":"CreateInstanceV2_1.html", - "node_id":"createinstancev2_1.xml", + "uri":"CreateInstanceV2.html", + "node_id":"createinstancev2.xml", "product_code":"apig", - "code":"142", - "des":"This API is used to create a pay-per-use dedicated gateway.POST /v2/{project_id}/apigw/instancesStatus code: 202Status code: 400Status code: 401Status code: 403Status cod", + "code":"152", + "des":"This API is used to create a pay-per-use dedicated gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instancesStatus code: 202Status code: 400Status code:", "doc_type":"api", "kw":"Creating a Dedicated Gateway (Pay-Per-Use),Gateway Management,API Reference", "search_title":"", @@ -2808,11 +2983,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfInstanceV2_1.html", - "node_id":"showdetailsofinstancev2_1.xml", + "uri":"ShowDetailsOfInstanceV2.html", + "node_id":"showdetailsofinstancev2.xml", "product_code":"apig", - "code":"143", - "des":"This API is used to query the details of a dedicated gateway.GET /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 401Status code: 403Status code", + "code":"153", + "des":"This API is used to query the details of a dedicated gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: ", "doc_type":"api", "kw":"Querying Dedicated Gateway Details,Gateway Management,API Reference", "search_title":"", @@ -2828,11 +3003,11 @@ "githuburl":"" }, { - "uri":"UpdateInstanceV2_1.html", - "node_id":"updateinstancev2_1.xml", + "uri":"UpdateInstanceV2.html", + "node_id":"updateinstancev2.xml", "product_code":"apig", - "code":"144", - "des":"This API is used to update a dedicated gateway.PUT /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 400Status code: 401Status code: 403Status co", + "code":"154", + "des":"This API is used to update a dedicated gateway.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 400Status code", "doc_type":"api", "kw":"Updating a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2848,11 +3023,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfInstanceProgressV2_1.html", - "node_id":"showdetailsofinstanceprogressv2_1.xml", + "uri":"ShowDetailsOfInstanceProgressV2.html", + "node_id":"showdetailsofinstanceprogressv2.xml", "product_code":"apig", - "code":"145", - "des":"This API is used to query the creation progress of a dedicated gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/progressStatus code: 200Status code: 401Status c", + "code":"155", + "des":"This API is used to query the creation progress of a dedicated gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/progressStatus cod", "doc_type":"api", "kw":"Querying the Creation Progress of a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2868,11 +3043,51 @@ "githuburl":"" }, { - "uri":"AddEngressEipV2_1.html", - "node_id":"addengresseipv2_1.xml", + "uri":"AddEipV2.html", + "node_id":"addeipv2.xml", "product_code":"apig", - "code":"146", - "des":"This API is used to enable public access for a dedicated gateway.POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400Status code: 401Status code: 4", + "code":"156", + "des":"This API is used to bind an EIP to a dedicated gateway or update the EIP bound to a dedicated gateway(only available for LVS gateways).For details, see Calling APIs.PUT /", + "doc_type":"api", + "kw":"Updating or Binding an EIP to a Dedicated Gateway,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AddEipV2" + } + ], + "title":"Updating or Binding an EIP to a Dedicated Gateway", + "githuburl":"" + }, + { + "uri":"RemoveEipV2.html", + "node_id":"removeeipv2.xml", + "product_code":"apig", + "code":"157", + "des":"This API is used to unbind the EIP of a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/eipStatus code: 401Status co", + "doc_type":"api", + "kw":"Unbinding the EIP of a Dedicated Gateway,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"RemoveEipV2" + } + ], + "title":"Unbinding the EIP of a Dedicated Gateway", + "githuburl":"" + }, + { + "uri":"AddEngressEipV2.html", + "node_id":"addengresseipv2.xml", + "product_code":"apig", + "code":"158", + "des":"This API is used to enable public access for a dedicated gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400", "doc_type":"api", "kw":"Enabling Public Access for a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2888,11 +3103,11 @@ "githuburl":"" }, { - "uri":"UpdateEngressEipV2_1.html", - "node_id":"updateengresseipv2_1.xml", + "uri":"UpdateEngressEipV2.html", + "node_id":"updateengresseipv2.xml", "product_code":"apig", - "code":"147", - "des":"This API is used to update the outbound access bandwidth of a dedicated gateway.PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400Status code: 401", + "code":"159", + "des":"This API is used to update the outbound access bandwidth of a dedicated gateway.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eipSt", "doc_type":"api", "kw":"Updating the Outbound Access Bandwidth of a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2908,11 +3123,11 @@ "githuburl":"" }, { - "uri":"RemoveEngressEipV2_1.html", - "node_id":"removeengresseipv2_1.xml", + "uri":"RemoveEngressEipV2.html", + "node_id":"removeengresseipv2.xml", "product_code":"apig", - "code":"148", - "des":"This API is used to disable public access for a dedicated gateway.DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 401Status code: 403Status code", + "code":"160", + "des":"This API is used to disable public access for a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: ", "doc_type":"api", "kw":"Disabling Public Access for a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2928,11 +3143,71 @@ "githuburl":"" }, { - "uri":"ListAvailableZonesV2_1.html", - "node_id":"listavailablezonesv2_1.xml", + "uri":"AddIngressEipV2.html", + "node_id":"addingresseipv2.xml", "product_code":"apig", - "code":"149", - "des":"This API is used to query AZs where you can buy gateways.GET /v2/{project_id}/apigw/available-zonesStatus code: 200Status code: 401Status code: 403Status code: 500NoneSta", + "code":"161", + "des":"This API is used to enable public inbound access for a gateway that uses ELB for load balancing.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{insta", + "doc_type":"api", + "kw":"Enabling Public Inbound Access,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AddIngressEipV2" + } + ], + "title":"Enabling Public Inbound Access", + "githuburl":"" + }, + { + "uri":"UpdateIngressEipV2.html", + "node_id":"updateingresseipv2.xml", + "product_code":"apig", + "code":"162", + "des":"This API is used to update the public inbound access bandwidth of a gateway that uses ELB for load balancing.For details, see Calling APIs.PUT /v2/{project_id}/apigw/inst", + "doc_type":"api", + "kw":"Updating Public Inbound Access Bandwidth of a Gateway,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateIngressEipV2" + } + ], + "title":"Updating Public Inbound Access Bandwidth of a Gateway", + "githuburl":"" + }, + { + "uri":"RemoveIngressEipV2.html", + "node_id":"removeingresseipv2.xml", + "product_code":"apig", + "code":"163", + "des":"This API is used to disable public inbound access for a gateway that uses ELB for load balancing.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{in", + "doc_type":"api", + "kw":"Disabling Public Inbound Access for a Gateway,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"RemoveIngressEipV2" + } + ], + "title":"Disabling Public Inbound Access for a Gateway", + "githuburl":"" + }, + { + "uri":"ListAvailableZonesV2.html", + "node_id":"listavailablezonesv2.xml", + "product_code":"apig", + "code":"164", + "des":"This API is used to query AZs where you can buy gateways.For details, see Calling APIs.GET /v2/{project_id}/apigw/available-zonesStatus code: 200Status code: 401Status co", "doc_type":"api", "kw":"Querying AZs,Gateway Management,API Reference", "search_title":"", @@ -2948,11 +3223,11 @@ "githuburl":"" }, { - "uri":"ListInstancesV2_1.html", - "node_id":"listinstancesv2_1.xml", + "uri":"ListInstancesV2.html", + "node_id":"listinstancesv2.xml", "product_code":"apig", - "code":"150", - "des":"This API is used to query dedicated gateways.GET /v2/{project_id}/apigw/instancesStatus code: 200Status code: 401Status code: 403Status code: 500NoneStatus code: 200OKSta", + "code":"165", + "des":"This API is used to query dedicated gateways.For details, see Calling APIs.GET /v2/{project_id}/apigw/instancesStatus code: 200Status code: 401Status code: 403Status code", "doc_type":"api", "kw":"Querying Dedicated Gateways,Gateway Management,API Reference", "search_title":"", @@ -2968,11 +3243,11 @@ "githuburl":"" }, { - "uri":"DeleteInstancesV2_1.html", - "node_id":"deleteinstancesv2_1.xml", + "uri":"DeleteInstancesV2.html", + "node_id":"deleteinstancesv2.xml", "product_code":"apig", - "code":"151", - "des":"This API is used to delete a dedicated gateway.DELETE /v2/{project_id}/apigw/instances/{instance_id}Status code: 401Status code: 403Status code: 404Status code: 500NoneSt", + "code":"166", + "des":"This API is used to delete a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}Status code: 401Status code: 403Status c", "doc_type":"api", "kw":"Deleting a Dedicated Gateway,Gateway Management,API Reference", "search_title":"", @@ -2988,10 +3263,780 @@ "githuburl":"" }, { - "uri":"CredentialManagement_1.html", - "node_id":"credentialmanagement_1.xml", + "uri":"CreatePostPayResizeOrder.html", + "node_id":"createpostpayresizeorder.xml", "product_code":"apig", - "code":"152", + "code":"167", + "des":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid", + "doc_type":"api", + "kw":"Modifying the Specifications of a Pay-Per-Use Gateway,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CreatePostPayResizeOrder" + } + ], + "title":"Modifying the Specifications of a Pay-Per-Use Gateway", + "githuburl":"" + }, + { + "uri":"ShowRestrictionOfInstanceV2.html", + "node_id":"showrestrictionofinstancev2.xml", + "product_code":"apig", + "code":"168", + "des":"This API is used to query the constraints of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/restrictionStatus code: 200Status ", + "doc_type":"api", + "kw":"Querying Gateway Constraints,Gateway Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowRestrictionOfInstanceV2" + } + ], + "title":"Querying Gateway Constraints", + "githuburl":"" + }, + { + "uri":"VPCEndpointsManagement.html", + "node_id":"vpcendpointsmanagement.xml", + "product_code":"apig", + "code":"169", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPC Endpoint Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"VPC Endpoint Management", + "githuburl":"" + }, + { + "uri":"ListEndpointConnections.html", + "node_id":"listendpointconnections.xml", + "product_code":"apig", + "code":"170", + "des":"This API is used to query the VPC endpoint connections of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connecti", + "doc_type":"api", + "kw":"Querying VPC Endpoint Connections,VPC Endpoint Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListEndpointConnections" + } + ], + "title":"Querying VPC Endpoint Connections", + "githuburl":"" + }, + { + "uri":"AcceptOrRejectEndpointConnections.html", + "node_id":"acceptorrejectendpointconnections.xml", + "product_code":"apig", + "code":"171", + "des":"This API is used to accept or reject a VPC endpoint connection for a gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoin", + "doc_type":"api", + "kw":"Accepting or Rejecting a VPC Endpoint Connection,VPC Endpoint Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AcceptOrRejectEndpointConnections" + } + ], + "title":"Accepting or Rejecting a VPC Endpoint Connection", + "githuburl":"" + }, + { + "uri":"ListEndpointPermissions.html", + "node_id":"listendpointpermissions.xml", + "product_code":"apig", + "code":"172", + "des":"This API is used to query the whitelist records of a gateway's VPC endpoint service.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-e", + "doc_type":"api", + "kw":"Querying Whitelist Records of a VPC Endpoint Service,VPC Endpoint Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListEndpointPermissions" + } + ], + "title":"Querying Whitelist Records of a VPC Endpoint Service", + "githuburl":"" + }, + { + "uri":"AddEndpointPermissions.html", + "node_id":"addendpointpermissions.xml", + "product_code":"apig", + "code":"173", + "des":"This API is used to add whitelist records in batches for a gateway's VPC endpoint service.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id", + "doc_type":"api", + "kw":"Adding Whitelist Records for a VPC Endpoint Service,VPC Endpoint Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AddEndpointPermissions" + } + ], + "title":"Adding Whitelist Records for a VPC Endpoint Service", + "githuburl":"" + }, + { + "uri":"DeleteEndpointPermissions.html", + "node_id":"deleteendpointpermissions.xml", + "product_code":"apig", + "code":"174", + "des":"This API is used to delete whitelist records of a gateway's VPC endpoint service in batches.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_", + "doc_type":"api", + "kw":"Deleting Whitelist Records of a VPC Endpoint Service,VPC Endpoint Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeleteEndpointPermissions" + } + ], + "title":"Deleting Whitelist Records of a VPC Endpoint Service", + "githuburl":"" + }, + { + "uri":"GatewayTagManagement.html", + "node_id":"gatewaytagmanagement.xml", + "product_code":"apig", + "code":"175", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Gateway Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"Gateway Tag Management", + "githuburl":"" + }, + { + "uri":"ListProjectInstanceTags.html", + "node_id":"listprojectinstancetags.xml", + "product_code":"apig", + "code":"176", + "des":"This API is used to query all gateway tags of a project.Only users who have been authorized with a policy containing action apig:instanceTags:list can call this API.For d", + "doc_type":"api", + "kw":"Querying All Gateway Tags of a Project,Gateway Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListProjectInstanceTags" + } + ], + "title":"Querying All Gateway Tags of a Project", + "githuburl":"" + }, + { + "uri":"ListInstanceTags.html", + "node_id":"listinstancetags.xml", + "product_code":"apig", + "code":"177", + "des":"This API is used to query all tags of a gateway.Only users who have been authorized with a policy containing actions apig:instanceTags:list and apig:instances:get can cal", + "doc_type":"api", + "kw":"Querying Tags of a Gateway,Gateway Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListInstanceTags" + } + ], + "title":"Querying Tags of a Gateway", + "githuburl":"" + }, + { + "uri":"BatchCreateOrDeleteInstanceTags.html", + "node_id":"batchcreateordeleteinstancetags.xml", + "product_code":"apig", + "code":"178", + "des":"This API is used to add tags to a gateway or delete the tags of a gateway.Only users who have been authorized with a policy containing actions apig:instances:get, apig:in", + "doc_type":"api", + "kw":"Adding or Deleting Tags of a Gateway,Gateway Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchCreateOrDeleteInstanceTags" + } + ], + "title":"Adding or Deleting Tags of a Gateway", + "githuburl":"" + }, + { + "uri":"MicroserviceCenterManagement.html", + "node_id":"microservicecentermanagement.xml", + "product_code":"apig", + "code":"179", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Microservice Center Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"Microservice Center Management", + "githuburl":"" + }, + { + "uri":"ImportMicroservice.html", + "node_id":"importmicroservice.xml", + "product_code":"apig", + "code":"180", + "des":"This API is used to import a microservice.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/microservice/importStatus code: 201Status code", + "doc_type":"api", + "kw":"Importing a Microservice,Microservice Center Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ImportMicroservice" + } + ], + "title":"Importing a Microservice", + "githuburl":"" + }, + { + "uri":"SslCertificateManagement.html", + "node_id":"sslcertificatemanagement.xml", + "product_code":"apig", + "code":"181", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"SSL Certificate Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"SSL Certificate Management", + "githuburl":"" + }, + { + "uri":"ListCertificatesV2.html", + "node_id":"listcertificatesv2.xml", + "product_code":"apig", + "code":"182", + "des":"This API is used to query the SSL certificates.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificatesStatus code: 200Status code: 400Status code: 401Status", + "doc_type":"api", + "kw":"Querying SSL Certificates,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListCertificatesV2" + } + ], + "title":"Querying SSL Certificates", + "githuburl":"" + }, + { + "uri":"CreateCertificateV2.html", + "node_id":"createcertificatev2.xml", + "product_code":"apig", + "code":"183", + "des":"This API is used to create an SSL certificate.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificatesStatus code: 200Status code: 400Status code: 401Status", + "doc_type":"api", + "kw":"Creating an SSL Certificate,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CreateCertificateV2" + } + ], + "title":"Creating an SSL Certificate", + "githuburl":"" + }, + { + "uri":"BatchAssociateCertsV2.html", + "node_id":"batchassociatecertsv2.xml", + "product_code":"apig", + "code":"184", + "des":"This API is used to bind a domain name with SSL certificates. Currently, only one certificate ID can be specified in certificate_ids.For details, see Calling APIs.POST /v", + "doc_type":"api", + "kw":"Binding a Domain Name with SSL Certificates,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchAssociateCertsV2" + } + ], + "title":"Binding a Domain Name with SSL Certificates", + "githuburl":"" + }, + { + "uri":"BatchDisassociateCertsV2.html", + "node_id":"batchdisassociatecertsv2.xml", + "product_code":"apig", + "code":"185", + "des":"This API is used to unbind a domain name's SSL certificates. Currently, only one certificate ID can be specified in certificate_ids.For details, see Calling APIs.POST /v2", + "doc_type":"api", + "kw":"Unbinding a Domain Name's SSL Certificates,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchDisassociateCertsV2" + } + ], + "title":"Unbinding a Domain Name's SSL Certificates", + "githuburl":"" + }, + { + "uri":"ShowDetailsOfCertificateV2.html", + "node_id":"showdetailsofcertificatev2.xml", + "product_code":"apig", + "code":"186", + "des":"This API is used to query the details about a certificate.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificates/{certificate_id}Status code: 200Status cod", + "doc_type":"api", + "kw":"Querying Certificate Details,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowDetailsOfCertificateV2" + } + ], + "title":"Querying Certificate Details", + "githuburl":"" + }, + { + "uri":"DeleteCertificateV2.html", + "node_id":"deletecertificatev2.xml", + "product_code":"apig", + "code":"187", + "des":"This API is used to delete an SSL certificate. Only certificates that are not bound to any domain name can be deleted.For details, see Calling APIs.DELETE /v2/{project_id", + "doc_type":"api", + "kw":"Deleting an SSL Certificate,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeleteCertificateV2" + } + ], + "title":"Deleting an SSL Certificate", + "githuburl":"" + }, + { + "uri":"UpdateCertificateV2.html", + "node_id":"updatecertificatev2.xml", + "product_code":"apig", + "code":"188", + "des":"This API is used to modify an SSL certificate.For details, see Calling APIs.PUT /v2/{project_id}/apigw/certificates/{certificate_id}Status code: 200Status code: 400Status", + "doc_type":"api", + "kw":"Modifying an SSL Certificate,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateCertificateV2" + } + ], + "title":"Modifying an SSL Certificate", + "githuburl":"" + }, + { + "uri":"BatchAssociateDomainsV2.html", + "node_id":"batchassociatedomainsv2.xml", + "product_code":"apig", + "code":"189", + "des":"This API is used to bind an SSL certificate to a domain name.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/attachStatus ", + "doc_type":"api", + "kw":"Binding an SSL Certificate to a Domain Name,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchAssociateDomainsV2" + } + ], + "title":"Binding an SSL Certificate to a Domain Name", + "githuburl":"" + }, + { + "uri":"BatchDisassociateDomainsV2.html", + "node_id":"batchdisassociatedomainsv2.xml", + "product_code":"apig", + "code":"190", + "des":"This API is used to unbind an SSL certificate from a domain name.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/detachSta", + "doc_type":"api", + "kw":"Unbinding an SSL Certificate from a Domain Name,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"BatchDisassociateDomainsV2" + } + ], + "title":"Unbinding an SSL Certificate from a Domain Name", + "githuburl":"" + }, + { + "uri":"ListAttachedDomainsV2.html", + "node_id":"listattacheddomainsv2.xml", + "product_code":"apig", + "code":"191", + "des":"This API is used to query the domain names to which an SSL certificate has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificates/{certificate_i", + "doc_type":"api", + "kw":"Querying Domain Names of an SSL Certificate,SSL Certificate Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListAttachedDomainsV2" + } + ], + "title":"Querying Domain Names of an SSL Certificate", + "githuburl":"" + }, + { + "uri":"PluginManagement.html", + "node_id":"pluginmanagement.xml", + "product_code":"apig", + "code":"192", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Plug-in Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"Plug-in Management", + "githuburl":"" + }, + { + "uri":"CreatePlugin.html", + "node_id":"createplugin.xml", + "product_code":"apig", + "code":"193", + "des":"Plug-in information.Plug-in names must be unique.Plug-in names must be unique.Plug-ins must be bound to an API and take effect immediately for the API after binding.Plug-", + "doc_type":"api", + "kw":"Creating a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CreatePlugin" + } + ], + "title":"Creating a Plug-in", + "githuburl":"" + }, + { + "uri":"UpdatePlugin.html", + "node_id":"updateplugin.xml", + "product_code":"apig", + "code":"194", + "des":"This API is used to modify a plug-in.Plug-in names must be unique.Plug-in names must be unique.The plug-in type and scope cannot be modified.The plug-in type and scope ca", + "doc_type":"api", + "kw":"Modifying a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdatePlugin" + } + ], + "title":"Modifying a Plug-in", + "githuburl":"" + }, + { + "uri":"DeletePlugin.html", + "node_id":"deleteplugin.xml", + "product_code":"apig", + "code":"195", + "des":"This API is used to delete a plug-in.Before deleting a plug-in, unbind it from all APIs.Before deleting a plug-in, unbind it from all APIs.For details, see Calling APIs.D", + "doc_type":"api", + "kw":"Deleting a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeletePlugin" + } + ], + "title":"Deleting a Plug-in", + "githuburl":"" + }, + { + "uri":"ListPlugins.html", + "node_id":"listplugins.xml", + "product_code":"apig", + "code":"196", + "des":"This API is used to query details about a group of plug-ins that meet specified conditions.Pagination queryPagination queryQuery by plug-in typeQuery by plug-in typeQuery", + "doc_type":"api", + "kw":"Querying Plug-ins,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListPlugins" + } + ], + "title":"Querying Plug-ins", + "githuburl":"" + }, + { + "uri":"ShowPlugin.html", + "node_id":"showplugin.xml", + "product_code":"apig", + "code":"197", + "des":"This API is used to query the details of a plug-in.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}Status code: 200Sta", + "doc_type":"api", + "kw":"Querying Plug-in Details,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowPlugin" + } + ], + "title":"Querying Plug-in Details", + "githuburl":"" + }, + { + "uri":"AttachApiToPlugin.html", + "node_id":"attachapitoplugin.xml", + "product_code":"apig", + "code":"198", + "des":"This API is used to bind a plug-in to APIs.Plug-ins can be bound only to published APIs.Plug-ins can be bound only to published APIs.Plug-ins take effect immediately afte", + "doc_type":"api", + "kw":"Binding a Plug-in to APIs,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AttachApiToPlugin" + } + ], + "title":"Binding a Plug-in to APIs", + "githuburl":"" + }, + { + "uri":"AttachPluginToApi.html", + "node_id":"attachplugintoapi.xml", + "product_code":"apig", + "code":"199", + "des":"This API is used to bind an API with plug-ins.Plug-ins can be bound only to published APIs.Plug-ins can be bound only to published APIs.Plug-ins take effect immediately a", + "doc_type":"api", + "kw":"Binding an API with Plug-ins,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AttachPluginToApi" + } + ], + "title":"Binding an API with Plug-ins", + "githuburl":"" + }, + { + "uri":"DetachApiFromPlugin.html", + "node_id":"detachapifromplugin.xml", + "product_code":"apig", + "code":"200", + "des":"This API is used to unbind a plug-in from all APIs to which it has been bound.The unbinding takes effect immediately.The unbinding takes effect immediately.For details, s", + "doc_type":"api", + "kw":"Unbinding a Plug-in from All APIs,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DetachApiFromPlugin" + } + ], + "title":"Unbinding a Plug-in from All APIs", + "githuburl":"" + }, + { + "uri":"DetachPluginFromApi.html", + "node_id":"detachpluginfromapi.xml", + "product_code":"apig", + "code":"201", + "des":"This API is used to unbind an API's plug-ins.The unbinding takes effect immediately.The unbinding takes effect immediately.For details, see Calling APIs.PUT /v2/{project_", + "doc_type":"api", + "kw":"Unbinding an API's Plug-ins,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DetachPluginFromApi" + } + ], + "title":"Unbinding an API's Plug-ins", + "githuburl":"" + }, + { + "uri":"ListPluginAttachedApis.html", + "node_id":"listpluginattachedapis.xml", + "product_code":"apig", + "code":"202", + "des":"This API is used to query the APIs to which a plug-in has been bound.Query APIs bound with a specified plug-inQuery APIs bound with a specified plug-inPagination queryPag", + "doc_type":"api", + "kw":"Querying APIs Bound with a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListPluginAttachedApis" + } + ], + "title":"Querying APIs Bound with a Plug-in", + "githuburl":"" + }, + { + "uri":"ListApiAttachedPlugins.html", + "node_id":"listapiattachedplugins.xml", + "product_code":"apig", + "code":"203", + "des":"This API is used to query the plug-ins bound to an API.Query plug-ins bound to a specified APIQuery plug-ins bound to a specified APIPagination queryPagination queryFuzzy", + "doc_type":"api", + "kw":"Querying Plug-ins Bound to an API,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListApiAttachedPlugins" + } + ], + "title":"Querying Plug-ins Bound to an API", + "githuburl":"" + }, + { + "uri":"ListPluginAttachableApis.html", + "node_id":"listpluginattachableapis.xml", + "product_code":"apig", + "code":"204", + "des":"This API is used to query the APIs to which a plug-in can be bound.Pagination queryPagination queryFuzzy query by API nameFuzzy query by API nameAPIs already bound with o", + "doc_type":"api", + "kw":"Querying APIs to Which a Plug-in Can Be Bound,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListPluginAttachableApis" + } + ], + "title":"Querying APIs to Which a Plug-in Can Be Bound", + "githuburl":"" + }, + { + "uri":"ListApiAttachablePlugins.html", + "node_id":"listapiattachableplugins.xml", + "product_code":"apig", + "code":"205", + "des":"This API is used to query the plug-ins that can be bound to a specified API.Pagination queryFuzzy query by plug-in nameFor details, see Calling APIs.GET /v2/{project_id}/", + "doc_type":"api", + "kw":"Querying Plug-ins That Can Be Bound to an API,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListApiAttachablePlugins" + } + ], + "title":"Querying Plug-ins That Can Be Bound to an API", + "githuburl":"" + }, + { + "uri":"CredentialManagement.html", + "node_id":"credentialmanagement.xml", + "product_code":"apig", + "code":"206", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Credential Management", @@ -3006,11 +4051,11 @@ "githuburl":"" }, { - "uri":"CreateAnAppV2_1.html", - "node_id":"createanappv2_1.xml", + "uri":"CreateAnAppV2.html", + "node_id":"createanappv2.xml", "product_code":"apig", - "code":"153", - "des":"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.POST /v2/{project_id}/apigw/instanc", + "code":"207", + "des":"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.For details, see Calling APIs.POST ", "doc_type":"api", "kw":"Creating an App,Credential Management,API Reference", "search_title":"", @@ -3026,10 +4071,10 @@ "githuburl":"" }, { - "uri":"UpdateAppV2_1.html", - "node_id":"updateappv2_1.xml", + "uri":"UpdateAppV2.html", + "node_id":"updateappv2.xml", "product_code":"apig", - "code":"154", + "code":"208", "des":"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, ", "doc_type":"api", "kw":"Modifying an App,Credential Management,API Reference", @@ -3046,11 +4091,11 @@ "githuburl":"" }, { - "uri":"DeleteAppV2_1.html", - "node_id":"deleteappv2_1.xml", + "uri":"DeleteAppV2.html", + "node_id":"deleteappv2.xml", "product_code":"apig", - "code":"155", - "des":"This API is used to delete an app.Deleted apps cannot call APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 400Status code: 401Status ", + "code":"209", + "des":"This API is used to delete an app.Deleted apps cannot call APIs.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status co", "doc_type":"api", "kw":"Deleting an App,Credential Management,API Reference", "search_title":"", @@ -3066,11 +4111,11 @@ "githuburl":"" }, { - "uri":"ResettingAppSecretV2_1.html", - "node_id":"resettingappsecretv2_1.xml", + "uri":"ResettingAppSecretV2.html", + "node_id":"resettingappsecretv2.xml", "product_code":"apig", - "code":"156", - "des":"This API is used to reset the AppSecret of an app.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}Status code: 200Status code: 400Status code: 401S", + "code":"210", + "des":"This API is used to reset the AppSecret of an app.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}Status code: 200Sta", "doc_type":"api", "kw":"Resetting the AppSecret of an App,Credential Management,API Reference", "search_title":"", @@ -3086,11 +4131,11 @@ "githuburl":"" }, { - "uri":"CheckAppV2_1.html", - "node_id":"checkappv2_1.xml", + "uri":"CheckAppV2.html", + "node_id":"checkappv2.xml", "product_code":"apig", - "code":"157", - "des":"This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.GET", + "code":"211", + "des":"This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.For", "doc_type":"api", "kw":"Verifying an App,Credential Management,API Reference", "search_title":"", @@ -3106,11 +4151,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfAppV2_1.html", - "node_id":"showdetailsofappv2_1.xml", + "uri":"ShowDetailsOfAppV2.html", + "node_id":"showdetailsofappv2.xml", "product_code":"apig", - "code":"158", - "des":"This API is used to query the details of an app.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 200Status code: 400Status code: 401Status cod", + "code":"212", + "des":"This API is used to query the details of an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 200Status code:", "doc_type":"api", "kw":"Querying App Details,Credential Management,API Reference", "search_title":"", @@ -3126,11 +4171,11 @@ "githuburl":"" }, { - "uri":"ListAppsV2_1.html", - "node_id":"listappsv2_1.xml", + "uri":"ListAppsV2.html", + "node_id":"listappsv2.xml", "product_code":"apig", - "code":"159", - "des":"This API is used to query apps.GET /v2/{project_id}/apigw/instances/{instance_id}/appsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500None", + "code":"213", + "des":"This API is used to query apps.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/appsStatus code: 200Status code: 400Status code: 401Status", "doc_type":"api", "kw":"Querying Apps,Credential Management,API Reference", "search_title":"", @@ -3146,11 +4191,11 @@ "githuburl":"" }, { - "uri":"CreateAppCodeV2_1.html", - "node_id":"createappcodev2_1.xml", + "uri":"CreateAppCodeV2.html", + "node_id":"createappcodev2.xml", "product_code":"apig", - "code":"160", - "des":"This API is used to create an AppCode for an app for simple authentication.POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Stat", + "code":"214", + "des":"This API is used to create an AppCode for an app for simple authentication.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}", "doc_type":"api", "kw":"Creating an AppCode,Credential Management,API Reference", "search_title":"", @@ -3166,11 +4211,11 @@ "githuburl":"" }, { - "uri":"CreateAppCodeAutoV2_1.html", - "node_id":"createappcodeautov2_1.xml", + "uri":"CreateAppCodeAutoV2.html", + "node_id":"createappcodeautov2.xml", "product_code":"apig", - "code":"161", - "des":"This API is used to generate a random AppCode.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Status code: 400Status code: 401St", + "code":"215", + "des":"This API is used to generate a random AppCode.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Stat", "doc_type":"api", "kw":"Generating an AppCode,Credential Management,API Reference", "search_title":"", @@ -3186,11 +4231,11 @@ "githuburl":"" }, { - "uri":"DeleteAppCodeV2_1.html", - "node_id":"deleteappcodev2_1.xml", + "uri":"DeleteAppCodeV2.html", + "node_id":"deleteappcodev2.xml", "product_code":"apig", - "code":"162", - "des":"This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-c", + "code":"216", + "des":"This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{in", "doc_type":"api", "kw":"Deleting an AppCode,Credential Management,API Reference", "search_title":"", @@ -3206,11 +4251,11 @@ "githuburl":"" }, { - "uri":"ShowDetailsOfAppCodeV2_1.html", - "node_id":"showdetailsofappcodev2_1.xml", + "uri":"ShowDetailsOfAppCodeV2.html", + "node_id":"showdetailsofappcodev2.xml", "product_code":"apig", - "code":"163", - "des":"This API is used to query the details of an AppCode created for an app for simple authentication.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-code", + "code":"217", + "des":"This API is used to query the details of an AppCode created for an app for simple authentication.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{insta", "doc_type":"api", "kw":"Querying AppCode Details,Credential Management,API Reference", "search_title":"", @@ -3226,11 +4271,11 @@ "githuburl":"" }, { - "uri":"ListAppCodesV2_1.html", - "node_id":"listappcodesv2_1.xml", + "uri":"ListAppCodesV2.html", + "node_id":"listappcodesv2.xml", "product_code":"apig", - "code":"164", - "des":"This API is used to query the AppCodes of an app.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 200Status code: 400Status code: 40", + "code":"218", + "des":"This API is used to query the AppCodes of an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 200S", "doc_type":"api", "kw":"Querying AppCodes of an App,Credential Management,API Reference", "search_title":"", @@ -3245,11 +4290,367 @@ "title":"Querying AppCodes of an App", "githuburl":"" }, + { + "uri":"ShowAppBoundAppQuota.html", + "node_id":"showappboundappquota.xml", + "product_code":"apig", + "code":"219", + "des":"This API is used to query quotas associated with a specified credential.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/bou", + "doc_type":"api", + "kw":"Querying Quotas Associated with a Credential,Credential Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowAppBoundAppQuota" + } + ], + "title":"Querying Quotas Associated with a Credential", + "githuburl":"" + }, + { + "uri":"UpdateAppAcl.html", + "node_id":"updateappacl.xml", + "product_code":"apig", + "code":"220", + "des":"This API is used to configure access control settings for a credential.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-", + "doc_type":"api", + "kw":"Configuring Access Control Settings for an App,Credential Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateAppAcl" + } + ], + "title":"Configuring Access Control Settings for an App", + "githuburl":"" + }, + { + "uri":"ShowDetailsOfAppAcl.html", + "node_id":"showdetailsofappacl.xml", + "product_code":"apig", + "code":"221", + "des":"This API is used to query the access control details about an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-aclSt", + "doc_type":"api", + "kw":"Querying Access Control Details About an App,Credential Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowDetailsOfAppAcl" + } + ], + "title":"Querying Access Control Details About an App", + "githuburl":"" + }, + { + "uri":"DeleteAppAcl.html", + "node_id":"deleteappacl.xml", + "product_code":"apig", + "code":"222", + "des":"This API is used to delete the access control settings of a credential.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/a", + "doc_type":"api", + "kw":"Deleting Access Control Settings of an App,Credential Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeleteAppAcl" + } + ], + "title":"Deleting Access Control Settings of an App", + "githuburl":"" + }, + { + "uri":"CredentialQuotaPoliciesManagement.html", + "node_id":"credentialquotapoliciesmanagement.xml", + "product_code":"apig", + "code":"223", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Credential Quota Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"Credential Quota Management", + "githuburl":"" + }, + { + "uri":"CreateAppQuota.html", + "node_id":"createappquota.xml", + "product_code":"apig", + "code":"224", + "des":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta", + "doc_type":"api", + "kw":"Creating a Credential Quota,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"CreateAppQuota" + } + ], + "title":"Creating a Credential Quota", + "githuburl":"" + }, + { + "uri":"ShowAppQuota.html", + "node_id":"showappquota.xml", + "product_code":"apig", + "code":"225", + "des":"This API is used to query credential quota details.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}Status code: ", + "doc_type":"api", + "kw":"Querying Credential Quota Details,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowAppQuota" + } + ], + "title":"Querying Credential Quota Details", + "githuburl":"" + }, + { + "uri":"ListAppQuotas.html", + "node_id":"listappquotas.xml", + "product_code":"apig", + "code":"226", + "des":"This API is used to query credential quotas. Fuzzy query by name is supported.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotasS", + "doc_type":"api", + "kw":"Querying Credential Quotas,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListAppQuotas" + } + ], + "title":"Querying Credential Quotas", + "githuburl":"" + }, + { + "uri":"UpdateAppQuota.html", + "node_id":"updateappquota.xml", + "product_code":"apig", + "code":"227", + "des":"This API is used to modify a credential quota.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}Status code: 200St", + "doc_type":"api", + "kw":"Modifying a Credential Quota,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"UpdateAppQuota" + } + ], + "title":"Modifying a Credential Quota", + "githuburl":"" + }, + { + "uri":"DeleteAppQuota.html", + "node_id":"deleteappquota.xml", + "product_code":"apig", + "code":"228", + "des":"This API is used to delete a credential quota. When a credential quota is deleted, the association between the quota and credential is also deleted.For details, see Calli", + "doc_type":"api", + "kw":"Deleting a Credential Quota,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DeleteAppQuota" + } + ], + "title":"Deleting a Credential Quota", + "githuburl":"" + }, + { + "uri":"ListAppQuotaBoundApps.html", + "node_id":"listappquotaboundapps.xml", + "product_code":"apig", + "code":"229", + "des":"This API is used to query the credentials bound to a credential quota. Fuzzy match by credential name is supported.For details, see Calling APIs.GET /v2/{project_id}/apig", + "doc_type":"api", + "kw":"Querying the Credentials Bound to a Specified Quota,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListAppQuotaBoundApps" + } + ], + "title":"Querying the Credentials Bound to a Specified Quota", + "githuburl":"" + }, + { + "uri":"AssociateAppsForAppQuota.html", + "node_id":"associateappsforappquota.xml", + "product_code":"apig", + "code":"230", + "des":"This API is used to bind a credential quota with credentials.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/b", + "doc_type":"api", + "kw":"Binding a Credential Quota with Credentials,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"AssociateAppsForAppQuota" + } + ], + "title":"Binding a Credential Quota with Credentials", + "githuburl":"" + }, + { + "uri":"DisassociateAppQuotaWithApp.html", + "node_id":"disassociateappquotawithapp.xml", + "product_code":"apig", + "code":"231", + "des":"This API is used to unbind a credential quota from a credential.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_", + "doc_type":"api", + "kw":"Unbinding a Credential Quota from a Credential,Credential Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"DisassociateAppQuotaWithApp" + } + ], + "title":"Unbinding a Credential Quota from a Credential", + "githuburl":"" + }, + { + "uri":"ListAppQuotaBindableApps.html", + "node_id":"listappquotabindableapps.xml", + "product_code":"apig", + "code":"232", + "des":"This API is used to query the credentials that can be bound to a credential quota. Fuzzy search by credential name is supported.For details, see Calling APIs.GET /v2/{pro", + "doc_type":"api", + "kw":"Querying Credentials That Can Be Bound to a Credential Quota,Credential Quota Management,API Referen", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ListAppQuotaBindableApps" + } + ], + "title":"Querying Credentials That Can Be Bound to a Credential Quota", + "githuburl":"" + }, + { + "uri":"AsynchronousTaskManagement.html", + "node_id":"asynchronoustaskmanagement.xml", + "product_code":"apig", + "code":"233", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Asynchronous Task Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"apig" + } + ], + "title":"Asynchronous Task Management", + "githuburl":"" + }, + { + "uri":"ExportApiDefinitionsAsync.html", + "node_id":"exportapidefinitionsasync.xml", + "product_code":"apig", + "code":"234", + "des":"This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended field", + "doc_type":"api", + "kw":"Exporting APIs Asynchronously,Asynchronous Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ExportApiDefinitionsAsync" + } + ], + "title":"Exporting APIs Asynchronously", + "githuburl":"" + }, + { + "uri":"ImportApiDefinitionsAsync.html", + "node_id":"importapidefinitionsasync.xml", + "product_code":"apig", + "code":"235", + "des":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section", + "doc_type":"api", + "kw":"Importing APIs Asynchronously,Asynchronous Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ImportApiDefinitionsAsync" + } + ], + "title":"Importing APIs Asynchronously", + "githuburl":"" + }, + { + "uri":"ShowAsyncTaskResult.html", + "node_id":"showasynctaskresult.xml", + "product_code":"apig", + "code":"236", + "des":"This API is used to query the result of an asynchronous task.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id}Status ", + "doc_type":"api", + "kw":"Querying the Result of an Asynchronous Task,Asynchronous Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"apig", + "operation_id":"ShowAsyncTaskResult" + } + ], + "title":"Querying the Result of an Asynchronous Task", + "githuburl":"" + }, { "uri":"api-grant-policy.html", "node_id":"api-grant-policy.xml", "product_code":"apig", - "code":"165", + "code":"237", "des":"This chapter describes fine-grained permissions management for your APIG.If your account does not require individual IAM users, skip this section.Only dedicated gateways ", "doc_type":"api", "kw":"Permissions Policies and Supported Actions,API Reference", @@ -3257,10 +4658,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Permissions Policies and Supported Actions", @@ -3270,7 +4668,7 @@ "uri":"apig-api-190529271.html", "node_id":"apig-api-190529271.xml", "product_code":"apig", - "code":"166", + "code":"238", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -3278,20 +4676,17 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Appendix", "githuburl":"" }, { - "uri":"apig-en-api-180713204.html", - "node_id":"apig-en-api-180713204.xml", + "uri":"apig-api-180713204.html", + "node_id":"apig-api-180713204.xml", "product_code":"apig", - "code":"167", + "code":"239", "des":"APIG supports pagination query of resource lists, such as an API list.To perform a pagination query, add the following parameters to the URL:page_size: number of records ", "doc_type":"api", "kw":"Pagination Query,Appendix,API Reference", @@ -3299,20 +4694,17 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Pagination Query", "githuburl":"" }, { - "uri":"apig-en-api-180713205.html", - "node_id":"apig-en-api-180713205.xml", + "uri":"apig-api-180713205.html", + "node_id":"apig-api-180713205.xml", "product_code":"apig", - "code":"168", + "code":"240", "des":"APIG filters query results by object attribute when you query a resource list, such as an API list.Example:", "doc_type":"api", "kw":"Result Filtering,Appendix,API Reference", @@ -3320,20 +4712,17 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Result Filtering", "githuburl":"" }, { - "uri":"apig-en-api-180713206.html", - "node_id":"apig-en-api-180713206.xml", + "uri":"apig-api-180713206.html", + "node_id":"apig-api-180713206.xml", "product_code":"apig", - "code":"169", + "code":"241", "des":"Table 1 describes common status codes.", "doc_type":"api", "kw":"HTTP Status Codes,Appendix,API Reference", @@ -3341,10 +4730,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"HTTP Status Codes", @@ -3354,26 +4740,25 @@ "uri":"ErrorCode.html", "node_id":"errorcode_1.xml", "product_code":"apig", - "code":"170", + "code":"242", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", "search_title":"", "metedata":[ { - "prodname":"apig", - "opensource":"true", - "documenttype":"api" + "documenttype":"api", + "prodname":"apig" } ], "title":"Error Codes", "githuburl":"" }, { - "uri":"apig-api-20210402.html", - "node_id":"apig-api-20210402.xml", + "uri":"apig-api-20200402.html", + "node_id":"apig-api-20200402.xml", "product_code":"apig", - "code":"171", + "code":"243", "des":"The following table lists the features that are supported by dedicated gateways.If the gateway you use does not have specific features, contact technical support to upgra", "doc_type":"api", "kw":"Supported Features,Appendix,API Reference", @@ -3381,10 +4766,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Supported Features", @@ -3394,7 +4776,7 @@ "uri":"apig-api-180713009.html", "node_id":"apig-api-180713009.xml", "product_code":"apig", - "code":"172", + "code":"244", "des":"You can also obtain a project ID by calling the IAM API used to query project information.The API used to obtain a project ID is \"GET https://{Endpoint}/v3/projects/\". {E", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -3402,10 +4784,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Obtaining a Project ID", @@ -3415,7 +4794,7 @@ "uri":"apig-api-180713005.html", "node_id":"apig-api-180713005.xml", "product_code":"apig", - "code":"173", + "code":"245", "des":"An account name and account ID are required for some URLs when an API is called. To obtain an account name and account ID, perform the following operations:Log in to the ", "doc_type":"api", "kw":"Obtaining an Account Name and Account ID,Appendix,API Reference", @@ -3423,20 +4802,17 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Obtaining an Account Name and Account ID", "githuburl":"" }, { - "uri":"apig-en-api-180713215.html", - "node_id":"apig-en-api-180713215.xml", + "uri":"apig-api-180713215.html", + "node_id":"apig-api-180713215.xml", "product_code":"apig", - "code":"174", + "code":"246", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", @@ -3444,10 +4820,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"apig", - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes" + "prodname":"apig" } ], "title":"Change History", diff --git a/docs/apig/api-ref/AclPolicyBinding_1.html b/docs/apig/api-ref/AclPolicyBinding_1.html deleted file mode 100644 index ab96b985..00000000 --- a/docs/apig/api-ref/AclPolicyBinding_1.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Binding/Unbinding Access Control Policies

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/AclPolicyManagement_1.html b/docs/apig/api-ref/AclPolicyManagement_1.html deleted file mode 100644 index 76cdcd26..00000000 --- a/docs/apig/api-ref/AclPolicyManagement_1.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Access Control Policy Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/AddEngressEipV2_1.html b/docs/apig/api-ref/AddEngressEipV2_1.html deleted file mode 100644 index 5c6118b9..00000000 --- a/docs/apig/api-ref/AddEngressEipV2_1.html +++ /dev/null @@ -1,327 +0,0 @@ - - -

Enabling Public Access for a Dedicated Gateway

-

Function

This API is used to enable public access for a dedicated gateway.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eip

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

-
-
-
-

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

-

bandwidth_size

-

No

-

String

-

Outbound access bandwidth.

-

Unit: Mbit/s

-

bandwidth_charging_mode

-

No

-

String

-

Billing type of the public outbound access bandwidth.

-

  • bandwidth: billed by bandwidth

    -

  • traffic: billed by traffic

    -
-

Default: bandwidth

-

Enumeration values:

-

  • bandwidth

    -

  • traffic

    -
-
-
-
-

Response Parameters

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Enabling public access for a gateway

-
{
-  "bandwidth_size" : "5",
-  "bandwidth_charging_mode" : "traffic"
-}
-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIC.9210",
-  "error_msg" : "create cloud nat eip failed"
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/AddingBackendInstancesV2_1.html b/docs/apig/api-ref/AddingBackendInstancesV2_1.html deleted file mode 100644 index 9db97870..00000000 --- a/docs/apig/api-ref/AddingBackendInstancesV2_1.html +++ /dev/null @@ -1,643 +0,0 @@ - - -

Adding or Updating Backend Instances

-

Function

This API is used to add backend instances to a VPC channel.

-

If a backend instance with the specified address already exists, the instance information is updated. If the request body contains multiple backend instance definitions with the same address, the first definition is used.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

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

-

vpc_channel_id

-

Yes

-

String

-

VPC channel 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

-

members

-

Yes

-

Array of MemberInfo objects

-

Backend instances.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 MemberInfo

Parameter

-

Mandatory

-

Type

-

Description

-

host

-

No

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

No

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

No

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

No

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

No

-

Integer

-

Backend server status.

-

  • 1: available

    -

  • 2: unavailable

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

port

-

No

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

No

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

No

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

members

-

Array of VpcMemberInfo objects

-

Cloud server list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 VpcMemberInfo

Parameter

-

Type

-

Description

-

host

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

Integer

-

Backend server status.

-

  • 1: available

    -

  • 2: unavailable

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

port

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-

id

-

String

-

Backend instance ID.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

create_time

-

String

-

Time when the backend server is added to the VPC channel.

-

member_group_id

-

String

-

Backend server group ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

-
-

Example Responses

Status code: 201

-

Created

- -

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2004",
-  "error_msg" : "The parameter value is outside the allowable range,parameterName:weight. 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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

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.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/ApiGroupManagement_1.html b/docs/apig/api-ref/ApiGroupManagement_1.html deleted file mode 100644 index 5b1e18ae..00000000 --- a/docs/apig/api-ref/ApiGroupManagement_1.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

API Group Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/ApiImportExport_1.html b/docs/apig/api-ref/ApiImportExport_1.html deleted file mode 100644 index c5512271..00000000 --- a/docs/apig/api-ref/ApiImportExport_1.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

API Import and Export

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/ApiManagement_1.html b/docs/apig/api-ref/ApiManagement_1.html deleted file mode 100644 index e1b6f771..00000000 --- a/docs/apig/api-ref/ApiManagement_1.html +++ /dev/null @@ -1,40 +0,0 @@ - - -

API Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/ApicInstanceManagement_1.html b/docs/apig/api-ref/ApicInstanceManagement_1.html deleted file mode 100644 index d817b5db..00000000 --- a/docs/apig/api-ref/ApicInstanceManagement_1.html +++ /dev/null @@ -1,34 +0,0 @@ - - -

Gateway Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/ApigTagManagement_1.html b/docs/apig/api-ref/ApigTagManagement_1.html deleted file mode 100644 index 0de915c6..00000000 --- a/docs/apig/api-ref/ApigTagManagement_1.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

Tag Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/AppAuthoringManagement_1.html b/docs/apig/api-ref/AppAuthoringManagement_1.html deleted file mode 100644 index f5c553f8..00000000 --- a/docs/apig/api-ref/AppAuthoringManagement_1.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

App Authorization Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/AssociateCertificateV2_1.html b/docs/apig/api-ref/AssociateCertificateV2_1.html deleted file mode 100644 index 5d4878f1..00000000 --- a/docs/apig/api-ref/AssociateCertificateV2_1.html +++ /dev/null @@ -1,438 +0,0 @@ - - -

Adding a Certificate to a Domain Name

-

Function

When you create an API to be accessed through HTTPS, you must add an SSL certificate to the independent domain name that has been bound to the group the API belongs to.

-

This API is used to add a certificate to a specific domain name.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate

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

-

group_id

-

Yes

-

String

-

API group ID.

-

domain_id

-

Yes

-

String

-

Domain 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

-

cert_content

-

Yes

-

String

-

Certificate content.

-

name

-

Yes

-

String

-

Certificate name. It can contain 4 to 50 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

-

private_key

-

Yes

-

String

-

Private key.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

url_domain

-

String

-

Custom domain name.

-

id

-

String

-

Domain ID.

-

status

-

Integer

-

CNAME resolution status.

-

  • 1: not resolved

    -

  • 2: resolving

    -

  • 3: resolved

    -

  • 4: resolution failed

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -

  • 3

    -

  • 4

    -
-

min_ssl_version

-

String

-

Minimum SSL version supported.

-

is_http_redirect_to_https

-

Boolean

-

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

-

Default: false

-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

ssl_name

-

String

-

Certificate name.

-

ssl_id

-

String

-

Certificate ID.

-
-
-

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

Binding a certificate to a domain name

-
{
-  "name" : "cert_demo",
-  "private_key" : "'-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----\\n'",
-  "cert_content" : "'-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----\\n'"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "ssl_name" : "cert_demo",
-  "url_domain" : "www.example.com",
-  "ssl_id" : "a27be832f2e9441c8127fe48e3b5ac67",
-  "id" : " f6bb84ccf1c34035878aa51b7253b21c",
-  "status" : 3
-}
-

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

-
{
-  "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.3020",
-  "error_msg" : "The URL domain does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/AssociateDomainV2_1.html b/docs/apig/api-ref/AssociateDomainV2_1.html deleted file mode 100644 index 1da8fa61..00000000 --- a/docs/apig/api-ref/AssociateDomainV2_1.html +++ /dev/null @@ -1,420 +0,0 @@ - - -

Binding a Domain Name

-

Function

A user-defined domain name takes effect only after an A record set has been added. For details, see section "Adding an A Record Set" in the Domain Name Service User Guide.

-

An API group can be bound with a maximum of five domain names. After you bind a domain name to an API group, APIs in the group can be called using the domain name.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains

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

-

group_id

-

Yes

-

String

-

API group 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

-

min_ssl_version

-

No

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-

  • TLSv1.1

    -

  • TLSv1.2

    -
-

is_http_redirect_to_https

-

No

-

Boolean

-

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

-

Default: false

-

url_domain

-

Yes

-

String

-

Custom domain name. It can contain a maximum of 255 characters and must comply with domain name specifications.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

url_domain

-

String

-

Custom domain name.

-

id

-

String

-

Domain ID.

-

status

-

Integer

-

CNAME resolution status.

-

  • 1: not resolved

    -

  • 2: resolving

    -

  • 3: resolved

    -

  • 4: resolution failed

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -

  • 3

    -

  • 4

    -
-

min_ssl_version

-

String

-

Minimum SSL version supported.

-

is_http_redirect_to_https

-

Boolean

-

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

-

Default: false

-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-
-
-

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

Binding a domain name to an API group

-
{
-  "url_domain" : "www.company.com"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "url_domain" : "www.company.com",
-  "id" : "c5e0d5ba62a34d26ad5c709ae22c1a17",
-  "status" : 3,
-  "min_ssl_version" : "TLSv1.1",
-  "is_http_redirect_to_https" : false,
-  "verified_client_certificate_enabled" : false
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2024",
-  "error_msg" : "Invalid URL domain name"
-}
-

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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/AssociateRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/AssociateRequestThrottlingPolicyV2_1.html deleted file mode 100644 index 84d8cda8..00000000 --- a/docs/apig/api-ref/AssociateRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,372 +0,0 @@ - - -

Binding a Request Throttling Policy

-

Function

The request throttling policy bound to an API will control access of all users to the API.

-

If the number of API calls within a specified period reaches the limit, subsequent access will be rejected, protecting the backend API from abnormal traffic and ensuring stable service running.

-

This API is used to bind a request throttling policy to an API that has been published in an environment. You can bind different request throttling policies to an API in different environments, but can bind only one request throttling policy to the API in each environment.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings

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

-
-
-
-

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

-

strategy_id

-

Yes

-

String

-

Request throttling policy ID.

-

Minimum: 1

-

Maximum: 65

-

publish_ids

-

Yes

-

Array of strings

-

API publication record ID.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

throttle_applys

-

Array of ThrottleApiBinding objects

-

Request throttling policy binding records.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ThrottleApiBinding

Parameter

-

Type

-

Description

-

publish_id

-

String

-

API publication record ID.

-

scope

-

Integer

-

Scope of the policy.

-

  • 1: the API

    -

  • 2: a user

    -

  • 3: an app

    -
-

Currently, only "1" is supported.

-

Enumeration values:

-

  • 1

    -

  • 2

    -

  • 3

    -
-

strategy_id

-

String

-

Request throttling policy ID.

-

apply_time

-

String

-

Binding time.

-

id

-

String

-

Binding record ID.

-
-
-

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

Binding a request throttling policy to an API

-
{
-  "publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ],
-  "strategy_id" : "3437448ad06f4e0c91a224183116e965"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "throttle_applys" : [ {
-    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
-    "scope" : 1,
-    "strategy_id" : "3437448ad06f4e0c91a224183116e965",
-    "apply_time" : "2020-08-03T12:25:52.257613934Z",
-    "id" : "3e06ac135e18477e918060d3c59d6f6a"
-  } ]
-}
-

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.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

201

-

Created

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Request Throttling Policies
-
-
- diff --git a/docs/apig/api-ref/AssociateSignatureKeyV2_1.html b/docs/apig/api-ref/AssociateSignatureKeyV2_1.html deleted file mode 100644 index 89733098..00000000 --- a/docs/apig/api-ref/AssociateSignatureKeyV2_1.html +++ /dev/null @@ -1,484 +0,0 @@ - - -

Binding a Signature Key

-

Function

A signature key takes effect only after being bound to an API.

-

When requesting the backend service, APIG uses the signature key to cryptographically sign requests. The backend service verifies the signature to identify request sources.

-

This API is used to bind a signature key to one or more published APIs. You can bind different signature keys to an API in different environments, but can bind only one signature key to the API in each environment.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings

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

-
-
-
-

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

-

sign_id

-

Yes

-

String

-

Signature key ID.

-

publish_ids

-

Yes

-

Array of strings

-

API publication record ID.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

bindings

-

Array of SignApiBindingInfo objects

-

APIs bound to the signature key.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SignApiBindingInfo

Parameter

-

Type

-

Description

-

publish_id

-

String

-

API publication record ID.

-

api_id

-

String

-

API ID.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

binding_time

-

String

-

Binding time.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

env_name

-

String

-

Name of the environment in which the API has been published.

-

api_type

-

Integer

-

API type.

-

api_name

-

String

-

API name.

-

id

-

String

-

Binding record ID.

-

api_remark

-

String

-

API description.

-

sign_id

-

String

-

Signature key ID.

-

sign_name

-

String

-

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

-

sign_key

-

String

-

Signature key.

-
  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.
  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.
  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.
  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.
-

sign_secret

-

String

-

Signature secret.

-
  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
  • public_key: The value contains 15 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a value is automatically generated.
  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a value is automatically generated.
-

sign_type

-

String

-

Signature key type.

-
  • hmac
  • basic
  • public_key
  • aes
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-
  • hmac
  • basic
  • public_key
  • aes
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Binding a signature key to a published API

-
{
-  "sign_id" : "0b0e8f456b8742218af75f945307173c",
-  "publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "bindings" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "sign_secret" : "dc0************2b3",
-    "group_name" : "api_group_001",
-    "sign_id" : "0b0e8f456b8742218af75f945307173c",
-    "sign_key" : "a071a20d460a4f639a636c3d7e3d8163",
-    "binding_time" : "2020-08-03T04:00:11.638167852Z",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "sign_name" : "signature_demo",
-    "api_type" : 1,
-    "api_name" : "Api_http",
-    "id" : "25082bd52f74442bb1d273993d567938",
-    "api_remark" : "Web backend API"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:sign_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.3017",
-  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Binding/Unbinding Signature Keys
-
-
- diff --git a/docs/apig/api-ref/BatchDeleteAclV2_1.html b/docs/apig/api-ref/BatchDeleteAclV2_1.html deleted file mode 100644 index db4ceb1b..00000000 --- a/docs/apig/api-ref/BatchDeleteAclV2_1.html +++ /dev/null @@ -1,410 +0,0 @@ - - -

Deleting Multiple Access Control Policies

-

Function

This API is used to delete multiple access control policies.

-

Access control policies bound to APIs cannot be deleted.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/acls

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

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

action

-

Yes

-

String

-

The value must be delete.

-
-
-
-

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

acls

-

No

-

Array of strings

-

IDs of the access control policies to be deleted.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

success_count

-

Integer

-

Number of access control policies that have been successfully deleted.

-

failure

-

Array of AclBatchResultFailureResp objects

-

Error message and access control policies that fail to be deleted.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 6 AclBatchResultFailureResp

Parameter

-

Type

-

Description

-

acl_id

-

String

-

ID of an access control policy that fails to be deleted.

-

acl_name

-

String

-

Name of the access control policy.

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Deleting multiple access control policies

-
{
-  "acls" : [ "7eb619ecf2a24943b099833cd24a01ba", "3a68d39f115d4c128fccd6f624ea6109" ]
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "failure" : [ {
-    "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
-    "acl_name" : "acl_demo",
-    "error_code" : "APIG.3447",
-    "error_msg" : "The access control policy has been bound to APIs"
-  } ],
-  "success_count" : 1
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value: parameter action should be \\\"delete\\\""
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/BatchDeleteApiAclBindingV2_1.html b/docs/apig/api-ref/BatchDeleteApiAclBindingV2_1.html deleted file mode 100644 index 0be96673..00000000 --- a/docs/apig/api-ref/BatchDeleteApiAclBindingV2_1.html +++ /dev/null @@ -1,415 +0,0 @@ - - -

Unbinding Access Control Policies

-

Function

This API is used to unbind multiple access control policies from APIs.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

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

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

action

-

Yes

-

String

-

The value must be delete.

-
-
-
-

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

acl_bindings

-

No

-

Array of strings

-

IDs of the access control policy binding records to be canceled.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

success_count

-

Integer

-

Number of access control policies that have been successfully unbound.

-

failure

-

Array of AclBindingBatchFailure objects

-

Error message and access control policies that fail to be unbound.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 AclBindingBatchFailure

Parameter

-

Type

-

Description

-

bind_id

-

String

-

ID of an access control policy binding record that fails to be canceled.

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-

api_id

-

String

-

ID of an API from which unbinding fails.

-

api_name

-

String

-

Name of the API from which unbinding fails.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Unbinding multiple access control policies from APIs

-
{
-  "acl_bindings" : [ "332c5db1458a477b89b2ea741fec94a3" ]
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "failure" : [ {
-    "bind_id" : "3a68d39f115d4c128fccd6f624ea6109",
-    "error_code" : "APIG.3010",
-    "error_msg" : "The access control policy binding record does not exist"
-  } ],
-  "success_count" : 1
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value: parameter action should be \\\"delete\\\""
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Access Control Policies
-
-
- diff --git a/docs/apig/api-ref/BatchDisassociateThrottlingPolicyV2_1.html b/docs/apig/api-ref/BatchDisassociateThrottlingPolicyV2_1.html deleted file mode 100644 index 22e3c0e7..00000000 --- a/docs/apig/api-ref/BatchDisassociateThrottlingPolicyV2_1.html +++ /dev/null @@ -1,377 +0,0 @@ - - -

Unbinding Request Throttling Policies

-

Function

This API is used to unbind request throttling policies from APIs.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings

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

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

action

-

Yes

-

String

-

The value must be delete.

-
-
-
-

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

throttle_bindings

-

No

-

Array of strings

-

IDs of the request throttling policy binding records to be canceled.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

success_count

-

Integer

-

Number of request throttling policies that have been successfully unbound.

-

failure

-

Array of ThrottleBindingBatchFailure objects

-

Error message and request throttling policies that fail to be unbound.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ThrottleBindingBatchFailure

Parameter

-

Type

-

Description

-

bind_id

-

String

-

ID of a request throttling policy binding record that fails to be canceled.

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-

api_id

-

String

-

ID of an API from which unbinding fails.

-

api_name

-

String

-

Name of the API from which unbinding fails.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Unbinding request throttling policies from APIs

-
{
-  "throttle_bindings" : [ "6a6a75b425df416cbdcd7821da30be8d", "b11e5970f732440dbea647580647d57f" ]
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "failure" : [ {
-    "bind_id" : "b11e5970f732440dbea647580647d57f",
-    "error_code" : "APIG.3012",
-    "error_msg" : "The request throttling policy binding record does not exist"
-  } ],
-  "success_count" : 1
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "parameter action should be \\\"delete\\\""
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Request Throttling Policies
-
-
- diff --git a/docs/apig/api-ref/BatchPublishOrOfflineApiV2_1.html b/docs/apig/api-ref/BatchPublishOrOfflineApiV2_1.html deleted file mode 100644 index 57c1da17..00000000 --- a/docs/apig/api-ref/BatchPublishOrOfflineApiV2_1.html +++ /dev/null @@ -1,472 +0,0 @@ - - -

Publishing APIs or Taking APIs Offline

-

Function

This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/publish

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

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

action

-

Yes

-

String

-

  • online: publish APIs

    -

  • offline: take APIs offline

    -
-
-
-
-

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

apis

-

No

-

Array of strings

-

IDs of APIs to be published or taken offline. A maximum of 1000 APIs are allowed at a time. Either apis or group_id must be specified.

-

env_id

-

Yes

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID. Either apis or group_id must be specified.

-

remark

-

No

-

String

-

Description of the publication.

-

It cannot exceed 255 characters.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

success

-

Array of PublishResp objects

-

Message for successful API publication or taking offline.

-

failure

-

Array of BatchFailure objects

-

Error message and APIs that fail to be published or taken offline.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 PublishResp

Parameter

-

Type

-

Description

-

publish_id

-

String

-

Publication record ID.

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

remark

-

String

-

Description about the publication.

-

publish_time

-

String

-

Publication time.

-

version_id

-

String

-

API version currently in use.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 7 BatchFailure

Parameter

-

Type

-

Description

-

api_id

-

String

-

ID of an API that fails to be published or taken offline.

-

api_name

-

String

-

Name of an API that fails to be published or taken offline.

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Publishing APIs

-
{
-  "apis" : [ "3a955b791bd24b1c9cd94c745f8d1aad", "abd9c4b2ff974888b0ba79be7e6b2762" ],
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "remark" : "Published to the production environment"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "success" : [ {
-    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
-    "api_id" : "3a955b791bd24b1c9cd94c745f8d1aad",
-    "api_name" : "Api_mock",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "version_id" : "632b2c9e022941969af9a1d45735ae2c",
-    "remark" : "Published to the production environment",
-    "publish_time" : "2020-08-03T03:01:31.26522821Z"
-  } ],
-  "failure" : [ {
-    "api_id" : "abd9c4b2ff974888b0ba79be7e6b2762",
-    "error_code" : "APIG.3002",
-    "error_msg" : "Api abd9c4b2ff974888b0ba79be7e6b2762 not found"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value: parameter action should be \\\"online\\\" or \\\"offline\\\""
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/CLASS.TXT.json b/docs/apig/api-ref/CLASS.TXT.json index 53b29540..f7e02903 100644 --- a/docs/apig/api-ref/CLASS.TXT.json +++ b/docs/apig/api-ref/CLASS.TXT.json @@ -1,84 +1,48 @@ [ { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.This", "product_code":"apig", "title":"Before You Start", - "uri":"apig-en-api-180713001.html", + "uri":"apig-api-190529263.html", "doc_type":"api", "p_code":"", "code":"1" }, { - "desc":"API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.This", + "desc":"Public cloud application programming interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", "product_code":"apig", - "title":"Overview", - "uri":"apig-api-190529263.html", + "title":"API Usage", + "uri":"apig-api-0001.html", "doc_type":"api", - "p_code":"1", + "p_code":"", "code":"2" }, - { - "desc":"APIG supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", - "product_code":"apig", - "title":"API Calling", - "uri":"apig-api-190529264.html", - "doc_type":"api", - "p_code":"1", - "code":"3" - }, - { - "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support.", - "product_code":"apig", - "title":"Endpoints", - "uri":"apig-api-190529265.html", - "doc_type":"api", - "p_code":"1", - "code":"4" - }, - { - "desc":"The number of APIG resources that you can create is determined by your quota. To increase your quota, contact technical support.For more constraints, see API description.", - "product_code":"apig", - "title":"Constraints", - "uri":"apig-api-190529266.html", - "doc_type":"api", - "p_code":"1", - "code":"5" - }, - { - "desc":"AccountAn account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It c", - "product_code":"apig", - "title":"Concepts", - "uri":"apig-api-190529267.html", - "doc_type":"api", - "p_code":"1", - "code":"6" - }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Calling APIs", - "uri":"apig-en-api-180713003.html", + "uri":"apig-api-180713003.html", "doc_type":"api", "p_code":"", - "code":"7" + "code":"3" }, { - "desc":"This section describes the structure of a REST API request, and uses the APIG API for creating an API group (dedicated gateways) as an example to demonstrate how to call ", + "desc":"This section describes the structure of a REST API request, and uses the APIG API for creating an API group as an example to demonstrate how to call an API.A request URI ", "product_code":"apig", "title":"Making an API Request", - "uri":"apig-en-api-180713011.html", + "uri":"apig-api-180713011.html", "doc_type":"api", - "p_code":"7", - "code":"8" + "p_code":"3", + "code":"4" }, { - "desc":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au", + "desc":"Requests for calling an API can be authenticated using either of the following methods:AK/SK-based authentication: Requests are authenticated by encrypting the request bo", "product_code":"apig", "title":"Authentication", "uri":"apig-api-190529268.html", "doc_type":"api", - "p_code":"7", - "code":"9" + "p_code":"3", + "code":"5" }, { "desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", @@ -86,8 +50,8 @@ "title":"Response", "uri":"apig-api-190529269.html", "doc_type":"api", - "p_code":"7", - "code":"10" + "p_code":"3", + "code":"6" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -96,751 +60,787 @@ "uri":"apig-phapi-20070101.html", "doc_type":"api", "p_code":"", - "code":"11" + "code":"7" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"API Group Management", - "uri":"ApiGroupManagement_1.html", + "uri":"ApiGroupManagement.html", "doc_type":"api", - "p_code":"11", - "code":"12" + "p_code":"7", + "code":"8" }, { "desc":"This API is used to create an API group. An API group is an API management unit and the entry to a service. A subdomain name is returned as the access entry when an API g", "product_code":"apig", "title":"Creating an API Group", - "uri":"CreateApiGroupV2_1.html", + "uri":"CreateApiGroupV2.html", "doc_type":"api", - "p_code":"12", - "code":"13" + "p_code":"8", + "code":"9" }, { - "desc":"This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.PUT /v2/{project_id}/apigw/instances/{insta", + "desc":"This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.For details, see Calling APIs.PUT /v2/{proj", "product_code":"apig", "title":"Modifying an API Group", - "uri":"UpdateApiGroupV2_1.html", + "uri":"UpdateApiGroupV2.html", "doc_type":"api", - "p_code":"12", - "code":"14" + "p_code":"8", + "code":"10" }, { "desc":"This API is used to delete an API group.If the group to delete contains APIs, take the APIs offline and delete them.All resources (independent domain names and SSL certif", "product_code":"apig", "title":"Deleting an API Group", - "uri":"DeleteApiGroupV2_1.html", + "uri":"DeleteApiGroupV2.html", "doc_type":"api", - "p_code":"12", - "code":"15" + "p_code":"8", + "code":"11" }, { - "desc":"This API is used to query the details of an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}Status code: 200Status code: 400Status code:", + "desc":"This API is used to query the details of an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}Status code: 2", "product_code":"apig", "title":"Querying API Group Details", - "uri":"ShowDetailsOfApiGroupV2_1.html", + "uri":"ShowDetailsOfApiGroupV2.html", "doc_type":"api", - "p_code":"12", - "code":"16" + "p_code":"8", + "code":"12" }, { - "desc":"This API is used to query API groups.You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.GET /v2/{", + "desc":"This API is used to query the API group list.You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.F", "product_code":"apig", "title":"Querying API Groups", - "uri":"ListApiGroupsV2_1.html", + "uri":"ListApiGroupsV2.html", "doc_type":"api", - "p_code":"12", - "code":"17" + "p_code":"8", + "code":"13" + }, + { + "desc":"This API is used to check whether the API group name exists.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/checkStatus code:", + "product_code":"apig", + "title":"Verifying an API Group Name", + "uri":"CheckApiGroupsV2.html", + "doc_type":"api", + "p_code":"8", + "code":"14" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Environment Management", - "uri":"EnvManagement_1.html", + "uri":"EnvManagement.html", "doc_type":"api", - "p_code":"11", - "code":"18" + "p_code":"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", "product_code":"apig", "title":"Creating an Environment", - "uri":"CreateEnvironmentV2_1.html", + "uri":"CreateEnvironmentV2.html", "doc_type":"api", - "p_code":"18", - "code":"19" + "p_code":"15", + "code":"16" }, { - "desc":"This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.PUT /v2/{project_id}/apigw/instance", + "desc":"This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.For details, see Calling APIs.PUT /", "product_code":"apig", "title":"Modifying an Environment", - "uri":"UpdateEnvironmentV2_1.html", + "uri":"UpdateEnvironmentV2.html", "doc_type":"api", - "p_code":"18", - "code":"20" + "p_code":"15", + "code":"17" }, { "desc":"This API is used to delete an environment.This operation will cause the APIs published in the environment to become inaccessible to relevant apps and users. Ensure that y", "product_code":"apig", "title":"Deleting an Environment", - "uri":"DeleteEnvironmentV2_1.html", + "uri":"DeleteEnvironmentV2.html", "doc_type":"api", - "p_code":"18", - "code":"21" + "p_code":"15", + "code":"18" }, { - "desc":"This API is used to query environments.GET /v2/{project_id}/apigw/instances/{instance_id}/envsStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "desc":"This API is used to query environments.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/envsStatus code: 200Status code: 400Status code: 4", "product_code":"apig", "title":"Querying Environments", - "uri":"ListEnvironmentsV2_1.html", + "uri":"ListEnvironmentsV2.html", "doc_type":"api", - "p_code":"18", - "code":"22" + "p_code":"15", + "code":"19" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Environment Variable Management", - "uri":"EnvVariableManagement_1.html", + "uri":"EnvVariableManagement.html", "doc_type":"api", - "p_code":"11", - "code":"23" + "p_code":"7", + "code":"20" }, { "desc":"Publishing an API in different environments may involve various variables, such as API service deployment address and request version.You can define environment variables", "product_code":"apig", "title":"Creating a Variable", - "uri":"CreateEnvironmentVariableV2_1.html", + "uri":"CreateEnvironmentVariableV2.html", "doc_type":"api", - "p_code":"23", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to delete an environment variable.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Stat", + "product_code":"apig", + "title":"Deleting a Variable", + "uri":"DeleteEnvironmentVariableV2.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to query the details of an environment variable.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_varia", + "product_code":"apig", + "title":"Querying Variable Details", + "uri":"ShowDetailsOfEnvironmentVariableV2.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is used to query all environment variables under an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variablesStatu", + "product_code":"apig", + "title":"Querying Environment Variables", + "uri":"ListEnvironmentVariablesV2.html", + "doc_type":"api", + "p_code":"20", "code":"24" }, { - "desc":"This API is used to delete an environment variable.DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Status code: 401Status code: 403St", + "desc":"This API is used to modify an environment variable. If an environment variable is referenced by the backend service address of an API, modifying the environment variable ", "product_code":"apig", - "title":"Deleting a Variable", - "uri":"DeleteEnvironmentVariableV2_1.html", + "title":"Modifying a Variable", + "uri":"UpdateEnvironmentVariableV2.html", "doc_type":"api", - "p_code":"23", + "p_code":"20", "code":"25" }, - { - "desc":"This API is used to query the details of an environment variable.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}Status code: 200Status ", - "product_code":"apig", - "title":"Querying Variable Details", - "uri":"ShowDetailsOfEnvironmentVariableV2_1.html", - "doc_type":"api", - "p_code":"23", - "code":"26" - }, - { - "desc":"This API is used to query all environment variables under an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/env-variablesStatus code: 200Status code: 400Sta", - "product_code":"apig", - "title":"Querying Environment Variables", - "uri":"ListEnvironmentVariablesV2_1.html", - "doc_type":"api", - "p_code":"23", - "code":"27" - }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Request Throttling Policy Management", - "uri":"ThrottlingPolicyManagement_1.html", + "uri":"ThrottlingPolicyManagement.html", "doc_type":"api", - "p_code":"11", - "code":"28" + "p_code":"7", + "code":"26" }, { "desc":"After an API goes online, the system attaches a request throttling policy to it by default. The API provider can change the request throttling policy based on the service", "product_code":"apig", "title":"Creating a Request Throttling Policy", - "uri":"CreateRequestThrottlingPolicyV2_1.html", + "uri":"CreateRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"28", + "p_code":"26", + "code":"27" + }, + { + "desc":"This API is used to modify the information about a request throttling policy.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{t", + "product_code":"apig", + "title":"Modifying a Request Throttling Policy", + "uri":"UpdateRequestThrottlingPolicyV2.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "desc":"This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.For details, see Calling APIs.DELETE /v2/{project_id}/api", + "product_code":"apig", + "title":"Deleting a Request Throttling Policy", + "uri":"DeleteRequestThrottlingPolicyV2.html", + "doc_type":"api", + "p_code":"26", "code":"29" }, { - "desc":"This API is used to modify the information about a request throttling policy.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}Status code: 200Sta", + "desc":"This API is used to query all the request throttling policies.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/throttlesStatus code: 200St", "product_code":"apig", - "title":"Modifying a Request Throttling Policy", - "uri":"UpdateRequestThrottlingPolicyV2_1.html", + "title":"Querying Request Throttling Policies", + "uri":"ListRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"28", + "p_code":"26", "code":"30" }, { - "desc":"This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/thr", - "product_code":"apig", - "title":"Deleting a Request Throttling Policy", - "uri":"DeleteRequestThrottlingPolicyV2_1.html", - "doc_type":"api", - "p_code":"28", - "code":"31" - }, - { - "desc":"This API is used to query all the request throttling policies.GET /v2/{project_id}/apigw/instances/{instance_id}/throttlesStatus code: 200Status code: 400Status code: 401", - "product_code":"apig", - "title":"Querying Request Throttling Policies", - "uri":"ListRequestThrottlingPolicyV2_1.html", - "doc_type":"api", - "p_code":"28", - "code":"32" - }, - { - "desc":"This API is used to query the details of a request throttling policy.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}Status code: 200Status code", + "desc":"This API is used to query the details of a request throttling policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_", "product_code":"apig", "title":"Querying Details of a Request Throttling Policy", - "uri":"ShowDetailsOfRequestThrottlingPolicyV2_1.html", + "uri":"ShowDetailsOfRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"28", - "code":"33" + "p_code":"26", + "code":"31" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"API Management", - "uri":"ApiManagement_1.html", + "uri":"ApiManagement.html", "doc_type":"api", - "p_code":"11", - "code":"34" + "p_code":"7", + "code":"32" }, { "desc":"This API is used to create an API. An API is an interface that encapsulates a set of service capabilities.The definition of an API defines how the API is called by users ", "product_code":"apig", "title":"Creating an API", - "uri":"CreateApiV2_1.html", + "uri":"CreateApiV2.html", "doc_type":"api", - "p_code":"34", - "code":"35" + "p_code":"32", + "code":"33" }, { - "desc":"This API is used to modify the information about an API, including its backend information.PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 20", + "desc":"This API is used to modify the information about an API, including its backend information.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id", "product_code":"apig", "title":"Modifying an API", - "uri":"UpdateApiV2_1.html", + "uri":"UpdateApiV2.html", "doc_type":"api", - "p_code":"34", - "code":"36" + "p_code":"32", + "code":"34" }, { "desc":"This API is used to delete an API.This operation will delete all related resources and binding relationships of the API, such as publication records, backend services, an", "product_code":"apig", "title":"Deleting an API", - "uri":"DeleteApiV2_1.html", + "uri":"DeleteApiV2.html", "doc_type":"api", - "p_code":"34", - "code":"37" + "p_code":"32", + "code":"35" }, { "desc":"This API is used to publish an API or take an API offline.An API can be called only in an environment where the API has been published. APIs that have not been published ", "product_code":"apig", "title":"Publishing an API or Taking an API Offline", - "uri":"CreateOrDeletePublishRecordForApiV2_1.html", + "uri":"CreateOrDeletePublishRecordForApiV2.html", "doc_type":"api", - "p_code":"34", + "p_code":"32", + "code":"36" + }, + { + "desc":"This API is used to query the details of an API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 200Status code:", + "product_code":"apig", + "title":"Querying API Details", + "uri":"ShowDetailsOfApiV2.html", + "doc_type":"api", + "p_code":"32", + "code":"37" + }, + { + "desc":"This API is used to query APIs to return their details and publication information. Backend and request parameter information of the APIs will not be returned.For details", + "product_code":"apig", + "title":"Querying APIs", + "uri":"ListApisV2.html", + "doc_type":"api", + "p_code":"32", "code":"38" }, { - "desc":"This API is used to query the details of an API.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}Status code: 200Status code: 401Status code: 403Status cod", + "desc":"This API is used to verify the API definition, that is, whether the API path or name already exists.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{i", "product_code":"apig", - "title":"Querying API Details", - "uri":"ShowDetailsOfApiV2_1.html", + "title":"Verifying the API Definition", + "uri":"CheckApisV2.html", "doc_type":"api", - "p_code":"34", + "p_code":"32", "code":"39" }, { - "desc":"This API is used to query APIs to return details and publication information of the APIs. Backend information of the APIs will not be returned.GET /v2/{project_id}/apigw/", + "desc":"This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.For details, see Calling APIs.POST /", "product_code":"apig", - "title":"Querying APIs", - "uri":"ListApisV2_1.html", + "title":"Debugging an API", + "uri":"DebugApiV2.html", "doc_type":"api", - "p_code":"34", + "p_code":"32", "code":"40" }, { - "desc":"This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.POST /v2/{project_id}/apigw/instance", + "desc":"This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.For details, see Calling API", "product_code":"apig", - "title":"Debugging an API", - "uri":"DebugApiV2_1.html", + "title":"Publishing APIs or Taking APIs Offline", + "uri":"BatchPublishOrOfflineApiV2.html", "doc_type":"api", - "p_code":"34", + "p_code":"32", "code":"41" }, { - "desc":"This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.POST /v2/{project_id}/apigw/", - "product_code":"apig", - "title":"Publishing APIs or Taking APIs Offline", - "uri":"BatchPublishOrOfflineApiV2_1.html", - "doc_type":"api", - "p_code":"34", - "code":"42" - }, - { - "desc":"This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.GET /v2/{project_id}/apigw/in", + "desc":"This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.For details, see Calling APIs", "product_code":"apig", "title":"Querying Historical Versions of an API", - "uri":"ListApiVersionsV2_1.html", + "uri":"ListApiVersionsV2.html", "doc_type":"api", - "p_code":"34", - "code":"43" + "p_code":"32", + "code":"42" }, { "desc":"This API is used to switch the version of an API. A version is generated based on the current definition of an API when the API is published. The version records the defi", "product_code":"apig", "title":"Switching the Version of an API", - "uri":"ChangeApiVersionV2_1.html", + "uri":"ChangeApiVersionV2.html", "doc_type":"api", - "p_code":"34", - "code":"44" + "p_code":"32", + "code":"43" }, { "desc":"This API is used to query the runtime definition of an API in a specified environment. The runtime definition of an API in the RELEASE environment is queried if no enviro", "product_code":"apig", "title":"Querying the Runtime Definition of an API", - "uri":"ListApiRuntimeDefinitionV2_1.html", + "uri":"ListApiRuntimeDefinitionV2.html", "doc_type":"api", - "p_code":"34", + "p_code":"32", + "code":"44" + }, + { + "desc":"This API is used to query the details of a specified API version.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_i", + "product_code":"apig", + "title":"Querying API Version Details", + "uri":"ListApiVersionDetailV2.html", + "doc_type":"api", + "p_code":"32", "code":"45" }, { - "desc":"This API is used to query the details of a specified API version.GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_id}Status code: 200Status code:", - "product_code":"apig", - "title":"Querying API Version Details", - "uri":"ListApiVersionDetailV2_1.html", - "doc_type":"api", - "p_code":"34", - "code":"46" - }, - { - "desc":"This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.DELETE /v2/{project_id}/apigw/insta", + "desc":"This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.For details, see Calling APIs.DELET", "product_code":"apig", "title":"Taking an API Version Offline", - "uri":"DeleteApiByVersionIdV2_1.html", + "uri":"DeleteApiByVersionIdV2.html", "doc_type":"api", - "p_code":"34", - "code":"47" + "p_code":"32", + "code":"46" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Signature Key Management", - "uri":"SignatureKeyManagement_1.html", + "uri":"SignatureKeyManagement.html", "doc_type":"api", - "p_code":"11", - "code":"48" + "p_code":"7", + "code":"47" }, { "desc":"It is a good practice to provide a protection mechanism for APIs to ensure access security. For example, authenticating API request sources and denying the access from un", "product_code":"apig", "title":"Creating a Signature Key", - "uri":"CreateSignatureKeyV2_1.html", + "uri":"CreateSignatureKeyV2.html", "doc_type":"api", - "p_code":"48", + "p_code":"47", + "code":"48" + }, + { + "desc":"This API is used to modify the information about a signature key.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}Status co", + "product_code":"apig", + "title":"Modifying a Signature Key", + "uri":"UpdateSignatureKeyV2.html", + "doc_type":"api", + "p_code":"47", "code":"49" }, { - "desc":"This API is used to modify the information about a signature key.PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}Status code: 200Status code: 400Status ", + "desc":"This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.For details, see Calling AP", "product_code":"apig", - "title":"Modifying a Signature Key", - "uri":"UpdateSignatureKeyV2_1.html", + "title":"Deleting a Signature Key", + "uri":"DeleteSignatureKeyV2.html", "doc_type":"api", - "p_code":"48", + "p_code":"47", "code":"50" }, { - "desc":"This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.DELETE /v2/{project_id}/api", - "product_code":"apig", - "title":"Deleting a Signature Key", - "uri":"DeleteSignatureKeyV2_1.html", - "doc_type":"api", - "p_code":"48", - "code":"51" - }, - { - "desc":"This API is used to query all the signature keys.GET /v2/{project_id}/apigw/instances/{instance_id}/signsStatus code: 200Status code: 400Status code: 401Status code: 403S", + "desc":"This API is used to query all the signature keys.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/signsStatus code: 200Status code: 400Sta", "product_code":"apig", "title":"Querying Signature Keys", - "uri":"ListSignatureKeysV2_1.html", + "uri":"ListSignatureKeysV2.html", "doc_type":"api", - "p_code":"48", - "code":"52" + "p_code":"47", + "code":"51" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Binding/Unbinding Signature Keys", - "uri":"SignatureKeyBindingManagement_1.html", + "uri":"SignatureKeyBindingManagement.html", "doc_type":"api", - "p_code":"11", - "code":"53" + "p_code":"7", + "code":"52" }, { "desc":"A signature key takes effect only after being bound to an API.When requesting the backend service, APIG uses the signature key to cryptographically sign requests. The bac", "product_code":"apig", "title":"Binding a Signature Key", - "uri":"AssociateSignatureKeyV2_1.html", + "uri":"AssociateSignatureKeyV2.html", "doc_type":"api", - "p_code":"53", + "p_code":"52", + "code":"53" + }, + { + "desc":"This API is used to unbind a signature key from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id", + "product_code":"apig", + "title":"Unbinding a Signature Key", + "uri":"DisassociateSignatureKeyV2.html", + "doc_type":"api", + "p_code":"52", "code":"54" }, { - "desc":"This API is used to unbind a signature key from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id}Status code: 400Status code: ", + "desc":"This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.For details, see Cal", "product_code":"apig", - "title":"Unbinding a Signature Key", - "uri":"DisassociateSignatureKeyV2_1.html", + "title":"Querying Signature Keys Bound to an API", + "uri":"ListSignatureKeysBindedToApiV2.html", "doc_type":"api", - "p_code":"53", + "p_code":"52", "code":"55" }, { - "desc":"This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.GET /v2/{project_id}", + "desc":"This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.For details, see Calling APIs.GET /v2/{project_id}/a", "product_code":"apig", - "title":"Querying Signature Keys Bound to an API", - "uri":"ListSignatureKeysBindedToApiV2_1.html", + "title":"Querying APIs Not Bound with a Signature Key", + "uri":"ListApisNotBoundWithSignatureKeyV2.html", "doc_type":"api", - "p_code":"53", + "p_code":"52", "code":"56" }, { - "desc":"This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.GET /v2/{project_id}/apigw/instances/{instance_id}/s", - "product_code":"apig", - "title":"Querying APIs Not Bound with a Signature Key", - "uri":"ListApisNotBoundWithSignatureKeyV2_1.html", - "doc_type":"api", - "p_code":"53", - "code":"57" - }, - { - "desc":"This API is used to query the APIs to which a signature key has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apisStatus code: 200Sta", + "desc":"This API is used to query the APIs to which a signature key has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/", "product_code":"apig", "title":"Querying APIs Bound with a Signature Key", - "uri":"ListApisBindedToSignatureKeyV2_1.html", + "uri":"ListApisBindedToSignatureKeyV2.html", "doc_type":"api", - "p_code":"53", - "code":"58" + "p_code":"52", + "code":"57" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Binding/Unbinding Request Throttling Policies", - "uri":"ThrottlingPolicyBinding_1.html", + "uri":"ThrottlingPolicyBinding.html", "doc_type":"api", - "p_code":"11", - "code":"59" + "p_code":"7", + "code":"58" }, { "desc":"The request throttling policy bound to an API will control access of all users to the API.If the number of API calls within a specified period reaches the limit, subseque", "product_code":"apig", "title":"Binding a Request Throttling Policy", - "uri":"AssociateRequestThrottlingPolicyV2_1.html", + "uri":"AssociateRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"59", + "p_code":"58", + "code":"59" + }, + { + "desc":"This API is used to unbind a request throttling policy from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{", + "product_code":"apig", + "title":"Unbinding a Request Throttling Policy", + "uri":"DisassociateRequestThrottlingPolicyV2.html", + "doc_type":"api", + "p_code":"58", "code":"60" }, { - "desc":"This API is used to unbind a request throttling policy from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_id}Status cod", + "desc":"This API is used to query the APIs to which a specified request throttling policy has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{insta", "product_code":"apig", - "title":"Unbinding a Request Throttling Policy", - "uri":"DisassociateRequestThrottlingPolicyV2_1.html", + "title":"Querying APIs Bound with a Request Throttling Policy", + "uri":"ListApisBindedToRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"59", + "p_code":"58", "code":"61" }, { - "desc":"This API is used to query the APIs to which a specified request throttling policy has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/bind", + "desc":"This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.For details, see Calling ", "product_code":"apig", - "title":"Querying APIs Bound with a Request Throttling Policy", - "uri":"ListApisBindedToRequestThrottlingPolicyV2_1.html", + "title":"Querying APIs Not Bound with a Request Throttling Policy", + "uri":"ListApisUnbindedToRequestThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"59", + "p_code":"58", "code":"62" }, { - "desc":"This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.GET /v2/{project_id}/apig", + "desc":"This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.For ", "product_code":"apig", - "title":"Querying APIs Not Bound with a Request Throttling Policy", - "uri":"ListApisUnbindedToRequestThrottlingPolicyV2_1.html", + "title":"Querying Request Throttling Policies Bound to an API", + "uri":"ListRequestThrottlingPoliciesBindedToApiV2.html", "doc_type":"api", - "p_code":"59", + "p_code":"58", "code":"63" }, { - "desc":"This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.GET ", - "product_code":"apig", - "title":"Querying Request Throttling Policies Bound to an API", - "uri":"ListRequestThrottlingPoliciesBindedToApiV2_1.html", - "doc_type":"api", - "p_code":"59", - "code":"64" - }, - { - "desc":"This API is used to unbind request throttling policies from APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindingsStatus code: 200Status code: 400Statu", + "desc":"This API is used to unbind request throttling policies from APIs.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindingsStatus ", "product_code":"apig", "title":"Unbinding Request Throttling Policies", - "uri":"BatchDisassociateThrottlingPolicyV2_1.html", + "uri":"BatchDisassociateThrottlingPolicyV2.html", "doc_type":"api", - "p_code":"59", - "code":"65" + "p_code":"58", + "code":"64" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Excluded Request Throttling Configuration", - "uri":"SpecialThrottlingSetting_0.html", + "uri":"SpecialThrottlingSetting.html", "doc_type":"api", - "p_code":"11", - "code":"66" + "p_code":"7", + "code":"65" }, { "desc":"A request throttling policy controls the maximum number of times an API can be accessed within a specified period and the maximum numbers of times the API can be accessed", "product_code":"apig", "title":"Creating an Excluded Request Throttling Configuration", - "uri":"CreateSpecialThrottlingConfigurationV2_0.html", + "uri":"CreateSpecialThrottlingConfigurationV2.html", "doc_type":"api", - "p_code":"66", + "p_code":"65", + "code":"66" + }, + { + "desc":"This API is used to modify an excluded configuration of a request throttling policy.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/throt", + "product_code":"apig", + "title":"Modifying an Excluded Request Throttling Configuration", + "uri":"UpdateSpecialThrottlingConfigurationV2.html", + "doc_type":"api", + "p_code":"65", "code":"67" }, { - "desc":"This API is used to modify an excluded configuration of a request throttling policy.PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-sp", + "desc":"This API is used to delete an excluded configuration of a request throttling policy.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/th", "product_code":"apig", - "title":"Modifying an Excluded Request Throttling Configuration", - "uri":"UpdateSpecialThrottlingConfigurationV2_0.html", + "title":"Deleting an Excluded Request Throttling Configuration", + "uri":"DeleteSpecialThrottlingConfigurationV2.html", "doc_type":"api", - "p_code":"66", + "p_code":"65", "code":"68" }, { - "desc":"This API is used to delete an excluded configuration of a request throttling policy.DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle", - "product_code":"apig", - "title":"Deleting an Excluded Request Throttling Configuration", - "uri":"DeleteSpecialThrottlingConfigurationV2_0.html", - "doc_type":"api", - "p_code":"66", - "code":"69" - }, - { - "desc":"This API is used to query all excluded configurations of a request throttling policy.GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-s", + "desc":"This API is used to query all excluded configurations of a request throttling policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/thro", "product_code":"apig", "title":"Querying Excluded Request Throttling Configurations", - "uri":"ListSpecialThrottlingConfigurationsV2_0.html", + "uri":"ListSpecialThrottlingConfigurationsV2.html", "doc_type":"api", - "p_code":"66", - "code":"70" + "p_code":"65", + "code":"69" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"App Authorization Management", - "uri":"AppAuthoringManagement_1.html", + "uri":"AppAuthoringManagement.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", + "code":"70" + }, + { + "desc":"An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.For details, see Calling APIs.PO", + "product_code":"apig", + "title":"Authorizing Apps", + "uri":"CreateAuthorizingAppsV2.html", + "doc_type":"api", + "p_code":"70", "code":"71" }, { - "desc":"An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.POST /v2/{project_id}/apigw/inst", + "desc":"This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.For details, see Calling APIs.DELETE", "product_code":"apig", - "title":"Authorizing Apps", - "uri":"CreateAuthorizingAppsV2_1.html", + "title":"Canceling Authorization", + "uri":"CancelingAuthorizationV2.html", "doc_type":"api", - "p_code":"71", + "p_code":"70", "code":"72" }, { - "desc":"This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.DELETE /v2/{project_id}/apigw/instan", + "desc":"This API is used to query the APIs to which a specified app has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/bind", "product_code":"apig", - "title":"Canceling Authorization", - "uri":"CancelingAuthorizationV2_1.html", + "title":"Querying APIs Bound with an App", + "uri":"ListApisBindedToAppV2.html", "doc_type":"api", - "p_code":"71", + "p_code":"70", "code":"73" }, { - "desc":"This API is used to query the APIs to which a specified app has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apisStatus code: 200Status ", + "desc":"This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.For details, see Calling APIs.GET /v2/{project_id}/apigw/i", "product_code":"apig", - "title":"Querying APIs Bound with an App", - "uri":"ListApisBindedToAppV2_1.html", + "title":"Querying APIs Not Bound with an App", + "uri":"ListApisUnbindedToAppV2.html", "doc_type":"api", - "p_code":"71", + "p_code":"70", "code":"74" }, { - "desc":"This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.GET /v2/{project_id}/apigw/instances/{instance_id}/app-aut", - "product_code":"apig", - "title":"Querying APIs Not Bound with an App", - "uri":"ListApisUnbindedToAppV2_1.html", - "doc_type":"api", - "p_code":"71", - "code":"75" - }, - { - "desc":"This API is used to query the apps that have been bound to a specified API.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-appsStatus code: 200Status ", + "desc":"This API is used to query the apps that have been bound to a specified API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/bind", "product_code":"apig", "title":"Querying Apps Bound to an API", - "uri":"ListAppsBindedToApiV2_1.html", + "uri":"ListAppsBindedToApiV2.html", "doc_type":"api", - "p_code":"71", - "code":"76" + "p_code":"70", + "code":"75" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Resource Query", - "uri":"ResourceQuery_1.html", + "uri":"ResourceQuery.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", + "code":"76" + }, + { + "desc":"This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.F", + "product_code":"apig", + "title":"Querying API Quantities", + "uri":"ListApiQuantitiesV2.html", + "doc_type":"api", + "p_code":"76", "code":"77" }, { - "desc":"This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.G", + "desc":"This API is used to query the number of API groups.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groupsStatus code: 2", "product_code":"apig", - "title":"Querying API Quantities", - "uri":"ListApiQuantitiesV2_1.html", + "title":"Querying API Group Quantities", + "uri":"ListApiGroupsQuantitiesV2.html", "doc_type":"api", - "p_code":"77", + "p_code":"76", "code":"78" }, { - "desc":"This API is used to query the number of API groups that have been listed on KooGallery and the number of API groups that have not been listed.GET /v2/{project_id}/apigw/i", - "product_code":"apig", - "title":"Querying API Group Quantities", - "uri":"ListApiGroupsQuantitiesV2_1.html", - "doc_type":"api", - "p_code":"77", - "code":"79" - }, - { - "desc":"This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.GET /v2/{pro", + "desc":"This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.For details,", "product_code":"apig", "title":"Querying App Quantities", - "uri":"ListAppQuantitiesV2_1.html", + "uri":"ListAppQuantitiesV2.html", "doc_type":"api", - "p_code":"77", - "code":"80" + "p_code":"76", + "code":"79" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Domain Name Management", - "uri":"DomainnameManagement_1.html", + "uri":"DomainnameManagement.html", "doc_type":"api", - "p_code":"11", - "code":"81" + "p_code":"7", + "code":"80" }, { "desc":"A user-defined domain name takes effect only after an A record set has been added. For details, see section \"Adding an A Record Set\" in the Domain Name Service User Guide", "product_code":"apig", "title":"Binding a Domain Name", - "uri":"AssociateDomainV2_1.html", + "uri":"AssociateDomainV2.html", "doc_type":"api", - "p_code":"81", - "code":"82" + "p_code":"80", + "code":"81" }, { "desc":"When you create an API to be accessed through HTTPS, you must add an SSL certificate to the independent domain name that has been bound to the group the API belongs to.Th", "product_code":"apig", "title":"Adding a Certificate to a Domain Name", - "uri":"AssociateCertificateV2_1.html", + "uri":"AssociateCertificateV2.html", "doc_type":"api", - "p_code":"81", + "p_code":"80", + "code":"82" + }, + { + "desc":"This API is used to modify the configuration of a domain name bound to an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-g", + "product_code":"apig", + "title":"Modifying a Domain Name", + "uri":"UpdateDomainV2.html", + "doc_type":"api", + "p_code":"80", "code":"83" }, { - "desc":"This API is used to modify the configuration of a domain name bound to an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{doma", + "desc":"This API is used to unbind a custom domain name from an API group.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id", "product_code":"apig", - "title":"Modifying a Domain Name", - "uri":"UpdateDomainV2_1.html", + "title":"Unbinding a Domain Name", + "uri":"DisassociateDomainV2.html", "doc_type":"api", - "p_code":"81", + "p_code":"80", "code":"84" }, { - "desc":"This API is used to unbind a custom domain name from an API group.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}Status co", + "desc":"This API is used to disable or enable the debugging domain name bound to an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api", "product_code":"apig", - "title":"Unbinding a Domain Name", - "uri":"DisassociateDomainV2_1.html", + "title":"Setting Accessibility of a Debugging Domain Name", + "uri":"UpdateSlDomainSettingV2.html", "doc_type":"api", - "p_code":"81", + "p_code":"80", "code":"85" }, { - "desc":"This API is used to delete a certificate that is no longer needed or has expired.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{doma", + "desc":"This API is used to delete a certificate that is no longer needed or has expired.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-g", "product_code":"apig", "title":"Deleting the Certificate Bound to a Domain Name", - "uri":"DisassociateCertificateV2_1.html", + "uri":"DisassociateCertificateV2.html", "doc_type":"api", - "p_code":"81", + "p_code":"80", "code":"86" }, { - "desc":"This API is used to query the details of the certificate bound to a domain name.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_i", + "desc":"This API is used to query the details of the certificate bound to a domain name.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-group", "product_code":"apig", "title":"Querying Details of the Certificate Bound to a Domain Name", - "uri":"ShowDetailsOfDomainNameCertificateV2_1.html", + "uri":"ShowDetailsOfDomainNameCertificateV2.html", "doc_type":"api", - "p_code":"81", + "p_code":"80", "code":"87" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Access Control Policy Management", - "uri":"AclPolicyManagement_1.html", + "uri":"AclPolicyManagement.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"88" }, { "desc":"This API is used to create an access control policy to allow or deny API access from certain IP addresses or tenants. The acl_value value of a domain is a tenant name rat", "product_code":"apig", "title":"Creating an Access Control Policy", - "uri":"CreateAclStrategyV2_1.html", + "uri":"CreateAclStrategyV2.html", "doc_type":"api", "p_code":"88", "code":"89" }, { - "desc":"This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.PUT /v2/{project_id}/apigw/instances/{instance_id}/", + "desc":"This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.For details, see Calling APIs.PUT /v2/{project_id}/", "product_code":"apig", "title":"Modifying an Access Control Policy", - "uri":"UpdateAclStrategyV2_1.html", + "uri":"UpdateAclStrategyV2.html", "doc_type":"api", "p_code":"88", "code":"90" }, { - "desc":"This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{a", + "desc":"This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/i", "product_code":"apig", "title":"Deleting an Access Control Policy", - "uri":"DeleteAclV2_1.html", + "uri":"DeleteAclV2.html", "doc_type":"api", "p_code":"88", "code":"91" }, { - "desc":"This API is used to delete multiple access control policies.Access control policies bound to APIs cannot be deleted.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl", + "desc":"This API is used to delete multiple access control policies.Access control policies bound to APIs cannot be deleted.For details, see Calling APIs.PUT /v2/{project_id}/api", "product_code":"apig", "title":"Deleting Multiple Access Control Policies", - "uri":"BatchDeleteAclV2_1.html", + "uri":"BatchDeleteAclV2.html", "doc_type":"api", "p_code":"88", "code":"92" }, { - "desc":"This API is used to query the details of an access control policy.GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}Status code: 200Status code: 400Status c", + "desc":"This API is used to query the details of an access control policy.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}Status cod", "product_code":"apig", "title":"Querying Details of an Access Control Policy", - "uri":"ShowDetailsOfAclPolicyV2_1.html", + "uri":"ShowDetailsOfAclPolicyV2.html", "doc_type":"api", "p_code":"88", "code":"93" }, { - "desc":"This API is used to query all the access control policies.GET /v2/{project_id}/apigw/instances/{instance_id}/aclsStatus code: 200Status code: 400Status code: 401Status co", + "desc":"This API is used to query all the access control policies.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/aclsStatus code: 200Status code", "product_code":"apig", "title":"Querying Access Control Policies", - "uri":"ListAclStrategiesV2_1.html", + "uri":"ListAclStrategiesV2.html", "doc_type":"api", "p_code":"88", "code":"94" @@ -849,61 +849,61 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Binding/Unbinding Access Control Policies", - "uri":"AclPolicyBinding_1.html", + "uri":"AclPolicyBinding.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"95" }, { "desc":"This API is used to bind an access control policy to a specified API.You can bind different access control policies to an API in different environments, but you can bind ", "product_code":"apig", "title":"Binding an Access Control Policy to an API", - "uri":"CreateApiAclBindingV2_1.html", + "uri":"CreateApiAclBindingV2.html", "doc_type":"api", "p_code":"95", "code":"96" }, { - "desc":"This API is used to unbind an access control policy from an API.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}Status code: 400Status", + "desc":"This API is used to unbind an access control policy from an API.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bind", "product_code":"apig", "title":"Unbinding an Access Control Policy", - "uri":"DeleteApiAclBindingV2_1.html", + "uri":"DeleteApiAclBindingV2.html", "doc_type":"api", "p_code":"95", "code":"97" }, { - "desc":"This API is used to unbind multiple access control policies from APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindingsStatus code: 200Status code: 400Statu", + "desc":"This API is used to unbind multiple access control policies from APIs.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindingsStatus ", "product_code":"apig", "title":"Unbinding Access Control Policies", - "uri":"BatchDeleteApiAclBindingV2_1.html", + "uri":"BatchDeleteApiAclBindingV2.html", "doc_type":"api", "p_code":"95", "code":"98" }, { - "desc":"This API is used to query the APIs to which an access control policy has been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apisStatus code", + "desc":"This API is used to query the APIs to which an access control policy has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-b", "product_code":"apig", "title":"Querying APIs Bound with an Access Control Policy", - "uri":"ListApisBindedToAclPolicyV2_1.html", + "uri":"ListApisBindedToAclPolicyV2.html", "doc_type":"api", "p_code":"95", "code":"99" }, { - "desc":"This API is used to query the published APIs to which an access control policy has not been bound.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded", + "desc":"This API is used to query the published APIs to which an access control policy has not been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{inst", "product_code":"apig", "title":"Querying APIs Not Bound with an Access Control Policy", - "uri":"ListApisUnbindedToAclPolicyV2_1.html", + "uri":"ListApisUnbindedToAclPolicyV2.html", "doc_type":"api", "p_code":"95", "code":"100" }, { - "desc":"This API is used to query the access control policies that have been bound to a specified API.GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-aclsS", + "desc":"This API is used to query the access control policies that have been bound to a specified API.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance", "product_code":"apig", "title":"Querying Access Control Policies Bound to an API", - "uri":"ListAclPolicyBindedToApiV2_1.html", + "uri":"ListAclPolicyBindedToApiV2.html", "doc_type":"api", "p_code":"95", "code":"101" @@ -912,52 +912,52 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Custom Authorizer Management", - "uri":"CustomAuthorizerManagement_1.html", + "uri":"CustomAuthorizerManagement.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"102" }, { - "desc":"This API is used to create a custom authorizer.POST /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 201Status code: 400Status code: 401Status code:", + "desc":"This API is used to create a custom authorizer.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 201Status code: 4", "product_code":"apig", "title":"Creating a Custom Authorizer", - "uri":"CreateCustomAuthorizerV2_1.html", + "uri":"CreateCustomAuthorizerV2.html", "doc_type":"api", "p_code":"102", "code":"103" }, { - "desc":"This API is used to modify a custom authorizer.PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 200Status code: 401Status code: ", + "desc":"This API is used to modify a custom authorizer.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 20", "product_code":"apig", "title":"Modifying a Custom Authorizer", - "uri":"UpdateCustomAuthorizerV2_1.html", + "uri":"UpdateCustomAuthorizerV2.html", "doc_type":"api", "p_code":"102", "code":"104" }, { - "desc":"This API is used to delete a custom authorizer.DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 400Status code: 401Status cod", + "desc":"This API is used to delete a custom authorizer.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code:", "product_code":"apig", "title":"Deleting a Custom Authorizer", - "uri":"DeleteCustomAuthorizerV2_1.html", + "uri":"DeleteCustomAuthorizerV2.html", "doc_type":"api", "p_code":"102", "code":"105" }, { - "desc":"This API is used to query the details of a custom authorizer.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}Status code: 200Status code: 40", + "desc":"This API is used to query the details of a custom authorizer.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}S", "product_code":"apig", "title":"Querying Custom Authorizer Details", - "uri":"ShowDetailsOfCustomAuthorizersV2_1.html", + "uri":"ShowDetailsOfCustomAuthorizersV2.html", "doc_type":"api", "p_code":"102", "code":"106" }, { - "desc":"This API is used to query all the custom authorizers under a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus code: 200Status code: 400Status ", + "desc":"This API is used to query all the custom authorizers under a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/authorizersStatus co", "product_code":"apig", "title":"Querying Custom Authorizers", - "uri":"ListCustomAuthorizersV2_1.html", + "uri":"ListCustomAuthorizersV2.html", "doc_type":"api", "p_code":"102", "code":"107" @@ -966,25 +966,25 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"API Import and Export", - "uri":"ApiImportExport_1.html", + "uri":"ApiImportExport.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"108" }, { "desc":"This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended field", "product_code":"apig", "title":"Exporting APIs", - "uri":"ExportApiDefinitionsV2_1.html", + "uri":"ExportApiDefinitionsV2.html", "doc_type":"api", "p_code":"108", "code":"109" }, { - "desc":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields, see section \"Import", + "desc":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section", "product_code":"apig", "title":"Importing APIs", - "uri":"ImportApiDefinitionsV2_1.html", + "uri":"ImportApiDefinitionsV2.html", "doc_type":"api", "p_code":"108", "code":"110" @@ -993,16 +993,16 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"VPC Channel Management", - "uri":"VpcChannelManagement_1.html", + "uri":"VpcChannelManagement.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"111" }, { "desc":"This API is used to create a VPC channel from APIG to your private VPC resources. Afterwards, when creating an API, you can configure your backend service to use this VPC", "product_code":"apig", "title":"Creating a VPC Channel", - "uri":"CreateVpcChannelV2_1.html", + "uri":"CreateVpcChannelV2.html", "doc_type":"api", "p_code":"111", "code":"112" @@ -1011,34 +1011,34 @@ "desc":"This API is used to update the parameters of a VPC channel.If the VPC channel is overwritten with an empty backend instance list, all the existing backend instances will ", "product_code":"apig", "title":"Updating a VPC Channel", - "uri":"UpdateVpcChannelV2_1.html", + "uri":"UpdateVpcChannelV2.html", "doc_type":"api", "p_code":"111", "code":"113" }, { - "desc":"This API is used to delete a VPC channel.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 400Status code: 401Status code: 4", + "desc":"This API is used to delete a VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 400", "product_code":"apig", "title":"Deleting a VPC Channel", - "uri":"DeleteVpcChannelV2_1.html", + "uri":"DeleteVpcChannelV2.html", "doc_type":"api", "p_code":"111", "code":"114" }, { - "desc":"This API is used to query the details of a VPC channel.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Status code: 200Status code: 400Sta", + "desc":"This API is used to query the details of a VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}Statu", "product_code":"apig", "title":"Querying VPC Channel Details", - "uri":"ShowDetailsOfVpcChannelV2_1.html", + "uri":"ShowDetailsOfVpcChannelV2.html", "doc_type":"api", "p_code":"111", "code":"115" }, { - "desc":"This API is used to query the VPC channels under a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channelsStatus code: 200Status code: 400Status code: 401", + "desc":"This API is used to query the VPC channels under a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channelsStatus code: 200St", "product_code":"apig", "title":"Querying VPC Channels", - "uri":"ListVpcChannelsV2_1.html", + "uri":"ListVpcChannelsV2.html", "doc_type":"api", "p_code":"111", "code":"116" @@ -1047,16 +1047,16 @@ "desc":"This API is used to add backend instances to a VPC channel.If a backend instance with the specified address already exists, the instance information is updated. If the re", "product_code":"apig", "title":"Adding or Updating Backend Instances", - "uri":"AddingBackendInstancesV2_1.html", + "uri":"AddingBackendInstancesV2.html", "doc_type":"api", "p_code":"111", "code":"117" }, { - "desc":"This API is used to query the backend instances of a specified VPC channel.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/membersStatus ", + "desc":"This API is used to query the backend instances of a specified VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{", "product_code":"apig", "title":"Querying Backend Servers of a VPC Channel", - "uri":"ListBackendInstancesV2_1.html", + "uri":"ListBackendInstancesV2.html", "doc_type":"api", "p_code":"111", "code":"118" @@ -1065,415 +1065,1063 @@ "desc":"This API is used to update the backend instances of a specified VPC channel. During the update, the request parameters overwrite the backend instances of the correspondin", "product_code":"apig", "title":"Updating Backend Instances", - "uri":"UpdateBackendInstancesV2_1.html", + "uri":"UpdateBackendInstancesV2.html", "doc_type":"api", "p_code":"111", "code":"119" }, { - "desc":"This API is used to delete a backend instance from a specified VPC channel.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/{me", + "desc":"This API is used to delete a backend instance from a specified VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channel", "product_code":"apig", "title":"Removing a Backend Server", - "uri":"DeleteBackendInstanceV2_1.html", + "uri":"DeleteBackendInstanceV2.html", "doc_type":"api", "p_code":"111", "code":"120" }, + { + "desc":"This API is used to enable backend servers of a VPC channel.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id", + "product_code":"apig", + "title":"Enabling Backend Servers", + "uri":"BatchEnableMembers.html", + "doc_type":"api", + "p_code":"111", + "code":"121" + }, + { + "desc":"This API is used to disable backend servers of a VPC channel.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_i", + "product_code":"apig", + "title":"Disabling Backend Servers", + "uri":"BatchDisableMembers.html", + "doc_type":"api", + "p_code":"111", + "code":"122" + }, + { + "desc":"This API is used to modify the health check configuration of a VPC channel.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{", + "product_code":"apig", + "title":"Modifying VPC Channel Health Check", + "uri":"UpdateHealthCheck.html", + "doc_type":"api", + "p_code":"111", + "code":"123" + }, + { + "desc":"When creating a backend server group for a VPC channel, you can determine whether to associate backend instances with the group to facilitate backend server node manageme", + "product_code":"apig", + "title":"Adding or Updating a Backend Server Group of a VPC Channel", + "uri":"CreateMemberGroup.html", + "doc_type":"api", + "p_code":"111", + "code":"124" + }, + { + "desc":"This API is used to query backend server groups of a VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channe", + "product_code":"apig", + "title":"Querying Backend Server Groups of a VPC Channel", + "uri":"ListMemberGroups.html", + "doc_type":"api", + "p_code":"111", + "code":"125" + }, + { + "desc":"This API is used to query a backend server group of a specified VPC channel.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/", + "product_code":"apig", + "title":"Querying a Backend Server Group of a VPC Channel", + "uri":"ShowDetailsOfMemberGroup.html", + "doc_type":"api", + "p_code":"111", + "code":"126" + }, + { + "desc":"This API is used to delete a backend server group of a specified VPC channel.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-chann", + "product_code":"apig", + "title":"Deleting a Backend Server Group of a VPC Channel", + "uri":"DeleteMemberGroup.html", + "doc_type":"api", + "p_code":"111", + "code":"127" + }, + { + "desc":"This API is used to update a backend server group of a VPC channel.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_chan", + "product_code":"apig", + "title":"Updating a Backend Server Group of a VPC Channel", + "uri":"UpdateMemberGroup.html", + "doc_type":"api", + "p_code":"111", + "code":"128" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Monitoring Information Query", - "uri":"MonitoringInfoQuerying_1.html", + "uri":"MonitoringInfoQuerying.html", "doc_type":"api", - "p_code":"11", - "code":"121" + "p_code":"7", + "code":"129" }, { "desc":"This API is used to query the number of times APIs in an API group are called within a period. The query is based on 1 minute. If the time range is within one hour, the s", "product_code":"apig", "title":"Querying API Calls Within a Period", - "uri":"ListLatelyApiStatisticsV2_1.html", + "uri":"ListLatelyApiStatisticsV2.html", "doc_type":"api", - "p_code":"121", - "code":"122" + "p_code":"129", + "code":"130" + }, + { + "desc":"This API is used to query the monitoring metric data at a specified granularity in a specified period of time.For details, see Calling APIs.GET /v2/{project_id}/apigw/ins", + "product_code":"apig", + "title":"Querying Monitoring Data", + "uri":"ListMetricData.html", + "doc_type":"api", + "p_code":"129", + "code":"131" }, { "desc":"This API is used to query the total number of times all APIs in an API group are called based on the API group ID. The query is based on 1 minute. If the time range is wi", "product_code":"apig", "title":"Querying API Calls Under an API Group in the Last One Hour", - "uri":"ListLatelyGroupStatisticsV2_1.html", + "uri":"ListLatelyGroupStatisticsV2.html", "doc_type":"api", - "p_code":"121", - "code":"123" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"apig", - "title":"Group Response Management", - "uri":"GroupResponseManagement_1.html", - "doc_type":"api", - "p_code":"11", - "code":"124" - }, - { - "desc":"This API is used to create a response for an API group.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responsesStatus code: 201Status c", - "product_code":"apig", - "title":"Creating a Group Response", - "uri":"CreateGatewayResponseV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"125" - }, - { - "desc":"This API is used to query the details of a response defined for an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{r", - "product_code":"apig", - "title":"Querying Group Response Details", - "uri":"ShowDetailsOfGatewayResponseV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"126" - }, - { - "desc":"This API is used to modify a response of an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}Status code:", - "product_code":"apig", - "title":"Modifying a Group Response", - "uri":"UpdateGatewayResponseV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"127" - }, - { - "desc":"This API is used to delete a group response of an API group.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}Sta", - "product_code":"apig", - "title":"Deleting a Group Response", - "uri":"DeleteGatewayResponseV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"128" - }, - { - "desc":"This API is used to query the response of an error type defined for an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-response", - "product_code":"apig", - "title":"Querying the Response of an Error Type", - "uri":"ShowDetailsOfGatewayResponseTypeV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"129" - }, - { - "desc":"This API is used to modify the response of an error type defined for an API group.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-respons", - "product_code":"apig", - "title":"Modifying the Response of an Error Type", - "uri":"UpdateGatewayResponseTypeV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"130" - }, - { - "desc":"This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.DELETE /v", - "product_code":"apig", - "title":"Deleting the Response of an Error Type", - "uri":"DeleteGatewayResponseTypeV2_1.html", - "doc_type":"api", - "p_code":"124", - "code":"131" - }, - { - "desc":"This API is used to query the responses of an API group.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responsesStatus code: 200Status c", - "product_code":"apig", - "title":"Querying Group Responses", - "uri":"ListGatewayResponsesV2_1.html", - "doc_type":"api", - "p_code":"124", + "p_code":"129", "code":"132" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", - "title":"Tag Management", - "uri":"ApigTagManagement_1.html", + "title":"Group Response Management", + "uri":"GroupResponseManagement.html", "doc_type":"api", - "p_code":"11", + "p_code":"7", "code":"133" }, { - "desc":"This API is used to query tags of a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/tagsStatus code: 200Status code: 400Status code: 401Status code: 403Status ", + "desc":"This API is used to create a response for an API group.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-res", "product_code":"apig", - "title":"Querying Tags", - "uri":"ListTagsV2_1.html", + "title":"Creating a Group Response", + "uri":"CreateGatewayResponseV2.html", "doc_type":"api", "p_code":"133", "code":"134" }, + { + "desc":"This API is used to query the details of a response defined for an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{", + "product_code":"apig", + "title":"Querying Group Response Details", + "uri":"ShowDetailsOfGatewayResponseV2.html", + "doc_type":"api", + "p_code":"133", + "code":"135" + }, + { + "desc":"This API is used to modify a response of an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-respo", + "product_code":"apig", + "title":"Modifying a Group Response", + "uri":"UpdateGatewayResponseV2.html", + "doc_type":"api", + "p_code":"133", + "code":"136" + }, + { + "desc":"This API is used to delete a group response of an API group.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gate", + "product_code":"apig", + "title":"Deleting a Group Response", + "uri":"DeleteGatewayResponseV2.html", + "doc_type":"api", + "p_code":"133", + "code":"137" + }, + { + "desc":"This API is used to query the response of an error type defined for an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-grou", + "product_code":"apig", + "title":"Querying the Response of an Error Type", + "uri":"ShowDetailsOfGatewayResponseTypeV2.html", + "doc_type":"api", + "p_code":"133", + "code":"138" + }, + { + "desc":"This API is used to modify the response of an error type defined for an API group.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/api-gro", + "product_code":"apig", + "title":"Modifying the Response of an Error Type", + "uri":"UpdateGatewayResponseTypeV2.html", + "doc_type":"api", + "p_code":"133", + "code":"139" + }, + { + "desc":"This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.For detai", + "product_code":"apig", + "title":"Deleting the Response of an Error Type", + "uri":"DeleteGatewayResponseTypeV2.html", + "doc_type":"api", + "p_code":"133", + "code":"140" + }, + { + "desc":"This API is used to query the responses of an API group.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-res", + "product_code":"apig", + "title":"Querying Group Responses", + "uri":"ListGatewayResponsesV2.html", + "doc_type":"api", + "p_code":"133", + "code":"141" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Tag Management", + "uri":"ApigTagManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"142" + }, + { + "desc":"This API is used to query tags of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/tagsStatus code: 200Status code: 400Status co", + "product_code":"apig", + "title":"Querying Tags", + "uri":"ListTagsV2.html", + "doc_type":"api", + "p_code":"142", + "code":"143" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Gateway Feature Management", - "uri":"InstanceFeatureManagement_1.html", + "uri":"InstanceFeatureManagement.html", "doc_type":"api", - "p_code":"11", - "code":"135" + "p_code":"7", + "code":"144" }, { "desc":"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 d", "product_code":"apig", "title":"Configuring a Feature for a Gateway", - "uri":"CreateFeatureV2_1.html", + "uri":"CreateFeatureV2.html", "doc_type":"api", - "p_code":"135", - "code":"136" + "p_code":"144", + "code":"145" }, { "desc":"This API is used to query the features of a gateway. If a gateway does not support the features listed in the following table, contact technical support to upgrade the ga", "product_code":"apig", "title":"Querying Gateway Features", - "uri":"ListFeaturesV2_1.html", + "uri":"ListFeaturesV2.html", "doc_type":"api", - "p_code":"135", - "code":"137" + "p_code":"144", + "code":"146" + }, + { + "desc":"This API is used to query the supported features of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/instance-featuresStatus cod", + "product_code":"apig", + "title":"Querying the Supported Features of a Gateway", + "uri":"ListInstanceFeatures.html", + "doc_type":"api", + "p_code":"144", + "code":"147" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Configuration Management", - "uri":"ConfigManagement_1.html", + "uri":"ConfigManagement.html", "doc_type":"api", - "p_code":"11", - "code":"138" + "p_code":"7", + "code":"148" }, { - "desc":"This API is used to query the resource configurations and usage of a gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/project/configsStatus code: 200Status code", + "desc":"This API is used to query the resource configurations and usage of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/project/conf", "product_code":"apig", "title":"Querying Resource Configurations of a Gateway", - "uri":"ListProjectCofigsV2_1.html", + "uri":"ListProjectCofigsV2.html", "doc_type":"api", - "p_code":"138", - "code":"139" + "p_code":"148", + "code":"149" }, { - "desc":"This API is used to query the gateway configurations.GET /v2/{project_id}/apigw/instance/configsStatus code: 200Status code: 400Status code: 401Status code: 403Status cod", + "desc":"This API is used to query the gateway configurations.For details, see Calling APIs.GET /v2/{project_id}/apigw/instance/configsStatus code: 200Status code: 400Status code:", "product_code":"apig", "title":"Querying Gateway Configurations", - "uri":"ListInstanceConfigsV2_1.html", + "uri":"ListInstanceConfigsV2.html", "doc_type":"api", - "p_code":"138", - "code":"140" + "p_code":"148", + "code":"150" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Gateway Management", - "uri":"ApicInstanceManagement_1.html", + "uri":"ApicInstanceManagement.html", "doc_type":"api", - "p_code":"11", - "code":"141" + "p_code":"7", + "code":"151" }, { - "desc":"This API is used to create a pay-per-use dedicated gateway.POST /v2/{project_id}/apigw/instancesStatus code: 202Status code: 400Status code: 401Status code: 403Status cod", + "desc":"This API is used to create a pay-per-use dedicated gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instancesStatus code: 202Status code: 400Status code:", "product_code":"apig", "title":"Creating a Dedicated Gateway (Pay-Per-Use)", - "uri":"CreateInstanceV2_1.html", + "uri":"CreateInstanceV2.html", "doc_type":"api", - "p_code":"141", - "code":"142" + "p_code":"151", + "code":"152" }, { - "desc":"This API is used to query the details of a dedicated gateway.GET /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 401Status code: 403Status code", + "desc":"This API is used to query the details of a dedicated gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: ", "product_code":"apig", "title":"Querying Dedicated Gateway Details", - "uri":"ShowDetailsOfInstanceV2_1.html", + "uri":"ShowDetailsOfInstanceV2.html", "doc_type":"api", - "p_code":"141", - "code":"143" + "p_code":"151", + "code":"153" }, { - "desc":"This API is used to update a dedicated gateway.PUT /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 400Status code: 401Status code: 403Status co", + "desc":"This API is used to update a dedicated gateway.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}Status code: 200Status code: 400Status code", "product_code":"apig", "title":"Updating a Dedicated Gateway", - "uri":"UpdateInstanceV2_1.html", + "uri":"UpdateInstanceV2.html", "doc_type":"api", - "p_code":"141", - "code":"144" + "p_code":"151", + "code":"154" }, { - "desc":"This API is used to query the creation progress of a dedicated gateway.GET /v2/{project_id}/apigw/instances/{instance_id}/progressStatus code: 200Status code: 401Status c", + "desc":"This API is used to query the creation progress of a dedicated gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/progressStatus cod", "product_code":"apig", "title":"Querying the Creation Progress of a Dedicated Gateway", - "uri":"ShowDetailsOfInstanceProgressV2_1.html", + "uri":"ShowDetailsOfInstanceProgressV2.html", "doc_type":"api", - "p_code":"141", - "code":"145" + "p_code":"151", + "code":"155" }, { - "desc":"This API is used to enable public access for a dedicated gateway.POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400Status code: 401Status code: 4", + "desc":"This API is used to bind an EIP to a dedicated gateway or update the EIP bound to a dedicated gateway(only available for LVS gateways).For details, see Calling APIs.PUT /", + "product_code":"apig", + "title":"Updating or Binding an EIP to a Dedicated Gateway", + "uri":"AddEipV2.html", + "doc_type":"api", + "p_code":"151", + "code":"156" + }, + { + "desc":"This API is used to unbind the EIP of a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/eipStatus code: 401Status co", + "product_code":"apig", + "title":"Unbinding the EIP of a Dedicated Gateway", + "uri":"RemoveEipV2.html", + "doc_type":"api", + "p_code":"151", + "code":"157" + }, + { + "desc":"This API is used to enable public access for a dedicated gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400", "product_code":"apig", "title":"Enabling Public Access for a Dedicated Gateway", - "uri":"AddEngressEipV2_1.html", + "uri":"AddEngressEipV2.html", "doc_type":"api", - "p_code":"141", - "code":"146" + "p_code":"151", + "code":"158" }, { - "desc":"This API is used to update the outbound access bandwidth of a dedicated gateway.PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 400Status code: 401", + "desc":"This API is used to update the outbound access bandwidth of a dedicated gateway.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eipSt", "product_code":"apig", "title":"Updating the Outbound Access Bandwidth of a Dedicated Gateway", - "uri":"UpdateEngressEipV2_1.html", + "uri":"UpdateEngressEipV2.html", "doc_type":"api", - "p_code":"141", - "code":"147" + "p_code":"151", + "code":"159" }, { - "desc":"This API is used to disable public access for a dedicated gateway.DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: 401Status code: 403Status code", + "desc":"This API is used to disable public access for a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eipStatus code: ", "product_code":"apig", "title":"Disabling Public Access for a Dedicated Gateway", - "uri":"RemoveEngressEipV2_1.html", + "uri":"RemoveEngressEipV2.html", "doc_type":"api", - "p_code":"141", - "code":"148" + "p_code":"151", + "code":"160" }, { - "desc":"This API is used to query AZs where you can buy gateways.GET /v2/{project_id}/apigw/available-zonesStatus code: 200Status code: 401Status code: 403Status code: 500NoneSta", + "desc":"This API is used to enable public inbound access for a gateway that uses ELB for load balancing.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{insta", + "product_code":"apig", + "title":"Enabling Public Inbound Access", + "uri":"AddIngressEipV2.html", + "doc_type":"api", + "p_code":"151", + "code":"161" + }, + { + "desc":"This API is used to update the public inbound access bandwidth of a gateway that uses ELB for load balancing.For details, see Calling APIs.PUT /v2/{project_id}/apigw/inst", + "product_code":"apig", + "title":"Updating Public Inbound Access Bandwidth of a Gateway", + "uri":"UpdateIngressEipV2.html", + "doc_type":"api", + "p_code":"151", + "code":"162" + }, + { + "desc":"This API is used to disable public inbound access for a gateway that uses ELB for load balancing.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{in", + "product_code":"apig", + "title":"Disabling Public Inbound Access for a Gateway", + "uri":"RemoveIngressEipV2.html", + "doc_type":"api", + "p_code":"151", + "code":"163" + }, + { + "desc":"This API is used to query AZs where you can buy gateways.For details, see Calling APIs.GET /v2/{project_id}/apigw/available-zonesStatus code: 200Status code: 401Status co", "product_code":"apig", "title":"Querying AZs", - "uri":"ListAvailableZonesV2_1.html", + "uri":"ListAvailableZonesV2.html", "doc_type":"api", - "p_code":"141", - "code":"149" + "p_code":"151", + "code":"164" }, { - "desc":"This API is used to query dedicated gateways.GET /v2/{project_id}/apigw/instancesStatus code: 200Status code: 401Status code: 403Status code: 500NoneStatus code: 200OKSta", + "desc":"This API is used to query dedicated gateways.For details, see Calling APIs.GET /v2/{project_id}/apigw/instancesStatus code: 200Status code: 401Status code: 403Status code", "product_code":"apig", "title":"Querying Dedicated Gateways", - "uri":"ListInstancesV2_1.html", + "uri":"ListInstancesV2.html", "doc_type":"api", - "p_code":"141", - "code":"150" + "p_code":"151", + "code":"165" }, { - "desc":"This API is used to delete a dedicated gateway.DELETE /v2/{project_id}/apigw/instances/{instance_id}Status code: 401Status code: 403Status code: 404Status code: 500NoneSt", + "desc":"This API is used to delete a dedicated gateway.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}Status code: 401Status code: 403Status c", "product_code":"apig", "title":"Deleting a Dedicated Gateway", - "uri":"DeleteInstancesV2_1.html", + "uri":"DeleteInstancesV2.html", "doc_type":"api", - "p_code":"141", - "code":"151" + "p_code":"151", + "code":"166" + }, + { + "desc":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid", + "product_code":"apig", + "title":"Modifying the Specifications of a Pay-Per-Use Gateway", + "uri":"CreatePostPayResizeOrder.html", + "doc_type":"api", + "p_code":"151", + "code":"167" + }, + { + "desc":"This API is used to query the constraints of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/restrictionStatus code: 200Status ", + "product_code":"apig", + "title":"Querying Gateway Constraints", + "uri":"ShowRestrictionOfInstanceV2.html", + "doc_type":"api", + "p_code":"151", + "code":"168" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"VPC Endpoint Management", + "uri":"VPCEndpointsManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"169" + }, + { + "desc":"This API is used to query the VPC endpoint connections of a gateway.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connecti", + "product_code":"apig", + "title":"Querying VPC Endpoint Connections", + "uri":"ListEndpointConnections.html", + "doc_type":"api", + "p_code":"169", + "code":"170" + }, + { + "desc":"This API is used to accept or reject a VPC endpoint connection for a gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoin", + "product_code":"apig", + "title":"Accepting or Rejecting a VPC Endpoint Connection", + "uri":"AcceptOrRejectEndpointConnections.html", + "doc_type":"api", + "p_code":"169", + "code":"171" + }, + { + "desc":"This API is used to query the whitelist records of a gateway's VPC endpoint service.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-e", + "product_code":"apig", + "title":"Querying Whitelist Records of a VPC Endpoint Service", + "uri":"ListEndpointPermissions.html", + "doc_type":"api", + "p_code":"169", + "code":"172" + }, + { + "desc":"This API is used to add whitelist records in batches for a gateway's VPC endpoint service.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id", + "product_code":"apig", + "title":"Adding Whitelist Records for a VPC Endpoint Service", + "uri":"AddEndpointPermissions.html", + "doc_type":"api", + "p_code":"169", + "code":"173" + }, + { + "desc":"This API is used to delete whitelist records of a gateway's VPC endpoint service in batches.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_", + "product_code":"apig", + "title":"Deleting Whitelist Records of a VPC Endpoint Service", + "uri":"DeleteEndpointPermissions.html", + "doc_type":"api", + "p_code":"169", + "code":"174" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Gateway Tag Management", + "uri":"GatewayTagManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"175" + }, + { + "desc":"This API is used to query all gateway tags of a project.Only users who have been authorized with a policy containing action apig:instanceTags:list can call this API.For d", + "product_code":"apig", + "title":"Querying All Gateway Tags of a Project", + "uri":"ListProjectInstanceTags.html", + "doc_type":"api", + "p_code":"175", + "code":"176" + }, + { + "desc":"This API is used to query all tags of a gateway.Only users who have been authorized with a policy containing actions apig:instanceTags:list and apig:instances:get can cal", + "product_code":"apig", + "title":"Querying Tags of a Gateway", + "uri":"ListInstanceTags.html", + "doc_type":"api", + "p_code":"175", + "code":"177" + }, + { + "desc":"This API is used to add tags to a gateway or delete the tags of a gateway.Only users who have been authorized with a policy containing actions apig:instances:get, apig:in", + "product_code":"apig", + "title":"Adding or Deleting Tags of a Gateway", + "uri":"BatchCreateOrDeleteInstanceTags.html", + "doc_type":"api", + "p_code":"175", + "code":"178" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Microservice Center Management", + "uri":"MicroserviceCenterManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"179" + }, + { + "desc":"This API is used to import a microservice.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/microservice/importStatus code: 201Status code", + "product_code":"apig", + "title":"Importing a Microservice", + "uri":"ImportMicroservice.html", + "doc_type":"api", + "p_code":"179", + "code":"180" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"SSL Certificate Management", + "uri":"SslCertificateManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"181" + }, + { + "desc":"This API is used to query the SSL certificates.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificatesStatus code: 200Status code: 400Status code: 401Status", + "product_code":"apig", + "title":"Querying SSL Certificates", + "uri":"ListCertificatesV2.html", + "doc_type":"api", + "p_code":"181", + "code":"182" + }, + { + "desc":"This API is used to create an SSL certificate.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificatesStatus code: 200Status code: 400Status code: 401Status", + "product_code":"apig", + "title":"Creating an SSL Certificate", + "uri":"CreateCertificateV2.html", + "doc_type":"api", + "p_code":"181", + "code":"183" + }, + { + "desc":"This API is used to bind a domain name with SSL certificates. Currently, only one certificate ID can be specified in certificate_ids.For details, see Calling APIs.POST /v", + "product_code":"apig", + "title":"Binding a Domain Name with SSL Certificates", + "uri":"BatchAssociateCertsV2.html", + "doc_type":"api", + "p_code":"181", + "code":"184" + }, + { + "desc":"This API is used to unbind a domain name's SSL certificates. Currently, only one certificate ID can be specified in certificate_ids.For details, see Calling APIs.POST /v2", + "product_code":"apig", + "title":"Unbinding a Domain Name's SSL Certificates", + "uri":"BatchDisassociateCertsV2.html", + "doc_type":"api", + "p_code":"181", + "code":"185" + }, + { + "desc":"This API is used to query the details about a certificate.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificates/{certificate_id}Status code: 200Status cod", + "product_code":"apig", + "title":"Querying Certificate Details", + "uri":"ShowDetailsOfCertificateV2.html", + "doc_type":"api", + "p_code":"181", + "code":"186" + }, + { + "desc":"This API is used to delete an SSL certificate. Only certificates that are not bound to any domain name can be deleted.For details, see Calling APIs.DELETE /v2/{project_id", + "product_code":"apig", + "title":"Deleting an SSL Certificate", + "uri":"DeleteCertificateV2.html", + "doc_type":"api", + "p_code":"181", + "code":"187" + }, + { + "desc":"This API is used to modify an SSL certificate.For details, see Calling APIs.PUT /v2/{project_id}/apigw/certificates/{certificate_id}Status code: 200Status code: 400Status", + "product_code":"apig", + "title":"Modifying an SSL Certificate", + "uri":"UpdateCertificateV2.html", + "doc_type":"api", + "p_code":"181", + "code":"188" + }, + { + "desc":"This API is used to bind an SSL certificate to a domain name.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/attachStatus ", + "product_code":"apig", + "title":"Binding an SSL Certificate to a Domain Name", + "uri":"BatchAssociateDomainsV2.html", + "doc_type":"api", + "p_code":"181", + "code":"189" + }, + { + "desc":"This API is used to unbind an SSL certificate from a domain name.For details, see Calling APIs.POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/detachSta", + "product_code":"apig", + "title":"Unbinding an SSL Certificate from a Domain Name", + "uri":"BatchDisassociateDomainsV2.html", + "doc_type":"api", + "p_code":"181", + "code":"190" + }, + { + "desc":"This API is used to query the domain names to which an SSL certificate has been bound.For details, see Calling APIs.GET /v2/{project_id}/apigw/certificates/{certificate_i", + "product_code":"apig", + "title":"Querying Domain Names of an SSL Certificate", + "uri":"ListAttachedDomainsV2.html", + "doc_type":"api", + "p_code":"181", + "code":"191" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Plug-in Management", + "uri":"PluginManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"192" + }, + { + "desc":"Plug-in information.Plug-in names must be unique.Plug-in names must be unique.Plug-ins must be bound to an API and take effect immediately for the API after binding.Plug-", + "product_code":"apig", + "title":"Creating a Plug-in", + "uri":"CreatePlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"193" + }, + { + "desc":"This API is used to modify a plug-in.Plug-in names must be unique.Plug-in names must be unique.The plug-in type and scope cannot be modified.The plug-in type and scope ca", + "product_code":"apig", + "title":"Modifying a Plug-in", + "uri":"UpdatePlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"194" + }, + { + "desc":"This API is used to delete a plug-in.Before deleting a plug-in, unbind it from all APIs.Before deleting a plug-in, unbind it from all APIs.For details, see Calling APIs.D", + "product_code":"apig", + "title":"Deleting a Plug-in", + "uri":"DeletePlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"195" + }, + { + "desc":"This API is used to query details about a group of plug-ins that meet specified conditions.Pagination queryPagination queryQuery by plug-in typeQuery by plug-in typeQuery", + "product_code":"apig", + "title":"Querying Plug-ins", + "uri":"ListPlugins.html", + "doc_type":"api", + "p_code":"192", + "code":"196" + }, + { + "desc":"This API is used to query the details of a plug-in.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}Status code: 200Sta", + "product_code":"apig", + "title":"Querying Plug-in Details", + "uri":"ShowPlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"197" + }, + { + "desc":"This API is used to bind a plug-in to APIs.Plug-ins can be bound only to published APIs.Plug-ins can be bound only to published APIs.Plug-ins take effect immediately afte", + "product_code":"apig", + "title":"Binding a Plug-in to APIs", + "uri":"AttachApiToPlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"198" + }, + { + "desc":"This API is used to bind an API with plug-ins.Plug-ins can be bound only to published APIs.Plug-ins can be bound only to published APIs.Plug-ins take effect immediately a", + "product_code":"apig", + "title":"Binding an API with Plug-ins", + "uri":"AttachPluginToApi.html", + "doc_type":"api", + "p_code":"192", + "code":"199" + }, + { + "desc":"This API is used to unbind a plug-in from all APIs to which it has been bound.The unbinding takes effect immediately.The unbinding takes effect immediately.For details, s", + "product_code":"apig", + "title":"Unbinding a Plug-in from All APIs", + "uri":"DetachApiFromPlugin.html", + "doc_type":"api", + "p_code":"192", + "code":"200" + }, + { + "desc":"This API is used to unbind an API's plug-ins.The unbinding takes effect immediately.The unbinding takes effect immediately.For details, see Calling APIs.PUT /v2/{project_", + "product_code":"apig", + "title":"Unbinding an API's Plug-ins", + "uri":"DetachPluginFromApi.html", + "doc_type":"api", + "p_code":"192", + "code":"201" + }, + { + "desc":"This API is used to query the APIs to which a plug-in has been bound.Query APIs bound with a specified plug-inQuery APIs bound with a specified plug-inPagination queryPag", + "product_code":"apig", + "title":"Querying APIs Bound with a Plug-in", + "uri":"ListPluginAttachedApis.html", + "doc_type":"api", + "p_code":"192", + "code":"202" + }, + { + "desc":"This API is used to query the plug-ins bound to an API.Query plug-ins bound to a specified APIQuery plug-ins bound to a specified APIPagination queryPagination queryFuzzy", + "product_code":"apig", + "title":"Querying Plug-ins Bound to an API", + "uri":"ListApiAttachedPlugins.html", + "doc_type":"api", + "p_code":"192", + "code":"203" + }, + { + "desc":"This API is used to query the APIs to which a plug-in can be bound.Pagination queryPagination queryFuzzy query by API nameFuzzy query by API nameAPIs already bound with o", + "product_code":"apig", + "title":"Querying APIs to Which a Plug-in Can Be Bound", + "uri":"ListPluginAttachableApis.html", + "doc_type":"api", + "p_code":"192", + "code":"204" + }, + { + "desc":"This API is used to query the plug-ins that can be bound to a specified API.Pagination queryFuzzy query by plug-in nameFor details, see Calling APIs.GET /v2/{project_id}/", + "product_code":"apig", + "title":"Querying Plug-ins That Can Be Bound to an API", + "uri":"ListApiAttachablePlugins.html", + "doc_type":"api", + "p_code":"192", + "code":"205" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Credential Management", - "uri":"CredentialManagement_1.html", + "uri":"CredentialManagement.html", "doc_type":"api", - "p_code":"11", - "code":"152" + "p_code":"7", + "code":"206" }, { - "desc":"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.POST /v2/{project_id}/apigw/instanc", + "desc":"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.For details, see Calling APIs.POST ", "product_code":"apig", "title":"Creating an App", - "uri":"CreateAnAppV2_1.html", + "uri":"CreateAnAppV2.html", "doc_type":"api", - "p_code":"152", - "code":"153" + "p_code":"206", + "code":"207" }, { "desc":"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, ", "product_code":"apig", "title":"Modifying an App", - "uri":"UpdateAppV2_1.html", + "uri":"UpdateAppV2.html", "doc_type":"api", - "p_code":"152", - "code":"154" + "p_code":"206", + "code":"208" }, { - "desc":"This API is used to delete an app.Deleted apps cannot call APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 400Status code: 401Status ", + "desc":"This API is used to delete an app.Deleted apps cannot call APIs.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status co", "product_code":"apig", "title":"Deleting an App", - "uri":"DeleteAppV2_1.html", + "uri":"DeleteAppV2.html", "doc_type":"api", - "p_code":"152", - "code":"155" + "p_code":"206", + "code":"209" }, { - "desc":"This API is used to reset the AppSecret of an app.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}Status code: 200Status code: 400Status code: 401S", + "desc":"This API is used to reset the AppSecret of an app.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}Status code: 200Sta", "product_code":"apig", "title":"Resetting the AppSecret of an App", - "uri":"ResettingAppSecretV2_1.html", + "uri":"ResettingAppSecretV2.html", "doc_type":"api", - "p_code":"152", - "code":"156" + "p_code":"206", + "code":"210" }, { - "desc":"This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.GET", + "desc":"This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.For", "product_code":"apig", "title":"Verifying an App", - "uri":"CheckAppV2_1.html", + "uri":"CheckAppV2.html", "doc_type":"api", - "p_code":"152", - "code":"157" + "p_code":"206", + "code":"211" }, { - "desc":"This API is used to query the details of an app.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 200Status code: 400Status code: 401Status cod", + "desc":"This API is used to query the details of an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}Status code: 200Status code:", "product_code":"apig", "title":"Querying App Details", - "uri":"ShowDetailsOfAppV2_1.html", + "uri":"ShowDetailsOfAppV2.html", "doc_type":"api", - "p_code":"152", - "code":"158" + "p_code":"206", + "code":"212" }, { - "desc":"This API is used to query apps.GET /v2/{project_id}/apigw/instances/{instance_id}/appsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500None", + "desc":"This API is used to query apps.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/appsStatus code: 200Status code: 400Status code: 401Status", "product_code":"apig", "title":"Querying Apps", - "uri":"ListAppsV2_1.html", + "uri":"ListAppsV2.html", "doc_type":"api", - "p_code":"152", - "code":"159" + "p_code":"206", + "code":"213" }, { - "desc":"This API is used to create an AppCode for an app for simple authentication.POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Stat", + "desc":"This API is used to create an AppCode for an app for simple authentication.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}", "product_code":"apig", "title":"Creating an AppCode", - "uri":"CreateAppCodeV2_1.html", + "uri":"CreateAppCodeV2.html", "doc_type":"api", - "p_code":"152", - "code":"160" + "p_code":"206", + "code":"214" }, { - "desc":"This API is used to generate a random AppCode.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Status code: 400Status code: 401St", + "desc":"This API is used to generate a random AppCode.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 201Stat", "product_code":"apig", "title":"Generating an AppCode", - "uri":"CreateAppCodeAutoV2_1.html", + "uri":"CreateAppCodeAutoV2.html", "doc_type":"api", - "p_code":"152", - "code":"161" + "p_code":"206", + "code":"215" }, { - "desc":"This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-c", + "desc":"This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{in", "product_code":"apig", "title":"Deleting an AppCode", - "uri":"DeleteAppCodeV2_1.html", + "uri":"DeleteAppCodeV2.html", "doc_type":"api", - "p_code":"152", - "code":"162" + "p_code":"206", + "code":"216" }, { - "desc":"This API is used to query the details of an AppCode created for an app for simple authentication.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-code", + "desc":"This API is used to query the details of an AppCode created for an app for simple authentication.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{insta", "product_code":"apig", "title":"Querying AppCode Details", - "uri":"ShowDetailsOfAppCodeV2_1.html", + "uri":"ShowDetailsOfAppCodeV2.html", "doc_type":"api", - "p_code":"152", - "code":"163" + "p_code":"206", + "code":"217" }, { - "desc":"This API is used to query the AppCodes of an app.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 200Status code: 400Status code: 40", + "desc":"This API is used to query the AppCodes of an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codesStatus code: 200S", "product_code":"apig", "title":"Querying AppCodes of an App", - "uri":"ListAppCodesV2_1.html", + "uri":"ListAppCodesV2.html", "doc_type":"api", - "p_code":"152", - "code":"164" + "p_code":"206", + "code":"218" + }, + { + "desc":"This API is used to query quotas associated with a specified credential.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/bou", + "product_code":"apig", + "title":"Querying Quotas Associated with a Credential", + "uri":"ShowAppBoundAppQuota.html", + "doc_type":"api", + "p_code":"206", + "code":"219" + }, + { + "desc":"This API is used to configure access control settings for a credential.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-", + "product_code":"apig", + "title":"Configuring Access Control Settings for an App", + "uri":"UpdateAppAcl.html", + "doc_type":"api", + "p_code":"206", + "code":"220" + }, + { + "desc":"This API is used to query the access control details about an app.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-aclSt", + "product_code":"apig", + "title":"Querying Access Control Details About an App", + "uri":"ShowDetailsOfAppAcl.html", + "doc_type":"api", + "p_code":"206", + "code":"221" + }, + { + "desc":"This API is used to delete the access control settings of a credential.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/a", + "product_code":"apig", + "title":"Deleting Access Control Settings of an App", + "uri":"DeleteAppAcl.html", + "doc_type":"api", + "p_code":"206", + "code":"222" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Credential Quota Management", + "uri":"CredentialQuotaPoliciesManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"223" + }, + { + "desc":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta", + "product_code":"apig", + "title":"Creating a Credential Quota", + "uri":"CreateAppQuota.html", + "doc_type":"api", + "p_code":"223", + "code":"224" + }, + { + "desc":"This API is used to query credential quota details.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}Status code: ", + "product_code":"apig", + "title":"Querying Credential Quota Details", + "uri":"ShowAppQuota.html", + "doc_type":"api", + "p_code":"223", + "code":"225" + }, + { + "desc":"This API is used to query credential quotas. Fuzzy query by name is supported.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotasS", + "product_code":"apig", + "title":"Querying Credential Quotas", + "uri":"ListAppQuotas.html", + "doc_type":"api", + "p_code":"223", + "code":"226" + }, + { + "desc":"This API is used to modify a credential quota.For details, see Calling APIs.PUT /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}Status code: 200St", + "product_code":"apig", + "title":"Modifying a Credential Quota", + "uri":"UpdateAppQuota.html", + "doc_type":"api", + "p_code":"223", + "code":"227" + }, + { + "desc":"This API is used to delete a credential quota. When a credential quota is deleted, the association between the quota and credential is also deleted.For details, see Calli", + "product_code":"apig", + "title":"Deleting a Credential Quota", + "uri":"DeleteAppQuota.html", + "doc_type":"api", + "p_code":"223", + "code":"228" + }, + { + "desc":"This API is used to query the credentials bound to a credential quota. Fuzzy match by credential name is supported.For details, see Calling APIs.GET /v2/{project_id}/apig", + "product_code":"apig", + "title":"Querying the Credentials Bound to a Specified Quota", + "uri":"ListAppQuotaBoundApps.html", + "doc_type":"api", + "p_code":"223", + "code":"229" + }, + { + "desc":"This API is used to bind a credential quota with credentials.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/b", + "product_code":"apig", + "title":"Binding a Credential Quota with Credentials", + "uri":"AssociateAppsForAppQuota.html", + "doc_type":"api", + "p_code":"223", + "code":"230" + }, + { + "desc":"This API is used to unbind a credential quota from a credential.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_", + "product_code":"apig", + "title":"Unbinding a Credential Quota from a Credential", + "uri":"DisassociateAppQuotaWithApp.html", + "doc_type":"api", + "p_code":"223", + "code":"231" + }, + { + "desc":"This API is used to query the credentials that can be bound to a credential quota. Fuzzy search by credential name is supported.For details, see Calling APIs.GET /v2/{pro", + "product_code":"apig", + "title":"Querying Credentials That Can Be Bound to a Credential Quota", + "uri":"ListAppQuotaBindableApps.html", + "doc_type":"api", + "p_code":"223", + "code":"232" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"apig", + "title":"Asynchronous Task Management", + "uri":"AsynchronousTaskManagement.html", + "doc_type":"api", + "p_code":"7", + "code":"233" + }, + { + "desc":"This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended field", + "product_code":"apig", + "title":"Exporting APIs Asynchronously", + "uri":"ExportApiDefinitionsAsync.html", + "doc_type":"api", + "p_code":"233", + "code":"234" + }, + { + "desc":"This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section", + "product_code":"apig", + "title":"Importing APIs Asynchronously", + "uri":"ImportApiDefinitionsAsync.html", + "doc_type":"api", + "p_code":"233", + "code":"235" + }, + { + "desc":"This API is used to query the result of an asynchronous task.For details, see Calling APIs.GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id}Status ", + "product_code":"apig", + "title":"Querying the Result of an Asynchronous Task", + "uri":"ShowAsyncTaskResult.html", + "doc_type":"api", + "p_code":"233", + "code":"236" }, { "desc":"This chapter describes fine-grained permissions management for your APIG.If your account does not require individual IAM users, skip this section.Only dedicated gateways ", @@ -1482,7 +2130,7 @@ "uri":"api-grant-policy.html", "doc_type":"api", "p_code":"", - "code":"165" + "code":"237" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1491,34 +2139,34 @@ "uri":"apig-api-190529271.html", "doc_type":"api", "p_code":"", - "code":"166" + "code":"238" }, { "desc":"APIG supports pagination query of resource lists, such as an API list.To perform a pagination query, add the following parameters to the URL:page_size: number of records ", "product_code":"apig", "title":"Pagination Query", - "uri":"apig-en-api-180713204.html", + "uri":"apig-api-180713204.html", "doc_type":"api", - "p_code":"166", - "code":"167" + "p_code":"238", + "code":"239" }, { "desc":"APIG filters query results by object attribute when you query a resource list, such as an API list.Example:", "product_code":"apig", "title":"Result Filtering", - "uri":"apig-en-api-180713205.html", + "uri":"apig-api-180713205.html", "doc_type":"api", - "p_code":"166", - "code":"168" + "p_code":"238", + "code":"240" }, { "desc":"Table 1 describes common status codes.", "product_code":"apig", "title":"HTTP Status Codes", - "uri":"apig-en-api-180713206.html", + "uri":"apig-api-180713206.html", "doc_type":"api", - "p_code":"166", - "code":"169" + "p_code":"238", + "code":"241" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1526,17 +2174,17 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"166", - "code":"170" + "p_code":"238", + "code":"242" }, { "desc":"The following table lists the features that are supported by dedicated gateways.If the gateway you use does not have specific features, contact technical support to upgra", "product_code":"apig", "title":"Supported Features", - "uri":"apig-api-20210402.html", + "uri":"apig-api-20200402.html", "doc_type":"api", - "p_code":"166", - "code":"171" + "p_code":"238", + "code":"243" }, { "desc":"You can also obtain a project ID by calling the IAM API used to query project information.The API used to obtain a project ID is \"GET https://{Endpoint}/v3/projects/\". {E", @@ -1544,8 +2192,8 @@ "title":"Obtaining a Project ID", "uri":"apig-api-180713009.html", "doc_type":"api", - "p_code":"166", - "code":"172" + "p_code":"238", + "code":"244" }, { "desc":"An account name and account ID are required for some URLs when an API is called. To obtain an account name and account ID, perform the following operations:Log in to the ", @@ -1553,16 +2201,16 @@ "title":"Obtaining an Account Name and Account ID", "uri":"apig-api-180713005.html", "doc_type":"api", - "p_code":"166", - "code":"173" + "p_code":"238", + "code":"245" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"apig", "title":"Change History", - "uri":"apig-en-api-180713215.html", + "uri":"apig-api-180713215.html", "doc_type":"api", "p_code":"", - "code":"174" + "code":"246" } ] \ No newline at end of file diff --git a/docs/apig/api-ref/CancelingAuthorizationV2_1.html b/docs/apig/api-ref/CancelingAuthorizationV2_1.html deleted file mode 100644 index 3c36d5cc..00000000 --- a/docs/apig/api-ref/CancelingAuthorizationV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Canceling Authorization

-

Function

This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_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_auth_id

-

Yes

-

String

-

Authorization record 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3009",
-  "error_msg" : "The app authorization record does not exist,id:dd29b33ae4394e3b924b582c6b40880b"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: App Authorization Management
-
-
- diff --git a/docs/apig/api-ref/ChangeApiVersionV2_1.html b/docs/apig/api-ref/ChangeApiVersionV2_1.html deleted file mode 100644 index ed0cbc5b..00000000 --- a/docs/apig/api-ref/ChangeApiVersionV2_1.html +++ /dev/null @@ -1,389 +0,0 @@ - - -

Switching the Version of an API

-

Function

This API is used to switch the version of an API. A version is generated based on the current definition of an API when the API is published. The version records the definition and status of the API when it is published.

-

You can switch between multiple versions of an API, but only one version of an API takes effect in the same environment.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_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.

-

api_id

-

Yes

-

String

-

API 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

-

version_id

-

No

-

String

-

API version ID.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

publish_id

-

String

-

Publication record ID.

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

remark

-

String

-

Description about the publication.

-

publish_time

-

String

-

Publication time.

-

version_id

-

String

-

API version currently in use.

-
-
-

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

Switching an API to a specified version

-
{
-  "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
-  "api_id" : "5f918d104dc84480a75166ba99efff21",
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
-  "publish_time" : "2020-08-03T03:27:49.483295655Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2000",
-  "error_msg" : "Parameter error: Serialization error: unexpected end of JSON input"
-}
-

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.3022",
-  "error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/CheckAppV2_1.html b/docs/apig/api-ref/CheckAppV2_1.html deleted file mode 100644 index b64c0543..00000000 --- a/docs/apig/api-ref/CheckAppV2_1.html +++ /dev/null @@ -1,332 +0,0 @@ - - -

Verifying an App

-

Function

This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apps/validation/{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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

Name.

-

remark

-

String

-

Description.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "app_demo",
-  "remark" : "Demo app",
-  "id" : "356de8eb7a8742168586e5daf5339965"
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ConfigManagement_1.html b/docs/apig/api-ref/ConfigManagement_1.html deleted file mode 100644 index 0324638a..00000000 --- a/docs/apig/api-ref/ConfigManagement_1.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

Configuration Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/CreateAclStrategyV2_1.html b/docs/apig/api-ref/CreateAclStrategyV2_1.html deleted file mode 100644 index a83a59ce..00000000 --- a/docs/apig/api-ref/CreateAclStrategyV2_1.html +++ /dev/null @@ -1,430 +0,0 @@ - - -

Creating an Access Control Policy

-

Function

This API is used to create an access control policy to allow or deny API access from certain IP addresses or tenants. The acl_value value of a domain is a tenant name rather than a domain name (such as www.exampleDomain.com).

-
-

URI

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

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

-
-
-
-

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

-

acl_name

-

Yes

-

String

-

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

-

acl_type

-

Yes

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

Enumeration values:

-

  • PERMIT

    -

  • DENY

    -
-

acl_value

-

Yes

-

String

-

One or more objects from which the access will be controlled. Separate multiple objects with commas.

-

  • If entity_type is set to IP, enter up to 100 IP addresses.

    -

  • If entity_type is set to DOMAIN, enter account names. Each account name can contain up to 64 ASCII characters except commas (,). Do not use only digits. The total length cannot exceed 1024 characters.

    -

  • If entity_type is set to DOMAIN_ID, enter account IDs. For details about how to obtain an account ID, see "Appendix" > "Obtaining an Account Name and Account ID" in this document.

    -
-

entity_type

-

Yes

-

String

-

Object type.

-

  • IP: IP address.

    -

  • DOMAIN: Account name.

    -

  • DOMAIN_ID: Account ID.

    -
-

Enumeration values:

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

acl_name

-

String

-

Name.

-

acl_type

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

acl_value

-

String

-

Access control objects.

-

entity_type

-

String

-

Object type.

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-

id

-

String

-

ID.

-

update_time

-

String

-

Update time.

-
-
-

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

Creating an access control policy to allow access from specified IP addresses

-
{
-  "acl_name" : "acl_demo",
-  "acl_type" : "PERMIT",
-  "acl_value" : "192.168.1.5,192.168.10.1",
-  "entity_type" : "IP"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "id" : "7eb619ecf2a24943b099833cd24a01ba",
-  "acl_name" : "acl_demo",
-  "entity_type" : "IP",
-  "acl_type" : "PERMIT",
-  "acl_value" : "192.168.1.5,192.168.10.1",
-  "update_time" : "2020-08-04T08:42:43.461276217Z"
-}
-

Status code: 400

-

Bad Request

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

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/CreateAnAppV2_1.html b/docs/apig/api-ref/CreateAnAppV2_1.html deleted file mode 100644 index 33700ec5..00000000 --- a/docs/apig/api-ref/CreateAnAppV2_1.html +++ /dev/null @@ -1,428 +0,0 @@ - - -

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.

-
-

URI

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

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

-
-
-
-

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: 500

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

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.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/CreateApiAclBindingV2_1.html b/docs/apig/api-ref/CreateApiAclBindingV2_1.html deleted file mode 100644 index 4772ef04..00000000 --- a/docs/apig/api-ref/CreateApiAclBindingV2_1.html +++ /dev/null @@ -1,397 +0,0 @@ - - -

Binding an Access Control Policy to an API

-

Function

This API is used to bind an access control policy to a specified API.

-

You can bind different access control policies to an API in different environments, but you can bind only one access control policy to the API in each environment.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

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

-
-
-
-

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

-

acl_id

-

No

-

String

-

Access control policy ID.

-

publish_ids

-

No

-

Array of strings

-

API publication record ID.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

acl_bindings

-

Array of AclApiBindingInfo objects

-

Access control policy binding records.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 AclApiBindingInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Binding record ID.

-

api_id

-

String

-

API ID.

-

env_id

-

String

-

Environment ID.

-

acl_id

-

String

-

Access control policy ID.

-

create_time

-

String

-

Binding time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Binding an access control policy to an API

-
{
-  "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
-  "publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "acl_bindings" : [ {
-    "id" : "332c5db1458a477b89b2ea741fec94a3",
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
-    "create_time" : "2020-08-04T08:58:03.001228747Z"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:acl_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.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Binding/Unbinding Access Control Policies
-
-
- diff --git a/docs/apig/api-ref/CreateApiGroupV2_1.html b/docs/apig/api-ref/CreateApiGroupV2_1.html deleted file mode 100644 index 7ca1729d..00000000 --- a/docs/apig/api-ref/CreateApiGroupV2_1.html +++ /dev/null @@ -1,539 +0,0 @@ - - -

Creating an API Group

-

Function

This API is used to create an API group. An API group is an API management unit and the entry to a service. A subdomain name is returned as the access entry when an API group is created. APIs in an API group should be correlated with each other.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups

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

-
-
-
-

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

-

API group name.

-

The value can contain 3 to 255 characters, including letters, digits, and special characters (-_./():). It must start with a letter or digit.

-

Minimum: 3

-

Maximum: 255

-

remark

-

No

-

String

-

API group description.

-

Maximum: 1000

-

roma_app_id

-

No

-

String

-

ID of the integration application to which the API group belongs.

-

This parameter is required when the group version is V2.

-

Currently, this parameter is not supported.

-

version

-

No

-

String

-

Group version.

-
  • V1: global group
  • V2: application-level group
-

The default value is V1. This parameter is not supported currently.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-

sl_domains

-

Array of strings

-

Automatically allocated subdomain names.

-

remark

-

String

-

Description.

-

call_limits

-

Integer

-

Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls.

-

Currently, this parameter is not supported.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

is_default

-

Integer

-

Indicates whether the API group is the default group.

-

version

-

String

-

Group version.

-
  • V1: global group
  • V2: application-level group
-

The default value is V1. This parameter is not supported currently.

-

roma_app_id

-

String

-

ID of the integration application to which the API group belongs.

-

This parameter is required when the group version is V2.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the integration application to which the API group belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Creating an API group

-
{
-  "name" : "api_group_001",
-  "remark" : "API group 1"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "update_time" : "2020-07-31T06:55:55.383169299Z",
-  "name" : "api_group_001",
-  "on_sell_status" : 2,
-  "remark" : "API group 1",
-  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
-  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "register_time" : "2020-07-31T06:55:55.383169068Z",
-  "status" : 1,
-  "is_default" : 2
-}
-

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.

-
-
-
-
-
Parent topic: API Group Management
-
-
- diff --git a/docs/apig/api-ref/CreateApiV2_1.html b/docs/apig/api-ref/CreateApiV2_1.html deleted file mode 100644 index 843fd750..00000000 --- a/docs/apig/api-ref/CreateApiV2_1.html +++ /dev/null @@ -1,3424 +0,0 @@ - - -

Creating an API

-

Function

This API is used to create an API. An API is an interface that encapsulates a set of service capabilities.

-

The definition of an API defines how the API is called by users and how APIG accesses the actual backend service requested by users. APIG supports four backend types: HTTP/HTTPS, FunctionGraph, and Mock.

-
-

URI

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

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

-
-
-
-

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

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Yes

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

No

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

Yes

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

Yes

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

Yes

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

No

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

No

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

No

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

Yes

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

No

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

Yes

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

No

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

No

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

result_failure_sample

-

No

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

tags

-

No

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

No

-

String

-

Group response ID.

-

roma_app_id

-

No

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

No

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

No

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

No

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

mock_info

-

No

-

ApiMockCreate object

-

Mock backend details.

-

func_info

-

No

-

ApiFuncCreate object

-

FunctionGraph backend details.

-

req_params

-

No

-

Array of ReqParamBase objects

-

Request parameters.

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

policy_mocks

-

No

-

Array of ApiPolicyMockCreate objects

-

Mock backend policies.

-

policy_functions

-

No

-

Array of ApiPolicyFunctionCreate objects

-

FunctionGraph backend policies.

-

backend_api

-

No

-

BackendApiCreate object

-

Web backend details.

-

policy_https

-

No

-

Array of ApiPolicyHttpCreate objects

-

Web backend policies.

-
-
- -
- - - - - - - - - - - -
Table 4 AuthOpt

Parameter

-

Mandatory

-

Type

-

Description

-

app_code_auth_type

-

No

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiMockCreate

Parameter

-

Mandatory

-

Type

-

Description

-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

No

-

String

-

Response.

-

version

-

No

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

No

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ApiFuncCreate

Parameter

-

Mandatory

-

Type

-

Description

-

function_urn

-

Yes

-

String

-

Function URN.

-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

Yes

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

Yes

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Yes

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

No

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ReqParamBase

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

Yes

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

Yes

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

No

-

String

-

Default value.

-

sample_value

-

No

-

String

-

Example value.

-

required

-

No

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

No

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

No

-

String

-

Enumerated value.

-

min_num

-

No

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

No

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

No

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

No

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

No

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

No

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

No

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ApiPolicyMockCreate

Parameter

-

Mandatory

-

Type

-

Description

-

result_content

-

No

-

String

-

Response.

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ApiPolicyFunctionCreate

Parameter

-

Mandatory

-

Type

-

Description

-

function_urn

-

Yes

-

String

-

Function URN.

-

invocation_type

-

Yes

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

Yes

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

No

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 BackendApiCreate

Parameter

-

Mandatory

-

Type

-

Description

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

url_domain

-

No

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

Yes

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

Yes

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

No

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

timeout

-

Yes

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

No

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

No

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

No

-

ApiBackendVpcReq object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

No

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 ApiPolicyHttpCreate

Parameter

-

Mandatory

-

Type

-

Description

-

url_domain

-

No

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

Yes

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

Yes

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY. Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

timeout

-

No

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

No

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

vpc_channel_info

-

No

-

ApiBackendVpcReq object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

No

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 BackendParamBase

Parameter

-

Mandatory

-

Type

-

Description

-

origin

-

Yes

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

Yes

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

No

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

Yes

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

Yes

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ApiConditionBase

Parameter

-

Mandatory

-

Type

-

Description

-

req_param_name

-

No

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

No

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

Yes

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

Yes

-

String

-

Condition value.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 14 ApiBackendVpcReq

Parameter

-

Mandatory

-

Type

-

Description

-

vpc_channel_proxy_host

-

No

-

String

-

Proxy host.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel ID.

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

status

-

Integer

-

App status.

-
  • 1: valid
-

arrange_necessary

-

Integer

-

Indicates whether to enable orchestration.

-

register_time

-

String

-

Time when the API is registered.

-

update_time

-

String

-

Time when the API was last modified.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

group_version

-

String

-

Version of the API group to which the API belongs.

-

The default value is V1. Other versions are not supported.

-

Default: V1

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

Separate multiple environment IDs with vertical bars (|).

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

Separate multiple environment names with vertical bars (|).

-

publish_id

-

String

-

Publication record ID.

-

Separate multiple publication record IDs with vertical bars (|).

-

publish_time

-

String

-

Publication time.

-

Separate the time of multiple publication records with vertical bars (|).

-

roma_app_name

-

String

-

Name of the integration application to which the API belongs.

-

Currently, this parameter is not supported.

-

ld_api_id

-

String

-

ID of the corresponding custom backend API.

-

Currently, this parameter is not supported.

-

backend_api

-

BackendApi object

-

Web backend details.

-

api_group_info

-

ApiGroupCommonInfo object

-

API group information.

-

func_info

-

ApiFunc object

-

FunctionGraph backend details.

-

mock_info

-

ApiMock object

-

Mock backend details.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

policy_functions

-

Array of ApiPolicyFunctionResp objects

-

FunctionGraph backend policies.

-

policy_mocks

-

Array of ApiPolicyMockResp objects

-

Mock backend policies.

-

policy_https

-

Array of ApiPolicyHttpResp objects

-

Web backend policies.

-
-
- -
- - - - - - - - - -
Table 16 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 BackendApi

Parameter

-

Type

-

Description

-

authorizer_id

-

String

-

Custom authorizer ID.

-

url_domain

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

id

-

String

-

ID.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

register_time

-

String

-

Registration time.

-

update_time

-

String

-

Update time.

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 18 ApiGroupCommonInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 19 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 20 ApiFunc

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 21 ApiMock

Parameter

-

Type

-

Description

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

String

-

Response.

-

version

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 22 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 23 ApiPolicyFunctionResp

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 24 ApiPolicyMockResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

result_content

-

String

-

Response.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 25 ApiPolicyHttpResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

url_domain

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 26 BackendParam

Parameter

-

Type

-

Description

-

origin

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-

id

-

String

-

Parameter ID.

-

req_param_id

-

String

-

Request parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 27 CoditionResp

Parameter

-

Type

-

Description

-

req_param_name

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

String

-

Condition value.

-

id

-

String

-

ID.

-

req_param_id

-

String

-

Input parameter ID.

-

req_param_location

-

String

-

Input parameter location.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 28 VpcInfo

Parameter

-

Type

-

Description

-

ecs_id

-

String

-

Cloud server ID.

-

ecs_name

-

String

-

Cloud server name.

-

cascade_flag

-

Boolean

-

Indicates whether to use the cascading mode.

-

Currently, this parameter is not supported.

-

vpc_channel_proxy_host

-

String

-

Proxy host.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

vpc_channel_port

-

Integer

-

VPC channel port.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 29 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 30 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 31 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 32 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 33 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

-
-

Example Responses

Status code: 201

-

Created

- -

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3019",
-  "error_msg" : "The function URN does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/CreateAppCodeAutoV2_1.html b/docs/apig/api-ref/CreateAppCodeAutoV2_1.html deleted file mode 100644 index e6b0c17b..00000000 --- a/docs/apig/api-ref/CreateAppCodeAutoV2_1.html +++ /dev/null @@ -1,341 +0,0 @@ - - -

Generating an AppCode

-

Function

This API is used to generate a random AppCode.

-
-

URI

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

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

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

app_code

-

String

-

AppCode value.

-

It can contain 64 to 180 characters, starting with a letter, digit, plus sign (+), or slash (/). Only letters, digits, and the following special characters are allowed: +_!@#$%-/=

-

id

-

String

-

ID.

-

app_id

-

String

-

App ID.

-

create_time

-

String

-

Creation time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 201

-

Created

-
{
-  "app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a",
-  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-  "id" : "b3d34f746d0847fb95138670e10207ed",
-  "create_time" : "2020-07-24T02:31:45.790909295Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
-  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/CreateAppCodeV2_1.html b/docs/apig/api-ref/CreateAppCodeV2_1.html deleted file mode 100644 index f330513b..00000000 --- a/docs/apig/api-ref/CreateAppCodeV2_1.html +++ /dev/null @@ -1,368 +0,0 @@ - - -

Creating an AppCode

-

Function

This API is used to create an AppCode for an app for simple authentication.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

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

-

app_code

-

Yes

-

String

-

AppCode value.

-

It can contain 64 to 180 characters, starting with a letter, digit, plus sign (+), or slash (/). Only letters, digits, and the following special characters are allowed: +_!@#$%-/=

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

app_code

-

String

-

AppCode value.

-

It can contain 64 to 180 characters, starting with a letter, digit, plus sign (+), or slash (/). Only letters, digits, and the following special characters are allowed: +_!@#$%-/=

-

id

-

String

-

ID.

-

app_id

-

String

-

App ID.

-

create_time

-

String

-

Creation time.

-
-
-

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

Creating an AppCode for simple authentication

-
{
-  "app_code" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7W+gr4VJBB5BtJ4fdVOQoSvoji3gFxUDb5pWBz9wUcw9+8/bFZ1B/4pq29wCMQC0pQWX6zTndljDEl99As1pw+WntAU9xcq+ffagoH6zDpKUvdxV6Ezj8LcCcPZN6BU="
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "app_code" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7W+gr4VJBB5BtJ4fdVOQoSvoji3gFxUDb5pWBz9wUcw9+8/bFZ1B/4pq29wCMQC0pQWX6zTndljDEl99As1pw+WntAU9xcq+ffagoH6zDpKUvdxV6Ezj8LcCcPZN6BU=",
-  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-  "id" : "32dc8ca22d1b4b9cb94022186880576b",
-  "create_time" : "2020-07-24T02:37:24.835128293Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
-  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/CreateAuthorizingAppsV2_1.html b/docs/apig/api-ref/CreateAuthorizingAppsV2_1.html deleted file mode 100644 index 00bc9c5f..00000000 --- a/docs/apig/api-ref/CreateAuthorizingAppsV2_1.html +++ /dev/null @@ -1,516 +0,0 @@ - - -

Authorizing Apps

-

Function

An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/app-auths

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

-
-
-
-

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

-

env_id

-

Yes

-

String

-

ID of the environment in which the apps will be authorized.

-

app_ids

-

Yes

-

Array of strings

-

App IDs.

-

api_ids

-

Yes

-

Array of strings

-

API list.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

auths

-

Array of ApiAuthRelations objects

-

App authorization records.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiAuthRelations

Parameter

-

Type

-

Description

-

api_id

-

String

-

API ID.

-

auth_result

-

AuthResult object

-

Authorization result.

-

auth_time

-

String

-

Authorization time.

-

id

-

String

-

Authorization record ID.

-

app_id

-

String

-

App ID.

-

auth_role

-

String

-

Authorizer.

-

  • PROVIDER: API provider

    -

  • CONSUMER: API user

    -
-

Enumeration values:

-

  • PROVIDER

    -

  • CONSUMER

    -
-

auth_tunnel

-

String

-

Authorization channel type.

-

  • NORMAL: normal channel

    -

  • GREEN: green channel

    -
-

The default value is NORMAL. This parameter is not supported currently.

-

Enumeration values:

-

  • NORMAL

    -

  • GREEN

    -
-

auth_whitelist

-

Array of strings

-

Whitelist for the green channel.

-

auth_blacklist

-

Array of strings

-

Blacklist for the green channel.

-

visit_params

-

String

-

Access parameters.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 AuthResult

Parameter

-

Type

-

Description

-

status

-

String

-

Authorization result.

-

  • SUCCESS

    -

  • SKIPPED

    -

  • FAILED

    -
-

Enumeration values:

-

  • SUCCESS

    -

  • SKIPPED

    -

  • FAILED

    -
-

error_msg

-

String

-

Error message.

-

error_code

-

String

-

Error code.

-

api_name

-

String

-

Name of the API for which authorization fails.

-

app_name

-

String

-

Name of the app that fails to be authorized.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Authorizing an app to call an API

-
{
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "app_ids" : [ "356de8eb7a8742168586e5daf5339965" ],
-  "api_ids" : [ "5f918d104dc84480a75166ba99efff21" ]
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "auths" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "auth_result" : {
-      "status" : "SUCCESS"
-    },
-    "auth_time" : "22020-08-04T04:02:22.482227344Z",
-    "id" : "dd29b33ae4394e3b924b582c6b40880b",
-    "app_id" : "356de8eb7a8742168586e5daf5339965",
-    "auth_role" : "PROVIDER",
-    "auth_tunnel" : "NORMAL"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:api_ids. 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.3004",
-  "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

-

Created

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: App Authorization Management
-
-
- diff --git a/docs/apig/api-ref/CreateCustomAuthorizerV2_1.html b/docs/apig/api-ref/CreateCustomAuthorizerV2_1.html deleted file mode 100644 index 75b0c219..00000000 --- a/docs/apig/api-ref/CreateCustomAuthorizerV2_1.html +++ /dev/null @@ -1,646 +0,0 @@ - - -

Creating a Custom Authorizer

-

Function

This API is used to create a custom authorizer.

-
-

URI

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

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

-
-
-
-

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

-

Custom authorizer name.

-

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

-

type

-

Yes

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

Yes

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

Yes

-

String

-

Function URN.

-

authorizer_version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

No

-

Array of Identity objects

-

Identity source.

-

ttl

-

No

-

Integer

-

Maximum cache age.

-

user_data

-

No

-

String

-

User data.

-

ld_api_id

-

No

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

No

-

Boolean

-

Indicates whether to send the body.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 4 Identity

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Parameter name.

-

location

-

Yes

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

No

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

name

-

String

-

Custom authorizer name.

-

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

-

type

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

String

-

Function URN.

-

authorizer_version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

Array of Identity objects

-

Identity source.

-

ttl

-

Integer

-

Maximum cache age.

-

user_data

-

String

-

User data.

-

ld_api_id

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

Boolean

-

Indicates whether to send the body.

-

id

-

String

-

Custom authorizer ID.

-

create_time

-

String

-

Creation time.

-

roma_app_id

-

String

-

ID of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 Identity

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Creating a frontend custom authorizer

-
{
-  "name" : "Authorizer_demo",
-  "type" : "FRONTEND",
-  "authorizer_type" : "FUNC",
-  "authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-  "authorizer_version" : "v1",
-  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-  "identities" : [ {
-    "name" : "header",
-    "location" : "HEADER"
-  } ],
-  "user_data" : "authorizer_test"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "name" : "Authorizer_demo",
-  "type" : "FRONTEND",
-  "authorizer_type" : "FUNC",
-  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-  "authorizer_version" : "v1",
-  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-  "identities" : [ {
-    "name" : "header",
-    "location" : "HEADER"
-  } ],
-  "ttl" : 0,
-  "user_data" : "authorizer_test",
-  "id" : "0d982c1ac3da493dae47627b6439fc5c",
-  "create_time" : "2020-07-31T11:55:43Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:type. 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.3019",
-  "error_msg" : "The function URN does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Custom Authorizer Management
-
-
- diff --git a/docs/apig/api-ref/CreateEnvironmentV2_1.html b/docs/apig/api-ref/CreateEnvironmentV2_1.html deleted file mode 100644 index aba6516f..00000000 --- a/docs/apig/api-ref/CreateEnvironmentV2_1.html +++ /dev/null @@ -1,334 +0,0 @@ - - -

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.

-
-

URI

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

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

-
-
-
-

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

-

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

-

Minimum: 3

-

Maximum: 64

-

remark

-

No

-

String

-

Description.

-

Maximum: 255

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

create_time

-

String

-

Creation time.

-

name

-

String

-

Environment name.

-

remark

-

String

-

Description.

-

id

-

String

-

Environment ID.

-
-
-

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: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Creating an environment

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

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

-
{
-  "error_code" : "APIG.2012",
-  "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.

-
-
-
-
-
Parent topic: Environment Management
-
-
- diff --git a/docs/apig/api-ref/CreateEnvironmentVariableV2_1.html b/docs/apig/api-ref/CreateEnvironmentVariableV2_1.html deleted file mode 100644 index 1be467cf..00000000 --- a/docs/apig/api-ref/CreateEnvironmentVariableV2_1.html +++ /dev/null @@ -1,411 +0,0 @@ - - -

Creating a Variable

-

Function

Publishing an API in different environments may involve various variables, such as API service deployment address and request version.

-

You can define environment variables when creating an API. When the API is called, the environment variables will be replaced with the variable values to distinguish environments.

-

Environment variables are defined for an API group and apply to all APIs in the group.

-

  1. Environment variable names must be unique for an API group in the same environment.

    -

  2. Environment variable names are case-sensitive. For example, ABC and abc are two different variables.

    -

  3. APIs that use environment variables cannot be debugged.

    -

  4. You must enclose an environment variable in number signs (#) so that it can be replaced with the actual value of the environment in which the API is published. For example, if the URL of an API is https://#address#:8080 and the value of variable address is 192.168.1.5 in the RELEASE environment, the real URL of the API is https://192.168.1.5:8080 after publishing.

    -
-
-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/env-variables

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

-
-
-
-

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

-

variable_value

-

Yes

-

String

-

The variable value can contain 1 to 255 characters. Only letters, digits, and special characters (_-/.:) are allowed.

-

env_id

-

Yes

-

String

-

Environment ID.

-

Minimum: 1

-

Maximum: 65

-

group_id

-

Yes

-

String

-

API group ID.

-

Minimum: 1

-

Maximum: 65

-

variable_name

-

Yes

-

String

-

Variable name, which can contain 3 to 32 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. The variable name is equivalent to "#Name#" in API definitions. Characters between the number signs are case-sensitive. The variable name will be replaced with the variable value after API publication.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

variable_value

-

String

-

The variable value can contain 1 to 255 characters. Only letters, digits, and special characters (_-/.:) are allowed.

-

env_id

-

String

-

Environment ID.

-

Minimum: 1

-

Maximum: 65

-

group_id

-

String

-

API group ID.

-

Minimum: 1

-

Maximum: 65

-

variable_name

-

String

-

Variable name, which can contain 3 to 32 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. The variable name is equivalent to "#Name#" in API definitions. Characters between the number signs are case-sensitive. The variable name will be replaced with the variable value after API publication.

-

id

-

String

-

Environment variable ID.

-
-
-

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

Creating an environment variable

-
{
-  "variable_name" : "address",
-  "variable_value" : "192.168.1.5",
-  "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "variable_value" : "192.168.1.5",
-  "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "id" : "25054838a624400bbf2267cf5b3a3f70",
-  "variable_name" : "address"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:instance_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.3003",
-  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
-}
-

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.

-
-
-
-
-
Parent topic: Environment Variable Management
-
-
- diff --git a/docs/apig/api-ref/CreateFeatureV2_1.html b/docs/apig/api-ref/CreateFeatureV2_1.html deleted file mode 100644 index 2a79a97f..00000000 --- a/docs/apig/api-ref/CreateFeatureV2_1.html +++ /dev/null @@ -1,398 +0,0 @@ - - -

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

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

-
-
-
-

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

-

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

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

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

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

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.

-
-
-
-
-
Parent topic: Gateway Feature Management
-
-
- diff --git a/docs/apig/api-ref/CreateGatewayResponseV2_1.html b/docs/apig/api-ref/CreateGatewayResponseV2_1.html deleted file mode 100644 index 2cdf13ce..00000000 --- a/docs/apig/api-ref/CreateGatewayResponseV2_1.html +++ /dev/null @@ -1,530 +0,0 @@ - - -

Creating a Group Response

-

Function

This API is used to create a response for an API group.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

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

-

group_id

-

Yes

-

String

-

API group 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

-

No

-

String

-

Response name.

-

responses

-

No

-

Map<String,ResponseInfo>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 ResponseInfo

Parameter

-

Mandatory

-

Type

-

Description

-

status

-

No

-

Integer

-

HTTP status code of the response.

-

body

-

No

-

String

-

Response body template.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

name

-

String

-

Response name.

-

responses

-

Map<String,ResponseInfoResp>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-

id

-

String

-

Response ID.

-

default

-

Boolean

-

Indicates whether the group response is the default response.

-

create_time

-

String

-

Creation time.

-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Creating a response for an API group

-
{
-  "name" : "response_demo"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "create_time" : "2020-08-12T14:52:02.829753306+08:00",
-  "update_time" : "2020-08-12T14:52:02.829753306+08:00",
-  "default" : false,
-  "id" : "e839b367e10f4ab19d1c5008e476b83a",
-  "name" : "response_demo",
-  "responses" : {
-    "ACCESS_DENIED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 403
-    },
-    "AUTHORIZER_CONF_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_IDENTITIES_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_HEADER_MISSING" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "BACKEND_TIMEOUT" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 504
-    },
-    "BACKEND_UNAVAILABLE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 502
-    },
-    "DEFAULT_4XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "DEFAULT_5XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "NOT_FOUND" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 404
-    },
-    "REQUEST_PARAMETERS_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 400
-    },
-    "THROTTLED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 429
-    },
-    "UNAUTHORIZED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    }
-
-  }
-}
-

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/CreateInstanceV2_1.html b/docs/apig/api-ref/CreateInstanceV2_1.html deleted file mode 100644 index 1014324a..00000000 --- a/docs/apig/api-ref/CreateInstanceV2_1.html +++ /dev/null @@ -1,578 +0,0 @@ - - -

Creating a Dedicated Gateway (Pay-Per-Use)

-

Function

This API is used to create a pay-per-use dedicated gateway.

-
-

URI

POST /v2/{project_id}/apigw/instances

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

-
-
-
-

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

-

description

-

No

-

String

-

Gateway description.

-

maintain_begin

-

No

-

String

-

Start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.

-

During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

maintain_end

-

No

-

String

-

End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.

-

During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

instance_name

-

Yes

-

String

-

Gateway name.

-

Minimum: 3

-

Maximum: 64

-

instance_id

-

No

-

String

-

Gateway ID, which will be automatically generated if you do not specify this parameter.

-

spec_id

-

Yes

-

String

-

Gateway edition. Options:

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

Enumeration values:

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

vpc_id

-

Yes

-

String

-

VPC ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console, and click the name of a VPC to view the VPC ID on the displayed details page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying VPCs" in the VPC API Reference.
-

subnet_id

-

Yes

-

String

-

Subnet network ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Subnets" in the VPC API Reference.
-

security_group_id

-

Yes

-

String

-

ID of the security group to which the gateway belongs.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the Security Groups page, click the target security group. Then view the security group ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Security Groups" in the VPC API Reference.
-

enterprise_project_id

-

No

-

String

-

Enterprise project ID. This parameter is required if you are using an enterprise account.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the Enterprise Project Management page, click the name of the target enterprise project, and view the project ID on the displayed page.
  • Method 2: Call the corresponding project management API. For details, see section "Querying the Enterprise Project List" in the Enterprise Management API Reference.
-

available_zone_ids

-

Yes

-

Array of strings

-

AZs.

-

An AZ is a physical region where resources use independent power supply and networks. AZs are physically isolated but interconnected through an internal network. To enhance application availability, create gateways in different AZs.

-

To obtain AZ information, call the API used to query AZs.

-

bandwidth_size

-

No

-

Integer

-

Outbound access bandwidth.

-

This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.

-

Default: 5

-

bandwidth_charging_mode

-

No

-

String

-

Billing type of the public outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway.

-
  • bandwidth: billed by bandwidth
  • traffic: billed by traffic
-

Default: bandwidth

-

Enumeration values:

-
  • bandwidth
  • traffic
-

loadbalancer_provider

-

Yes

-

String

-

Type of the load balancer used by the gateway.

-
  • ELB
-

tags

-

No

-

Array of TmsKeyValue objects

-

Tags.

-

A maximum of 20 tags can be created for a gateway.

-

Array Length: 0 - 20

-

vpcep_service_name

-

No

-

String

-

Name of a VPC endpoint service.

-

It can contain max. 16 characters, including letters, digits, hyphens (-), and underscores.

-

If this parameter is not specified, the system automatically generates a name in the "{region}.apig.{service_id}" format.

-

If this parameter is specified, the system automatically generates a name in the "{region}.{vpcep_service_name}.{service_id}" format.

-

After the gateway is created, you can modify this name on the Gateways > VPC Endpoints page.

-

ingress_bandwidth_size

-

No

-

Integer

-

Public inbound access bandwidth.

-

This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.

-

Default: 5

-

ingress_bandwidth_charging_mode

-

No

-

String

-

Billing type of the public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb.

-
  • bandwidth: billed by bandwidth
  • traffic: billed by traffic
-

Default: bandwidth

-

Enumeration values:

-
  • bandwidth
  • traffic
-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 TmsKeyValue

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Key.

-

Include UTF-8 letters, digits, spaces, or special characters (_.:=+-@).

-

Do not start with _sys_ because it is a system label.

-

Minimum: 1

-

Maximum: 128

-

value

-

No

-

String

-

Value.

-

You can enter letters, digits, and spaces or other special characters (_.:/=+-@) in UTF-8 format.

-

Minimum: 0

-

Maximum: 255

-
-
-
-

Response Parameters

Status code: 202

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

Parameter

-

Type

-

Description

-

instance_id

-

String

-

Gateway ID.

-

message

-

String

-

Information about the gateway creation task.

-

job_id

-

String

-

Task ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Creating a gateway with network and security group configurations

-
{
-  "available_zone_ids" : [ "xx-xxx-7b", "xx-xxx-7a" ],
-  "bandwidth_size" : 5,
-  "description" : "test create instance",
-  "enterprise_project_id" : "0",
-  "instance_name" : "apig-demo",
-  "maintain_begin" : "22:00:00",
-  "maintain_end" : "02:00:00",
-  "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
-  "spec_id" : "PROFESSIONAL",
-  "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
-  "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
-}
-
-

Example Responses

Status code: 202

-

Accepted

-
{
-  "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
-  "message" : "JOB_ASSIGNED_FOR_PROVISIONING_0003I:The job JOB-bdb370eb6f4c4c73b61b95a9da38beb5 has been assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running provisioning.",
-  "job_id" : "JOB-edbac2355fb7433e98f173ea2e452e2d"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIC.7211",
-  "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]"
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7301",
-  "error_msg" : "Instance spec not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

202

-

Accepted

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/CreateOrDeletePublishRecordForApiV2_1.html b/docs/apig/api-ref/CreateOrDeletePublishRecordForApiV2_1.html deleted file mode 100644 index 40517a51..00000000 --- a/docs/apig/api-ref/CreateOrDeletePublishRecordForApiV2_1.html +++ /dev/null @@ -1,417 +0,0 @@ - - -

Publishing an API or Taking an API Offline

-

Function

This API is used to publish an API or take an API offline.

-

An API can be called only in an environment where the API has been published. APIs that have not been published cannot be called.

-

You can remove an API from an environment in which it has been published. After this operation, the API can no longer be called in the environment.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

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

-
-
-
-

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

-

action

-

Yes

-

String

-

Operation to perform.

-

  • online: publish APIs

    -

  • offline: take APIs offline

    -
-

Enumeration values:

-

  • online

    -

  • offline

    -
-

env_id

-

Yes

-

String

-

ID of the environment in which the API will be published.

-

api_id

-

Yes

-

String

-

ID of the API to be published or taken offline.

-

remark

-

No

-

String

-

Description about the publishing. It cannot exceed 255 characters.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

publish_id

-

String

-

Publication record ID.

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

remark

-

String

-

Description about the publication.

-

publish_time

-

String

-

Publication time.

-

version_id

-

String

-

API version currently in use.

-
-
-

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

Publishing an API in an environment

-
{
-  "action" : "online",
-  "api_id" : "5f918d104dc84480a75166ba99efff21",
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "api_id" : "5f918d104dc84480a75166ba99efff21",
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
-  "publish_time" : "2020-08-03T01:36:00.592970615Z",
-  "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:action. 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" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/CreateRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/CreateRequestThrottlingPolicyV2_1.html deleted file mode 100644 index f38137b8..00000000 --- a/docs/apig/api-ref/CreateRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,530 +0,0 @@ - - -

Creating a Request Throttling Policy

-

Function

After an API goes online, the system attaches a request throttling policy to it by default. The API provider can change the request throttling policy based on the service capabilities and load of the API. A request throttling policy restricts the maximum number of times an API can be called within a specified period.

-
-

URI

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

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

-
-
-
-

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

-

app_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

Yes

-

String

-

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

-

time_unit

-

Yes

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

No

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Yes

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

No

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

No

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Yes

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

app_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

String

-

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

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

id

-

String

-

Request throttling policy ID.

-

bind_num

-

Integer

-

Number of APIs to which the request throttling policy has been bound.

-

is_inclu_special_throttle

-

Integer

-

Indicates whether an excluded request throttling configuration has been created.

-

  • 1: yes

    -

  • 2: no

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

create_time

-

String

-

Creation time.

-
-
-

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: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Creating a request throttling policy (max. API requests: 800; max. user requests: 500; max. app requests: 300; max. IP address requests: 600; period: 1s)

-
{
-  "api_call_limits" : 800,
-  "app_call_limits" : 300,
-  "enable_adaptive_control" : "FALSE",
-  "ip_call_limits" : 600,
-  "name" : "throttle_demo",
-  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-  "time_interval" : 1,
-  "time_unit" : "SECOND",
-  "type" : 1,
-  "user_call_limits" : 500
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "name" : "throttle_demo",
-  "create_time" : "2020-07-31T08:44:02.205366118Z",
-  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-  "type" : 1,
-  "time_interval" : 1,
-  "ip_call_limits" : 600,
-  "app_call_limits" : 300,
-  "time_unit" : "SECOND",
-  "api_call_limits" : 800,
-  "id" : "3437448ad06f4e0c91a224183116e965",
-  "user_call_limits" : 500,
-  "enable_adaptive_control" : "FALSE",
-  "bind_num" : 0,
-  "is_inclu_special_throttle" : 2
-}
-

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.

-
-
-
-
-
Parent topic: Request Throttling Policy Management
-
-
- diff --git a/docs/apig/api-ref/CreateSignatureKeyV2_1.html b/docs/apig/api-ref/CreateSignatureKeyV2_1.html deleted file mode 100644 index a0b6010e..00000000 --- a/docs/apig/api-ref/CreateSignatureKeyV2_1.html +++ /dev/null @@ -1,450 +0,0 @@ - - -

Creating a Signature Key

-

Function

It is a good practice to provide a protection mechanism for APIs to ensure access security. For example, authenticating API request sources and denying the access from unauthorized sources.

-

A signature key is a protection mechanism in case.

-

Create a signature key and bind it to an API. When requesting the API, APIG uses the signature key to encrypt request parameter data and generate a signature. The backend service of the API verifies requests by using the signature. Unauthorized requests will be denied to protect the API against attacks from unknown sources.

-
-

URI

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

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

-
-
-
-

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

-

Signature key name. It can contain letters, digits, and underscores(_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

-

sign_type

-

No

-

String

-

Signature key type.

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

sign_key

-

No

-

String

-

Signature key.

-

  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.

    -

  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_secret

-

No

-

String

-

Signature secret.

-

  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • public_key: The value can contain 16 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_algorithm

-

No

-

String

-

Signature algorithm. Specify a signature algorithm only when using an AES signature key. By default, no algorithm is used.

-

Enumeration values:

-

  • aes-128-cfb

    -

  • aes-256-cfb

    -
-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

name

-

String

-

Signature key name. It can contain letters, digits, and underscores(_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

-

sign_type

-

String

-

Signature key type.

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

sign_key

-

String

-

Signature key.

-

  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.

    -

  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_secret

-

String

-

Signature secret.

-

  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • public_key: The value can contain 16 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_algorithm

-

String

-

Signature algorithm. Specify a signature algorithm only when using an AES signature key. By default, no algorithm is used.

-

Enumeration values:

-

  • aes-128-cfb

    -

  • aes-256-cfb

    -
-

update_time

-

String

-

Update time.

-

create_time

-

String

-

Creation time.

-

id

-

String

-

Signature key ID.

-
-
-

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: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Create a signature key with a custom key and secret.

-
{
-  "name" : "signature_demo",
-  "sign_key" : "signkeysignkey",
-  "sign_secret" : "sig************ret"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "sign_secret" : "sig************ret",
-  "update_time" : "2020-08-03T03:39:38.119032888Z",
-  "create_time" : "2020-08-03T03:39:38.119032659Z",
-  "name" : "signature_demo",
-  "id" : "0b0e8f456b8742218af75f945307173c",
-  "sign_key" : "signkeysignkey",
-  "sign_type" : "hmac"
-}
-

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.

-
-
-
-
-
Parent topic: Signature Key Management
-
-
- diff --git a/docs/apig/api-ref/CreateSpecialThrottlingConfigurationV2_0.html b/docs/apig/api-ref/CreateSpecialThrottlingConfigurationV2_0.html deleted file mode 100644 index 503b587f..00000000 --- a/docs/apig/api-ref/CreateSpecialThrottlingConfigurationV2_0.html +++ /dev/null @@ -1,432 +0,0 @@ - - -

Creating an Excluded Request Throttling Configuration

-

Function

A request throttling policy controls the maximum number of times an API can be accessed within a specified period and the maximum numbers of times the API can be accessed by a tenant or an app within the same period.

-

If necessary, you can create an excluded request throttling configuration to specify the threshold of API calls for a specific app. For example, if you set the API call threshold for all apps to 500 calls/minute, you can specify the API call threshold of app 1 as 800 calls/minute.

-

You can add excluded apps or tenants to a request throttling policy.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

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

-

throttle_id

-

Yes

-

String

-

Request throttling policy 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

-

call_limits

-

Yes

-

Integer

-

Maximum number of times an excluded object can access an API within the throttling period.

-

object_id

-

Yes

-

String

-

Excluded app ID or excluded account ID.

-

object_type

-

Yes

-

String

-

Excluded object type.

-

Enumeration values:

-

  • APP

    -

  • USER

    -
-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

id

-

String

-

Excluded configuration ID.

-

call_limits

-

Integer

-

Maximum number of times an excluded object can access an API within the throttling period.

-

apply_time

-

String

-

Throttling period.

-

app_name

-

String

-

App name.

-

app_id

-

String

-

App ID.

-

object_id

-

String

-

ID of an object specified in the excluded configuration.

-

object_type

-

String

-

Excluded object type, which can be APP or USER.

-

object_name

-

String

-

Name of an app or a tenant to which the excluded configuration applies.

-

throttle_id

-

String

-

Request throttling policy ID.

-
-
-

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

Adding an excluded app to a request throttling policy with threshold 150

-
{
-  "call_limits" : 150,
-  "object_id" : "356de8eb7a8742168586e5daf5339965",
-  "object_type" : "APP"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "call_limits" : 150,
-  "app_name" : "app_demo",
-  "object_name" : "app_demo",
-  "object_id" : "356de8eb7a8742168586e5daf5339965",
-  "throttle_id" : "3437448ad06f4e0c91a224183116e965",
-  "apply_time" : "2020-08-04T02:40:56.717710961Z",
-  "id" : "a3e9ff8db55544ed9db91d8b048770c0",
-  "app_id" : "356de8eb7a8742168586e5daf5339965",
-  "object_type" : "APP"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2003",
-  "error_msg" : "The parameter value is too large,parameterName:call_limits. 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.3004",
-  "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

-

Created

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Excluded Request Throttling Configuration
-
-
- diff --git a/docs/apig/api-ref/CreateVpcChannelV2_1.html b/docs/apig/api-ref/CreateVpcChannelV2_1.html deleted file mode 100644 index f79d88ac..00000000 --- a/docs/apig/api-ref/CreateVpcChannelV2_1.html +++ /dev/null @@ -1,1670 +0,0 @@ - - -

Creating a VPC Channel

-

Function

This API is used to create a VPC channel from APIG to your private VPC resources. Afterwards, when creating an API, you can configure your backend service to use this VPC channel so that APIG can directly access your private VPC resources.

-

You can create a maximum of 30 VPC channels.

-
-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

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

-
-
-
-

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

-

VPC channel name.

-

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

-

port

-

Yes

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Yes

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

Yes

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

No

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

No

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

member_groups

-

No

-

Array of MemberGroupCreate objects

-

Backend server groups of the VPC channel.

-

members

-

No

-

Array of MemberInfo objects

-

Backend instances of the VPC channel.

-

vpc_health_config

-

No

-

VpcHealthConfig object

-

Health check details.

-

microservice_info

-

No

-

MicroServiceCreate object

-

Microservice details.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 MemberGroupCreate

Parameter

-

Mandatory

-

Type

-

Description

-

member_group_name

-

Yes

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

No

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

No

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

No

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

No

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

No

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

No

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 MicroserviceLabel

Parameter

-

Mandatory

-

Type

-

Description

-

label_name

-

Yes

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

Yes

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 MemberInfo

Parameter

-

Mandatory

-

Type

-

Description

-

host

-

No

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

No

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

No

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

No

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

No

-

Integer

-

Backend server status.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

port

-

No

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

No

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

No

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 VpcHealthConfig

Parameter

-

Mandatory

-

Type

-

Description

-

protocol

-

Yes

-

String

-

Protocol for performing health checks on backend servers in the VPC channel.

-
  • TCP
  • HTTP
  • HTTPS
-

Enumeration values:

-
  • TCP
  • HTTP
  • HTTPS
-

path

-

No

-

String

-

Destination path for health checks. This parameter is required if protocol is set to http or https.

-

method

-

No

-

String

-

Request method for health checks.

-

Default: GET

-

Enumeration values:

-
  • GET
  • HEAD
-

port

-

No

-

Integer

-

Destination port for health checks. If this parameter is not specified or set to 0, the host port of the VPC channel is used.

-

If this parameter is set to a non-zero value, the corresponding port is used for health checks.

-

Minimum: 0

-

Maximum: 65535

-

threshold_normal

-

Yes

-

Integer

-

Healthy threshold. It refers to the number of consecutive successful checks required for a backend server to be considered healthy.

-

Minimum: 1

-

Maximum: 10

-

threshold_abnormal

-

Yes

-

Integer

-

Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy.

-

Minimum: 1

-

Maximum: 10

-

time_interval

-

Yes

-

Integer

-

Interval between consecutive checks. Unit: s. The value must be greater than the value of timeout.

-

Minimum: 1

-

Maximum: 300

-

http_code

-

No

-

String

-

Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats:

-
  • Multiple values, for example, 200,201,202
  • Range, for example, 200-299
  • Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.
-

enable_client_ssl

-

No

-

Boolean

-

Indicates whether to enable two-way authentication. If this function is enabled, the certificate specified in the backend_client_certificate configuration item of the gateway is used.

-

Default: false

-

status

-

No

-

Integer

-

Health check result.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

timeout

-

Yes

-

Integer

-

Timeout for determining whether a health check fails. Unit: s. The value must be less than the value of time_interval.

-

Minimum: 1

-

Maximum: 30

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 MicroServiceCreate

Parameter

-

Mandatory

-

Type

-

Description

-

service_type

-

No

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

No

-

MicroServiceInfoCSEBase object

-

CSE microservice details. This parameter is required if service_type is set to CSE.

-

cce_info

-

No

-

MicroServiceInfoCCEBase object

-

CCE workload details. This parameter is required if service_type is set to CCE. Either app_name or any of label_key and label_value must be set. If only app_name is set, label_key='app' and label_value=app_name.

-

cce_service_info

-

No

-

MicroServiceInfoCCEServiceBase object

-

CCE Service details.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 9 MicroServiceInfoCSEBase

Parameter

-

Mandatory

-

Type

-

Description

-

engine_id

-

Yes

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

Yes

-

String

-

Microservice ID.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 MicroServiceInfoCCEBase

Parameter

-

Mandatory

-

Type

-

Description

-

cluster_id

-

Yes

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

Yes

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

Yes

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

No

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

No

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

No

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 11 MicroServiceInfoCCEServiceBase

Parameter

-

Mandatory

-

Type

-

Description

-

cluster_id

-

Yes

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

Yes

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

Yes

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

VPC channel name.

-

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

-

port

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

create_time

-

String

-

Time when the VPC channel is created.

-

id

-

String

-

VPC channel ID.

-

status

-

Integer

-

VPC channel status.

-
  • 1: normal
  • 2: abnormal
-

Enumeration values:

-
  • 1
  • 2
-

member_groups

-

Array of MemberGroupInfo objects

-

Backend server groups.

-

microservice_info

-

MicroServiceInfo object

-

Microservice information.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 MemberGroupInfo

Parameter

-

Type

-

Description

-

member_group_name

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

member_group_id

-

String

-

ID of the backend server group of the VPC channel.

-

create_time

-

String

-

Time when the backend server group is created.

-

update_time

-

String

-

Time when the backend server group is updated.

-
-
- -
- - - - - - - - - - - - - -
Table 14 MicroserviceLabel

Parameter

-

Type

-

Description

-

label_name

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 MicroServiceInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Microservice ID.

-

instance_id

-

String

-

Gateway ID.

-

service_type

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

MicroServiceInfoCSE object

-

CSE microservice details.

-

cce_info

-

MicroServiceInfoCCE object

-

CCE microservice workload details.

-

cce_service_info

-

MicroServiceInfoCCEService object

-

CCE microservice Service details.

-

update_time

-

String

-

Microservice update time.

-

create_time

-

String

-

Microservice creation time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 16 MicroServiceInfoCSE

Parameter

-

Type

-

Description

-

engine_id

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

String

-

Microservice ID.

-

Maximum: 64

-

engine_name

-

String

-

Microservice engine name.

-

service_name

-

String

-

Microservice name.

-

register_address

-

String

-

Registration center address.

-

cse_app_id

-

String

-

App to which the microservice belongs.

-

version

-

String

-

Microservice version, which has been discarded and is reflected in the version of the backend server group.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 MicroServiceInfoCCE

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 18 MicroServiceInfoCCEService

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 19 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 20 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 21 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 22 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 23 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

-
-

Example Responses

Status code: 201

-

Created

- -

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2001",
-  "error_msg" : "The request parameters must be specified, parameter name:members"
-}
-

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.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/CredentialManagement_1.html b/docs/apig/api-ref/CredentialManagement_1.html deleted file mode 100644 index 34930551..00000000 --- a/docs/apig/api-ref/CredentialManagement_1.html +++ /dev/null @@ -1,38 +0,0 @@ - - -

Credential Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/CustomAuthorizerManagement_1.html b/docs/apig/api-ref/CustomAuthorizerManagement_1.html deleted file mode 100644 index abf68213..00000000 --- a/docs/apig/api-ref/CustomAuthorizerManagement_1.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Custom Authorizer Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/DebugApiV2_1.html b/docs/apig/api-ref/DebugApiV2_1.html deleted file mode 100644 index 01ef402e..00000000 --- a/docs/apig/api-ref/DebugApiV2_1.html +++ /dev/null @@ -1,501 +0,0 @@ - - -

Debugging an API

-

Function

This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_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.

-

api_id

-

Yes

-

String

-

API 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

-

body

-

No

-

String

-

Message body, with a maximum of 2,097,152 bytes.

-

header

-

No

-

Map<String,Array<String>>

-

Header parameters, with each value being a character string array. Each parameter name must meet the following requirements:

-

  • Contains letters, digits, periods (.), or hyphens (-).

    -

  • Starts with a letter, with a maximum of 32 bytes.

    -

  • Case-insensitive and cannot start with X-Apig- or X-Sdk-.

    -

  • Case-insensitive and cannot be X-Stage.

    -

  • Case-insensitive and cannot be X-Auth-Token or Authorization when mode is set to MARKET or CONSUMER.

    -
-
NOTE:

Each header name is normalized before use. For example, x-MY-hEaDer is normalized as X-My-Header.

-
-

method

-

Yes

-

String

-

API request method.

-

Enumeration values:

-

  • GET

    -

  • POST

    -

  • PUT

    -

  • DELETE

    -

  • HEAD

    -

  • PATCH

    -

  • OPTIONS

    -
-

mode

-

Yes

-

String

-

Debugging mode:

-

  • DEVELOPER: Debug the definitions of an API that has not been published.

    -

  • CONSUMER: Debug the definitions of an API that has been published in a specified environment.

    -
-
NOTE:

In DEVELOPER mode, the API caller must be the API provider.

-
-

-

In CONSUMER mode, the API caller must be the API provider or has been authorized to access the API in a specific environment.

-

path

-

Yes

-

String

-

Request path of the API, starting with a slash (/) and containing up to 1024 characters.

-
NOTE:

The request path must meet the requirements so that it can be correctly decoded after percent-encoding.

-
-

query

-

No

-

Map<String,Array<String>>

-

Query strings, with each value being a character string array. Each parameter name must meet the following requirements:

-

  • Contains letters, digits, periods (.), hyphens (-), or underscores (_).

    -

  • Starts with a letter, with a maximum of 32 bytes.

    -

  • Case-insensitive and cannot start with X-Apig- or X-Sdk-.

    -

  • Case-insensitive and cannot be X-Stage.

    -
-

scheme

-

Yes

-

String

-

Request protocol.

-

  • HTTP

    -

  • HTTPS

    -
-

app_key

-

No

-

String

-

AppKey used in the debugging request.

-

app_secret

-

No

-

String

-

AppSecret used in the debugging request.

-

domain

-

No

-

String

-

Access domain name of the API. If no value is specified, one of the following default values will be used based on the mode:

-

  • DEVELOPER: The subdomain name of the API group will be used.

    -

  • MARKET: This parameter is not used currently.

    -

  • CONSUMER: The subdomain name of the API group will be used.

    -
-

stage

-

No

-

String

-

Running environment specified by the debugging request. This parameter is valid only when mode is set to CONSUMER. If this parameter is not specified, the following default value is used:

-

  • CONSUMER RELEASE

    -
-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

request

-

String

-

Body of the debugging request.

-

response

-

String

-

Body of the debugging response, with a maximum of 2,097,152 bytes. Any content beyond this threshold will be truncated.

-
NOTE:

Any content beyond the length limit will be truncated, and text [TRUNCATED] will be added to the response body.

-
-

latency

-

Integer

-

Debugging duration in milliseconds.

-

log

-

String

-

Debugging logs.

-
-
-

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

Debugging an API

-
{
-  "mode" : "DEVELOPER",
-  "scheme" : "HTTPS",
-  "method" : "GET",
-  "path" : "/test/mock"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "request" : "GET /test/mock HTTP/1.1\nHost: c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com\nUser-Agent: APIGatewayDebugClient/1.0\nX-Apig-Mode: debug\n\n",
-  "response" : "HTTP/1.1 200 OK\nTransfer-Encoding: chunked\nConnection: keep-alive\nContent-Type: application/json\nDate: Mon, 03 Aug 2020 02:51:22 GMT\nServer: api-gateway\nX-Apig-Latency: 0\nX-Apig-Ratelimit-Api: remain:99,limit:100,time:1 minute\nX-Apig-Ratelimit-Api-Allenv: remain:14999,limit:15000,time:1 second\nX-Request-Id: d4ec6e33148bdeffe8f55b43472d1251\n\nmock success",
-  "latency" : 5,
-  "log" : ""
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:mode. 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" : "API 3a955b791bd24b1c9cd94c745f8d1aad does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/DeleteAclV2_1.html b/docs/apig/api-ref/DeleteAclV2_1.html deleted file mode 100644 index 27314035..00000000 --- a/docs/apig/api-ref/DeleteAclV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Deleting an Access Control Policy

-

Function

This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_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.

-

acl_id

-

Yes

-

String

-

Access control policy 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "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.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/DeleteApiAclBindingV2_1.html b/docs/apig/api-ref/DeleteApiAclBindingV2_1.html deleted file mode 100644 index fea6f95b..00000000 --- a/docs/apig/api-ref/DeleteApiAclBindingV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Unbinding an Access Control Policy

-

Function

This API is used to unbind an access control policy from an API.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_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.

-

acl_bindings_id

-

Yes

-

String

-

Binding record 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "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.3010",
-  "error_msg" : "The access control policy binding record does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Access Control Policies
-
-
- diff --git a/docs/apig/api-ref/DeleteApiByVersionIdV2_1.html b/docs/apig/api-ref/DeleteApiByVersionIdV2_1.html deleted file mode 100644 index 6a676ba5..00000000 --- a/docs/apig/api-ref/DeleteApiByVersionIdV2_1.html +++ /dev/null @@ -1,253 +0,0 @@ - - -

Taking an API Version Offline

-

Function

This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_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.

-

version_id

-

Yes

-

String

-

API version.

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3022",
-  "error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/DeleteApiGroupV2_1.html b/docs/apig/api-ref/DeleteApiGroupV2_1.html deleted file mode 100644 index d6e28126..00000000 --- a/docs/apig/api-ref/DeleteApiGroupV2_1.html +++ /dev/null @@ -1,255 +0,0 @@ - - -

Deleting an API Group

-

Function

This API is used to delete an API group.

-

If the group to delete contains APIs, take the APIs offline and delete them.

-

All resources (independent domain names and SSL certificates) directly or indirectly associated with the group will be deleted. The operation will also unbind the external domain names from the subdomain name based on the CNAME resolution mode.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_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.

-

group_id

-

Yes

-

String

-

API group 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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Group Management
-
-
- diff --git a/docs/apig/api-ref/DeleteApiV2_1.html b/docs/apig/api-ref/DeleteApiV2_1.html deleted file mode 100644 index b1db0012..00000000 --- a/docs/apig/api-ref/DeleteApiV2_1.html +++ /dev/null @@ -1,254 +0,0 @@ - - -

Deleting an API

-

Function

This API is used to delete an API.

-

This operation will delete all related resources and binding relationships of the API, such as publication records, backend services, and app authorization information.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_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.

-

api_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/DeleteAppCodeV2_1.html b/docs/apig/api-ref/DeleteAppCodeV2_1.html deleted file mode 100644 index bc725f0e..00000000 --- a/docs/apig/api-ref/DeleteAppCodeV2_1.html +++ /dev/null @@ -1,300 +0,0 @@ - - -

Deleting an AppCode

-

Function

This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_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.

-

app_code_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
-  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/DeleteAppV2_1.html b/docs/apig/api-ref/DeleteAppV2_1.html deleted file mode 100644 index 6cda8856..00000000 --- a/docs/apig/api-ref/DeleteAppV2_1.html +++ /dev/null @@ -1,292 +0,0 @@ - - -

Deleting an App

-

Function

This API is used to delete an app.

-

Deleted apps cannot call APIs.

-
-

URI

DELETE /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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/DeleteBackendInstanceV2_1.html b/docs/apig/api-ref/DeleteBackendInstanceV2_1.html deleted file mode 100644 index 92dd02f6..00000000 --- a/docs/apig/api-ref/DeleteBackendInstanceV2_1.html +++ /dev/null @@ -1,300 +0,0 @@ - - -

Removing a Backend Server

-

Function

This API is used to delete a backend instance from a specified VPC channel.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/{member_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.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel ID.

-

member_id

-

Yes

-

String

-

Backend instance 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3024",
-  "error_msg" : "The VPC instance does not exist,id:be63c6260a1043888187f84af39c9f0e"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/DeleteCustomAuthorizerV2_1.html b/docs/apig/api-ref/DeleteCustomAuthorizerV2_1.html deleted file mode 100644 index 52bd7597..00000000 --- a/docs/apig/api-ref/DeleteCustomAuthorizerV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Deleting a Custom Authorizer

-

Function

This API is used to delete a custom authorizer.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_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.

-

authorizer_id

-

Yes

-

String

-

Custom authorizer 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "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.3081",
-  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Custom Authorizer Management
-
-
- diff --git a/docs/apig/api-ref/DeleteEnvironmentV2_1.html b/docs/apig/api-ref/DeleteEnvironmentV2_1.html deleted file mode 100644 index d0a4632b..00000000 --- a/docs/apig/api-ref/DeleteEnvironmentV2_1.html +++ /dev/null @@ -1,255 +0,0 @@ - - -

Deleting an Environment

-

Function

This API is used to delete an environment.

-

This operation will cause the APIs published in the environment to become inaccessible to relevant apps and users. Ensure that you have notified users of the deletion, or confirm that the APIs can be removed from the deleted environment.

-

You cannot delete environments where APIs have been published.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_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.

-

env_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3003",
-  "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Management
-
-
- diff --git a/docs/apig/api-ref/DeleteEnvironmentVariableV2_1.html b/docs/apig/api-ref/DeleteEnvironmentVariableV2_1.html deleted file mode 100644 index 445140b2..00000000 --- a/docs/apig/api-ref/DeleteEnvironmentVariableV2_1.html +++ /dev/null @@ -1,253 +0,0 @@ - - -

Deleting a Variable

-

Function

This API is used to delete an environment variable.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_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.

-

env_variable_id

-

Yes

-

String

-

Environment variable 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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3011",
-  "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Variable Management
-
-
- diff --git a/docs/apig/api-ref/DeleteGatewayResponseTypeV2_1.html b/docs/apig/api-ref/DeleteGatewayResponseTypeV2_1.html deleted file mode 100644 index d3b05ea2..00000000 --- a/docs/apig/api-ref/DeleteGatewayResponseTypeV2_1.html +++ /dev/null @@ -1,312 +0,0 @@ - - -

Deleting the Response of an Error Type

-

Function

This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type}

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

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

Response ID.

-

response_type

-

Yes

-

String

-

Error type. Options:

-
  • AUTH_FAILURE: IAM or app authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: A custom authorizer error has occurred. For example, communication failed or an error response was returned.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the frontend custom authorizer is missing or invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable due to communication error.
  • BACKEND_TIMEOUT: Communication with the backend timed out.
  • THROTTLED: The request was rejected due to throttling.
  • UNAUTHORIZED: The credential you use is not authorized to call the API.
  • ACCESS_DENIED: Access denied. For example, the access control policy is triggered or an attack is detected.
  • NOT_FOUND: No API is matched.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter or unsupported HTTP method.
  • DEFAULT_4XX: Another 4XX error occurred.
  • DEFAULT_5XX: Another 5XX error occurred.
-

Enumeration values:

-
  • AUTH_FAILURE
  • AUTH_HEADER_MISSING
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONF_FAILURE
  • AUTHORIZER_IDENTITIES_FAILURE
  • BACKEND_UNAVAILABLE
  • BACKEND_TIMEOUT
  • THROTTLED
  • UNAUTHORIZED
  • ACCESS_DENIED
  • NOT_FOUND
  • REQUEST_PARAMETERS_FAILURE
  • DEFAULT_4XX
  • DEFAULT_5XX
-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/DeleteGatewayResponseV2_1.html b/docs/apig/api-ref/DeleteGatewayResponseV2_1.html deleted file mode 100644 index 9804b1c8..00000000 --- a/docs/apig/api-ref/DeleteGatewayResponseV2_1.html +++ /dev/null @@ -1,300 +0,0 @@ - - -

Deleting a Group Response

-

Function

This API is used to delete a group response of an API group.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/DeleteInstancesV2_1.html b/docs/apig/api-ref/DeleteInstancesV2_1.html deleted file mode 100644 index 48306de7..00000000 --- a/docs/apig/api-ref/DeleteInstancesV2_1.html +++ /dev/null @@ -1,244 +0,0 @@ - - -

Deleting a Dedicated Gateway

-

Function

This API is used to delete a dedicated gateway.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_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.

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/DeleteRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/DeleteRequestThrottlingPolicyV2_1.html deleted file mode 100644 index d0b7535a..00000000 --- a/docs/apig/api-ref/DeleteRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,253 +0,0 @@ - - -

Deleting a Request Throttling Policy

-

Function

This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_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.

-

throttle_id

-

Yes

-

String

-

Request throttling policy 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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Request Throttling Policy Management
-
-
- diff --git a/docs/apig/api-ref/DeleteSignatureKeyV2_1.html b/docs/apig/api-ref/DeleteSignatureKeyV2_1.html deleted file mode 100644 index 346c8b33..00000000 --- a/docs/apig/api-ref/DeleteSignatureKeyV2_1.html +++ /dev/null @@ -1,253 +0,0 @@ - - -

Deleting a Signature Key

-

Function

This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_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.

-

sign_id

-

Yes

-

String

-

Signature key 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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3017",
-  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Signature Key Management
-
-
- diff --git a/docs/apig/api-ref/DeleteSpecialThrottlingConfigurationV2_0.html b/docs/apig/api-ref/DeleteSpecialThrottlingConfigurationV2_0.html deleted file mode 100644 index 00ea676f..00000000 --- a/docs/apig/api-ref/DeleteSpecialThrottlingConfigurationV2_0.html +++ /dev/null @@ -1,300 +0,0 @@ - - -

Deleting an Excluded Request Throttling Configuration

-

Function

This API is used to delete an excluded configuration of a request throttling policy.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_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.

-

throttle_id

-

Yes

-

String

-

Request throttling policy ID.

-

strategy_id

-

Yes

-

String

-

Excluded configuration 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3013",
-  "error_msg" : "Excluded request throttling configuration a3e9ff8db55544ed9db91d8b048770c0 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Excluded Request Throttling Configuration
-
-
- diff --git a/docs/apig/api-ref/DeleteVpcChannelV2_1.html b/docs/apig/api-ref/DeleteVpcChannelV2_1.html deleted file mode 100644 index af3ff8b9..00000000 --- a/docs/apig/api-ref/DeleteVpcChannelV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Deleting a VPC Channel

-

Function

This API is used to delete a VPC channel.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_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.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/DisassociateCertificateV2_1.html b/docs/apig/api-ref/DisassociateCertificateV2_1.html deleted file mode 100644 index 114f5ed4..00000000 --- a/docs/apig/api-ref/DisassociateCertificateV2_1.html +++ /dev/null @@ -1,309 +0,0 @@ - - -

Deleting the Certificate Bound to a Domain Name

-

Function

This API is used to delete a certificate that is no longer needed or has expired.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

domain_id

-

Yes

-

String

-

Domain ID.

-

certificate_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:domain_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.3020",
-  "error_msg" : "The URL domain does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/DisassociateDomainV2_1.html b/docs/apig/api-ref/DisassociateDomainV2_1.html deleted file mode 100644 index 81fbb44b..00000000 --- a/docs/apig/api-ref/DisassociateDomainV2_1.html +++ /dev/null @@ -1,300 +0,0 @@ - - -

Unbinding a Domain Name

-

Function

This API is used to unbind a custom domain name from an API group.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

domain_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.3474",
-  "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound"
-}
-

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.3020",
-  "error_msg" : "The URL domain does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/DisassociateRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/DisassociateRequestThrottlingPolicyV2_1.html deleted file mode 100644 index 9339baa3..00000000 --- a/docs/apig/api-ref/DisassociateRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Unbinding a Request Throttling Policy

-

Function

This API is used to unbind a request throttling policy from an API.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_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.

-

throttle_binding_id

-

Yes

-

String

-

ID of a request throttling policy binding record.

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3012",
-  "error_msg" : "The request throttling policy binding record does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Request Throttling Policies
-
-
- diff --git a/docs/apig/api-ref/DisassociateSignatureKeyV2_1.html b/docs/apig/api-ref/DisassociateSignatureKeyV2_1.html deleted file mode 100644 index bea46f22..00000000 --- a/docs/apig/api-ref/DisassociateSignatureKeyV2_1.html +++ /dev/null @@ -1,291 +0,0 @@ - - -

Unbinding a Signature Key

-

Function

This API is used to unbind a signature key from an API.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_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.

-

sign_bindings_id

-

Yes

-

String

-

Signature key binding record 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.

-
-
-
-

Response Parameters

Status code: 400

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

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.3018",
-  "error_msg" : "The signature key binding record does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Signature Keys
-
-
- diff --git a/docs/apig/api-ref/DomainnameManagement_1.html b/docs/apig/api-ref/DomainnameManagement_1.html deleted file mode 100644 index d4bfc7a8..00000000 --- a/docs/apig/api-ref/DomainnameManagement_1.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Domain Name Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/EnvManagement_1.html b/docs/apig/api-ref/EnvManagement_1.html deleted file mode 100644 index 76141fd1..00000000 --- a/docs/apig/api-ref/EnvManagement_1.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Environment Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/EnvVariableManagement_1.html b/docs/apig/api-ref/EnvVariableManagement_1.html deleted file mode 100644 index 1cc2a4b5..00000000 --- a/docs/apig/api-ref/EnvVariableManagement_1.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Environment Variable Management

-

-
-
- - -
-
Parent topic: Dedicated Gateway APIs (V2)
-
-
- diff --git a/docs/apig/api-ref/ErrorCode.html b/docs/apig/api-ref/ErrorCode.html index 480b992c..18dd3afc 100644 --- a/docs/apig/api-ref/ErrorCode.html +++ b/docs/apig/api-ref/ErrorCode.html @@ -1,3009 +1,3254 @@

Error Codes

-
-

Status Code

+
+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/apig/api-ref/ExportApiDefinitionsV2_1.html b/docs/apig/api-ref/ExportApiDefinitionsV2_1.html deleted file mode 100644 index 7e274add..00000000 --- a/docs/apig/api-ref/ExportApiDefinitionsV2_1.html +++ /dev/null @@ -1,421 +0,0 @@ - - -

Exporting APIs

-

Function

This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended fields of APIG, see section "Importing and Exporting APIs: Extended Definition" in the Developer Guide.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export

- -

Status Code

Error Codes

+

Error Codes

Error Message

+

Error Message

Description

+

Description

Solution

+

Solution

204

+

204

APIG.0000

+

APIG.0000

Successful

+

Successful

Successful

+

Successful

You do not need to take any actions.

+

You do not need to take any actions.

400

+

400

APIC.7211

+

APIC.7211

Parameter value does not match the rules

+

Parameter value does not match the rules

Parameter value does not match the rules

+

Parameter value does not match the rules

Modify the parameter value.

+

Modify the parameter value.

400

+

400

APIC.7230

+

APIC.7230

The maintenance time window must be 4 hours.

+

The maintenance time window must be 4 hours.

The maintenance time window must be 4 hours.

+

The maintenance time window must be 4 hours.

Modify the maintenance time window to 4 hours.

+

Modify the maintenance time window to 4 hours.

400

+

400

APIC.7235

+

APIC.7235

The maintenance time window must start or end with 2, 6, 10, 14, 18, or 22.

+

The maintenance time window must start or end with 2, 6, 10, 14, 18, or 22.

The maintenance time window must start or end with 2, 6, 10, 14, 18, or 22.

+

The maintenance time window must start or end with 2, 6, 10, 14, 18, or 22.

Modify the maintenance time window to start or end with 2, 6, 10, 14, 18, or 22.

+

Modify the maintenance time window to start or end with 2, 6, 10, 14, 18, or 22.

400

+

400

APIC.7238

+

APIC.7238

An AZ must be specified.

+

An AZ must be specified.

An AZ must be specified.

+

An AZ must be specified.

Specify an AZ when creating a gateway.

+

Specify an AZ when creating a gateway.

400

+

400

APIC.7239

+

APIC.7239

Invalid IP address.

+

Invalid IP address.

Invalid IP address.

+

Invalid IP address.

Enter a valid IP address.

+

Enter a valid IP address.

400

+

400

APIC.7241

+

APIC.7241

An enterprise project ID must be specified if you are an enterprise user.

+

An enterprise project ID must be specified if you are an enterprise user.

An enterprise project ID must be specified if you are an enterprise user.

+

An enterprise project ID must be specified if you are an enterprise user.

Specify an enterprise project ID.

+

Specify an enterprise project ID.

400

+

400

APIC.7242

+

APIC.7242

Load balancing is not supported by this edition.

+

Load balancing is not supported by this edition.

Load balancing is not supported by this edition.

+

Load balancing is not supported by this edition.

Change the gateway edition.

+

Change the gateway edition.

400

+

400

APIC.7243

+

APIC.7243

Scale-up is not supported by this edition.

+

Scale-up is not supported by this edition.

Scale-up is not supported by this edition.

+

Scale-up is not supported by this edition.

Change the gateway edition.

+

Change the gateway edition.

400

+

400

APIC.7244

+

APIC.7244

The bandwidth cannot be updated.

+

The bandwidth cannot be updated.

The bandwidth cannot be updated.

+

The bandwidth cannot be updated.

Do not perform this operation.

+

Do not perform this operation.

400

+

400

APIC.7500

+

APIC.7254

The gateway name already exists.

+

IPv6 access not supported.

The gateway name already exists.

+

IPv6 access not supported.

Use another gateway name.

+

Contact technical support.

400

+

400

APIC.7503

+

APIC.7255

Parameters az and azList cannot be used at the same time.

+

IPv6 not supported for the subnet used when creating the gateway or enabling IPv6 access.

Parameters az and azList cannot be used at the same time.

+

IPv6 not supported for the subnet used when creating the gateway or enabling IPv6 access.

Delete az or azList.

+

Use another subnet that supports IPv6.

400

+

400

APIC.7505

+

APIC.7257

The gateway ID already exists.

+

The custom inbound port is bound to a custom domain name.

The gateway ID already exists.

+

The port is bound to another API group.

Change the gateway ID.

+

Delete or modify the domain name bound to the custom inbound port.

400

+

400

APIC.9206

+

APIC.7258

Failed to create the gateway.

+

Port already defined.

Failed to create the gateway.

+

Port already defined.

If the resources are insufficient, expand the resources. If the network is abnormal, check the service network for connectivity.

+

Enter another port number.

400

+

400

APIC.9208

+

APIC.7312

Failed to disable public outbound access.

+

The AZ does not support IPv6.

Failed to disable public outbound access.

+

The AZ does not support IPv6.

Contact technical support to view the logs.

+

Use an AZ that supports IPv6.

400

+

400

APIC.9210

+

APIC.7313

create cloud nat eip failed

+

The bandwidth for IPv6 cannot be less than 5 MB.

create cloud nat eip failed

+

The bandwidth for IPv6 cannot be less than 5 MB.

Contact technical support to view the background logs.

+

Increase the bandwidth

400

+

400

APIC.9211

+

APIC.7500

update bandwidth size failed

+

The gateway name already exists.

update bandwidth size failed

+

The gateway name already exists.

Contact technical support.

+

Use another gateway name.

400

+

400

APIC.9215

+

APIC.7503

Failed to scale up the gateway.

+

Parameters az and azList cannot be used at the same time.

Failed to scale up the gateway.

+

Parameters az and azList cannot be used at the same time.

Contact technical support to view the background logs.

+

Delete az or azList.

400

+

400

APIC.9216

+

APIC.7505

Failed to enable public inbound access.

+

The gateway ID already exists.

Failed to enable public inbound access.

+

The gateway ID already exists.

Contact technical support to view the background logs.

+

Change the gateway ID.

400

+

400

APIC.9217

+

APIC.9206

Failed to accept VPC peering connection or create route

+

Failed to create the gateway.

Failed to accept VPC peering connection or create route

+

Failed to create the gateway.

Connect technical support to view background logs.

+

If the resources are insufficient, expand the resources. If the network is abnormal, check the service network for connectivity.

400

+

400

APIC.9218

+

APIC.9208

Create instance failed due to insufficient quota.

+

Failed to disable public outbound access.

Create instance failed due to insufficient quota.

+

Failed to disable public outbound access.

Increase the quota and try again.

+

Contact technical support to view the logs.

400

+

400

APIC.9219

+

APIC.9210

Create instance failed due to insufficient resources.

+

create cloud nat eip failed

Create instance failed due to insufficient resources.

+

create cloud nat eip failed

Expand the resource capacity and try again.

+

Contact technical support to view the background logs.

400

+

400

APIC.9222

+

APIC.9211

Lock gateway operation failed.

+

update bandwidth size failed

Lock gateway operation failed.

+

update bandwidth size failed

Contact technical support.

+

Contact technical support.

400

+

400

APIG.1119

+

APIC.9215

No permissions to perform this operation.

+

Failed to scale up the gateway.

No permissions to perform this operation.

+

Failed to scale up the gateway.

Apply for the required permissions and try again.

+

Contact technical support to view the background logs.

400

+

400

APIG.1120

+

APIC.9216

No permissions to create ELB channels.

+

Failed to enable public inbound access.

No permissions to create ELB channels.

+

Failed to enable public inbound access.

Ensure that the ELB channel belongs to your account. If you are an IAM user, apply for the required permissions.

+

Contact technical support to view the background logs.

400

+

400

APIG.1201

+

APIC.9217

The resources belong to different tenants.

+

Failed to accept VPC peering connection or create route

The resources belong to different tenants.

+

Failed to accept VPC peering connection or create route

Ensure that the resources belong to the same tenant.

+

Connect technical support to view background logs.

400

+

400

APIG.2000

+

APIC.9218

Parameter error.

+

Create instance failed due to insufficient quota.

Parameter error.

+

Create instance failed due to insufficient quota.

Modify the request parameters based on the reasons stated in the API response.

+

Increase the quota and try again.

400

+

400

APIG.2001

+

APIC.9219

The request parameters must be specified.

+

Create instance failed due to insufficient resources. +

The request parameters must be specified.

+

Create instance failed due to insufficient resources.

Set request parameters.

+

Expand the resource capacity and try again.

400

+

400

APIG.2002

+

APIC.9222

The parameter value is too small.

+

Lock gateway operation failed.

The parameter value is too small.

+

Lock gateway operation failed.

Modify the request parameter.

+

Contact technical support.

400

+

400

APIG.2003

+

APIC.9223

The parameter value is too large.

+

Delete custom inbound port failed.

The parameter value is too large.

+

Delete custom inbound port failed.

Modify the request parameter.

+

Try again later or contact technical support.

400

+

400

APIG.2004

+

APIC.9224

The parameter value is outside the allowable range.

+

Add custom inbound port failed.

The parameter value is outside the allowable range.

+

Add custom inbound port failed.

Modify the request parameter.

+

Try again later or contact technical support.

400

+

400

APIG.2005

+

APIG.1119

The parameter is too short.

+

No permissions to perform this operation.

The parameter is too short.

+

No permissions to perform this operation.

Modify the request parameter.

+

Apply for the required permissions and try again.

400

+

400

APIG.2006

+

APIG.1120

The parameter is too long.

+

No permissions to create ELB channels.

The parameter is too long.

+

No permissions to create ELB channels.

Modify the request parameter.

+

Ensure that the ELB channel belongs to your account. If you are an IAM user, apply for the required permissions.

400

+

400

APIG.2007

+

APIG.1201

Invalid length.

+

The resources belong to different tenants.

Invalid length.

+

The resources belong to different tenants.

Modify the request parameter.

+

Ensure that the resources belong to the same tenant.

400

+

400

APIG.2008

+

APIG.2000

Only letters are allowed.

+

Parameter error.

Only letters are allowed.

+

Parameter error.

Modify the request parameter.

+

Modify the request parameters based on the reasons stated in the API response.

400

+

400

APIG.2009

+

APIG.2001

Only digits are allowed.

+

The request parameters must be specified.

Only digits are allowed.

+

The request parameters must be specified.

Modify the request parameter.

+

Set request parameters.

400

+

400

APIG.2010

+

APIG.2002

Only letters and digits are allowed.

+

The parameter value is too small.

Only letters and digits are allowed.

+

The parameter value is too small.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2011

+

APIG.2003

Invalid parameter value.

+

The parameter value is too large.

Invalid parameter value.

+

The parameter value is too large.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2012

+

APIG.2004

Invalid parameter value.

+

The parameter value is outside the allowable range.

Invalid parameter value.

+

The parameter value is outside the allowable range.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2013

+

APIG.2005

Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

The parameter is too short.

Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

The parameter is too short.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2014

+

APIG.2006

Invalid email address.

+

The parameter is too long.

Invalid email address.

+

The parameter is too long.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2015

+

APIG.2007

Invalid IP address.

+

Invalid length.

Invalid IP address.

+

Invalid length.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2016

+

APIG.2008

The characters are not encoded using Base 64.

+

Only letters are allowed.

The characters are not encoded using Base 64.

+

Only letters are allowed.

Change the value of the request parameter to a Base 64-encoded character string.

+

Modify the request parameter.

400

+

400

APIG.2017

+

APIG.2009

Invalid mobile number.

+

Only digits are allowed.

Invalid mobile number.

+

Only digits are allowed.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2018

+

APIG.2010

Invalid telephone number.

+

Only letters and digits are allowed.

Invalid telephone number.

+

Only letters and digits are allowed.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2019

+

APIG.2011

Invalid telephone or mobile number.

+

Invalid parameter value.

Invalid telephone or mobile number.

+

Invalid parameter value.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2020

+

APIG.2012

Invalid postal code.

+

Invalid parameter value.

Invalid postal code.

+

Invalid parameter value.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2021

+

APIG.2013

The URL domain is not included in the IP address whitelist.

+

Only letters, digits, hyphens (-), and underscores (_) are allowed.

The URL domain is not included in the IP address whitelist.

+

Only letters, digits, hyphens (-), and underscores (_) are allowed.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2022

+

APIG.2014

The URL domain is included in the IP address blacklist.

+

Invalid email address.

The URL domain is included in the IP address blacklist.

+

Invalid email address.

Modify the request parameter.

+

Modify the request parameter.

400

+

400

APIG.2023

+

APIG.2015

URL domain CNAME resolution failed.

+

Invalid IP address.

URL domain CNAME resolution failed.

+

Invalid IP address.

Register the CNAME resolution record of the domain name.

+

Modify the request parameter.

400

+

400

APIG.2024

+

APIG.2016

Invalid URL domain.

+

The characters are not encoded using Base 64.

Invalid URL domain.

+

The characters are not encoded using Base 64.

Use a correct domain name.

+

Change the value of the request parameter to a Base 64-encoded character string.

400

+

400

APIG.2025

+

APIG.2017

Invalid port number.

+

Invalid mobile number.

Invalid port number.

+

Invalid mobile number.

Use a correct port number.

+

Modify the request parameter.

400

+

400

APIG.2026

+

APIG.2018

The request path parameters are not defined.

+

Invalid telephone number.

The request path parameters are not defined.

+

Invalid telephone number.

Add the parameters contained in the request path to the request parameters.

+

Modify the request parameter.

400

+

400

APIG.2027

+

APIG.2019

The backend path parameters are not defined.

+

Invalid telephone or mobile number.

The backend path parameters are not defined.

+

Invalid telephone or mobile number.

Add the parameters contained in the backend request path to the backend parameters.

+

Modify the request parameter.

400

+

400

APIG.2028

+

APIG.2020

The request parameters mapped to the backend parameters are not defined.

+

Invalid postal code.

The request parameters mapped to the backend parameters are not defined.

+

Invalid postal code.

Map the backend parameters to the correct request parameters.

+

Modify the request parameter.

400

+

400

APIG.2029

+

APIG.2021

The default certificate already exists.

+

The URL domain is not included in the IP address whitelist.

The default certificate already exists.

+

The URL domain is not included in the IP address whitelist.

Contact technical support.

+

Modify the request parameter.

400

+

400

APIG.2030

+

APIG.2022

Bad request for debugging the API.

+

The URL domain is included in the IP address blacklist.

Bad request for debugging the API.

+

The URL domain is included in the IP address blacklist.

Set correct API debugging parameters.

+

Modify the request parameter.

400

+

400

APIG.2034

+

APIG.2023

The domain name has not been filed. File it first.

+

URL domain CNAME resolution failed.

The domain name has not been filed. File it first.

+

URL domain CNAME resolution failed.

Complete ICP filing for the domain name.

+

Register the CNAME resolution record of the domain name.

400

+

400

APIG.2035

+

APIG.2024

The ICP Filing System is busy. Please try again later.

+

Invalid URL domain.

The ICP Filing System is busy. Please try again later.

+

Invalid URL domain.

Contact technical support.

+

Use a correct domain name.

400

+

400

APIG.2036

+

APIG.2025

Only APIs that use custom authentication can have authorizer parameters.

+

Invalid port number.

Only APIs that use custom authentication can have authorizer parameters.

+

Invalid port number.

Delete unnecessary parameters.

+

Use a correct port number.

400

+

400

APIG.2041

+

APIG.2026

Invalid microservice.

+

The request path parameters are not defined.

Invalid microservice.

+

The request path parameters are not defined.

Change service_id to a valid microservice ID.

+

Add the parameters contained in the request path to the request parameters.

400

+

400

APIG.2042

+

APIG.2027

Invalid engine.

+

The backend path parameters are not defined.

Invalid engine.

+

The backend path parameters are not defined.

Change engine_id to a valid microservice engine ID.

+

Add the parameters contained in the backend request path to the backend parameters.

400

+

400

APIG.2044

+

APIG.2028

Invalid title of info

+

The request parameters mapped to the backend parameters are not defined.

Invalid Info.title

+

The request parameters mapped to the backend parameters are not defined.

The Info.title must meet the documents

+

Map the backend parameters to the correct request parameters.

400

+

400

APIG.2045

+

APIG.2029

Parse Servers error. The Servers must meet the documents

+

The default certificate already exists.

Servers field parsing error. Servers field is invalid

+

The default certificate already exists.

The Servers must meet the documents

+

Contact technical support.

400

+

400

APIG.2101

+

APIG.2030

The certificate and private key do not match.

+

Bad request for debugging the API.

The certificate and private key do not match.

+

Bad request for debugging the API.

Use a certificate and private key that match each other.

+

Set correct API debugging parameters.

400

+

400

APIG.2102

+

APIG.2034

The certificate has expired.

+

The domain name has not been filed. File it first.

The certificate has expired.

+

The domain name has not been filed. File it first.

Use a valid certificate.

+

Complete ICP filing for the domain name.

400

+

400

APIG.2103

+

APIG.2035

The certificate domain name and the custom domain name do not match.

+

The ICP Filing System is busy. Please try again later.

The certificate domain name and the custom domain name do not match.

+

The ICP Filing System is busy. Please try again later.

Ensure that the domain name in the certificate is the same as the custom domain name.

+

Contact technical support.

400

+

400

APIG.2104

+

APIG.2036

The certificate chain is not matched.

+

Only APIs that use custom authentication can have authorizer parameters.

The certificate chain is not matched.

+

Only APIs that use custom authentication can have authorizer parameters.

In a certificate chain, ensure that the server certificate is in the first place and followed by other certificates in sequence.

+

Delete unnecessary parameters.

400

+

400

APIG.2105

+

APIG.2041

Encrypted private keys are not supported.

+

Invalid microservice.

Encrypted private keys are not supported.

+

Invalid microservice.

Use unencrypted private keys.

+

Change service_id to a valid microservice ID.

400

+

400

APIG.2106

+

APIG.2042

Invalid certificate or private key.

+

Invalid engine.

Invalid certificate or private key.

+

Invalid engine.

Use a correct certificate and private key.

+

Change engine_id to a valid microservice engine ID.

400

+

400

APIG.2108

+

APIG.2044

Microservice unavailable.

+

Invalid title of info

Microservice unavailable.

+

Invalid Info.title

Change service_id to the ID of an available microservice.

+

The Info.title must meet the documents

400

+

400

APIG.2109

+

APIG.2045

Invalid certificate. SAN missing.

+

Parse Servers error. The Servers must meet the documents

Invalid certificate. SAN missing.

+

Servers field parsing error. Servers field is invalid

Generate a new certifcate that contains a SAN.

+

The Servers must meet the documents

400

+

400

APIG.3148

+

APIG.2046

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

+

Incorrect custom authentication timeout.

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

+

Incorrect custom authentication timeout.

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

+

Modify the custom authentication timeout. It should be less than or equal to the function execution timeout and the V2 API timeout (600s).

400

+

400

APIG.3201

+

APIG.2047

The API group name already exists.

+

Incorrect number of retries for custom authentication.

The API group name already exists.

+

Set the number of custom authentication retries to a value between 0 and 10.

Use another name.

+

Set the number of custom authentication retries to a value between 0 and 10.

400

+

400

APIG.3202

+

APIG.2048

The API name already exists.

+

Incorrect Nacos configurations.

The API name already exists.

+

Incorrect Nacos configurations.

Use another name.

+

Correct the Nacos configurations.

400

+

400

APIG.3203

+

APIG.2049

The app name already exists.

+

The port is not in the defined custom inbound ports.

The app name already exists.

+

The port is not in the defined custom inbound ports.

Use another name.

+

Use the default HTTP/HTTPS port, or define a new port in the inbound rule.

400

+

400

APIG.3204

+

APIG.2050

The request throttling policy name already exists.

+

The combination of this domain name and port already exists.

The request throttling policy name already exists.

+

The combination of this domain name and port already exists.

Use another name.

+

Specify another domain name or port number.

400

+

400

APIG.3205

+

APIG.2051

The environment name already exists.

+

A domain name cannot be bound with different certificates.

The environment name already exists.

+

A domain name cannot be bound with different certificates.

Use another name.

+

Bind the same certificate.

400

+

400

APIG.3206

+

APIG.2101

The access control policy name already exists.

+

The certificate and private key do not match.

The access control policy name already exists.

+

The certificate and private key do not match.

Use another name.

+

Use a certificate and private key that match each other.

400

+

400

APIG.3207

+

APIG.2102

The signature key name already exists.

+

The certificate has expired.

The signature key name already exists.

+

The certificate has expired.

Use another name.

+

Use a valid certificate.

400

+

400

APIG.3208

+

APIG.2103

The VPC channel name already exists.

+

The certificate domain name and the custom domain name do not match.

The VPC channel name already exists.

+

The certificate domain name and the custom domain name do not match.

Use another name.

+

Ensure that the domain name in the certificate is the same as the custom domain name.

400

+

400

APIG.3209

+

APIG.2104

The parameter name already exists.

+

The certificate chain is not matched.

The parameter name already exists.

+

The certificate chain is not matched.

Use another name.

+

In a certificate chain, ensure that the server certificate is in the first place and followed by other certificates in sequence.

400

+

400

APIG.3210

+

APIG.2105

The backend policy name already exists.

+

Encrypted private keys are not supported.

The backend policy name already exists.

+

Encrypted private keys are not supported.

Use another name.

+

Use unencrypted private keys.

400

+

400

APIG.3211

+

APIG.2106

The authorizer name already exists.

+

Invalid certificate or private key.

The authorizer name already exists.

+

Invalid certificate or private key.

Use another name.

+

Use a correct certificate and private key.

400

+

400

APIG.3212

+

APIG.2108

The identity source name already exists.

+

Microservice unavailable.

The identity source name already exists.

+

Microservice unavailable.

Use another name.

+

Change service_id to the ID of an available microservice.

400

+

400

APIG.3213

+

APIG.2109

The tag name already exists.

+

Invalid certificate. SAN missing.

The tag name already exists.

+

Invalid certificate. SAN missing.

Use another name.

+

Generate a new certificate that contains a SAN.

400

+

400

APIG.3216

+

APIG.3073

The response name already exists.

+

The IP address or IP address/CIDR mask does not exist.

The response name already exists.

+

The IP address or IP address/CIDR mask does not exist.

Use another name.

+

Check the IP address or IP address/CIDR mask.

400

+

400

APIG.3301

+

APIG.3148

The API already exists.

+

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

The API already exists.

+

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

Change the request method and URL of the API.

+

Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC.

400

+

400

APIG.3302

+

APIG.3153

The excluded configuration already exists.

+

The number of custom GeoIPs exceeds the limit.

The excluded configuration already exists.

+

The number of custom GeoIPs exceeds the limit.

Use another name.

+

Delete unnecessary custom GeoIPs.

400

+

400

APIG.3303

+

APIG.3201

The environment variable already exists.

+

The API group name already exists.

The environment variable already exists.

+

The API group name already exists.

Use another name.

+

Use another name.

400

+

400

APIG.3304

+

APIG.3202

The purchasing order already exists.

+

The API name already exists.

The purchasing order already exists.

+

The API name already exists.

Contact technical support.

+

Use another name.

400

+

400

APIG.3305

+

APIG.3203

The URL domain name already exists.

+

The app name already exists.

The URL domain name already exists.

+

The app name already exists.

Contact technical support.

+

Use another name.

400

+

400

APIG.3306

+

APIG.3204

The IP address already exists.

+

The request throttling policy name already exists.

The IP address already exists.

+

The request throttling policy name already exists.

Contact technical support.

+

Use another name.

400

+

400

APIG.3308

+

APIG.3205

The excluded request throttling configuration already exists.

+

The environment name already exists.

The excluded request throttling configuration already exists.

+

The environment name already exists.

Contact technical support.

+

Use another name.

400

+

400

APIG.3309

+

APIG.3206

The operation has already been performed.

+

The access control policy name already exists.

The operation has already been performed.

+

The access control policy name already exists.

Contact technical support.

+

Use another name.

400

+

400

APIG.3310

+

APIG.3207

The AppKey already exists.

+

The signature key name already exists.

The AppKey already exists.

+

The signature key name already exists.

Use another AppKey.

+

Use another name.

400

+

400

APIG.3316

+

APIG.3208

The API authorization record already exists.

+

The VPC channel name already exists.

The API authorization record already exists.

+

The VPC channel name already exists.

Use another API or app.

+

Use another name.

400

+

400

APIG.3330

+

APIG.3209

VPC already bound to a microservice.

+

The parameter name already exists.

VPC already bound to a microservice.

+

The parameter name already exists.

Change vpc_channel_id to another ID not bound to any microservice.

+

Use another name.

400

+

400

APIG.3331

+

APIG.3210

The orchestration rule name already exists.

+

The backend policy name already exists.

The orchestration rule name already exists.

+

The backend policy name already exists.

Use a unique rule name.

+

Use another name.

400

+

400

APIG.3600

+

APIG.3211

JSON or YAML format error.

+

The authorizer name already exists.

JSON or YAML format error.

+

The authorizer name already exists.

Check whether the file to be imported is in correct YAML or JSON format.

+

Use another name.

400

+

400

APIG.3601

+

APIG.3212

The Swagger file version must be 2.0.

+

The identity source name already exists.

The Swagger file version must be 2.0.

+

The identity source name already exists.

Ensure that the Swagger file version is 2.0.

+

Use another name.

400

+

400

APIG.3602

+

APIG.3213

Syntax error in the Swagger file.

+

The tag name already exists.

Syntax error in the Swagger file.

+

The tag name already exists.

Check for syntax errors in the Swagger file.

+

Use another name.

400

+

400

APIG.3603

+

APIG.3216

The Swagger file content is too long.

+

The response name already exists.

The Swagger file content is too long.

+

The response name already exists.

Reduce the size of the Swagger file.

+

Use another name.

400

+

400

APIG.3608

+

APIG.3301

The API Designer does not support API modification.

+

The API already exists.

The API Designer does not support API modification.

+

The API already exists.

Contact technical support.

+

Change the request method and URL of the API.

400

+

400

APIG.3609

+

APIG.3302

The input file is empty.

+

The excluded configuration already exists.

The input file is empty.

+

The excluded configuration already exists.

Use a file that is not empty.

+

Use another name.

400

+

400

APIG.3710

+

APIG.3303

The VPC channel is being used by another third_auth plugin

+

The environment variable already exists.

The VPC channel is being used by another third_auth plugin

+

The environment variable already exists.

Unbind the third-party plug-in from the load balance channel, and then delete the load balance channel.

+

Use another name.

400

+

400

APIG.3715

+

APIG.3304

A domain name can only be bound with CA certificates of the same algorithm type.

+

The purchasing order already exists.

A domain name can only be bound with CA certificates of the same algorithm type.

+

The purchasing order already exists.

Unbind the existing CA certificates and try again.

+

Contact technical support.

401

+

400

APIC.7100

+

APIG.3305

Token missing. Log in again or try again later.

+

The URL domain name already exists.

Token missing. Log in again or try again later.

+

The URL domain name already exists.

Provide a token.

+

Contact technical support.

401

+

400

APIC.7101

+

APIG.3306

Token expired. Try again later.

+

The IP address already exists.

Token expired. Try again later.

+

The IP address already exists.

Obtain a new token.

+

Contact technical support.

401

+

400

APIC.7102

+

APIG.3308

Incorrect token or token resolution failure

+

The excluded request throttling configuration already exists.

Incorrect token or token resolution failure

+

The excluded request throttling configuration already exists.

Contact technical support to check the token encryption/decryption setting.

+

Contact technical support.

401

+

400

APIC.7103

+

APIG.3309

Token contains no project information.

+

The operation has already been performed.

Token contains no project information.

+

The operation has already been performed.

Specify project information when obtaining a token.

+

Contact technical support.

401

+

400

APIC.7105

+

APIG.3310

Token contains no user information.

+

The AppKey already exists.

Token contains no user information.

+

The AppKey already exists.

Specify user information when obtaining a token.

+

Use another AppKey.

401

+

400

APIC.7107

+

APIG.3316

Token contains no role information.

+

The API authorization record already exists.

Token contains no role information.

+

The API authorization record already exists.

Specify role information when obtaining a token.

+

Use another API or app.

401

+

400

APIG.1000

+

APIG.3330

Token missing. Log in again or try again later.

+

VPC already bound to a microservice.

Token missing. Log in again or try again later.

+

VPC already bound to a microservice.

Provide a token.

+

Change vpc_channel_id to another ID not bound to any microservice.

401

+

400

APIG.1001

+

APIG.3331

Session expired. Please try again later.

+

The orchestration rule name already exists.

Session expired. Please try again later.

+

The orchestration rule name already exists.

Obtain another token and try again.

+

Use a unique rule name.

401

+

400

APIG.1002

+

APIG.3332

Incorrect token or token resolution failed.

+

The IP address or IP address/CIDR mask already exists.

Incorrect token or token resolution failed..

+

The IP address or IP address/CIDR mask already exists.

Use a correct token.

+

Check whether the IP address or IP address/CIDR mask is unique.

401

+

400

APIG.1003

+

APIG.3600

Token contains no project information.

+

JSON or YAML format error.

Token contains no project information.

+

JSON or YAML format error.

Use a token containing project information.

+

Check whether the file to be imported is in correct YAML or JSON format.

401

+

400

APIG.1005

+

APIG.3601

No permissions to request this method

+

The Swagger file version must be 2.0.

No permissions to request this method

+

The Swagger file version must be 2.0.

Use a token with the required permissions.

+

Ensure that the Swagger file version is 2.0.

401

+

400

APIG.1007

+

APIG.3602

Token contains no domain information.

+

Syntax error in the Swagger file.

Token contains no domain information.

+

Syntax error in the Swagger file.

Contact technical support.

+

Check for syntax errors in the Swagger file.

401

+

400

APIG.1008

+

APIG.3603

Invalid domain.

+

The Swagger file content is too long.

Invalid domain.

+

The Swagger file content is too long.

Contact technical support.

+

Reduce the size of the Swagger file.

401

+

400

APIG.1009

+

APIG.3608

Token contains no user information.

+

The API Designer does not support API modification.

Token contains no user information.

+

The API Designer does not support API modification.

Use a token containing user information.

+

Contact technical support.

401

+

400

APIG.1010

+

APIG.3609

PDP server connection failed.

+

The input file is empty.

PDP server connection failed.

+

The input file is empty.

Contact technical support.

+

Use a file that is not empty.

401

+

400

APIG.1011

+

APIG.3710

You can request resources only after you complete real-name authentication.

+

The VPC channel is being used by another third_auth plugin

You can request resources only after you complete real-name authentication.

+

The VPC channel is being used by another third_auth plugin

Perform real-name authentication for your account and try again.

+

Unbind the third-party plug-in from the load balance channel, and then delete the load balance channel.

401

+

400

APIG.1012

+

APIG.3715

Your account balance is insufficient. Top up your account.

+

A domain name can only be bound with CA certificates of the same algorithm type.

Your account balance is insufficient. Top up your account.

+

A domain name can only be bound with CA certificates of the same algorithm type.

Top up your account.

+

Unbind the existing CA certificates and try again.

401

+

400

APIG.1013

+

APIG.3717

Your account has been frozen. Some functions become unavailable. To unfreeze your account, contact customer service.

+

Two-way TLS authentication not supported for HTTP or GRPC backend requests.

Your account has been frozen. Some functions become unavailable. To unfreeze your account, contact customer service.

+

Two-way TLS authentication not supported for HTTP or GRPC backend requests.

Restore your account and try again.

+

Disable two-way TLS authentication first.

403

+

401

APIC.7106

+

APIC.7100

Operation restricted. Check at My Account.

+

Token missing. Log in again or try again later.

Operation restricted. Check at My Account.

+

Token missing. Log in again or try again later.

Use a token with the required permissions.

+

Provide a token.

403

+

401

APIC.7109

+

APIC.7101

Access denied because your account is suspended.

+

Token expired. Try again later.

Access denied because your account is suspended.

+

Token expired. Try again later.

Restore your account first.

+

Obtain a new token.

403

+

401

APIC.7110

+

APIC.7102

Your account only has read permissions and can only send GET requests.

+

Incorrect token or token resolution failure

Your account only has read permissions and can only send GET requests.

+

Incorrect token or token resolution failure

Contact the account administrator to grant you administrator or fine-grained permissions.

+

Contact technical support to check the token encryption/decryption setting.

403

+

401

APIC.7111

+

APIC.7103

The requested resource does not belong to your account.

+

Token contains no project information.

The requested resource does not belong to your account.

+

Token contains no project information.

Use a correct token.

+

Specify project information when obtaining a token.

403

+

401

APIC.7118

+

APIC.7105

User domain does not match.

+

Token contains no user information.

User domain does not match.

+

Token contains no user information.

Check the domain info.

+

Specify user information when obtaining a token.

403

+

401

APIC.7130

+

APIC.7107

No permissions to access gateways in other projects.

+

Token contains no role information.

No permissions to access gateways in other projects.

+

Token contains no role information.

Specify the correct project ID.

+

Specify role information when obtaining a token.

403

+

401

APIC.7134

+

APIG.1000

No permissions to access this enterprise project.

+

Token missing. Log in again or try again later.

No permissions to access this enterprise project.

+

Token missing. Log in again or try again later.

Use an enterprise project that you have permissions to access.

+

Provide a token.

403

+

401

APIC.7300

+

APIG.1001

You do not have permission to perform action {x} on resource {x}.

+

Session expired. Please try again later.

You do not have permission to perform action {x} on resource {x}.

+

Session expired. Please try again later.

Check your permissions.

+

Obtain another token and try again.

403

+

401

APIC.7400

+

APIG.1002

Maximum number of gateways reached.

+

Incorrect token or token resolution failed.

Maximum number of gateways reached.

+

Incorrect token or token resolution failed..

Contact technical support to increase the gateway quota.

+

Use a correct token.

403

+

401

APIC.7402

+

APIG.1003

The number of tags exceeds the maximum allowed limit.

+

Token contains no project information.

The number of tags exceeds the maximum allowed limit.

+

Token contains no project information.

Delete unnecessary tags.

+

Use a token containing project information.

403

+

401

APIG.1020

+

APIG.1005

Insufficient permissions.

+

No permissions to request this method

Insufficient permissions.

+

No permissions to request this method

Grant the read and write permissions to the user.

+

Use a token with the required permissions.

403

+

401

APIG.1101

+

APIG.1007

No permissions to perform operations on this API group.

+

Token contains no domain information.

No permissions to perform operations on this API group.

+

Token contains no domain information.

Ensure that the API group belongs to your account. If you are an IAM user, apply for the required permissions.

+

Contact technical support.

403

+

401

APIG.1102

+

APIG.1008

No permissions to perform operations on this API.

+

Invalid domain.

No permissions to perform operations on this API.

+

Invalid domain.

Ensure that the API belongs to your account. If you are an IAM user, apply for the required permissions.

+

Contact technical support.

403

+

401

APIG.1103

+

APIG.1009

No permissions to perform operations on this environment.

+

Token contains no user information.

No permissions to perform operations on this environment.

+

Token contains no user information.

Ensure that the environment belongs to your account. If you are an IAM user, apply for the required permissions.

+

Use a token containing user information.

403

+

401

APIG.1104

+

APIG.1010

No permissions to perform operations on this app.

+

PDP server connection failed.

No permissions to perform operations on this app.

+

PDP server connection failed.

Ensure that the app belongs to your account. If you are an IAM user, apply for the required permissions.

+

Contact technical support.

403

+

401

APIG.1105

+

APIG.1011

No permissions to perform operations on this request throttling policy.

+

You can request resources only after you complete real-name authentication.

No permissions to perform operations on this request throttling policy.

+

You can request resources only after you complete real-name authentication.

Ensure that the request throttling policy belongs to your account. If you are an IAM user, apply for the required permissions.

+

Perform real-name authentication for your account and try again.

403

+

401

APIG.1106

+

APIG.1012

No permissions to perform operations on this access control policy.

+

Your account balance is insufficient. Top up your account.

No permissions to perform operations on this access control policy.

+

Your account balance is insufficient. Top up your account.

Ensure that the access control policy belongs to your account. If you are an IAM user, apply for the required permissions.

+

Top up your account.

403

+

401

APIG.1107

+

APIG.1013

No permissions to perform operations on this configuration.

+

Your account has been frozen. Some functions become unavailable. To unfreeze your account, contact customer service.

No permissions to perform operations on this configuration.

+

Your account has been frozen. Some functions become unavailable. To unfreeze your account, contact customer service.

Contact technical support.

+

Restore your account and try again.

403

+

403

APIG.1108

+

APIC.7106

No permissions to perform operations on this excluded configuration.

+

Operation restricted. Check at My Account.

No permissions to perform operations on this excluded configuration.

+

Operation restricted. Check at My Account.

Contact technical support.

+

Use a token with the required permissions.

403

+

403

APIG.1109

+

APIC.7109

No permissions to perform operations on this app authorization record.

+

Access denied because your account is suspended.

No permissions to perform operations on this app authorization record.

+

Access denied because your account is suspended.

Ensure that the app authorization information belongs to your account. If you are an IAM user, apply for the required permissions.

+

Restore your account first.

403

+

403

APIG.1110

+

APIC.7110

No permissions to perform operations on this environment variable.

+

Your account only has read permissions and can only send GET requests.

No permissions to perform operations on this environment variable.

+

Your account only has read permissions and can only send GET requests.

Ensure that the environment variable belongs to your account. If you are an IAM user, apply for the required permissions.

+

Contact the account administrator to grant you administrator or fine-grained permissions.

403

+

403

APIG.1111

+

APIC.7111

No permissions to perform operations on this subscription record.

+

The requested resource does not belong to your account.

No permissions to perform operations on this subscription record.

+

The requested resource does not belong to your account.

Ensure that the subscription belongs to your account. If you are an IAM user, apply for the required permissions.

+

Use a correct token.

403

+

403

APIG.1112

+

APIC.7118

No permissions to perform operations on this signature key.

+

User domain does not match.

No permissions to perform operations on this signature key.

+

User domain does not match.

Ensure that the signature key belongs to your account. If you are an IAM user, apply for the required permissions.

+

Check the domain info.

403

+

403

APIG.1113

+

APIC.7130

No permissions to perform operations on this VPC channel.

+

No permissions to access gateways in other projects.

No permissions to perform operations on this VPC channel.

+

No permissions to access gateways in other projects.

Ensure that the VPC channel belongs to your account. If you are an IAM user, apply for the required permissions.

+

Specify the correct project ID.

403

+

403

APIG.1115

+

APIC.7134

No permissions to perform operations on this certificate.

+

No permissions to access this enterprise project.

No permissions to perform operations on this certificate.

+

No permissions to access this enterprise project.

Ensure that the certificate belongs to your account. If you are an IAM user, apply for the required permissions.

+

Use an enterprise project that you have permissions to access.

403

+

403

APIG.1116

+

APIC.7300

No permissions to perform operations on this on-sale API.

+

You do not have permission to perform action {x} on resource {x}.

No permissions to perform operations on this on-sale API.

+

You do not have permission to perform action {x} on resource {x}.

Ensure that the API belongs to your account. If you are an IAM user, apply for the required permissions.

+

Check your permissions.

403

+

403

APIG.1136

+

APIC.7400

No permissions to perform operations on this instance.

+

Maximum number of gateways reached.

No permissions to perform operations on this instance.

+

Maximum number of gateways reached.

Contact technical support.

+

Contact technical support to increase the gateway quota.

403

+

403

APIG.1137

+

APIC.7402

No permissions to perform operations on this authorizer.

+

The number of tags exceeds the maximum allowed limit.

No permissions to perform operations on this authorizer.

+

The number of tags exceeds the maximum allowed limit.

Ensure that the custom authorizer belongs to your account. If you are an IAM user, apply for the required permissions.

+

Delete unnecessary tags.

403

+

403

APIG.1140

+

APIC.7403

No permissions to perform operations on this feature.

+

The number of custom inbound ports has reached the maximum.

No permissions to perform operations on this feature.

+

The number of custom inbound ports has reached the maximum.

Ensure that the feature belongs to your account. If you are an IAM user, apply for the required permissions.

+

Increase the quota for custom inbound ports.

403

+

403

APIG.1200

+

APIG.1020

No permissions to perform operations on this API Swagger file.

+

Insufficient permissions. +

No permissions to perform operations on this API Swagger file.

+

Insufficient permissions. +

Ensure that the Swagger file belongs to your account. If you are an IAM user, apply for the required permissions.

+

Grant the read and write permissions to the user.

403

+

403

APIG.1301

+

APIG.1101

No permissions to perform operations on this domain

+

No permissions to perform operations on this API group.

No permissions to perform operations on this domain

+

No permissions to perform operations on this API group.

The domain to be operated must be under your own account.

+

Ensure that the API group belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3100

+

APIG.1102

The number of resources exceeds the maximum allowed limit.

+

No permissions to perform operations on this API.

The number of resources exceeds the maximum allowed limit.

+

No permissions to perform operations on this API.

Contact technical support to increase the quota.

+

Ensure that the API belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3101

+

APIG.1103

The number of API groups exceeds the maximum allowed limit.

+

No permissions to perform operations on this environment.

The number of API groups exceeds the maximum allowed limit.

+

No permissions to perform operations on this environment.

Contact technical support to increase the quota.

+

Ensure that the environment belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3102

+

APIG.1104

The number of APIs exceeds the maximum allowed limit.

+

No permissions to perform operations on this app.

The number of APIs exceeds the maximum allowed limit.

+

No permissions to perform operations on this app.

Contact technical support to increase the quota.

+

Ensure that the app belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3103

+

APIG.1105

The number of apps exceeds the maximum allowed limit.

+

No permissions to perform operations on this request throttling policy.

The number of apps exceeds the maximum allowed limit.

+

No permissions to perform operations on this request throttling policy.

Contact technical support to increase the quota.

+

Ensure that the request throttling policy belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3104

+

APIG.1106

The number of environments exceeds the maximum allowed limit.

+

No permissions to perform operations on this access control policy.

The number of environments exceeds the maximum allowed limit.

+

No permissions to perform operations on this access control policy.

Contact technical support to increase the quota.

+

Ensure that the access control policy belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3105

+

APIG.1107

The number of signature keys exceeds the maximum allowed limit.

+

No permissions to perform operations on this configuration.

The number of signature keys exceeds the maximum allowed limit.

+

No permissions to perform operations on this configuration.

Contact technical support to increase the quota.

+

Contact technical support.

403

+

403

APIG.3106

+

APIG.1108

The number of variables exceeds the maximum allowed limit.

+

No permissions to perform operations on this excluded configuration.

The number of variables exceeds the maximum allowed limit.

+

No permissions to perform operations on this excluded configuration.

Contact technical support to increase the quota.

+

Contact technical support.

403

+

403

APIG.3107

+

APIG.1109

The number of request throttling policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this app authorization record.

The number of request throttling policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this app authorization record.

Contact technical support to increase the quota.

+

Ensure that the app authorization information belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3108

+

APIG.1110

The number of domain names exceeds the maximum allowed limit.

+

No permissions to perform operations on this environment variable.

The number of domain names exceeds the maximum allowed limit.

+

No permissions to perform operations on this environment variable.

Contact technical support to increase the quota.

+

Ensure that the environment variable belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3109

+

APIG.1111

The number of VPC channels exceeds the maximum allowed limit.

+

No permissions to perform operations on this subscription record.

The number of VPC channels exceeds the maximum allowed limit.

+

No permissions to perform operations on this subscription record.

Contact technical support to increase the quota.

+

Ensure that the subscription belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3110

+

APIG.1112

The number of cloud servers in the VPC channel exceeds the maximum allowed limit.

+

No permissions to perform operations on this signature key.

The number of cloud servers in the VPC channel exceeds the maximum allowed limit.

+

No permissions to perform operations on this signature key.

Contact technical support to increase the quota.

+

Ensure that the signature key belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3111

+

APIG.1113

The number of parameters in req_params exceeds the maximum allowed limit.

+

No permissions to perform operations on this VPC channel.

The number of parameters in req_params exceeds the maximum allowed limit.

+

No permissions to perform operations on this VPC channel.

Contact technical support to increase the quota.

+

Ensure that the VPC channel belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3112

+

APIG.1115

The number of access control policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this certificate.

The number of access control policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this certificate.

Contact technical support to increase the quota.

+

Ensure that the certificate belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3113

+

APIG.1116

The number of API backend policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this on-sale API.

The number of API backend policies exceeds the maximum allowed limit.

+

No permissions to perform operations on this on-sale API.

Contact technical support to increase the quota.

+

Ensure that the API belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3114

+

APIG.1136

The number of policy conditions exceeds the maximum allowed limit.

+

No permissions to perform operations on this instance.

The number of policy conditions exceeds the maximum allowed limit.

+

No permissions to perform operations on this instance.

Contact technical support to increase the quota.

+

Contact technical support.

403

+

403

APIG.3116

+

APIG.1137

The number of authorizers exceeds the maximum allowed limit.

+

No permissions to perform operations on this authorizer.

The number of authorizers exceeds the maximum allowed limit.

+

No permissions to perform operations on this authorizer.

Contact technical support to increase the quota.

+

Ensure that the custom authorizer belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3117

+

APIG.1140

The number of identity sources exceeds the maximum allowed limit.

+

No permissions to perform operations on this feature.

The number of identity sources exceeds the maximum allowed limit.

+

No permissions to perform operations on this feature.

Contact technical support to increase the quota.

+

Ensure that the feature belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3125

+

APIG.1200

The number of APIs in the API group exceeds the maximum allowed limit.

+

No permissions to perform operations on this API Swagger file.

The number of APIs in the API group exceeds the maximum allowed limit.

+

No permissions to perform operations on this API Swagger file.

Contact technical support to increase the quota.

+

Ensure that the Swagger file belongs to your account. If you are an IAM user, apply for the required permissions.

403

+

403

APIG.3127

+

APIG.1301

The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time.

+

No permissions to perform operations on this domain

The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time.

+

No permissions to perform operations on this domain

Reduce the number of APIs to import.

+

The domain to be operated must be under your own account.

403

+

403

APIG.3131

+

APIG.3100

The number of AppCodes exceeds the maximum allowed limit.

+

The number of resources exceeds the maximum allowed limit.

The number of AppCodes exceeds the maximum allowed limit.

+

The number of resources exceeds the maximum allowed limit.

Contact technical support to increase the quota.

+

Contact technical support to increase the quota.

403

+

403

APIG.3132

+

APIG.3101

The number of Swagger APIs in the API group exceeds the maximum allowed limit.

+

The number of API groups exceeds the maximum allowed limit.

The number of Swagger APIs in the API group exceeds the maximum allowed limit.

+

The number of API groups exceeds the maximum allowed limit.

Contact technical support to increase the quota.

+

Contact technical support to increase the quota.

403

+

403

APIG.3133

+

APIG.3102

The number of API tags exceeds the maximum allowed limit.

+

The number of APIs exceeds the maximum allowed limit.

The number of API tags exceeds the maximum allowed limit.

+

The number of APIs exceeds the maximum allowed limit.

Contact technical support to increase the quota.

+

Contact technical support to increase the quota.

403

+

403

APIG.3136

+

APIG.3103

The number of responses exceeds the maximum allowed limit.

+

The number of apps exceeds the maximum allowed limit.

The number of responses exceeds the maximum allowed limit.

+

The number of apps exceeds the maximum allowed limit.

Contact technical support to increase the quota.

+

Contact technical support to increase the quota.

403

+

403

APIG.3150

+

APIG.3104

The number of orchestration rules exceeds the maximum.

+

The number of environments exceeds the maximum allowed limit.

The number of orchestration rules exceeds the maximum.

+

The number of environments exceeds the maximum allowed limit.

Contact technical support to increase the quota of orchestration rules.

+

Contact technical support to increase the quota.

403

+

403

APIG.3151

+

APIG.3105

The number of orchestration rules bound to the API exceeds the maximum.

+

The number of signature keys exceeds the maximum allowed limit.

The number of orchestration rules bound to the API exceeds the maximum.

+

The number of signature keys exceeds the maximum allowed limit.

Contact technical support to increase the quota of orchestration rules that can be bound to the API.

+

Contact technical support to increase the quota.

403

+

403

APIG.3411

+

APIG.3106

The APIs belong to different tenants.

+

The number of variables exceeds the maximum allowed limit.

The APIs belong to different tenants.

+

The number of variables exceeds the maximum allowed limit.

This operation is not allowed.

+

Contact technical support to increase the quota.

403

+

403

APIG.3412

+

APIG.3107

The API provider has been frozen.

+

The number of request throttling policies exceeds the maximum allowed limit.

The API provider has been frozen.

+

The number of request throttling policies exceeds the maximum allowed limit.

Contact technical support.

+

Contact technical support to increase the quota.

403

+

403

APIG.3414

+

APIG.3108

The VPC channel is already being used by another API.

+

The number of domain names exceeds the maximum allowed limit.

The VPC channel is already being used by another API.

+

The number of domain names exceeds the maximum allowed limit.

Delete the API associated with the VPC channel and then delete the VPC channel.

+

Contact technical support to increase the quota.

403

+

403

APIG.3415

+

APIG.3109

The API group cannot be deleted because it contains APIs.

+

The number of VPC channels exceeds the maximum allowed limit.

The API group cannot be deleted because it contains APIs.

+

The number of VPC channels exceeds the maximum allowed limit.

Delete the APIs in the API group and then delete the API group.

+

Contact technical support to increase the quota.

403

+

403

APIG.3416

+

APIG.3110

The API cannot be deleted because it has been published.

+

The number of cloud servers in the VPC channel exceeds the maximum allowed limit.

The API cannot be deleted because it has been published.

+

The number of cloud servers in the VPC channel exceeds the maximum allowed limit.

Take the API offline and then delete it.

+

Contact technical support to increase the quota.

403

+

403

APIG.3418

+

APIG.3111

The environment contains published APIs.

+

The number of parameters in req_params exceeds the maximum allowed limit.

The environment contains published APIs.

+

The number of parameters in req_params exceeds the maximum allowed limit.

This operation is not allowed.

+

Contact technical support to increase the quota.

403

+

403

APIG.3420

+

APIG.3112

The API group is no longer available on the marketplace.

+

The number of access control policies exceeds the maximum allowed limit.

The API group is no longer available on the marketplace.

+

The number of access control policies exceeds the maximum allowed limit.

Check whether the API group has been listed on the marketplace.

+

Contact technical support to increase the quota.

403

+

403

APIG.3447

+

APIG.3113

The access control policy cannot be deleted because it has been bound to APIs.

+

The number of API backend policies exceeds the maximum allowed limit.

The access control policy cannot be deleted because it has been bound to APIs.

+

The number of API backend policies exceeds the maximum allowed limit.

Delete the APIs bound with the access control policy and then delete the access control policy.

+

Contact technical support to increase the quota.

403

+

403

APIG.3451

+

APIG.3114

The request throttling policy cannot be deleted because it has been bound to APIs.

+

The number of policy conditions exceeds the maximum allowed limit.

The request throttling policy cannot be deleted because it has been bound to APIs.

+

The number of policy conditions exceeds the maximum allowed limit.

Delete the APIs bound with the request throttling policy and then delete the request throttling policy.

+

Contact technical support to increase the quota.

403

+

403

APIG.3471

+

APIG.3116

The operation cannot be performed on this type of VPC channel.

+

The number of authorizers exceeds the maximum allowed limit.

The operation cannot be performed on this type of VPC channel.

+

The number of authorizers exceeds the maximum allowed limit.

This operation is not allowed.

+

Contact technical support to increase the quota.

403

+

403

APIG.3472

+

APIG.3117

The load balancer is already being used by another VPC channel.

+

The number of identity sources exceeds the maximum allowed limit.

The load balancer is already being used by another VPC channel.

+

The number of identity sources exceeds the maximum allowed limit.

Unbind the load balancer from the VPC channel.

+

Contact technical support to increase the quota.

403

+

403

APIG.3473

+

APIG.3125

The load balancer has already been bound to another endpoint service.

+

The number of APIs in the API group exceeds the maximum allowed limit.

The load balancer has already been bound to another endpoint service.

+

The number of APIs in the API group exceeds the maximum allowed limit.

This operation is not allowed.

+

Contact technical support to increase the quota.

403

+

403

APIG.3474

+

APIG.3127

The API group ID in the URL does not match the API group to which the URL domain has been bound.

+

The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time.

The API group ID in the URL does not match the API group to which the URL domain has been bound.

+

The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time.

Change the API group specified in the URL to the API group associated with the domain name.

+

Reduce the number of APIs to import.

404

+

403

APIC.7301

+

APIG.3131

Instance spec not found

+

The number of AppCodes exceeds the maximum allowed limit.

Instance spec not found

+

The number of AppCodes exceeds the maximum allowed limit.

Use a valid instance spec.

+

Contact technical support to increase the quota.

404

+

403

APIC.7302

+

APIG.3132

Instance not found

+

The number of Swagger APIs in the API group exceeds the maximum allowed limit.

Instance not found

+

The number of Swagger APIs in the API group exceeds the maximum allowed limit.

Check whether the instance exists and use a valid instance ID.

+

Contact technical support to increase the quota.

404

+

403

APIC.7307

+

APIG.3133

The security group does not exist in the VPC.

+

The number of API tags exceeds the maximum allowed limit.

The security group does not exist in the VPC.

+

The number of API tags exceeds the maximum allowed limit.

Use an existing security group.

+

Contact technical support to increase the quota.

404

+

403

APIC.7310

+

APIG.3136

The region does not have any AZs.

+

The number of responses exceeds the maximum allowed limit.

The region does not have any AZs.

+

The number of responses exceeds the maximum allowed limit.

Use another region.

+

Contact technical support to increase the quota.

404

+

403

APIC.7311

+

APIG.3150

The NAT EIP does not exist in the VPC.

+

The number of orchestration rules exceeds the maximum.

The NAT EIP does not exist in the VPC.

+

The number of orchestration rules exceeds the maximum.

Use an existing NAT EIP.

+

Contact technical support to increase the quota of orchestration rules.

404

+

403

APIC.7314

+

APIG.3151

The VPC Endpoint of the gateway does not exist.

+

The number of orchestration rules bound to the API exceeds the maximum.

The VPC Endpoint of the gateway does not exist.

+

The number of orchestration rules bound to the API exceeds the maximum.

Contact technical support to check the VPC Endpoint.

+

Contact technical support to increase the quota of orchestration rules that can be bound to the API.

404

+

403

APIG.3001

+

APIG.3411

The API group does not exist

+

The APIs belong to different tenants.

The API group does not exist

+

The APIs belong to different tenants.

Check whether the API group exists.

+

This operation is not allowed.

404

+

403

APIG.3002

+

APIG.3412

The API does not exist.

+

The API provider has been frozen.

The API does not exist.

+

The API provider has been frozen.

Check whether the API exists.

+

Contact technical support.

404

+

403

APIG.3003

+

APIG.3414

The environment does not exist.

+

The VPC channel is already being used by another API.

The environment does not exist.

+

The VPC channel is already being used by another API.

Check whether the environment exists.

+

Delete the API associated with the VPC channel and then delete the VPC channel.

404

+

403

APIG.3004

+

APIG.3415

The app does not exist.

+

The API group cannot be deleted because it contains APIs.

The app does not exist.

+

The API group cannot be deleted because it contains APIs.

Check whether the app exists.

+

Delete the APIs in the API group and then delete the API group.

404

+

403

APIG.3005

+

APIG.3416

The request throttling policy does not exist.

+

The API cannot be deleted because it has been published.

The request throttling policy does not exist.

+

The API cannot be deleted because it has been published.

Check whether the request throttling policy exists.

+

Take the API offline and then delete it.

404

+

403

APIG.3006

+

APIG.3418

The access control policy does not exist.

+

The environment contains published APIs.

The access control policy does not exist.

+

The environment contains published APIs.

Check whether the access control policy exists.

+

This operation is not allowed.

404

+

403

APIG.3007

+

APIG.3420

The configuration does not exist.

+

The API group is no longer available on the marketplace.

The configuration does not exist.

+

The API group is no longer available on the marketplace.

Check whether the configuration exists.

+

Check whether the API group has been listed on the marketplace.

404

+

403

APIG.3008

+

APIG.3447

The excluded configuration does not exist.

+

The access control policy cannot be deleted because it has been bound to APIs.

The excluded configuration does not exist.

+

The access control policy cannot be deleted because it has been bound to APIs.

Check whether the excluded configuration exists.

+

Delete the APIs bound with the access control policy and then delete the access control policy.

404

+

403

APIG.3009

+

APIG.3451

The app authorization record does not exist.

+

The request throttling policy cannot be deleted because it has been bound to APIs.

The app authorization record does not exist.

+

The request throttling policy cannot be deleted because it has been bound to APIs.

Check whether the app authorization record exists.

+

Delete the APIs bound with the request throttling policy and then delete the request throttling policy.

404

+

403

APIG.3010

+

APIG.3471

The access control policy binding record does not exist.

+

The operation cannot be performed on this type of VPC channel.

The access control policy binding record does not exist.

+

The operation cannot be performed on this type of VPC channel.

Check whether the access control policy binding record exists.

+

This operation is not allowed.

404

+

403

APIG.3011

+

APIG.3472

The environment variable does not exist.

+

The load balancer is already being used by another VPC channel.

The environment variable does not exist.

+

The load balancer is already being used by another VPC channel.

Check whether the environment variable exists.

+

Unbind the load balancer from the VPC channel.

404

+

403

APIG.3012

+

APIG.3473

The request throttling policy binding record does not exist.

+

The load balancer has already been bound to another endpoint service.

The request throttling policy binding record does not exist.

+

The load balancer has already been bound to another endpoint service.

Check whether the request throttling policy binding record exists.

+

This operation is not allowed.

404

+

403

APIG.3013

+

APIG.3474

The excluded request throttling configuration does not exist.

+

The API group ID in the URL does not match the API group to which the URL domain has been bound.

The excluded request throttling configuration does not exist.

+

The API group ID in the URL does not match the API group to which the URL domain has been bound.

Check whether the excluded request throttling configuration exists.

+

Change the API group specified in the URL to the API group associated with the domain name.

404

+

404

APIG.3014

+

APIC.7301

The pre-subscription record does not exist.

+

Instance spec not found

The pre-subscription record does not exist.

+

Instance spec not found

Check whether the purchasing record exists.

+

Use a valid instance spec.

404

+

404

APIG.3015

+

APIC.7302

The API publication record does not exist.

+

Instance not found

The API publication record does not exist.

+

Instance not found

Check whether the API publication record exists.

+

Check whether the instance exists, and use a valid instance ID.

404

+

404

APIG.3016

+

APIC.7307

The API group listing information does not exist.

+

The security group does not exist in the VPC.

The API group listing information does not exist.

+

The security group does not exist in the VPC.

Check whether the API group has been listed on the marketplace.

+

Use an existing security group.

404

+

404

APIG.3017

+

APIC.7310

The signature key does not exist.

+

The region does not have any AZs.

The signature key does not exist.

+

The region does not have any AZs.

Check whether the signature key exists.

+

Use another region.

404

+

404

APIG.3018

+

APIC.7311

The signature key binding record does not exist.

+

The NAT EIP does not exist in the VPC.

The signature key binding record does not exist.

+

The NAT EIP does not exist in the VPC.

Check whether the signature key binding record exists.

+

Use an existing NAT EIP.

404

+

404

APIG.3019

+

APIC.7314

The function URN does not exist.

+

The VPC Endpoint of the gateway does not exist.

The function URN does not exist.

+

The VPC Endpoint of the gateway does not exist.

Check whether the function URN exists.

+

Contact technical support to check the VPC Endpoint.

404

+

404

APIG.3020

+

APIG.3001

The URL domain does not exist.

+

The API group does not exist

The URL domain does not exist.

+

The API group does not exist

Check whether the domain name exists.

+

Check whether the API group exists.

404

+

404

APIG.3021

+

APIG.3002

The SSL certificate does not exist.

+

The API does not exist.

The SSL certificate does not exist.

+

The API does not exist.

Check whether the SSL certificate exists.

+

Check whether the API exists.

404

+

404

APIG.3022

+

APIG.3003

The API version does not exist.

+

The environment does not exist.

The API version does not exist.

+

The environment does not exist.

Check whether the API version exists.

+

Check whether the environment exists.

404

+

404

APIG.3023

+

APIG.3004

The VPC channel does not exist.

+

The app does not exist.

The VPC channel does not exist.

+

The app does not exist.

Check whether the VPC channel exists.

+

Check whether the app exists.

404

+

404

APIG.3024

+

APIG.3005

The cloud server does not exist.

+

The request throttling policy does not exist.

The cloud server does not exist.

+

The request throttling policy does not exist.

Check whether the cloud server exists in the VPC channel.

+

Check whether the request throttling policy exists.

404

+

404

APIG.3025

+

APIG.3006

The certificate does not exist.

+

The access control policy does not exist.

The certificate does not exist.

+

The access control policy does not exist.

Check whether the certificate exists.

+

Check whether the access control policy exists.

404

+

404

APIG.3030

+

APIG.3007

The instance does not exist.

+

The configuration does not exist.

The instance does not exist.

+

The configuration does not exist.

Check whether the instance exists.

+

Check whether the configuration exists.

404

+

404

APIG.3081

+

APIG.3008

The authorizer does not exist.

+

The excluded configuration does not exist.

The authorizer does not exist.

+

The excluded configuration does not exist.

Check whether the custom authorizer exists.

+

Check whether the excluded configuration exists.

404

+

404

APIG.3082

+

APIG.3009

The AppCode does not exist.

+

The app authorization record does not exist.

The AppCode does not exist.

+

The app authorization record does not exist.

Check whether the AppCode exists.

+

Check whether the app authorization record exists.

404

+

404

APIG.3087

+

APIG.3010

The feature configuration does not exist.

+

The access control policy binding record does not exist.

The feature configuration does not exist.

+

The access control policy binding record does not exist.

Check whether the feature configuration exists.

+

Check whether the access control policy binding record exists.

404

+

404

APIG.3090

+

APIG.3011

The API Swagger file does not exist.

+

The environment variable does not exist.

The API Swagger file does not exist.

+

The environment variable does not exist.

Check whether the Swagger file exists.

+

Check whether the environment variable exists.

404

+

404

APIG.3092

+

APIG.3012

The ECS does not exist.

+

The request throttling policy binding record does not exist.

The ECS does not exist.

+

The request throttling policy binding record does not exist.

The ECS has already been deleted, or the ECS ID is incorrect.

+

Check whether the request throttling policy binding record exists.

404

+

404

APIG.3094

+

APIG.3013

Instance task does not exist.

+

The excluded request throttling configuration does not exist.

Instance task does not exist.

+

The excluded request throttling configuration does not exist.

Instance task is deleted or task ID is invalid.

+

Check whether the excluded request throttling configuration exists.

404

+

404

APIG.3095

+

APIG.3014

The orchestrations does not exist

+

The pre-subscription record does not exist.

The orchestrations does not exist

+

The pre-subscription record does not exist.

Check whether the orchestration rule corresponding to orchestration_id in the request parameter exists.

+

Check whether the purchasing record exists.

404

+

404

APIG.3097

+

APIG.3015

The binding record of this SSL certificate and domain name does not exist.

+

The API publication record does not exist.

The binding record of this SSL certificate and domain name does not exist.

+

The API publication record does not exist.

Check whether the binding record exists.

+

Check whether the API publication record exists.

409

+

404

APIC.7701

+

APIG.3016

Instance status conflict.

+

The API group listing information does not exist.

Instance status conflict.

+

The API group listing information does not exist.

Try again after the gateway upgrade is complete.

+

Check whether the API group has been listed on the marketplace.

409

+

404

APIC.7707

+

APIG.3017

Scaling up to the same specifications is not allowed.

+

The signature key does not exist.

Scaling up to the same specifications is not allowed.

+

The signature key does not exist.

Scale up to other specifications.

+

Check whether the signature key exists.

409

+

404

APIC.7709

+

APIG.3018

Public network access is enabled for the gateway.

+

The signature key binding record does not exist.

Public network access is enabled for the gateway.

+

The signature key binding record does not exist.

Disable public network access and try again.

+

Check whether the signature key binding record exists.

409

+

404

APIC.7710

+

APIG.3019

ELB is available only when the instance is in the Available state.

+

The function URN does not exist.

ELB is available only when the instance is in the Available state.

+

The function URN does not exist.

Contact technical support to restore the gateway status to Running, and try again.

+

Check whether the function URN exists.

409

+

404

APIC.7711

+

APIG.3020

Public inbound access is enabled for the instance

+

The URL domain does not exist.

Public inbound access is enabled for the instance.

+

The URL domain does not exist.

Disable public inbound access and try again.

+

Check whether the domain name exists.

409

+

404

APIC.7712

+

APIG.3021

The gateway operation has already been locked.

+

The SSL certificate does not exist.

The gateway operation has already been locked.

+

The SSL certificate does not exist.

Pay the order.

+

Check whether the SSL certificate exists.

409

+

404

APIG.1149

+

APIG.3022

No permission for this instance task.

+

The API version does not exist.

No permission for this instance task.

+

The API version does not exist.

Use a token of the correct project.

+

Check whether the API version exists.

409

+

404

APIG.3491

+

APIG.3023

The default response cannot be deleted.

+

The VPC channel does not exist.

The default response cannot be deleted.

+

The VPC channel does not exist.

This operation is not allowed.

+

Check whether the VPC channel exists.

409

+

404

APIG.3492

+

APIG.3024

The default response name cannot be modified.

+

The cloud server does not exist.

The default response name cannot be modified.

+

The cloud server does not exist.

This operation is not allowed.

+

Check whether the cloud server exists in the VPC channel.

409

+

404

APIG.3707

+

APIG.3025

Only published APIs can be bound with plug-ins.

+

The certificate does not exist.

Only published APIs can be bound with plug-ins.

+

The certificate does not exist.

Publish the API and try again.

+

Check whether the certificate exists.

409

+

404

APIG.3708

+

APIG.3030

The key usage of the certificate does not match

+

The instance does not exist.

The key usage of the certificate does not match

+

The instance does not exist.

Use matched key usage

+

Check whether the instance exists.

409

+

404

APIG.3709

+

APIG.3072

The signature algorithm of the certificate does not match

+

The specified task does not exist

The signature algorithm of the certificate does not match

+

The specified task does not exist

Change signature algorithm type

+

The specified task does not exist

409

+

404

APIG.3711

+

APIG.3081

A configuration parameter can be modified only once per minute.

+

The authorizer does not exist.

A configuration parameter can be modified only once per minute.

+

The authorizer does not exist.

Try again after 1 minute.

+

Check whether the custom authorizer exists.

409

+

404

APIG.3712

+

APIG.3082

User domain does not match.

+

The AppCode does not exist.

User domain does not match.

+

The AppCode does not exist.

Check the domain info.

+

Check whether the AppCode exists.

409

+

404

APIG.3716

+

APIG.3087

The orchestration rule is currently in use by another API.

+

The feature configuration does not exist.

The orchestration rule is currently in use by another API.

+

The feature configuration does not exist.

Unbind the orchestration rule from the API.

+

Check whether the feature configuration exists.

412

+

404

APIG.3458

+

APIG.3090

The feature is not supported by the current instance.

+

The API Swagger file does not exist.

The feature is not supported by the current instance.

+

The API Swagger file does not exist.

Contact technical support.

+

Check whether the Swagger file exists.

412

+

404

APIG.3713

+

APIG.3092

orchestration_mapped_param cannot be modified.

+

The ECS does not exist.

orchestration_mapped_param cannot be modified.

+

The ECS does not exist.

Do not modify orchestration_mapped_param.

+

The ECS has already been deleted, or the ECS ID is incorrect.

412

+

404

APIG.3714

+

APIG.3094

The backend request protocol does not support SM cryptographic algorithms.

+

Instance task does not exist.

The backend request protocol does not support SM cryptographic algorithms.

+

Instance task does not exist.

Change the protocol to HTTPS.

+

Instance task is deleted or task ID is invalid.

500

+

404

APIC.7253

+

APIG.3095

Internal configuration error.

+

The orchestrations does not exist

Internal configuration error.

+

The orchestrations does not exist

Check the internal configuration.

+

Check whether the orchestration rule corresponding to orchestration_id in the request parameter exists.

500

+

404

APIC.9000

+

APIG.3097

Failed to request internal service

+

The binding record of this SSL certificate and domain name does not exist.

Failed to request internal service

+

The binding record of this SSL certificate and domain name does not exist.

Contact technical support to view the background logs.

+

Check whether the binding record exists.

500

+

409

APIC.9005

+

APIC.7701

Order creation failed.

+

Instance status conflict.

Order creation failed.

+

Instance status conflict.

Contact technical support to view background logs related to CBC.

+

Try again after the gateway upgrade is complete.

500

+

409

APIC.9007

+

APIC.7707

Failed to access VPCEP

+

Scaling up to the same specifications is not allowed.

Failed to access VPCEP

+

Scaling up to the same specifications is not allowed.

Contact technical support to view logs related to VPCEP.

+

Scale up to other specifications.

500

+

409

APIC.9100

+

APIC.7709

Failed to access the database.

+

Public network access is enabled for the gateway.

Failed to access the database.

+

Public network access is enabled for the gateway.

Contact technical support to view background logs related to the database.

+

Disable public network access and try again.

500

+

409

APIC.9200

+

APIC.7710

Failed to query AZ information.

+

ELB is available only when the instance is in the Available state.

Failed to query AZ information.

+

ELB is available only when the instance is in the Available state.

Contact technical support to view the background logs.

+

Contact technical support to restore the gateway status to Running, and try again.

500

+

409

APIC.9204

+

APIC.7711

Failed to bind the EIP.

+

Public inbound access is enabled for the instance

Failed to bind the EIP.

+

Public inbound access is enabled for the instance.

Contact technical support to view the background logs.

+

Disable public inbound access and try again.

500

+

409

APIC.9209

+

APIC.7712

Failed to access EPS.

+

The gateway operation has already been locked.

Failed to access EPS.

+

The gateway operation has already been locked.

Contact technical support to view logs related to EPS.

+

Pay the order.

500

+

409

APIC.9999

+

APIG.1149

System error. Contact technical support.

+

No permission for this instance task.

System error. Contact technical support.

+

No permission for this instance task.

Contact technical support to view background logs of the management plane and locate the fault.

+

Use a token of the correct project.

500

+

409

APIG.1029

+

APIG.3491

PDP5 cannot be connected.

+

The default response cannot be deleted.

PDP5 cannot be connected.

+

The default response cannot be deleted.

Check the PDP5 connection.

+

This operation is not allowed.

500

+

409

APIG.3500

+

APIG.3492

Failed to synchronize data to etcd.

+

The default response name cannot be modified.

Failed to synchronize data to etcd.

+

The default response name cannot be modified.

Contact technical support.

+

This operation is not allowed.

500

+

409

APIG.9002

+

APIG.3707

Invalid function URN.

+

Only published APIs can be bound with plug-ins.

Invalid function URN.

+

Only published APIs can be bound with plug-ins.

Use a valid function URN.

+

Publish the API and try again.

500

+

409

APIG.9003

+

APIG.3708

Statistics Center request failed.

+

The key usage of the certificate does not match

Statistics Center request failed.

+

The key usage of the certificate does not match

Contact technical support.

+

Use matched key usage

500

+

409

APIG.9004

+

APIG.3709

IAM request failed.

+

The signature algorithm of the certificate does not match

IAM request failed.

+

The signature algorithm of the certificate does not match

Contact technical support.

+

Change signature algorithm type

500

+

409

APIG.9005

+

APIG.3711

VPC request failed.

+

A configuration parameter can be modified only once per minute.

VPC request failed.

+

A configuration parameter can be modified only once per minute.

Contact technical support.

+

Try again after 1 minute.

500

+

409

APIG.9006

+

APIG.3712

DNS request failed.

+

User domain does not match.

DNS request failed.

+

User domain does not match.

Contact technical support.

+

Check the domain info.

500

+

409

APIG.9007

+

APIG.3716

ELB request failed.

+

The orchestration rule is currently in use by another API.

ELB request failed.

+

The orchestration rule is currently in use by another API.

Contact technical support.

+

Unbind the orchestration rule from the API.

500

+

409

APIG.9008

+

APIG.3718

Too many requests. Try again later.

+

An instance task is currently being processed.

Too many requests. Try again later.

+

An instance task is currently being processed.

Please try again later.

+

Start a new task after the current one is complete.

500

+

409

APIG.9013

+

APIG.3719

Synchronize CCMS data failed

+

The load balance channel is referenced by another load balance channel and cannot be deleted.

Synchronize CCMS data failed

+

The load balance channel is referenced by another load balance channel and cannot be deleted.

Contact technical support.

+

Delete the referencing load balance channel first.

500

+

412

APIG.9999

+

APIG.3458

Internal Server Error

+

The feature is not supported by the current instance.

Internal Server Error

+

The feature is not supported by the current instance.

Contact technical support.

+

Contact technical support.

+

412

+

APIG.3713

+

orchestration_mapped_param cannot be modified.

+

orchestration_mapped_param cannot be modified.

+

Do not modify orchestration_mapped_param.

+

412

+

APIG.3714

+

The backend request protocol does not support SM cryptographic algorithms.

+

The backend request protocol does not support SM cryptographic algorithms.

+

Change the protocol to HTTPS.

+

500

+

APIC.7253

+

Internal configuration error.

+

Internal configuration error.

+

Check the internal configuration.

+

500

+

APIC.9000

+

Failed to request internal service

+

Failed to request internal service

+

Contact technical support to view the background logs.

+

500

+

APIC.9005

+

Order creation failed.

+

Order creation failed.

+

Contact technical support to view background logs related to CBC.

+

500

+

APIC.9007

+

Failed to access VPCEP

+

Failed to access VPCEP

+

Contact technical support to view logs related to VPCEP.

+

500

+

APIC.9100

+

Failed to access the database.

+

Failed to access the database.

+

Contact technical support to view background logs related to the database.

+

500

+

APIC.9200

+

Failed to query AZ information.

+

Failed to query AZ information.

+

Contact technical support to view the background logs.

+

500

+

APIC.9204

+

Failed to bind the EIP.

+

Failed to bind the EIP.

+

Contact technical support to view the background logs.

+

500

+

APIC.9209

+

Failed to access EPS.

+

Failed to access EPS.

+

Contact technical support to view logs related to EPS.

+

500

+

APIC.9999

+

System error. Contact technical support.

+

System error. Contact technical support.

+

Contact technical support to view background logs of the management plane and locate the fault.

+

500

+

APIG.1029

+

PDP5 cannot be connected.

+

PDP5 cannot be connected.

+

Check the PDP5 connection.

+

500

+

APIG.3500

+

Failed to synchronize data to etcd.

+

Failed to synchronize data to etcd.

+

Contact technical support.

+

500

+

APIG.9002

+

Invalid function URN.

+

Invalid function URN.

+

Use a valid function URN.

+

500

+

APIG.9003

+

Statistics Center request failed.

+

Statistics Center request failed.

+

Contact technical support.

+

500

+

APIG.9004

+

IAM request failed.

+

IAM request failed.

+

Contact technical support.

+

500

+

APIG.9005

+

VPC request failed.

+

VPC request failed.

+

Contact technical support.

+

500

+

APIG.9006

+

DNS request failed.

+

DNS request failed.

+

Contact technical support.

+

500

+

APIG.9007

+

ELB request failed.

+

ELB request failed.

+

Contact technical support.

+

500

+

APIG.9008

+

Too many requests. Try again later.

+

Too many requests. Try again later.

+

Please try again later.

+

500

+

APIG.9013

+

Synchronize CCMS data failed

+

Synchronize CCMS data failed

+

Contact technical support.

+

500

+

APIG.9999

+

Internal Server Error

+

Internal Server Error

+

Contact technical support.
- - - - - - - - - - - - - - - - -
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.

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

oas_version

-

No

-

String

-

Open API version.

-

Default: 2.0

-

Enumeration values:

-

  • 2.0

    -

  • 3.0

    -
-
-
-
-

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

env_id

-

Yes

-

String

-

ID of the environment in which APIs of a group have been published.

-

group_id

-

Yes

-

String

-

API group ID.

-

define

-

No

-

String

-

Definition scope of the APIs to be exported:

-

  • spec: basic definitions, including only the frontend definitions.

    -

  • proxy: full definitions, including the frontend and backend definitions.

    -

  • all: extended definitions, including the frontend and backend definitions as well as request throttling policies, access control policies, and custom authorizers.

    -

  • dev: development definitions, including the frontend and backend definitions of APIs that have not been published.

    -
-

Default: spec

-

Enumeration values:

-

  • spec

    -

  • proxy

    -

  • all

    -

  • dev

    -
-

type

-

No

-

String

-

Format for exporting API definitions.

-

Default: json

-

Enumeration values:

-

  • json

    -

  • yaml

    -

  • yml

    -
-

version

-

No

-

String

-

Version number of the APIs after exporting. The default value is the current date and time.

-

apis

-

No

-

Array of strings

-

IDs of the APIs to be exported.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

-

-

File

-

OK

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Exporting APIs

-
{
-  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "define" : "all"
-}
-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2001",
-  "error_msg" : "The request parameters must be specified,parameterName:env_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
- -
-
-
Parent topic: API Import and Export
-
-
- diff --git a/docs/apig/api-ref/GroupResponseManagement_1.html b/docs/apig/api-ref/GroupResponseManagement_1.html deleted file mode 100644 index 9ee0f8f4..00000000 --- a/docs/apig/api-ref/GroupResponseManagement_1.html +++ /dev/null @@ -1,30 +0,0 @@ - - -

Group Response Management

-

-
- - diff --git a/docs/apig/api-ref/ImportApiDefinitionsV2_1.html b/docs/apig/api-ref/ImportApiDefinitionsV2_1.html deleted file mode 100644 index 0c703865..00000000 --- a/docs/apig/api-ref/ImportApiDefinitionsV2_1.html +++ /dev/null @@ -1,592 +0,0 @@ - - -

Importing APIs

-

Function

This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields, see section "Importing and Exporting APIs: Extended Definition" in the Developer Guide.

-
-

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/import

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

-
-
-
-

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 FormData parameters

Parameter

-

Mandatory

-

Type

-

Description

-

is_create_group

-

No

-

Boolean

-

Specifies whether to create an API group.

-

Default: true

-

group_id

-

No

-

String

-

API group ID. This parameter is required if is_create_group is set to false.

-

extend_mode

-

No

-

String

-

Import mode of extended information.

-

  • merge: Retain the original extended information if a conflict occurs.

    -

  • override: Override the original extended information if a conflict occurs.

    -
-

Default: merge

-

Enumeration values:

-

  • merge

    -

  • override

    -
-

simple_mode

-

No

-

Boolean

-

Specifies whether to enable fast import.

-

Default: false

-

mock_mode

-

No

-

Boolean

-

Specifies whether to enable the Mock backend.

-

Default: false

-

api_mode

-

No

-

String

-

Import mode.

-

  • merge: Retain the original API information if a conflict occurs.

    -

  • override: Override the original API information if a conflict occurs.

    -
-

Default: merge

-

Enumeration values:

-

  • merge

    -

  • override

    -
-

file_name

-

Yes

-

File

-

Request body in JSON or YAML format for importing APIs.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

success

-

Array of Success objects

-

Import success information.

-

failure

-

Array of Failure objects

-

Import failure information.

-

swagger

-

Swagger object

-

Swagger file import result.

-

Currently, this parameter is not supported.

-

group_id

-

String

-

API group ID.

-

ignore

-

Array of Ignore objects

-

APIs that are not imported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 5 Success

Parameter

-

Type

-

Description

-

path

-

String

-

API request path.

-

method

-

String

-

API request method.

-

action

-

String

-

Import type. Options:

-

  • update: Update the APIs to an existing API group.

    -

  • create: Create APIs for a new API group.

    -
-

Enumeration values:

-

  • update

    -

  • create

    -
-

id

-

String

-

ID of a successfully imported API.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 6 Failure

Parameter

-

Type

-

Description

-

path

-

String

-

API request path.

-

error_msg

-

String

-

Error message displayed for an import failure.

-

method

-

String

-

API request method.

-

error_code

-

String

-

Error code displayed for an import failure.

-
-
- -
- - - - - - - - - - - - - -
Table 7 Swagger

Parameter

-

Type

-

Description

-

id

-

String

-

Swagger file No.

-

result

-

String

-

Import result description.

-
-
- -
- - - - - - - - - - - - - -
Table 8 Ignore

Parameter

-

Type

-

Description

-

method

-

String

-

API request method.

-

path

-

String

-

API request path.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 13 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Importing APIs

-
{
-  "is_create_group" : false,
-  "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
-  "file_name" : "APIGroup_test.json"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
-  "failure" : [ {
-    "path" : "/test/demo",
-    "error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo",
-    "method" : "GET",
-    "error_code" : "APIG.3301"
-  } ],
-  "success" : [ {
-    "path" : "/test",
-    "method" : "GET",
-    "action" : "create",
-    "id" : "8ae6bcafab6f49d78242bff26ad8a4f0"
-  } ],
-  "swagger" : {
-    "id" : "e2ea8a7c1cfc49b3830437cb79d7fd59",
-    "result" : "Success"
-  }
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.3201",
-  "error_msg" : "The API group name already exists"
-}
-

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.3001",
-  "error_msg" : "API group not found"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Import and Export
-
-
- diff --git a/docs/apig/api-ref/InstanceFeatureManagement_1.html b/docs/apig/api-ref/InstanceFeatureManagement_1.html deleted file mode 100644 index e4600d17..00000000 --- a/docs/apig/api-ref/InstanceFeatureManagement_1.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

Gateway Feature Management

-

-
- - diff --git a/docs/apig/api-ref/ListAclPolicyBindedToApiV2_1.html b/docs/apig/api-ref/ListAclPolicyBindedToApiV2_1.html deleted file mode 100644 index 93d44593..00000000 --- a/docs/apig/api-ref/ListAclPolicyBindedToApiV2_1.html +++ /dev/null @@ -1,501 +0,0 @@ - - -

Querying Access Control Policies Bound to an API

-

Function

This API is used to query the access control policies that have been bound to a specified API.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-acls

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

api_id

-

Yes

-

String

-

API ID.

-

env_id

-

No

-

String

-

Environment ID.

-

env_name

-

No

-

String

-

Environment name.

-

acl_id

-

No

-

String

-

Access control policy ID.

-

acl_name

-

No

-

String

-

Access control policy name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

acls

-

Array of ApiBindAclInfo objects

-

Access control policy list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiBindAclInfo

Parameter

-

Type

-

Description

-

acl_id

-

String

-

Access control policy ID.

-

acl_name

-

String

-

Access control policy name.

-

entity_type

-

String

-

Object type.

-

Enumeration values:

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-

acl_type

-

String

-

Access control type.

-

  • PERMIT: whitelist

    -

  • DENY: blacklist

    -
-

Enumeration values:

-

  • PERMIT

    -

  • DENY

    -
-

acl_value

-

String

-

Access control objects.

-

env_id

-

String

-

Effective environment ID.

-

env_name

-

String

-

Effective environment name.

-

bind_id

-

String

-

Binding record ID.

-

bind_time

-

String

-

Binding time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "acls" : [ {
-    "acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
-    "acl_name" : "acl_demo",
-    "entity_type" : "IP",
-    "acl_type" : "PERMIT",
-    "acl_value" : "192.168.1.5,192.168.10.1",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "bind_id" : "332c5db1458a477b89b2ea741fec94a3",
-    "bind_time" : "2020-08-04T08:58:03Z"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListAclStrategiesV2_1.html b/docs/apig/api-ref/ListAclStrategiesV2_1.html deleted file mode 100644 index 544d74f2..00000000 --- a/docs/apig/api-ref/ListAclStrategiesV2_1.html +++ /dev/null @@ -1,486 +0,0 @@ - - -

Querying Access Control Policies

-

Function

This API is used to query all the access control policies.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acls

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

Access control policy ID.

-

name

-

No

-

String

-

Access control policy name.

-

acl_type

-

No

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

entity_type

-

No

-

String

-

Object types.

-

  • IP

    -

  • DOMAIN

    -
-

precise_search

-

No

-

String

-

Parameter name (name) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

acls

-

Array of ApiAclInfoWithBindNum objects

-

Access control policy list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiAclInfoWithBindNum

Parameter

-

Type

-

Description

-

acl_name

-

String

-

Access control policy name.

-

acl_type

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

acl_value

-

String

-

Access control objects.

-

bind_num

-

Integer

-

Number of APIs.

-

entity_type

-

String

-

Object type.

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-

id

-

String

-

Access control policy ID.

-

update_time

-

String

-

Update time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "acls" : [ {
-    "bind_num" : 0,
-    "id" : "7eb619ecf2a24943b099833cd24a01ba",
-    "acl_name" : "acl_demo",
-    "entity_type" : "IP",
-    "acl_type" : "PERMIT",
-    "acl_value" : "192.168.1.5,192.168.10.1",
-    "update_time" : "2020-08-04T08:42:43Z"
-  } ]
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/ListApiGroupsQuantitiesV2_1.html b/docs/apig/api-ref/ListApiGroupsQuantitiesV2_1.html deleted file mode 100644 index c875e126..00000000 --- a/docs/apig/api-ref/ListApiGroupsQuantitiesV2_1.html +++ /dev/null @@ -1,316 +0,0 @@ - - -

Querying API Group Quantities

-

Function

This API is used to query the number of API groups that have been listed on KooGallery and the number of API groups that have not been listed.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groups

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

offsell_nums

-

Integer

-

Number of API groups that have not been listed on KooGallery.

-

Currently, this parameter is not supported.

-

onsell_nums

-

Integer

-

Number of API groups that have been listed on KooGallery.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "offsell_nums" : 0,
-  "onsell_nums" : 23
-}
-

Status code: 400

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Resource Query
-
-
- diff --git a/docs/apig/api-ref/ListApiGroupsV2_1.html b/docs/apig/api-ref/ListApiGroupsV2_1.html deleted file mode 100644 index 2dc718d3..00000000 --- a/docs/apig/api-ref/ListApiGroupsV2_1.html +++ /dev/null @@ -1,589 +0,0 @@ - - -

Querying API Groups

-

Function

This API is used to query API groups.

-

You can query all API groups in your account as a tenant, or query API groups of all tenants using an administrator account.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

API group ID.

-

name

-

No

-

String

-

API group name.

-

precise_search

-

No

-

String

-

Parameter name for exact matching. Only API group names are supported.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

groups

-

Array of ApiGroupInfo objects

-

API groups.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiGroupInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-

sl_domains

-

Array of strings

-

Automatically allocated subdomain names.

-

remark

-

String

-

Description.

-

call_limits

-

Integer

-

Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls.

-

Currently, this parameter is not supported.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

is_default

-

Integer

-

Indicates whether the API group is the default group.

-

version

-

String

-

Group version.

-
  • V1: global group
  • V2: application-level group
-

The default value is V1. This parameter is not supported currently.

-

roma_app_id

-

String

-

ID of the integration application to which the API group belongs.

-

This parameter is required when the group version is V2.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the integration application to which the API group belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "groups" : [ {
-    "update_time" : "2020-07-31T06:55:55Z",
-    "name" : "api_group_001",
-    "on_sell_status" : 2,
-    "remark" : "API group 1",
-    "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
-    "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-    "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "register_time" : "2020-07-31T06:55:55Z",
-    "status" : 1,
-    "is_default" : 2
-  }, {
-    "update_time" : "2020-06-24T15:29:42.421926Z",
-    "name" : "api_group_002",
-    "on_sell_status" : 2,
-    "remark" : "API group 2",
-    "sl_domain" : "02a8ab3cb2784de5a096852829671ae7.apic.****.com",
-    "sl_domains" : [ "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "02a8ab3cb2784de5a096852829671ae7.apic.****.cn" ],
-    "id" : "02a8ab3cb2784de5a096852829671ae7",
-    "register_time" : "2020-06-24T15:29:42.421926Z",
-    "status" : 1,
-    "is_default" : 2
-  } ]
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Group Management
-
-
- diff --git a/docs/apig/api-ref/ListApiQuantitiesV2_1.html b/docs/apig/api-ref/ListApiQuantitiesV2_1.html deleted file mode 100644 index 8674ed93..00000000 --- a/docs/apig/api-ref/ListApiQuantitiesV2_1.html +++ /dev/null @@ -1,323 +0,0 @@ - - -

Querying API Quantities

-

Function

This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/apis

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

instance_num

-

Integer

-

Total number of APIs.

-

nums_on_release

-

Integer

-

Number of APIs that have been published in the RELEASE environment.

-

nums_off_release

-

Integer

-

Number of APIs that have not been published in the RELEASE environment.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "instance_num" : 27,
-  "nums_on_release" : 11,
-  "nums_off_release" : 6
-}
-

Status code: 400

-

Bad Request

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

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Bad Request

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Resource Query
-
-
- diff --git a/docs/apig/api-ref/ListApiRuntimeDefinitionV2_1.html b/docs/apig/api-ref/ListApiRuntimeDefinitionV2_1.html deleted file mode 100644 index 4c87681c..00000000 --- a/docs/apig/api-ref/ListApiRuntimeDefinitionV2_1.html +++ /dev/null @@ -1,752 +0,0 @@ - - -

Querying the Runtime Definition of an API

-

Function

This API is used to query the runtime definition of an API in a specified environment. The runtime definition of an API in the RELEASE environment is queried if no environment is specified.

-

The definition of an API is classified into the following types:

-
  • Temporary definition: definition of an API used after the API was last edited.
  • Runtime definition: snapshot of the temporary definition of an API captured when the API is published in an environment.
-

The runtime definition of an API is accessed when the API is called in an environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/runtime/{api_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.

-

api_id

-

Yes

-

String

-

API ID.

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

env_id

-

No

-

String

-

ID of the environment in which the API is published.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

publish_id

-

String

-

Publication record ID.

-

sl_domain

-

String

-

Subdomain name of the API group.

-

sl_domains

-

Array of strings

-

Subdomain names that APIG automatically allocates to the API group.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-
-
- -
- - - - - - - - - -
Table 5 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "Api_http",
-  "type" : 1,
-  "version" : "V0.0.1",
-  "req_protocol" : "HTTPS",
-  "req_method" : "GET",
-  "req_uri" : "/test/http",
-  "auth_type" : "AUTHORIZER",
-  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
-  "auth_opt" : {
-    "app_code_auth_type" : "DISABLE"
-  },
-  "cors" : false,
-  "match_mode" : "NORMAL",
-  "backend_type" : "HTTP",
-  "remark" : "Web backend API",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "result_normal_sample" : "Example success response",
-  "result_failure_sample" : "Example failure response",
-  "id" : "5f918d104dc84480a75166ba99efff21",
-  "group_name" : "api_group_001",
-  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "run_env_name" : "RELEASE",
-  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
-  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]
-}
-

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" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/ListApiVersionDetailV2_1.html b/docs/apig/api-ref/ListApiVersionDetailV2_1.html deleted file mode 100644 index 5d919905..00000000 --- a/docs/apig/api-ref/ListApiVersionDetailV2_1.html +++ /dev/null @@ -1,1863 +0,0 @@ - - -

Querying API Version Details

-

Function

This API is used to query the details of a specified API version.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_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.

-

version_id

-

Yes

-

String

-

API version.

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

status

-

Integer

-

App status.

-
  • 1: valid
-

arrange_necessary

-

Integer

-

Indicates whether to enable orchestration.

-

register_time

-

String

-

Time when the API is registered.

-

update_time

-

String

-

Time when the API was last modified.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

group_version

-

String

-

Version of the API group to which the API belongs.

-

The default value is V1. Other versions are not supported.

-

Default: V1

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

Separate multiple environment IDs with vertical bars (|).

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

Separate multiple environment names with vertical bars (|).

-

publish_id

-

String

-

Publication record ID.

-

Separate multiple publication record IDs with vertical bars (|).

-

publish_time

-

String

-

Time when the API version is published.

-

roma_app_name

-

String

-

Name of the integration application to which the API belongs.

-

Currently, this parameter is not supported.

-

ld_api_id

-

String

-

ID of the corresponding custom backend API.

-

Currently, this parameter is not supported.

-

backend_api

-

BackendApi object

-

Web backend details.

-

api_group_info

-

ApiGroupCommonInfo object

-

API group information.

-

func_info

-

ApiFunc object

-

FunctionGraph backend details.

-

mock_info

-

ApiMock object

-

Mock backend details.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

policy_functions

-

Array of ApiPolicyFunctionResp objects

-

FunctionGraph backend policies.

-

policy_mocks

-

Array of ApiPolicyMockResp objects

-

Mock backend policies.

-

policy_https

-

Array of ApiPolicyHttpResp objects

-

Web backend policies.

-

sl_domain

-

String

-

Subdomain name that API Gateway automatically allocates to the API group.

-

sl_domains

-

Array of strings

-

Subdomain names that APIG automatically allocates to the API group.

-

version_id

-

String

-

API version ID.

-
-
- -
- - - - - - - - - -
Table 4 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 BackendApi

Parameter

-

Type

-

Description

-

authorizer_id

-

String

-

Custom authorizer ID.

-

url_domain

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

id

-

String

-

ID.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

register_time

-

String

-

Registration time.

-

update_time

-

String

-

Update time.

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ApiGroupCommonInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ApiFunc

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ApiMock

Parameter

-

Type

-

Description

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

String

-

Response.

-

version

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 ApiPolicyFunctionResp

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 ApiPolicyMockResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

result_content

-

String

-

Response.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ApiPolicyHttpResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

url_domain

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 14 BackendParam

Parameter

-

Type

-

Description

-

origin

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-

id

-

String

-

Parameter ID.

-

req_param_id

-

String

-

Request parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 CoditionResp

Parameter

-

Type

-

Description

-

req_param_name

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

String

-

Condition value.

-

id

-

String

-

ID.

-

req_param_id

-

String

-

Input parameter ID.

-

req_param_location

-

String

-

Input parameter location.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 16 VpcInfo

Parameter

-

Type

-

Description

-

ecs_id

-

String

-

Cloud server ID.

-

ecs_name

-

String

-

Cloud server name.

-

cascade_flag

-

Boolean

-

Indicates whether to use the cascading mode.

-

Currently, this parameter is not supported.

-

vpc_channel_proxy_host

-

String

-

Proxy host.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

vpc_channel_port

-

Integer

-

VPC channel port.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 17 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 18 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 19 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 20 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "Api_http",
-  "type" : 1,
-  "version" : "V0.0.1",
-  "req_protocol" : "HTTPS",
-  "req_method" : "GET",
-  "req_uri" : "/test/http",
-  "auth_type" : "AUTHORIZER",
-  "auth_opt" : [ {
-    "app_code_auth_type" : "DISABLE"
-  } ],
-  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
-  "cors" : false,
-  "match_mode" : "NORMAL",
-  "backend_type" : "HTTP",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "result_normal_sample" : "Example success response",
-  "result_failure_sample" : "Example failure response",
-  "id" : "5f918d104dc84480a75166ba99efff21",
-  "status" : 1,
-  "arrange_necessary" : 2,
-  "remark" : "Web backend API",
-  "register_time" : "2020-07-31T12:42:51Z",
-  "update_time" : "2020-08-02T16:32:47.046289Z",
-  "group_name" : "api_group_001",
-  "run_env_name" : "RELEASE",
-  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
-  "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
-  "publish_time" : "2020-08-03T01:36:00Z",
-  "backend_api" : {
-    "url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
-    "req_protocol" : "HTTPS",
-    "req_method" : "GET",
-    "req_uri" : "/test/benchmark",
-    "timeout" : 5000,
-    "id" : "1ce8fda3586d4371bd83c955df37e102",
-    "status" : 1,
-    "register_time" : "2020-07-31T12:42:51Z",
-    "update_time" : "2020-08-02T16:32:47.077029Z",
-    "vpc_channel_status" : 1,
-    "vpc_channel_info" : {
-      "cascade_flag" : false,
-      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-      "vpc_channel_proxy_host" : "www.example.com",
-      "vpc_channel_port" : 0
-    },
-    "retry_count" : "-1"
-  },
-  "backend_params" : [ {
-    "name" : "X-CONSTANT-HEADER",
-    "location" : "HEADER",
-    "origin" : "CONSTANT",
-    "value" : "demo",
-    "remark" : "constant_demo",
-    "id" : "8cb2eba19e7a4423a4e835647a8b8d76"
-  }, {
-    "name" : "app-id",
-    "location" : "HEADER",
-    "origin" : "SYSTEM",
-    "value" : "$context.appId",
-    "remark" : "App ID of the API caller",
-    "id" : "216ddda836e74d528f364ff589d9dd21"
-  } ]
-}
-

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.3022",
-  "error_msg" : "The API version does not exist,id:ee1a5a38d3d3493abf1dc4ed6cacfa0b"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/ListApiVersionsV2_1.html b/docs/apig/api-ref/ListApiVersionsV2_1.html deleted file mode 100644 index c4c71507..00000000 --- a/docs/apig/api-ref/ListApiVersionsV2_1.html +++ /dev/null @@ -1,469 +0,0 @@ - - -

Querying Historical Versions of an API

-

Function

This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_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.

-

api_id

-

Yes

-

String

-

API ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

env_id

-

No

-

String

-

Environment ID.

-

env_name

-

No

-

String

-

Environment name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

api_versions

-

Array of ApiVersionResp objects

-

Historical version list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiVersionResp

Parameter

-

Type

-

Description

-

version_id

-

String

-

API version ID.

-

version_no

-

String

-

API version.

-

api_id

-

String

-

API ID.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

env_name

-

String

-

Name of the environment in which the API has been published.

-

remark

-

String

-

Description about the publication.

-

publish_time

-

String

-

Publication time.

-

status

-

Integer

-

Version status.

-

  • 1: effective

    -

  • 2: not effective

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "api_versions" : [ {
-    "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
-    "version_no" : "20200803093600",
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "publish_time" : "2020-08-03T01:36:00Z",
-    "status" : 1
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/ListApisBindedToAclPolicyV2_1.html b/docs/apig/api-ref/ListApisBindedToAclPolicyV2_1.html deleted file mode 100644 index 236fc9c5..00000000 --- a/docs/apig/api-ref/ListApisBindedToAclPolicyV2_1.html +++ /dev/null @@ -1,514 +0,0 @@ - - -

Querying APIs Bound with an Access Control Policy

-

Function

This API is used to query the APIs to which an access control policy has been bound.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

acl_id

-

Yes

-

String

-

Access control policy ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-

env_id

-

No

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of AclBindApiInfo objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 AclBindApiInfo

Parameter

-

Type

-

Description

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

api_type

-

Long

-

API type.

-

api_remark

-

String

-

API description.

-

env_id

-

String

-

ID of the environment in which the policy takes effect.

-

env_name

-

String

-

Name of the environment in which the policy takes effect.

-

bind_id

-

String

-

Binding record ID.

-

group_name

-

String

-

API group name.

-

bind_time

-

String

-

Binding time.

-

publish_id

-

String

-

API publication record ID.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-

  • GET

    -

  • POST

    -

  • DELETE

    -

  • PUT

    -

  • PATCH

    -

  • HEAD

    -

  • OPTIONS

    -

  • ANY

    -
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "apis" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "api_name" : "Api_http",
-    "group_name" : "api_group_001",
-    "api_type" : 1,
-    "api_remark" : "Web backend API",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "bind_id" : "332c5db1458a477b89b2ea741fec94a3",
-    "bind_time" : "2020-08-04T08:58:03Z",
-    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListApisBindedToAppV2_1.html b/docs/apig/api-ref/ListApisBindedToAppV2_1.html deleted file mode 100644 index 270135cb..00000000 --- a/docs/apig/api-ref/ListApisBindedToAppV2_1.html +++ /dev/null @@ -1,617 +0,0 @@ - - -

Querying APIs Bound with an App

-

Function

This API is used to query the APIs to which a specified app has been bound.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

app_id

-

Yes

-

String

-

App ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-

group_id

-

No

-

String

-

API group ID.

-

group_name

-

No

-

String

-

API group name.

-

env_id

-

No

-

String

-

ID of the environment in which the app has been authorized.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

auths

-

Array of ApiAuthInfo objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiAuthInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Authorization record ID.

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

api_type

-

Integer

-

API type.

-

api_remark

-

String

-

API description.

-

env_id

-

String

-

ID of the environment in which an app has been authorized to call the API.

-

auth_role

-

String

-

Authorizer.

-

auth_time

-

String

-

Authorization time.

-

app_name

-

String

-

App name.

-

app_remark

-

String

-

App description.

-

app_type

-

String

-

App type.

-

The default value is apig. Other types are not supported currently.

-

Enumeration values:

-

  • apig

    -

  • roma

    -
-

app_creator

-

String

-

Creator of the app.

-

  • USER: The app is created by a tenant.

    -

  • MARKET: The app is allocated by KooGallery. This value is not supported currently.

    -
-

publish_id

-

String

-

API publication record ID.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

auth_tunnel

-

String

-

Authorization channel type.

-

  • NORMAL: normal channel

    -

  • GREEN: green channel

    -
-

The default value is NORMAL. This parameter is not supported currently.

-

Enumeration values:

-

  • NORMAL

    -

  • GREEN

    -
-

auth_whitelist

-

Array of strings

-

Whitelist for the green channel.

-

auth_blacklist

-

Array of strings

-

Blacklist for the green channel.

-

visit_param

-

String

-

Access parameters.

-

roma_app_type

-

String

-

ROMA application type.

-

  • subscription: subscription application

    -

  • integration: integration application

    -
-

Currently, this parameter is not supported.

-

env_name

-

String

-

Name of the environment in which the app has been authorized to call the API.

-

app_id

-

String

-

App ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "auths" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "app_name" : "app_demo",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "group_name" : "api_group_001",
-    "api_type" : 1,
-    "api_name" : "Api_http",
-    "app_id" : "356de8eb7a8742168586e5daf5339965",
-    "auth_time" : "2020-08-04T04:02:22Z",
-    "app_creator" : "USER",
-    "id" : "dd29b33ae4394e3b924b582c6b40880b",
-    "api_remark" : "Web backend Api",
-    "auth_role" : "PROVIDER",
-    "app_type" : "apig",
-    "auth_tunnel" : "NORMAL",
-    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3004",
-  "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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: App Authorization Management
-
-
- diff --git a/docs/apig/api-ref/ListApisBindedToRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/ListApisBindedToRequestThrottlingPolicyV2_1.html deleted file mode 100644 index 05e3a548..00000000 --- a/docs/apig/api-ref/ListApisBindedToRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,546 +0,0 @@ - - -

Querying APIs Bound with a Request Throttling Policy

-

Function

This API is used to query the APIs to which a specified request throttling policy has been bound.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

throttle_id

-

Yes

-

String

-

Request throttling policy ID.

-

env_id

-

No

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of ApiForThrottle objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiForThrottle

Parameter

-

Type

-

Description

-

auth_type

-

String

-

API authentication mode.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

publish_id

-

String

-

API publication record ID.

-

throttle_apply_id

-

String

-

ID of a request throttling policy binding record.

-

apply_time

-

String

-

Binding time.

-

remark

-

String

-

API description.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

type

-

Integer

-

API type.

-

throttle_name

-

String

-

Name of the request throttling policy bound to the API.

-

req_uri

-

String

-

Access address of the API.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

name

-

String

-

API name.

-

id

-

String

-

API ID.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-

  • GET

    -

  • POST

    -

  • DELETE

    -

  • PUT

    -

  • PATCH

    -

  • HEAD

    -

  • OPTIONS

    -

  • ANY

    -
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "apis" : [ {
-    "run_env_name" : "RELEASE",
-    "group_name" : "api_group_001",
-    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a",
-    "name" : "Api_http",
-    "apply_time" : "2020-08-03T12:25:52Z",
-    "remark" : "Web backend API",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "id" : "5f918d104dc84480a75166ba99efff21",
-    "type" : 1,
-    "throttle_name" : "throttle_demo",
-    "auth_type" : "APP",
-    "req_uri" : "/test/http"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListApisBindedToSignatureKeyV2_1.html b/docs/apig/api-ref/ListApisBindedToSignatureKeyV2_1.html deleted file mode 100644 index 4401fa4f..00000000 --- a/docs/apig/api-ref/ListApisBindedToSignatureKeyV2_1.html +++ /dev/null @@ -1,512 +0,0 @@ - - -

Querying APIs Bound with a Signature Key

-

Function

This API is used to query the APIs to which a signature key has been bound.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

sign_id

-

Yes

-

String

-

Signature key ID.

-

env_id

-

No

-

String

-

Environment ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-

group_id

-

No

-

String

-

API group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

bindings

-

Array of SignApiBindingBase objects

-

List of signature key binding records.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SignApiBindingBase

Parameter

-

Type

-

Description

-

publish_id

-

String

-

API publication record ID.

-

api_id

-

String

-

API ID.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

binding_time

-

String

-

Binding time.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

env_name

-

String

-

Name of the environment in which the API has been published.

-

api_type

-

Integer

-

API type.

-

api_name

-

String

-

API name.

-

id

-

String

-

Binding record ID.

-

api_remark

-

String

-

API description.

-

sign_id

-

String

-

Signature key ID.

-

sign_name

-

String

-

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

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "bindings" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "group_name" : "api_group_001",
-    "binding_time" : "2020-08-03T04:00:11Z",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "sign_name" : "signature_demo",
-    "api_type" : 1,
-    "api_name" : "Api_http",
-    "id" : "25082bd52f74442bb1d273993d567938",
-    "api_remark" : "Web backend API",
-    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3017",
-  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Signature Keys
-
-
- diff --git a/docs/apig/api-ref/ListApisNotBoundWithSignatureKeyV2_1.html b/docs/apig/api-ref/ListApisNotBoundWithSignatureKeyV2_1.html deleted file mode 100644 index f4d20c84..00000000 --- a/docs/apig/api-ref/ListApisNotBoundWithSignatureKeyV2_1.html +++ /dev/null @@ -1,512 +0,0 @@ - - -

Querying APIs Not Bound with a Signature Key

-

Function

This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

sign_id

-

Yes

-

String

-

Signature key ID.

-

env_id

-

No

-

String

-

Environment ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-

group_id

-

No

-

String

-

API group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of ApiForSign objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiForSign

Parameter

-

Type

-

Description

-

auth_type

-

String

-

API authentication mode.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

publish_id

-

String

-

Publication record ID.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

name

-

String

-

API name.

-

remark

-

String

-

API description.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

id

-

String

-

API ID.

-

req_uri

-

String

-

API request address.

-

type

-

Integer

-

API type.

-

signature_name

-

String

-

Name of the signature key bound to the API.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "apis" : [ {
-    "run_env_name" : "RELEASE",
-    "group_name" : "api_group_001",
-    "remark" : "Mock backend API",
-    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "name" : "Api_mock",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
-    "type" : 1,
-    "auth_type" : "IAM",
-    "req_uri" : "/test/mock"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3017",
-  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Signature Keys
-
-
- diff --git a/docs/apig/api-ref/ListApisUnbindedToAclPolicyV2_1.html b/docs/apig/api-ref/ListApisUnbindedToAclPolicyV2_1.html deleted file mode 100644 index 9c5c1f8b..00000000 --- a/docs/apig/api-ref/ListApisUnbindedToAclPolicyV2_1.html +++ /dev/null @@ -1,529 +0,0 @@ - - -

Querying APIs Not Bound with an Access Control Policy

-

Function

This API is used to query the published APIs to which an access control policy has not been bound.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

acl_id

-

Yes

-

String

-

Access control policy ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-

env_id

-

No

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of UnbindApiForAcl objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 UnbindApiForAcl

Parameter

-

Type

-

Description

-

id

-

String

-

API ID.

-

name

-

String

-

API name.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

type

-

Integer

-

API visibility.

-

remark

-

String

-

API description.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

publish_id

-

String

-

API publication record ID.

-

acl_name

-

String

-

Name of the same type of access control policy bound to the API.

-

req_uri

-

String

-

API request address.

-

auth_type

-

String

-

API authentication mode.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-

  • GET

    -

  • POST

    -

  • DELETE

    -

  • PUT

    -

  • PATCH

    -

  • HEAD

    -

  • OPTIONS

    -

  • ANY

    -
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "apis" : [ {
-    "name" : "Api_mock",
-    "type" : 1,
-    "remark" : "Mock backend API",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
-    "group_name" : "api_group_001",
-    "run_env_name" : "RELEASE",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
-    "req_uri" : "/test/mock",
-    "auth_type" : "IAM"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListApisUnbindedToAppV2_1.html b/docs/apig/api-ref/ListApisUnbindedToAppV2_1.html deleted file mode 100644 index 76f6838d..00000000 --- a/docs/apig/api-ref/ListApisUnbindedToAppV2_1.html +++ /dev/null @@ -1,508 +0,0 @@ - - -

Querying APIs Not Bound with an App

-

Function

This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

app_id

-

Yes

-

String

-

App ID.

-

env_id

-

Yes

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of ApiOutline objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiOutline

Parameter

-

Type

-

Description

-

auth_type

-

String

-

API authentication mode.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

publish_id

-

String

-

Publication record ID.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

name

-

String

-

API name.

-

remark

-

String

-

API description.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

id

-

String

-

API ID.

-

req_uri

-

String

-

API request address.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "apis" : [ {
-    "auth_type" : "APP",
-    "run_env_name" : "",
-    "group_name" : "api_group_001",
-    "publish_id" : "",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "name" : "Api_function",
-    "remark" : "FunctionGraph backend API",
-    "run_env_id" : "",
-    "id" : "abd9c4b2ff974888b0ba79be7e6b2763",
-    "req_uri" : "/test/function"
-  }, {
-    "auth_type" : "APP",
-    "run_env_name" : "RELEASE",
-    "group_name" : "APIGroup_d3da",
-    "publish_id" : "ca2631e233a74a758744ae1e19cc5ad7",
-    "group_id" : "6acd94abe58747ee8a73b10c70817bac",
-    "name" : "API_test",
-    "remark" : "FunctionGraph backend API",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "id" : "11cbec3a7a8345ca981b86d161bc436e",
-    "req_uri" : "/appcode"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3004",
-  "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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: App Authorization Management
-
-
- diff --git a/docs/apig/api-ref/ListApisUnbindedToRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/ListApisUnbindedToRequestThrottlingPolicyV2_1.html deleted file mode 100644 index b0338a0e..00000000 --- a/docs/apig/api-ref/ListApisUnbindedToRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,554 +0,0 @@ - - -

Querying APIs Not Bound with a Request Throttling Policy

-

Function

This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

throttle_id

-

Yes

-

String

-

Request throttling policy ID.

-

env_id

-

No

-

String

-

Environment ID.

-

group_id

-

No

-

String

-

API group ID.

-

api_id

-

No

-

String

-

API ID.

-

api_name

-

No

-

String

-

API name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of ApiForThrottle objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiForThrottle

Parameter

-

Type

-

Description

-

auth_type

-

String

-

API authentication mode.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

publish_id

-

String

-

API publication record ID.

-

throttle_apply_id

-

String

-

ID of a request throttling policy binding record.

-

apply_time

-

String

-

Binding time.

-

remark

-

String

-

API description.

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

type

-

Integer

-

API type.

-

throttle_name

-

String

-

Name of the request throttling policy bound to the API.

-

req_uri

-

String

-

Access address of the API.

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

name

-

String

-

API name.

-

id

-

String

-

API ID.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-

  • GET

    -

  • POST

    -

  • DELETE

    -

  • PUT

    -

  • PATCH

    -

  • HEAD

    -

  • OPTIONS

    -

  • ANY

    -
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "apis" : [ {
-    "run_env_name" : "RELEASE",
-    "group_name" : "api_group_001",
-    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "name" : "Api_mock",
-    "remark" : "Mock backend API",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
-    "type" : 1,
-    "auth_type" : "IAM",
-    "req_uri" : "/test/mock"
-  }, {
-    "run_env_name" : "RELEASE",
-    "group_name" : "APIGroup_d00511069",
-    "publish_id" : "0c613568c8644a1b92172156f77a5759",
-    "group_id" : "d7d0b9a54469424f942e16a6b6026936",
-    "name" : "API_nevj",
-    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "id" : "9e07bc00a1864ab4aafd4a23d19dd1c2",
-    "type" : 1,
-    "auth_type" : "APP",
-    "req_uri" : "/fdasf"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListApisV2_1.html b/docs/apig/api-ref/ListApisV2_1.html deleted file mode 100644 index 2d4c6957..00000000 --- a/docs/apig/api-ref/ListApisV2_1.html +++ /dev/null @@ -1,1335 +0,0 @@ - - -

Querying APIs

-

Function

This API is used to query APIs to return details and publication information of the APIs. Backend information of the APIs will not be returned.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

API ID.

-

name

-

No

-

String

-

API name.

-

group_id

-

No

-

String

-

API group ID.

-

req_protocol

-

No

-

String

-

Request protocol.

-

req_method

-

No

-

String

-

Request method.

-

req_uri

-

No

-

String

-

Request path.

-

auth_type

-

No

-

String

-

Security authentication mode.

-

env_id

-

No

-

String

-

ID of the environment in which the API has been published.

-

type

-

No

-

Integer

-

API type.

-

precise_search

-

No

-

String

-

Parameter name (name or req_uri) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apis

-

Array of ApiInfoPerPage objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiInfoPerPage

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

status

-

Integer

-

App status.

-
  • 1: valid
-

arrange_necessary

-

Integer

-

Indicates whether to enable orchestration.

-

register_time

-

String

-

Time when the API is registered.

-

update_time

-

String

-

Time when the API was last modified.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

group_version

-

String

-

Version of the API group to which the API belongs.

-

The default value is V1. Other versions are not supported.

-

Default: V1

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

Separate multiple environment IDs with vertical bars (|).

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

Separate multiple environment names with vertical bars (|).

-

publish_id

-

String

-

Publication record ID.

-

Separate multiple publication record IDs with vertical bars (|).

-

publish_time

-

String

-

Publication time.

-

Separate the time of multiple publication records with vertical bars (|).

-

roma_app_name

-

String

-

Name of the integration application to which the API belongs.

-

Currently, this parameter is not supported.

-

ld_api_id

-

String

-

ID of the corresponding custom backend API.

-

Currently, this parameter is not supported.

-

backend_api

-

BackendApi object

-

Backend information.

-

api_group_info

-

ApiGroupCommonInfo object

-

API group information.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-
-
- -
- - - - - - - - - -
Table 6 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 BackendApi

Parameter

-

Type

-

Description

-

authorizer_id

-

String

-

Custom authorizer ID.

-

url_domain

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

id

-

String

-

ID.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

register_time

-

String

-

Registration time.

-

update_time

-

String

-

Update time.

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 VpcInfo

Parameter

-

Type

-

Description

-

ecs_id

-

String

-

Cloud server ID.

-

ecs_name

-

String

-

Cloud server name.

-

cascade_flag

-

Boolean

-

Indicates whether to use the cascading mode.

-

Currently, this parameter is not supported.

-

vpc_channel_proxy_host

-

String

-

Proxy host.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

vpc_channel_port

-

Integer

-

VPC channel port.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ApiGroupCommonInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 13 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 14 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 15 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 3,
-  "size" : 3,
-  "apis" : [ {
-    "arrange_necessary" : 2,
-    "id" : "5f918d104dc84480a75166ba99efff21",
-    "tags" : [ "webApi" ],
-    "backend_type" : "HTTP",
-    "auth_type" : "AUTHORIZER",
-    "auth_opt" : {
-      "app_code_auth_type" : "DISABLE"
-    },
-    "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
-    "cors" : false,
-    "status" : 1,
-    "group_name" : "api_group_001",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "group_version" : "V1",
-    "match_mode" : "NORMAL",
-    "name" : "Api_http",
-    "req_protocol" : "HTTPS",
-    "req_method" : "GET",
-    "req_uri" : "/test/http",
-    "type" : 1,
-    "version" : "V0.0.1",
-    "register_time" : "2020-07-31T12:42:51Z",
-    "update_time" : "2020-08-02T16:32:47.046289Z",
-    "remark" : "Web backend API"
-  }, {
-    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "group_name" : "api_group_001",
-    "group_version" : "V1",
-    "match_mode" : "SWA",
-    "name" : "Api_mock",
-    "auth_type" : "IAM",
-    "auth_opt" : {
-      "auth_code_auth_type" : "DISABLE"
-    },
-    "backend_type" : "MOCK",
-    "cors" : false,
-    "req_protocol" : "HTTPS",
-    "req_uri" : "/test/mock",
-    "remark" : "Mock backend API",
-    "type" : 1,
-    "version" : "V0.0.1",
-    "req_method" : "GET",
-    "result_normal_sample" : "Example success response",
-    "result_failure_sample" : "Example failure response",
-    "tags" : [ "mockApi" ],
-    "register_time" : "2020-08-02T15:56:52Z",
-    "update_time" : "2020-08-02T15:56:52Z",
-    "status" : 1
-  }, {
-    "id" : "abd9c4b2ff974888b0ba79be7e6b2763",
-    "arrange_necessary" : 2,
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "group_name" : "api_group_001",
-    "group_version" : "V1",
-    "match_mode" : "NORMAL",
-    "name" : "Api_function",
-    "auth_type" : "APP",
-    "auth_opt" : {
-      "auth_code_auth_type" : "DISABLE"
-    },
-    "backend_type" : "FUNCTION",
-    "cors" : false,
-    "req_protocol" : "HTTPS",
-    "req_uri" : "/test/function",
-    "remark" : "FunctionGraph backend API",
-    "type" : 1,
-    "version" : "V0.0.1",
-    "status" : 1,
-    "req_method" : "GET",
-    "tags" : [ "functionApi" ],
-    "register_time" : "2020-08-02T15:36:19Z",
-    "update_time" : "2020-08-02T15:47:53.499266Z"
-  } ]
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/ListAppCodesV2_1.html b/docs/apig/api-ref/ListAppCodesV2_1.html deleted file mode 100644 index 3833dbd7..00000000 --- a/docs/apig/api-ref/ListAppCodesV2_1.html +++ /dev/null @@ -1,419 +0,0 @@ - - -

Querying AppCodes of an App

-

Function

This API is used to query the AppCodes of an app.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

app_codes

-

Array of AppCodeBaseInfo objects

-

AppCode list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 5 AppCodeBaseInfo

Parameter

-

Type

-

Description

-

app_code

-

String

-

AppCode value.

-

It can contain 64 to 180 characters, starting with a letter, digit, plus sign (+), or slash (/). Only letters, digits, and the following special characters are allowed: +_!@#$%-/=

-

id

-

String

-

ID.

-

app_id

-

String

-

App ID.

-

create_time

-

String

-

Creation time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "app_codes" : [ {
-    "app_code" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7W+gr4VJBB5BtJ4fdVOQoSvoji3gFxUDb5pWBz9wUcw9+8/bFZ1B/4pq29wCMQC0pQWX6zTndljDEl99As1pw+WntAU9xcq+ffagoH6zDpKUvdxV6Ezj8LcCcPZN6BU=",
-    "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-    "id" : "32dc8ca22d1b4b9cb94022186880576b",
-    "create_time" : "2020-07-24T02:37:24Z"
-  }, {
-    "app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a",
-    "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-    "id" : "b3d34f746d0847fb95138670e10207ed",
-    "create_time" : "2020-07-24T02:31:45Z"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
-  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ListAppQuantitiesV2_1.html b/docs/apig/api-ref/ListAppQuantitiesV2_1.html deleted file mode 100644 index 3ccecdd6..00000000 --- a/docs/apig/api-ref/ListAppQuantitiesV2_1.html +++ /dev/null @@ -1,315 +0,0 @@ - - -

Querying App Quantities

-

Function

This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/apps

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

authed_nums

-

Integer

-

Number of apps that have been authorized to access APIs.

-

unauthed_nums

-

Integer

-

Number of apps that have not been authorized to access APIs.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "authed_nums" : 7,
-  "unauthed_nums" : 5
-}
-

Status code: 400

-

Bad Request

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

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Bad Request

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Resource Query
-
-
- diff --git a/docs/apig/api-ref/ListAppsBindedToApiV2_1.html b/docs/apig/api-ref/ListAppsBindedToApiV2_1.html deleted file mode 100644 index 86ab41fe..00000000 --- a/docs/apig/api-ref/ListAppsBindedToApiV2_1.html +++ /dev/null @@ -1,598 +0,0 @@ - - -

Querying Apps Bound to an API

-

Function

This API is used to query the apps that have been bound to a specified API.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

api_id

-

No

-

String

-

API ID.

-

app_name

-

No

-

String

-

App name.

-

app_id

-

No

-

String

-

App ID.

-

env_id

-

No

-

String

-

Environment ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

auths

-

Array of ApiAuthInfo objects

-

API list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiAuthInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Authorization record ID.

-

api_id

-

String

-

API ID.

-

api_name

-

String

-

API name.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

api_type

-

Integer

-

API type.

-

api_remark

-

String

-

API description.

-

env_id

-

String

-

ID of the environment in which an app has been authorized to call the API.

-

auth_role

-

String

-

Authorizer.

-

auth_time

-

String

-

Authorization time.

-

app_name

-

String

-

App name.

-

app_remark

-

String

-

App description.

-

app_type

-

String

-

App type.

-

The default value is apig. Other types are not supported currently.

-

Enumeration values:

-

  • apig

    -

  • roma

    -
-

app_creator

-

String

-

Creator of the app.

-

  • USER: The app is created by a tenant.

    -

  • MARKET: The app is allocated by KooGallery. This value is not supported currently.

    -
-

publish_id

-

String

-

API publication record ID.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

auth_tunnel

-

String

-

Authorization channel type.

-

  • NORMAL: normal channel

    -

  • GREEN: green channel

    -
-

The default value is NORMAL. This parameter is not supported currently.

-

Enumeration values:

-

  • NORMAL

    -

  • GREEN

    -
-

auth_whitelist

-

Array of strings

-

Whitelist for the green channel.

-

auth_blacklist

-

Array of strings

-

Blacklist for the green channel.

-

visit_param

-

String

-

Access parameters.

-

roma_app_type

-

String

-

ROMA application type.

-

  • subscription: subscription application

    -

  • integration: integration application

    -
-

Currently, this parameter is not supported.

-

env_name

-

String

-

Name of the environment in which the app has been authorized to call the API.

-

app_id

-

String

-

App ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "auths" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "app_name" : "app_demo",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "group_name" : "api_group_001",
-    "api_type" : 1,
-    "api_name" : "Api_http",
-    "app_id" : "356de8eb7a8742168586e5daf5339965",
-    "auth_time" : "2020-08-04T04:02:22Z",
-    "app_creator" : "USER",
-    "id" : "dd29b33ae4394e3b924b582c6b40880b",
-    "api_remark" : "Web backend API",
-    "auth_role" : "PROVIDER",
-    "app_type" : "apig",
-    "auth_tunnel" : "NORMAL"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: App Authorization Management
-
-
- diff --git a/docs/apig/api-ref/ListAppsV2_1.html b/docs/apig/api-ref/ListAppsV2_1.html deleted file mode 100644 index 617e3730..00000000 --- a/docs/apig/api-ref/ListAppsV2_1.html +++ /dev/null @@ -1,521 +0,0 @@ - - -

Querying Apps

-

Function

This API is used to query apps.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apps

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

App ID.

-

name

-

No

-

String

-

App name.

-

status

-

No

-

Integer

-

App status.

-

app_key

-

No

-

String

-

AppKey.

-

creator

-

No

-

String

-

Creator of the app.

-

  • USER: The app is created by an API user.

    -

  • MARKET: This parameter is not used currently.

    -
-

precise_search

-

No

-

String

-

Parameter name (name) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

apps

-

Array of AppInfoWithBindNum objects

-

App list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 AppInfoWithBindNum

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.

-

bind_num

-

Integer

-

Number of bound APIs.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "apps" : [ {
-    "bind_num" : 0,
-    "creator" : "USER",
-    "update_time" : "2020-08-03T13:09:13Z",
-    "app_key" : "ee8f878c252747028f07eb116c2cd91b",
-    "name" : "app_demo",
-    "remark" : "Demo app",
-    "id" : "356de8eb7a8742168586e5daf5339965",
-    "app_secret" : "416************ab8",
-    "register_time" : "2020-08-03T13:09:13Z",
-    "status" : 1,
-    "app_type" : "apig"
-  }, {
-    "bind_num" : 3,
-    "creator" : "USER",
-    "update_time" : "2020-05-27T10:38:03.133586Z",
-    "app_key" : "840b8b5b1efc4ec686639759c2c584da",
-    "name" : "app_001",
-    "id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-    "app_secret" : "0a4************c6e",
-    "register_time" : "2020-03-28T11:09:06Z",
-    "status" : 1
-  } ]
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ListAvailableZonesV2_1.html b/docs/apig/api-ref/ListAvailableZonesV2_1.html deleted file mode 100644 index 07d4c6a5..00000000 --- a/docs/apig/api-ref/ListAvailableZonesV2_1.html +++ /dev/null @@ -1,335 +0,0 @@ - - -

Querying AZs

-

Function

This API is used to query AZs where you can buy gateways.

-
-

URI

GET /v2/{project_id}/apigw/available-zones

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

available_zones

-

Array of AvailableZone objects

-

AZ list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 AvailableZone

Parameter

-

Type

-

Description

-

name

-

String

-

AZ name.

-

id

-

String

-

Error message.

-

code

-

String

-

AZ code.

-

port

-

String

-

AZ port.

-

local_name

-

LocalName object

-

AZ names.

-

specs

-

Map<String,Boolean>

-

Gateway editions available in the AZ.

-
-
- -
- - - - - - - - - - - - - -
Table 5 LocalName

Parameter

-

Type

-

Description

-

en_us

-

String

-

AZ name.

-

zh_cn

-

String

-

AZ name.

-
-
-

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: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "available_zones" : [ {
-    "code" : "xx-xxx-4a",
-    "id" : "effdcbc7d4d64a02aa1fa26b42f56533",
-    "local_name" : {
-      "en_us" : "AZ1",
-      "zh_cn" : "<Name_of_AZ1>"
-    },
-    "name" : "<Name_of_AZ1>",
-    "port" : "8403",
-    "specs" : {
-      "BASIC" : true,
-      "ENTERPRISE" : true,
-      "PLATINUM" : true,
-      "PROFESSIONAL" : true,
-      "TRIAL" : true
-
-    }
-  }, {
-    "code" : "xx-xxx-4b",
-    "id" : "a0865121f83b41cbafce65930a22a6e8",
-    "local_name" : {
-      "en_us" : "AZ2",
-      "zh_cn" : "<Name_of_AZ2>"
-    },
-    "name" : "<Name_of_AZ2>",
-    "port" : "8404",
-    "specs" : {
-      "BASIC" : true,
-      "ENTERPRISE" : true,
-      "PLATINUM" : true,
-      "PROFESSIONAL" : true,
-      "TRIAL" : true
-    }
-  } ]
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/ListBackendInstancesV2_1.html b/docs/apig/api-ref/ListBackendInstancesV2_1.html deleted file mode 100644 index b8573583..00000000 --- a/docs/apig/api-ref/ListBackendInstancesV2_1.html +++ /dev/null @@ -1,548 +0,0 @@ - - -

Querying Backend Servers of a VPC Channel

-

Function

This API is used to query the backend instances of a specified VPC channel.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

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

-

vpc_channel_id

-

Yes

-

String

-

VPC channel ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

name

-

No

-

String

-

Cloud server name.

-

member_group_name

-

No

-

String

-

Backend server group name.

-

member_group_id

-

No

-

String

-

Backend server group ID.

-

precise_search

-

No

-

String

-

Parameter name for exact matching. Separate multiple parameter names with commas (,).

-

Currently, name and member_group_name are supported.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

members

-

Array of VpcMemberInfo objects

-

Cloud server list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 VpcMemberInfo

Parameter

-

Type

-

Description

-

host

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

Integer

-

Backend server status.

-

  • 1: available

    -

  • 2: unavailable

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

port

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-

id

-

String

-

Backend instance ID.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

create_time

-

String

-

Time when the backend server is added to the VPC channel.

-

member_group_id

-

String

-

Backend server group ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "members" : [ {
-    "host" : "192.168.0.5",
-    "weight" : 1,
-    "is_backup" : false,
-    "member_group_name" : "",
-    "status" : 1,
-    "port" : 22,
-    "ecs_id" : "192.168.0.5",
-    "ecs_name" : "192.168.0.5",
-    "id" : "be63c6260a1043888187f84af39c9f0e",
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "create_time" : "2020-07-23T07:11:57Z",
-    "member_group_id" : ""
-  }, {
-    "host" : "192.168.1.124",
-    "weight" : 2,
-    "is_backup" : false,
-    "member_group_name" : "",
-    "status" : 1,
-    "port" : 22,
-    "ecs_id" : "192.168.1.124",
-    "ecs_name" : "192.168.1.124",
-    "id" : "a57b13f1b89b417ca8acd76909e6df67",
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "create_time" : "2020-07-23T07:11:57Z",
-    "member_group_id" : ""
-  } ]
-}
-

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

-
{
-  "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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/ListCustomAuthorizersV2_1.html b/docs/apig/api-ref/ListCustomAuthorizersV2_1.html deleted file mode 100644 index e10141b7..00000000 --- a/docs/apig/api-ref/ListCustomAuthorizersV2_1.html +++ /dev/null @@ -1,566 +0,0 @@ - - -

Querying Custom Authorizers

-

Function

This API is used to query all the custom authorizers under a gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

ID.

-

name

-

No

-

String

-

Name.

-

type

-

No

-

String

-

Type.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

authorizer_list

-

Array of AuthorizerResp objects

-

Custom authorizers.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 AuthorizerResp

Parameter

-

Type

-

Description

-

name

-

String

-

Custom authorizer name.

-

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

-

type

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

String

-

Function URN.

-

authorizer_version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

Array of Identity objects

-

Identity source.

-

ttl

-

Integer

-

Maximum cache age.

-

user_data

-

String

-

User data.

-

ld_api_id

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

Boolean

-

Indicates whether to send the body.

-

id

-

String

-

Custom authorizer ID.

-

create_time

-

String

-

Creation time.

-

roma_app_id

-

String

-

ID of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 Identity

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "authorizer_list" : [ {
-    "name" : "Authorizer_demo",
-    "type" : "FRONTEND",
-    "authorizer_type" : "FUNC",
-    "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-     "authorizer_version" : "v1",
-    "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-    "identities" : [ {
-      "name" : "header",
-      "location" : "HEADER"
-    } ],
-    "ttl" : 0,
-    "user_data" : "authorizer_test",
-    "id" : "0d982c1ac3da493dae47627b6439fc5c",
-    "create_time" : "2020-07-31T11:55:43Z"
-  } ]
-}
-

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Custom Authorizer Management
-
-
- diff --git a/docs/apig/api-ref/ListEnvironmentVariablesV2_1.html b/docs/apig/api-ref/ListEnvironmentVariablesV2_1.html deleted file mode 100644 index c4b1284c..00000000 --- a/docs/apig/api-ref/ListEnvironmentVariablesV2_1.html +++ /dev/null @@ -1,420 +0,0 @@ - - -

Querying Environment Variables

-

Function

This API is used to query all environment variables under an API group.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

group_id

-

Yes

-

String

-

API group ID.

-

env_id

-

No

-

String

-

Environment ID.

-

variable_name

-

No

-

String

-

Variable name.

-

precise_search

-

No

-

String

-

Parameter name (name) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

variables

-

Array of EnvVariableInfo objects

-

Environment variable list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 EnvVariableInfo

Parameter

-

Type

-

Description

-

variable_value

-

String

-

The variable value can contain 1 to 255 characters. Only letters, digits, and special characters (_-/.:) are allowed.

-

env_id

-

String

-

Environment ID.

-

Minimum: 1

-

Maximum: 65

-

group_id

-

String

-

API group ID.

-

Minimum: 1

-

Maximum: 65

-

variable_name

-

String

-

Variable name, which can contain 3 to 32 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. The variable name is equivalent to "#Name#" in API definitions. Characters between the number signs are case-sensitive. The variable name will be replaced with the variable value after API publication.

-

id

-

String

-

Environment variable ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "variables" : [ {
-    "variable_value" : "8080",
-    "env_id" : "cca3616af3684b329064b2a631cb3eeb",
-    "group_id" : "73c58022f20d495aa18885d718647f09",
-    "id" : "09ab8135722440b9bf5d107f2a09d409",
-    "variable_name" : "port"
-  }, {
-    "variable_value" : "192.168.1.5",
-    "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
-    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-    "id" : "25054838a624400bbf2267cf5b3a3f70",
-    "variable_name" : "address"
-  } ],
-  "total" : 2,
-  "size" : 2
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Variable Management
-
-
- diff --git a/docs/apig/api-ref/ListEnvironmentsV2_1.html b/docs/apig/api-ref/ListEnvironmentsV2_1.html deleted file mode 100644 index 71aee667..00000000 --- a/docs/apig/api-ref/ListEnvironmentsV2_1.html +++ /dev/null @@ -1,380 +0,0 @@ - - -

Querying Environments

-

Function

This API is used to query environments.

-
-

URI

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

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

name

-

No

-

String

-

Environment name.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

envs

-

Array of EnvInfo objects

-

Environment list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 5 EnvInfo

Parameter

-

Type

-

Description

-

create_time

-

String

-

Creation time.

-

name

-

String

-

Environment name.

-

remark

-

String

-

Description.

-

id

-

String

-

Environment ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "envs" : [ {
-    "create_time" : "2019-02-12T19:42:19.914989Z",
-    "name" : "RELEASE",
-    "remark" : "xxx",
-    "id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
-  }, {
-    "create_time" : "2020-07-31T06:41:43Z",
-    "name" : "DEV",
-    "remark" : "Development environment",
-    "id" : "7a1ad0c350844ee69479b47df9a881cb"
-  } ]
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Management
-
-
- diff --git a/docs/apig/api-ref/ListFeaturesV2_1.html b/docs/apig/api-ref/ListFeaturesV2_1.html deleted file mode 100644 index c6ccea98..00000000 --- a/docs/apig/api-ref/ListFeaturesV2_1.html +++ /dev/null @@ -1,423 +0,0 @@ - - -

Querying Gateway Features

-

Function

This API is used to query the features of a gateway. If a gateway does not support the features listed in the following table, contact technical support to upgrade the gateway.

-

For details about the supported features and configuration examples, see "Appendix" > "Supported Features" in this document.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/features

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

features

-

Array of FeatureInfo objects

-

Feature list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 FeatureInfo

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

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "features" : [ {
-    "config" : "on",
-    "enable" : true,
-    "id" : "db9a9260cd3e4a16a9b5747a65d3ffaa",
-    "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
-    "name" : "app_api_key",
-    "update_time" : "2020-08-24T01:17:31.041984Z"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Feature Management
-
-
- diff --git a/docs/apig/api-ref/ListGatewayResponsesV2_1.html b/docs/apig/api-ref/ListGatewayResponsesV2_1.html deleted file mode 100644 index 290a0188..00000000 --- a/docs/apig/api-ref/ListGatewayResponsesV2_1.html +++ /dev/null @@ -1,469 +0,0 @@ - - -

Querying Group Responses

-

Function

This API is used to query the responses of an API group.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

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

-

group_id

-

Yes

-

String

-

API group ID.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

responses

-

Array of ResponsesInfo objects

-

Response list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ResponsesInfo

Parameter

-

Type

-

Description

-

name

-

String

-

Response name.

-

responses

-

Map<String,ResponseInfoResp>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-

id

-

String

-

Response ID.

-

default

-

Boolean

-

Indicates whether the group response is the default response.

-

create_time

-

String

-

Creation time.

-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "responses" : [ {
-    "create_time" : "2020-08-12T06:52:02Z",
-    "default" : false,
-    "id" : "e839b367e10f4ab19d1c5008e476b83a",
-    "name" : "response_demo",
-    "update_time" : "2020-08-12T06:52:02Z"
-  }, {
-    "create_time" : "2020-07-31T11:39:23Z",
-    "default" : true,
-    "id" : "ed8e8c52ab0e4a1c9c809268e5002e64",
-    "name" : "default",
-    "update_time" : "2020-07-31T11:39:23Z"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/ListInstanceConfigsV2_1.html b/docs/apig/api-ref/ListInstanceConfigsV2_1.html deleted file mode 100644 index 083e7401..00000000 --- a/docs/apig/api-ref/ListInstanceConfigsV2_1.html +++ /dev/null @@ -1,369 +0,0 @@ - - -

Querying Gateway Configurations

-

Function

This API is used to query the gateway configurations.

-
-

URI

GET /v2/{project_id}/apigw/instance/configs

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

configs

-

Array of InstanceConfig objects

-

Quota list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 InstanceConfig

Parameter

-

Type

-

Description

-

config_id

-

String

-

Quota ID.

-

config_name

-

String

-

Quota name.

-

Enumeration values:

-
  • INSTANCE_NUM_LIMIT
-

config_value

-

String

-

Quota value.

-

It indicates the value of the quota for the current gateway.

-

config_time

-

String

-

Time when the quota is created.

-

remark

-

String

-

Quota description.

-
  • INSTANCE_NUM_LIMIT: Number of instances that a tenant can create.
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "configs" : [ {
-    "config_id" : "1",
-    "config_name" : "INSTANCE_NUM_LIMIT",
-    "config_value" : "5",
-    "config_time" : 1597981093255,
-    "remark" : "xxx"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Configuration Management
-
-
- diff --git a/docs/apig/api-ref/ListInstancesV2_1.html b/docs/apig/api-ref/ListInstancesV2_1.html deleted file mode 100644 index a8bba15f..00000000 --- a/docs/apig/api-ref/ListInstancesV2_1.html +++ /dev/null @@ -1,438 +0,0 @@ - - -

Querying Dedicated Gateways

-

Function

This API is used to query dedicated gateways.

-
-

URI

GET /v2/{project_id}/apigw/instances

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

instance_id

-

No

-

String

-

Gateway ID.

-

instance_name

-

No

-

String

-

Gateway name.

-

status

-

No

-

String

-

Gateway status.

-
  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
-

Enumeration values:

-
  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

instances

-

Array of RespInstanceBase objects

-

Gateway list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 RespInstanceBase

Parameter

-

Type

-

Description

-

id

-

String

-

Gateway ID.

-

project_id

-

String

-

ID of the tenant to which the gateway belongs.

-

instance_name

-

String

-

Gateway name.

-

status

-

String

-

Instance status:

-
  • Creating: The instance is being created.
  • CreateSuccess: The instance is created successfully.
  • CreateFail: The instance fails to be created.
  • Initing: The instance is being initialized.
  • Registering: The instance is being registered.
  • Running: The instance is running.
  • InitingFailed: The instance fails to be initialized.
  • RegisterFailed: The instance fails to be registered.
  • Installing: The instance is being installed.
  • InstallFailed: The instance fails to be installed.
  • Updating: The instance is being upgraded.
  • UpdateFailed: The instance fails to be upgraded.
  • Rollbacking: The instance is being rolled back.
  • RollbackSuccess: The instance is rolled back successfully.
  • RollbackFailed: The instance fails to be rolled back.
  • Deleting: The instance is being deleted.
  • DeleteFailed: The instance fails to be deleted.
  • Unregistering: The instance is being deregistered.
  • UnRegisterFailed: The instance fails to be deregistered.
  • CreateTimeout: Creation of the instance times out.
  • InitTimeout: Initialization of the instance times out.
  • RegisterTimeout: Registration of the instance times out.
  • InstallTimeout: Installation of the instance times out.
  • UpdateTimeout: Upgrading of the instance times out.
  • RollbackTimeout: Rollback of the instance times out.
  • DeleteTimeout: Deletion of the instance times out.
  • UnregisterTimeout: Deregistration of the instance times out.
  • Starting: The instance is being started.
  • Freezing: The instance is being frozen.
  • Frozen: The instance is frozen.
  • Restarting: The instance is being restarted.
  • RestartFail: The instance fails to be restarted.
  • Unhealthy: The instance is abnormal.
  • RestartTimeout: Restart of the instance times out.
  • Resizing: The instance specification is changing.
  • ResizeFailed: The instance specification fails to be changed.
  • ResizeTimeout: The instance specification change times out.
-

Enumeration values:

-
  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
  • Resizing
  • ResizeFailed
  • ResizeTimeout
-

instance_status

-

Integer

-

Instance status ID:

-
  • 1: Creating
  • 2: Created successfully
  • 3: Creation failed
  • 4: Initializing
  • 5: Registering
  • 6: Running
  • 7: Initialization failed
  • 8: Registration failed
  • 10: Installing
  • 11: Installation failed
  • 12: Upgrading
  • 13: Upgrade failed
  • 20: Rolling back
  • 21: Rolled back
  • 22: Rollback failed
  • 23: Deleting
  • 24: Deletion failed
  • 25: Deregistering
  • 26: Deregistration failed
  • 27: Creation timed out
  • 28: Initialization timed out
  • 29: Registration timed out
  • 30: Installation timed out
  • 31: Upgrade timed out
  • 32: Rollback timed out
  • 33: Deletion timed out
  • 34: Deregistration timed out
  • 35: Starting
  • 36: Freezing
  • 37: Frozen
  • 38: Restarting
  • 39: Restart failed
  • 40: Abnormal
  • 41: Restart timed out
  • 42: Changing specification
  • 43: Specification change failed
  • 44: Specification change timed out
-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 10
  • 11
  • 12
  • 13
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
-

type

-

String

-

Gateway type.

-

The default value is apig.

-

spec

-

String

-

Gateway edition.

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

Enumeration values:

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

create_time

-

Long

-

Time when the gateway is created. The time is in the Unix timestamp format.

-

enterprise_project_id

-

String

-

Enterprise project ID. This parameter is required if you are using an enterprise account.

-

eip_address

-

String

-

EIP bound to the gateway.

-

charging_mode

-

Integer

-

Billing mode of the gateway.

-
  • 0: pay-per-use
  • 1: This parameter is not used currently.
-

Enumeration values:

-
  • 0
  • 1
-

loadbalancer_provider

-

String

-

Type of the load balancer used by the gateway.

-
  • ELB
-
-
-

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: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "instances" : [ {
-    "charging_mode" : 1,
-    "create_time" : 1585302825070,
-    "eip_address" : "198.162.155.221",
-    "enterprise_project_id" : "0",
-    "id" : "eddc4d25480b4cd6b512f270a1b8b341",
-    "instance_name" : "apig-Enterprise_Project_Pay-per-Use",
-    "instance_status" : 6,
-    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
-    "spec" : "PROFESSIONAL",
-    "status" : "Running",
-    "type" : "apig"
-  }, {
-    "charging_mode" : 0,
-    "create_time" : 1594370987422,
-    "eip_address" : "198.162.147.95",
-    "enterprise_project_id" : "0",
-    "id" : "2e2d613c64094a4a94ad38e7ca30adee",
-    "instance_name" : "apig-autotest-apitest-nodelete",
-    "instance_status" : 6,
-    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
-    "spec" : "PROFESSIONAL",
-    "status" : "Running",
-    "type" : "apig"
-  } ]
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/ListLatelyApiStatisticsV2_1.html b/docs/apig/api-ref/ListLatelyApiStatisticsV2_1.html deleted file mode 100644 index 1da35086..00000000 --- a/docs/apig/api-ref/ListLatelyApiStatisticsV2_1.html +++ /dev/null @@ -1,562 +0,0 @@ - - -

Querying API Calls Within a Period

-

Function

This API is used to query the number of times APIs in an API group are called within a period. The query is based on 1 minute. If the time range is within one hour, the server returns the number of API calls made every minute.

-

For security purposes, clear your operation records, including but not limited to records in the ~/.bash_history and /var/log/messages directories (if any), after running the curl command on the server to query information.

-
-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/api/latest

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

api_id

-

Yes

-

String

-

API ID.

-

duration

-

Yes

-

String

-

Time range (unit: h or m). For example, 1h refers to the latest 1 hour and 1m refers to the latest 1 minute.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

code

-

String

-

Response code.

-

msg

-

String

-

Response message.

-

start_time

-

Long

-

Timestamp (UTC) of the start time.

-

end_time

-

Long

-

Timestamp (UTC) of the end time.

-

list

-

Array of StatisticsAPI objects

-

Statistic data.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 StatisticsAPI

Parameter

-

Type

-

Description

-

max_latency

-

Integer

-

Maximum latency.

-

Unit: ms

-

avg_latency

-

Float

-

Average latency.

-

Unit: ms

-

req_count

-

Integer

-

Total number of requests.

-

req_count2xx

-

Integer

-

Total number of 2xx response codes.

-

req_count4xx

-

Integer

-

Total number of 4xx response codes.

-

req_count5xx

-

Integer

-

Total number of 5xx response codes.

-

req_count_error

-

Integer

-

Errors.

-

max_inner_latency

-

Integer

-

Maximum gateway latency.

-

Unit: ms

-

avg_inner_latency

-

Float

-

Average gateway latency.

-

Unit: ms

-

max_backend_latency

-

Integer

-

Maximum backend latency.

-

avg_backend_latency

-

Float

-

Average backend latency.

-

output_throughput

-

Long

-

Downstream throughput (bytes).

-

input_throughput

-

Long

-

Upstream throughput (bytes).

-

current_minute

-

Long

-

Timestamp (UTC) of API access.

-

cycle

-

String

-

Statistical period.

-

Enumeration values:

-

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

api_id

-

String

-

API ID.

-

group_id

-

String

-

API group ID.

-

provider

-

String

-

API provider.

-

req_time

-

String

-

Request time.

-

register_time

-

String

-

Recording time.

-

status

-

Integer

-

Status.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "code" : "APIG.0000",
-  "start_time" : 1595573280,
-  "end_time" : 1595576820,
-  "list" : [ {
-    "api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9",
-    "avg_backend_latency" : 2.71,
-    "avg_inner_latency" : 1.57,
-    "avg_latency" : 4.14,
-    "current_minute" : 1595576640,
-    "cycle" : "MINUTE",
-    "group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
-    "input_throughput" : 1071,
-    "max_backend_latency" : 6,
-    "max_inner_latency" : 8,
-    "max_latency" : 14,
-    "output_throughput" : 3790,
-    "provider" : "73d69ae0cfcf460190522d06b60f05ad",
-    "register_time" : "2020-07-24 15:44:56",
-    "req_count" : 7,
-    "req_count2xx" : 0,
-    "req_count4xx" : 6,
-    "req_count5xx" : 1,
-    "req_count_error" : 7,
-    "req_time" : "2020-07-24 15:44:00",
-    "status" : 1
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:api_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" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Monitoring Information Query
-
-
- diff --git a/docs/apig/api-ref/ListLatelyGroupStatisticsV2_1.html b/docs/apig/api-ref/ListLatelyGroupStatisticsV2_1.html deleted file mode 100644 index 2ac0891e..00000000 --- a/docs/apig/api-ref/ListLatelyGroupStatisticsV2_1.html +++ /dev/null @@ -1,505 +0,0 @@ - - -

Querying API Calls Under an API Group in the Last One Hour

-

Function

This API is used to query the total number of times all APIs in an API group are called based on the API group ID. The query is based on 1 minute. If the time range is within one hour, the server returns the number of API calls made every minute.

-

For security purposes, clear your operation records, including but not limited to records in the ~/.bash_history and /var/log/messages directories (if any), after running the curl command on the server to query information.

-
-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/group/latest

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

-
-
- -
- - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

group_id

-

Yes

-

String

-

API group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

code

-

String

-

Response code.

-

msg

-

String

-

Response message.

-

start_time

-

Long

-

Timestamp (UTC) of the start time.

-

end_time

-

Long

-

Timestamp (UTC) of the end time.

-

list

-

Array of StatisticsGroup objects

-

Statistic data.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 StatisticsGroup

Parameter

-

Type

-

Description

-

max_latency

-

Integer

-

Maximum latency.

-

Unit: ms

-

avg_latency

-

Float

-

Average latency.

-

Unit: ms

-

req_count

-

Integer

-

Total number of requests.

-

req_count2xx

-

Integer

-

Total number of 2xx response codes.

-

req_count4xx

-

Integer

-

Total number of 4xx response codes.

-

req_count5xx

-

Integer

-

Total number of 5xx response codes.

-

req_count_error

-

Integer

-

Errors.

-

output_throughput

-

Long

-

Downstream throughput (bytes).

-

input_throughput

-

Long

-

Upstream throughput (bytes).

-

current_minute

-

Long

-

Timestamp (UTC) of API access.

-

group_id

-

String

-

API group ID.

-

provider

-

String

-

API provider.

-

req_time

-

String

-

Request time.

-

register_time

-

String

-

Recording time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "code" : "APIG.0000",
-  "start_time" : 1595574540,
-  "end_time" : 1595578080,
-  "list" : [ {
-    "avg_latency" : 4.14,
-    "current_minute" : 1595576640,
-    "group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
-    "input_throughput" : 1071,
-    "max_latency" : 14,
-    "output_throughput" : 3790,
-    "provider" : "73d69ae0cfcf460190522d06b60f05ad",
-    "register_time" : "2020-07-24 15:44:56",
-    "req_count" : 7,
-    "req_count2xx" : 0,
-    "req_count4xx" : 6,
-    "req_count5xx" : 1,
-    "req_count_error" : 7,
-    "req_time" : "2020-07-24 15:44:00"
-  }, {
-    "avg_latency" : 3.67,
-    "current_minute" : 1595577900,
-    "group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
-    "input_throughput" : 915,
-    "max_latency" : 6,
-    "output_throughput" : 2763,
-    "provider" : "73d69ae0cfcf460190522d06b60f05ad",
-    "register_time" : "2020-07-24 16:05:12",
-    "req_count" : 6,
-    "req_count2xx" : 3,
-    "req_count4xx" : 0,
-    "req_count5xx" : 3,
-    "req_count_error" : 3,
-    "req_time" : "2020-07-24 16:05:00"
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group d0fc4e40b7d1492cba802f667c7c7226 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Monitoring Information Query
-
-
- diff --git a/docs/apig/api-ref/ListProjectCofigsV2_1.html b/docs/apig/api-ref/ListProjectCofigsV2_1.html deleted file mode 100644 index b0f76d61..00000000 --- a/docs/apig/api-ref/ListProjectCofigsV2_1.html +++ /dev/null @@ -1,515 +0,0 @@ - - -

Querying Resource Configurations of a Gateway

-

Function

This API is used to query the resource configurations and usage of a gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

configs

-

Array of Config objects

-

Quota list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 Config

Parameter

-

Type

-

Description

-

config_id

-

String

-

Quota ID.

-

config_name

-

String

-

Quota name.

-

Enumeration values:

-

  • API_NUM_LIMIT

    -

  • APP_NUM_LIMIT

    -

  • APIGROUP_NUM_LIMIT

    -

  • ENVIRONMENT_NUM_LIMIT

    -

  • VARIABLE_NUM_LIMIT

    -

  • SIGN_NUM_LIMIT

    -

  • THROTTLE_NUM_LIMIT

    -

  • APIGROUP_DOMAIN_NUM_LIMIT

    -

  • API_VERSION_NUM_LIMIT

    -

  • VPC_NUM_LIMIT

    -

  • VPC_INSTANCE_NUM_LIMIT

    -

  • API_PARAM_NUM_LIMIT

    -

  • API_USER_CALL_LIMIT

    -

  • ACL_NUM_LIMIT

    -

  • APP_THROTTLE_LIMIT

    -

  • USER_THROTTLE_LIMIT

    -

  • API_NUM_LIMIT_PER_GROUP

    -

  • API_POLICY_NUM_LIMIT

    -

  • API_CONDITION_NUM_LIMIT

    -

  • SL_DOMAIN_CALL_LIMIT

    -

  • ELB_SWITCH

    -

  • AUTHORIZER_NUM_LIMIT

    -

  • AUTHORIZER_IDENTITY_NUM_LIMIT

    -

  • APP_CODE_NUM_LIMIT

    -

  • REGION_MANAGER_WHITELIST_SERVICES

    -

  • API_SWAGGER_NUM_LIMIT

    -

  • API_TAG_NUM_LIMIT

    -

  • LTS_SWITCH

    -

  • APP_KEY_SECRET_SWITCH

    -

  • RESPONSE_NUM_LIMIT

    -

  • CONFIG_NUM_LIMIT_PER_APP

    -

  • BACKEND_TOKEN_ALLOW_SWITCH

    -

  • APP_TOKEN_SWITCH

    -

  • API_DESIGNER_SWITCH

    -

  • APP_API_KEY_SWITCH

    -

  • APP_BASIC_SWITCH

    -

  • APP_JWT_SWITCH

    -

  • APP_ROUTE_SWITCH

    -

  • PUBLIC_KEY_SWITCH

    -

  • APP_SECRET_SWITCH

    -

  • CASCADE_SWITCH

    -

  • IS_INIT_API_PATH_HASH

    -
-

config_value

-

String

-

Quota value.

-

It indicates the value of the quota for the current gateway.

-

config_time

-

String

-

Time when the quota is created.

-

remark

-

String

-

Quota description.

-

  • API_NUM_LIMIT: Maximum number of APIs you can create.

    -

  • APP_NUM_LIMIT: Maximum number of apps you can create.

    -

  • APIGROUP_NUM_LIMIT: Maximum number of API groups you can create.

    -

  • ENVIRONMENT_NUM_LIMIT: Maximum number of environments you can create.

    -

  • VARIABLE_NUM_LIMIT: Maximum number of environment variables you can create for an API group.

    -

  • SIGN_NUM_LIMIT: Maximum number of signature keys you can create.

    -

  • THROTTLE_NUM_LIMIT: Maximum number of request throttling policies you can create.

    -

  • APIGROUP_DOMAIN_NUM_LIMIT: Maximum number of custom domain names you can bind to an API group.

    -

  • API_VERSION_NUM_LIMIT: Maximum number of versions you can retain for an API.

    -

  • VPC_NUM_LIMIT: Maximum number of VPC channels you can create.

    -

  • VPC_INSTANCE_NUM_LIMIT: Maximum number of cloud servers you can associate with a VPC channel.

    -

  • API_PARAM_NUM_LIMIT: Maximum number of parameters you can configure for an API.

    -

  • API_USER_CALL_LIMIT: Maximum number of times an API can be called within a specific period.

    -

  • ACL_NUM_LIMIT: Maximum number of access control policies you can create.

    -

  • APP_THROTTLE_LIMIT: Maximum number of excluded apps allowed for a request throttling policy.

    -

  • USER_THROTTLE_LIMIT: Maximum number of excluded tenants allowed for a request throttling policy.

    -

  • API_NUM_LIMIT_PER_GROUP: Maximum number of APIs you can create for an API group.

    -

  • API_POLICY_NUM_LIMIT: Maximum number of policy backends you can configure for an API.

    -

  • API_CONDITION_NUM_LIMIT: Maximum number of conditions you can configure for a policy backend.

    -

  • SL_DOMAIN_CALL_LIMIT: Maximum number of requests that can be sent to a subdomain name within a specific period.

    -

  • ELB_SWITCH: Whether to enable ELB channels.

    -

  • AUTHORIZER_NUM_LIMIT: Maximum number of custom authorizers you can create.

    -

  • AUTHORIZER_IDENTITY_NUM_LIMIT: Maximum number of identity sources you can configure for a custom authorizer.

    -

  • APP_CODE_NUM_LIMIT: Maximum number of AppCodes you can create for an app.

    -

  • REGION_MANAGER_WHITELIST_SERVICES: Whitelist of services that are not verified by the region manager.

    -

  • API_SWAGGER_NUM_LIMIT: Maximum number of Swagger files you can bind to an API group.

    -

  • API_TAG_NUM_LIMIT: Maximum number of tags you can configure for an API.

    -

  • LTS_SWITCH: Whether to enable LTS log reporting.

    -

  • APP_KEY_SECRET_SWITCH: Whether to enable AppKey and AppSecret customization. 1: enable; 2: disable.

    -

  • RESPONSE_NUM_LIMIT: Maximum number of responses you can create for an API group.

    -

  • CONFIG_NUM_LIMIT_PER_APP: Maximum number of configuration items you can set for an app.

    -

  • BACKEND_TOKEN_ALLOW_SWITCH: Whether to allow tenants to transparently transmit tokens to the backend. 1: allow; 2: disallow.

    -

  • APP_TOKEN_SWITCH: Whether to enable AppTokens.

    -

  • API_DESIGNER_SWITCH: Whether to enable the API designer. 1: enable; 2: disable.

    -

  • APP_API_KEY_SWITCH: Whether to enable APP_API_KEY authentication.

    -

  • APP_BASIC_SWITCH: Whether to enable APP_BASIC authentication.

    -

  • APP_JWT_SWITCH: Whether to enable APP_JWT authentication.

    -

  • APP_ROUTE_SWITCH: Whether to enable app routes.

    -

  • PUBLIC_KEY_SWITCH: Whether to enable PUBLIC_KEY backend authentication.

    -

  • APP_SECRET_SWITCH: Whether to enable APP_SECRET authentication.

    -

  • CASCADE_SWITCH: Whether to enable cascaded gateways.

    -

  • IS_INIT_API_PATH_HASH: Whether API path hashing has been performed.

    -
-

used

-

Long

-

Used quota of the gateway.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 43,
-  "size" : 2,
-  "configs" : [ {
-    "config_id" : "9",
-    "config_name" : "API_VERSION_NUM_LIMIT",
-    "config_value" : "10",
-    "config_time" : "2019-02-12T19:42:19.914989Z",
-    "remark" : "xxx",
-    "used" : 0
-  }, {
-    "config_id" : "8",
-    "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT",
-    "config_value" : "5",
-    "config_time" : "2019-02-12T19:42:19.914989Z",
-    "remark" : "xxx",
-    "used" : 0
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Configuration Management
-
-
- diff --git a/docs/apig/api-ref/ListRequestThrottlingPoliciesBindedToApiV2_1.html b/docs/apig/api-ref/ListRequestThrottlingPoliciesBindedToApiV2_1.html deleted file mode 100644 index 2c298fb0..00000000 --- a/docs/apig/api-ref/ListRequestThrottlingPoliciesBindedToApiV2_1.html +++ /dev/null @@ -1,568 +0,0 @@ - - -

Querying Request Throttling Policies Bound to an API

-

Function

This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-throttles

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

api_id

-

Yes

-

String

-

API ID.

-

throttle_id

-

No

-

String

-

Request throttling policy ID.

-

throttle_name

-

No

-

String

-

Request throttling policy name.

-

env_id

-

No

-

String

-

Environment ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

throttles

-

Array of ThrottleForApi objects

-

Request throttling policy list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ThrottleForApi

Parameter

-

Type

-

Description

-

app_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

String

-

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

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

id

-

String

-

Request throttling policy ID.

-

bind_num

-

Integer

-

Number of APIs to which the request throttling policy has been bound.

-

is_inclu_special_throttle

-

Integer

-

Indicates whether an excluded request throttling configuration has been created.

-

  • 1: yes

    -

  • 2: no

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

create_time

-

String

-

Creation time.

-

env_name

-

String

-

Environment in which the request throttling policy takes effect.

-

bind_id

-

String

-

Policy binding record ID.

-

bind_time

-

String

-

Time when the policy is bound to the API.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "throttles" : [ {
-    "id" : "3437448ad06f4e0c91a224183116e965",
-    "name" : "throttle_demo",
-    "api_call_limits" : 800,
-    "user_call_limits" : 500,
-    "app_call_limits" : 300,
-    "ip_call_limits" : 600,
-    "time_interval" : 1,
-    "time_unit" : "SECOND",
-    "create_time" : "2020-07-31T08:44:02Z",
-    "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-    "is_inclu_special_throttle" : 2,
-    "env_name" : "RELEASE",
-    "type" : 1,
-    "bind_id" : "3e06ac135e18477e918060d3c59d6f6a",
-    "bind_time" : "2020-08-03T12:25:52Z",
-    "bind_num" : 0,
-    "enable_adaptive_control" : "FALSE"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/ListRequestThrottlingPolicyV2_1.html deleted file mode 100644 index 084b9e0f..00000000 --- a/docs/apig/api-ref/ListRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,497 +0,0 @@ - - -

Querying Request Throttling Policies

-

Function

This API is used to query all the request throttling policies.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

Request throttling policy ID.

-

name

-

No

-

String

-

Request throttling policy name.

-

precise_search

-

No

-

String

-

Parameter name (name) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

throttles

-

Array of ThrottlesInfo objects

-

Request throttling policy list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ThrottlesInfo

Parameter

-

Type

-

Description

-

app_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

String

-

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

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

id

-

String

-

Request throttling policy ID.

-

bind_num

-

Integer

-

Number of APIs to which the request throttling policy has been bound.

-

is_inclu_special_throttle

-

Integer

-

Indicates whether an excluded request throttling configuration has been created.

-

  • 1: yes

    -

  • 2: no

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

create_time

-

String

-

Creation time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "throttles" : [ {
-    "name" : "throttle_demo",
-    "create_time" : "2020-07-31T08:44:02.205366118Z",
-    "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-    "type" : 1,
-    "time_interval" : 1,
-    "ip_call_limits" : 600,
-    "app_call_limits" : 300,
-    "time_unit" : "SECOND",
-    "api_call_limits" : 800,
-    "id" : "3437448ad06f4e0c91a224183116e965",
-    "user_call_limits" : 500,
-    "enable_adaptive_control" : "FALSE",
-    "bind_num" : 0,
-    "is_inclu_special_throttle" : 2
-  } ]
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListSignatureKeysBindedToApiV2_1.html b/docs/apig/api-ref/ListSignatureKeysBindedToApiV2_1.html deleted file mode 100644 index 5d5e96f0..00000000 --- a/docs/apig/api-ref/ListSignatureKeysBindedToApiV2_1.html +++ /dev/null @@ -1,534 +0,0 @@ - - -

Querying Signature Keys Bound to an API

-

Function

This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-signs

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

api_id

-

Yes

-

String

-

API ID.

-

sign_id

-

No

-

String

-

Signature key ID.

-

sign_name

-

No

-

String

-

Signature key name.

-

env_id

-

No

-

String

-

Environment ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

bindings

-

Array of SignApiBindingInfo objects

-

APIs bound to the signature key.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SignApiBindingInfo

Parameter

-

Type

-

Description

-

publish_id

-

String

-

API publication record ID.

-

api_id

-

String

-

API ID.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

binding_time

-

String

-

Binding time.

-

env_id

-

String

-

ID of the environment in which the API has been published.

-

env_name

-

String

-

Name of the environment in which the API has been published.

-

api_type

-

Integer

-

API type.

-

api_name

-

String

-

API name.

-

id

-

String

-

Binding record ID.

-

api_remark

-

String

-

API description.

-

sign_id

-

String

-

Signature key ID.

-

sign_name

-

String

-

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

-

sign_key

-

String

-

Signature key.

-
  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.
  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.
  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.
  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.
-

sign_secret

-

String

-

Signature secret.

-
  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
  • public_key: The value contains 15 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a value is automatically generated.
  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a value is automatically generated.
-

sign_type

-

String

-

Signature key type.

-
  • hmac
  • basic
  • public_key
  • aes
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-
  • hmac
  • basic
  • public_key
  • aes
-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "bindings" : [ {
-    "api_id" : "5f918d104dc84480a75166ba99efff21",
-    "group_name" : "api_group_001",
-    "binding_time" : "2020-08-03T04:00:11Z",
-    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
-    "env_name" : "RELEASE",
-    "sign_id" : "0b0e8f456b8742218af75f945307173c",
-    "sign_name" : "signature_demo",
-    "sign_key" : "a071a20d460a4f639a636c3d7e3d8163",
-    "sign_secret" : "dc0************2b3",
-    "api_type" : 1,
-    "api_name" : "Api_http",
-    "id" : "25082bd52f74442bb1d273993d567938",
-    "api_remark" : "Web backend API"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Binding/Unbinding Signature Keys
-
-
- diff --git a/docs/apig/api-ref/ListSignatureKeysV2_1.html b/docs/apig/api-ref/ListSignatureKeysV2_1.html deleted file mode 100644 index 1ec4724c..00000000 --- a/docs/apig/api-ref/ListSignatureKeysV2_1.html +++ /dev/null @@ -1,481 +0,0 @@ - - -

Querying Signature Keys

-

Function

This API is used to query all the signature keys.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/signs

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

Signature key ID.

-

name

-

No

-

String

-

Signature key name.

-

precise_search

-

No

-

String

-

Parameter name (name) for exact matching.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

signs

-

Array of SignatureWithBindNum objects

-

Signature key list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SignatureWithBindNum

Parameter

-

Type

-

Description

-

name

-

String

-

Signature key name. It can contain letters, digits, and underscores(_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

-

sign_type

-

String

-

Signature key type.

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

sign_key

-

String

-

Signature key.

-

  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.

    -

  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_secret

-

String

-

Signature secret.

-

  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • public_key: The value can contain 16 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_algorithm

-

String

-

Signature algorithm. Specify a signature algorithm only when using an AES signature key. By default, no algorithm is used.

-

Enumeration values:

-

  • aes-128-cfb

    -

  • aes-256-cfb

    -
-

update_time

-

String

-

Update time.

-

create_time

-

String

-

Creation time.

-

id

-

String

-

Signature key ID.

-

bind_num

-

Integer

-

Number of bound APIs.

-

ldapi_bind_num

-

Integer

-

Number of custom backends bound.

-

Currently, this parameter is not supported.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "signs" : [ {
-    "sign_secret" : "sig************ret",
-    "update_time" : "2018-02-07T02:00:27.964766Z",
-    "create_time" : "2018-02-06T12:17:36Z",
-    "name" : "signature_demo",
-    "id" : "0b0e8f456b8742218af75f945307173c",
-    "sign_key" : "signkeysignkey",
-    "sign_type" : "hmac",
-    "bind_num" : 0,
-    "ldapi_bind_num" : 0
-  }, {
-    "sign_secret" : "9ce************16a",
-    "update_time" : "2020-07-30T03:56:58Z",
-    "create_time" : "2020-07-30T03:56:58Z",
-    "name" : "Signature_udlu",
-    "id" : "9dc388382fba485aadd19f932303f4c9",
-    "sign_key" : "ca50c5b670044c83b5b890a9a68a30d5",
-    "sign_type" : "hmac",
-    "bind_num" : 0,
-    "ldapi_bind_num" : 0
-  } ]
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Signature Key Management
-
-
- diff --git a/docs/apig/api-ref/ListSpecialThrottlingConfigurationsV2_0.html b/docs/apig/api-ref/ListSpecialThrottlingConfigurationsV2_0.html deleted file mode 100644 index 312f6f5a..00000000 --- a/docs/apig/api-ref/ListSpecialThrottlingConfigurationsV2_0.html +++ /dev/null @@ -1,480 +0,0 @@ - - -

Querying Excluded Request Throttling Configurations

-

Function

This API is used to query all excluded configurations of a request throttling policy.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

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

-

throttle_id

-

Yes

-

String

-

Request throttling policy ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

object_type

-

No

-

String

-

Object type, which can be APP or USER.

-

app_name

-

No

-

String

-

Name of an excluded app.

-

user

-

No

-

String

-

Name of an excluded user.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

throttle_specials

-

Array of ThrottleSpecialInfo objects

-

Excluded configuration list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ThrottleSpecialInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Excluded configuration ID.

-

call_limits

-

Integer

-

Maximum number of times an excluded object can access an API within the throttling period.

-

apply_time

-

String

-

Throttling period.

-

app_name

-

String

-

App name.

-

app_id

-

String

-

App ID.

-

object_id

-

String

-

ID of an object specified in the excluded configuration.

-

object_type

-

String

-

Excluded object type, which can be APP or USER.

-

object_name

-

String

-

Name of an app or a tenant to which the excluded configuration applies.

-

throttle_id

-

String

-

Request throttling policy ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 1,
-  "size" : 1,
-  "throttle_specials" : [ {
-    "call_limits" : 200,
-    "app_name" : "app_demo",
-    "object_name" : "app_demo",
-    "object_id" : "356de8eb7a8742168586e5daf5339965",
-    "throttle_id" : "3437448ad06f4e0c91a224183116e965",
-    "apply_time" : "2020-08-04T02:40:56Z",
-    "id" : "a3e9ff8db55544ed9db91d8b048770c0",
-    "app_id" : "356de8eb7a8742168586e5daf5339965",
-    "object_type" : "APP"
-  } ]
-}
-

Status code: 400

-

Bad Request

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

-

Not Found

-
{
-  "error_code" : "APIG.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ListTagsV2_1.html b/docs/apig/api-ref/ListTagsV2_1.html deleted file mode 100644 index d264352a..00000000 --- a/docs/apig/api-ref/ListTagsV2_1.html +++ /dev/null @@ -1,359 +0,0 @@ - - -

Querying Tags

-

Function

This API is used to query tags of a gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/tags

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

-
-
- -
- - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

tags

-

Array of strings

-

Tag list.

-
-
-

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "tags" : [ "webApi", "functionApi" ]
-}
-

Status code: 400

-

Bad Request

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Tag Management
-
-
- diff --git a/docs/apig/api-ref/ListVpcChannelsV2_1.html b/docs/apig/api-ref/ListVpcChannelsV2_1.html deleted file mode 100644 index 324271b6..00000000 --- a/docs/apig/api-ref/ListVpcChannelsV2_1.html +++ /dev/null @@ -1,991 +0,0 @@ - - -

Querying VPC Channels

-

Function

This API is used to query the VPC channels under a gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

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

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

offset

-

No

-

Long

-

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

-

Default: 0

-

limit

-

No

-

Integer

-

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

-

Minimum: 1

-

Maximum: 500

-

Default: 20

-

id

-

No

-

String

-

VPC channel ID.

-

name

-

No

-

String

-

VPC channel name.

-

dict_code

-

No

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

precise_search

-

No

-

String

-

Parameter name for exact matching. Separate multiple parameter names with commas (,).

-

Currently, name and member_group_name are supported.

-

member_host

-

No

-

String

-

Backend service address. By default, exact match is used. Fuzzy match is not supported.

-

member_port

-

No

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

member_group_name

-

No

-

String

-

Backend server group name.

-

member_group_id

-

No

-

String

-

Backend server group ID.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 3 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.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

vpc_channels

-

Array of VpcChannelInfo objects

-

VPC channel list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 VpcChannelInfo

Parameter

-

Type

-

Description

-

name

-

String

-

VPC channel name.

-

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

-

port

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

create_time

-

String

-

Time when the VPC channel is created.

-

id

-

String

-

VPC channel ID.

-

status

-

Integer

-

VPC channel status.

-
  • 1: normal
  • 2: abnormal
-

Enumeration values:

-
  • 1
  • 2
-

member_groups

-

Array of MemberGroupInfo objects

-

Backend server groups.

-

microservice_info

-

MicroServiceInfo object

-

Microservice information.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 MemberGroupInfo

Parameter

-

Type

-

Description

-

member_group_name

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

member_group_id

-

String

-

ID of the backend server group of the VPC channel.

-

create_time

-

String

-

Time when the backend server group is created.

-

update_time

-

String

-

Time when the backend server group is updated.

-
-
- -
- - - - - - - - - - - - - -
Table 7 MicroserviceLabel

Parameter

-

Type

-

Description

-

label_name

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 MicroServiceInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Microservice ID.

-

instance_id

-

String

-

Gateway ID.

-

service_type

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

MicroServiceInfoCSE object

-

CSE microservice details.

-

cce_info

-

MicroServiceInfoCCE object

-

CCE microservice workload details.

-

cce_service_info

-

MicroServiceInfoCCEService object

-

CCE microservice Service details.

-

update_time

-

String

-

Microservice update time.

-

create_time

-

String

-

Microservice creation time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 MicroServiceInfoCSE

Parameter

-

Type

-

Description

-

engine_id

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

String

-

Microservice ID.

-

Maximum: 64

-

engine_name

-

String

-

Microservice engine name.

-

service_name

-

String

-

Microservice name.

-

register_address

-

String

-

Registration center address.

-

cse_app_id

-

String

-

App to which the microservice belongs.

-

version

-

String

-

Microservice version, which has been discarded and is reflected in the version of the backend server group.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 MicroServiceInfoCCE

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 11 MicroServiceInfoCCEService

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 13 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 14 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 15 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 16 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "total" : 2,
-  "size" : 2,
-  "vpc_channels" : [ {
-    "name" : "channel 1",
-    "port" : 8080,
-    "balance_strategy" : 1,
-    "member_type" : "ip",
-    "dict_code" : "",
-    "create_time" : "2020-07-23T07:24:33Z",
-    "id" : "105c6902457144a4820dff8b1ad63331",
-    "status" : 1,
-    "member_groups" : [ ],
-    "type" : 2,
-    "microservice_info" : {
-      "id" : "",
-      "instance_id" : "",
-      "service_type" : "",
-      "cse_info" : {
-        "cse_app_id" : "",
-        "engine_id" : "",
-        "engine_name" : "",
-        "register_address" : "",
-        "service_id" : "",
-        "service_name" : ""
-      },
-      "cce_info" : {
-        "cluster_id" : "",
-        "cluster_name" : "",
-        "namespace" : "",
-        "workload_type" : "",
-        "app_name" : ""
-      },
-      "create_time" : "",
-      "update_time" : ""
-    }
-  }, {
-    "name" : "channel 2",
-    "port" : 8088,
-    "balance_strategy" : 2,
-    "member_type" : "ip",
-    "dict_code" : "",
-    "create_time" : "2020-07-23T07:11:57Z",
-    "id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "status" : 1,
-    "member_groups" : [ ],
-    "type" : 3,
-    "microservice_info" : {
-      "id" : "9483afa235be45158a70c19ab817ac65",
-      "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
-      "service_type" : "CCE",
-      "cse_info" : {
-        "cse_app_id" : "",
-        "engine_id" : "",
-        "engine_name" : "",
-        "register_address" : "",
-        "service_id" : "",
-        "service_name" : ""
-      },
-      "cce_info" : {
-        "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
-        "cluster_name" : "cce-test",
-        "namespace" : "default",
-        "workload_type" : "deployment",
-        "app_name" : "testapp"
-      },
-      "create_time" : "2020-07-23T07:11:57.244829604Z",
-      "update_time" : "2020-07-23T07:11:57.244829604Z"
-    }
-  } ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "The request parameters must be specified,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: 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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/MonitoringInfoQuerying_1.html b/docs/apig/api-ref/MonitoringInfoQuerying_1.html deleted file mode 100644 index cb4fe25b..00000000 --- a/docs/apig/api-ref/MonitoringInfoQuerying_1.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

Monitoring Information Query

-

-
- - diff --git a/docs/apig/api-ref/RemoveEngressEipV2_1.html b/docs/apig/api-ref/RemoveEngressEipV2_1.html deleted file mode 100644 index 54655855..00000000 --- a/docs/apig/api-ref/RemoveEngressEipV2_1.html +++ /dev/null @@ -1,244 +0,0 @@ - - -

Disabling Public Access for a Dedicated Gateway

-

Function

This API is used to disable public access for a dedicated gateway.

-
-

URI

DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eip

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 401

- -
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

204

-

No Content

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/ResettingAppSecretV2_1.html b/docs/apig/api-ref/ResettingAppSecretV2_1.html deleted file mode 100644 index 013aad45..00000000 --- a/docs/apig/api-ref/ResettingAppSecretV2_1.html +++ /dev/null @@ -1,446 +0,0 @@ - - -

Resetting the AppSecret of an App

-

Function

This API is used to reset the AppSecret of an app.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{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

-

app_secret

-

No

-

String

-

Secret, which can contain 8 to 128 characters, starting with a letter or digit. Only letters, digits, and special characters (_-!@#$%). To define an AppSecret, first enable the app_secret parameter.

-
-
-
-

Response Parameters

Status code: 200

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

Resetting secret

-
{
-  "app_secret" : "1ff************9a4"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "creator" : "USER",
-  "update_time" : "2020-08-03T14:12:43.038171689Z",
-  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
-  "name" : "app_demo",
-  "remark" : "Demo app",
-  "id" : "356de8eb7a8742168586e5daf5339965",
-  "app_secret" : "1ff************9a4",
-  "register_time" : "2020-08-03T13:09:13Z",
-  "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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ResourceQuery_1.html b/docs/apig/api-ref/ResourceQuery_1.html deleted file mode 100644 index 2b3f0b69..00000000 --- a/docs/apig/api-ref/ResourceQuery_1.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

Resource Query

-

-
- - diff --git a/docs/apig/api-ref/ShowDetailsOfAclPolicyV2_1.html b/docs/apig/api-ref/ShowDetailsOfAclPolicyV2_1.html deleted file mode 100644 index 496af1fb..00000000 --- a/docs/apig/api-ref/ShowDetailsOfAclPolicyV2_1.html +++ /dev/null @@ -1,363 +0,0 @@ - - -

Querying Details of an Access Control Policy

-

Function

This API is used to query the details of an access control policy.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_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.

-

acl_id

-

Yes

-

String

-

Access control policy 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

acl_name

-

String

-

Name.

-

acl_type

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

acl_value

-

String

-

Access control objects.

-

entity_type

-

String

-

Object type.

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-

id

-

String

-

ID.

-

update_time

-

String

-

Update time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "id" : "7eb619ecf2a24943b099833cd24a01ba",
-  "acl_name" : "acl_demo",
-  "entity_type" : "IP",
-  "acl_type" : "PERMIT",
-  "acl_value" : "192.168.1.5,192.168.10.1",
-  "update_time" : "2020-08-04T08:42:43Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "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.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfApiGroupV2_1.html b/docs/apig/api-ref/ShowDetailsOfApiGroupV2_1.html deleted file mode 100644 index e56a3db9..00000000 --- a/docs/apig/api-ref/ShowDetailsOfApiGroupV2_1.html +++ /dev/null @@ -1,524 +0,0 @@ - - -

Querying API Group Details

-

Function

This API is used to query the details of an API group.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_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.

-

group_id

-

Yes

-

String

-

API group 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-

sl_domains

-

Array of strings

-

Automatically allocated subdomain names.

-

remark

-

String

-

Description.

-

call_limits

-

Integer

-

Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls.

-

Currently, this parameter is not supported.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

is_default

-

Integer

-

Indicates whether the API group is the default group.

-

version

-

String

-

Group version.

-
  • V1: global group
  • V2: application-level group
-

The default value is V1. This parameter is not supported currently.

-

roma_app_id

-

String

-

ID of the integration application to which the API group belongs.

-

This parameter is required when the group version is V2.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the integration application to which the API group belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
-

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "update_time" : "2020-07-31T06:55:55Z",
-  "name" : "api_group_001",
-  "on_sell_status" : 2,
-  "remark" : "API group 1",
-  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
-  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "register_time" : "2020-07-31T06:55:55Z",
-  "status" : 1,
-  "is_default" : 2
-}
-

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

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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Group Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfApiV2_1.html b/docs/apig/api-ref/ShowDetailsOfApiV2_1.html deleted file mode 100644 index 94dcbc84..00000000 --- a/docs/apig/api-ref/ShowDetailsOfApiV2_1.html +++ /dev/null @@ -1,1836 +0,0 @@ - - -

Querying API Details

-

Function

This API is used to query the details of an API.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_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.

-

api_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

status

-

Integer

-

App status.

-
  • 1: valid
-

arrange_necessary

-

Integer

-

Indicates whether to enable orchestration.

-

register_time

-

String

-

Time when the API is registered.

-

update_time

-

String

-

Time when the API was last modified.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

group_version

-

String

-

Version of the API group to which the API belongs.

-

The default value is V1. Other versions are not supported.

-

Default: V1

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

Separate multiple environment IDs with vertical bars (|).

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

Separate multiple environment names with vertical bars (|).

-

publish_id

-

String

-

Publication record ID.

-

Separate multiple publication record IDs with vertical bars (|).

-

publish_time

-

String

-

Publication time.

-

Separate the time of multiple publication records with vertical bars (|).

-

roma_app_name

-

String

-

Name of the integration application to which the API belongs.

-

Currently, this parameter is not supported.

-

ld_api_id

-

String

-

ID of the corresponding custom backend API.

-

Currently, this parameter is not supported.

-

backend_api

-

BackendApi object

-

Web backend details.

-

api_group_info

-

ApiGroupCommonInfo object

-

API group information.

-

func_info

-

ApiFunc object

-

FunctionGraph backend details.

-

mock_info

-

ApiMock object

-

Mock backend details.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

policy_functions

-

Array of ApiPolicyFunctionResp objects

-

FunctionGraph backend policies.

-

policy_mocks

-

Array of ApiPolicyMockResp objects

-

Mock backend policies.

-

policy_https

-

Array of ApiPolicyHttpResp objects

-

Web backend policies.

-
-
- -
- - - - - - - - - -
Table 4 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 BackendApi

Parameter

-

Type

-

Description

-

authorizer_id

-

String

-

Custom authorizer ID.

-

url_domain

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

id

-

String

-

ID.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

register_time

-

String

-

Registration time.

-

update_time

-

String

-

Update time.

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ApiGroupCommonInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ApiFunc

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ApiMock

Parameter

-

Type

-

Description

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

String

-

Response.

-

version

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 ApiPolicyFunctionResp

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 ApiPolicyMockResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

result_content

-

String

-

Response.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ApiPolicyHttpResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

url_domain

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 14 BackendParam

Parameter

-

Type

-

Description

-

origin

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-

id

-

String

-

Parameter ID.

-

req_param_id

-

String

-

Request parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 CoditionResp

Parameter

-

Type

-

Description

-

req_param_name

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

String

-

Condition value.

-

id

-

String

-

ID.

-

req_param_id

-

String

-

Input parameter ID.

-

req_param_location

-

String

-

Input parameter location.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 16 VpcInfo

Parameter

-

Type

-

Description

-

ecs_id

-

String

-

Cloud server ID.

-

ecs_name

-

String

-

Cloud server name.

-

cascade_flag

-

Boolean

-

Indicates whether to use the cascading mode.

-

Currently, this parameter is not supported.

-

vpc_channel_proxy_host

-

String

-

Proxy host.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

vpc_channel_port

-

Integer

-

VPC channel port.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 17 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 18 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 19 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 20 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "id" : "5f918d104dc84480a75166ba99efff21",
-  "tags" : [ "webApi" ],
-  "arrange_necessary" : 2,
-  "backend_type" : "HTTP",
-  "auth_type" : "AUTHORIZER",
-  "auth_opt" : {
-    "app_code_auth_type" : "DISABLE"
-  },
-  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
-  "backend_api" : {
-    "update_time" : "2020-08-02T16:32:47.077029Z",
-    "vpc_channel_status" : 1,
-    "vpc_channel_info" : {
-      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-      "vpc_channel_proxy_host" : "www.example.com"
-    },
-    "url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
-    "req_protocol" : "HTTPS",
-    "id" : "1ce8fda3586d4371bd83c955df37e102",
-    "req_method" : "GET",
-    "register_time" : "2020-07-31T12:42:51Z",
-    "req_uri" : "/test/benchmark",
-    "timeout" : 5000,
-    "status" : 1,
-    "retry_count" : "-1"
-  },
-  "cors" : false,
-  "status" : 1,
-  "group_name" : "api_group_001",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "group_version" : "V1",
-  "match_mode" : "NORMAL",
-  "name" : "Api_http",
-  "req_protocol" : "HTTPS",
-  "req_method" : "GET",
-  "req_uri" : "/test/http",
-  "type" : 1,
-  "version" : "V0.0.1",
-  "result_normal_sample" : "Example success response",
-  "result_failure_sample" : "Example failure response",
-  "register_time" : "2020-07-31T12:42:51Z",
-  "update_time" : "2020-08-02T16:32:47.046289Z",
-  "remark" : "Web backend API",
-  "backend_params" : [ {
-    "name" : "X-CONSTANT-HEADER",
-    "value" : "demo",
-    "location" : "HEADER",
-    "origin" : "CONSTANT",
-    "remark" : "constant_demo",
-    "id" : "8cb2eba19e7a4423a4e835647a8b8d76"
-  }, {
-    "name" : "app-id",
-    "value" : "$context.appId",
-    "location" : "HEADER",
-    "origin" : "SYSTEM",
-    "remark" : "App ID of the API caller",
-    "id" : "216ddda836e74d528f364ff589d9dd21"
-  } ]
-}
-

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" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfAppCodeV2_1.html b/docs/apig/api-ref/ShowDetailsOfAppCodeV2_1.html deleted file mode 100644 index 729881cf..00000000 --- a/docs/apig/api-ref/ShowDetailsOfAppCodeV2_1.html +++ /dev/null @@ -1,350 +0,0 @@ - - -

Querying AppCode Details

-

Function

This API is used to query the details of an AppCode created for an app for simple authentication.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_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.

-

app_code_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 201

- -
- - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

app_code

-

String

-

AppCode value.

-

It can contain 64 to 180 characters, starting with a letter, digit, plus sign (+), or slash (/). Only letters, digits, and the following special characters are allowed: +_!@#$%-/=

-

id

-

String

-

ID.

-

app_id

-

String

-

App ID.

-

create_time

-

String

-

Creation time.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 201

-

Created

-
{
-  "app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a",
-  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
-  "id" : "b3d34f746d0847fb95138670e10207ed",
-  "create_time" : "2020-07-24T02:31:45Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:app_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.3004",
-  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfAppV2_1.html b/docs/apig/api-ref/ShowDetailsOfAppV2_1.html deleted file mode 100644 index 58a19f20..00000000 --- a/docs/apig/api-ref/ShowDetailsOfAppV2_1.html +++ /dev/null @@ -1,420 +0,0 @@ - - -

Querying App Details

-

Function

This API is used to query the details of an app.

-
-

URI

GET /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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 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 4 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "creator" : "USER",
-  "update_time" : "2020-08-03T13:09:13Z",
-  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
-  "name" : "app_demo",
-  "remark" : "Demo app",
-  "id" : "356de8eb7a8742168586e5daf5339965",
-  "app_secret" : "416************ab8",
-  "register_time" : "2020-08-03T13:09:13Z",
-  "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

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfCustomAuthorizersV2_1.html b/docs/apig/api-ref/ShowDetailsOfCustomAuthorizersV2_1.html deleted file mode 100644 index 3b874f11..00000000 --- a/docs/apig/api-ref/ShowDetailsOfCustomAuthorizersV2_1.html +++ /dev/null @@ -1,475 +0,0 @@ - - -

Querying Custom Authorizer Details

-

Function

This API is used to query the details of a custom authorizer.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_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.

-

authorizer_id

-

Yes

-

String

-

Custom authorizer 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

Custom authorizer name.

-

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

-

type

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

String

-

Function URN.

-

authorizer_version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

Array of Identity objects

-

Identity source.

-

ttl

-

Integer

-

Maximum cache age.

-

user_data

-

String

-

User data.

-

ld_api_id

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

Boolean

-

Indicates whether to send the body.

-

id

-

String

-

Custom authorizer ID.

-

create_time

-

String

-

Creation time.

-

roma_app_id

-

String

-

ID of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 4 Identity

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "Authorizer_demo",
-  "type" : "FRONTEND",
-  "authorizer_type" : "FUNC",
-  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-  "authorizer_version" : "v1",
-  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-  "identities" : [ {
-    "name" : "header",
-    "location" : "HEADER"
-  } ],
-  "ttl" : 0,
-  "user_data" : "authorizer_test",
-  "id" : "0d982c1ac3da493dae47627b6439fc5c",
-  "create_time" : "2020-07-31T11:55:43Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:type. 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.3081",
-  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Custom Authorizer Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfDomainNameCertificateV2_1.html b/docs/apig/api-ref/ShowDetailsOfDomainNameCertificateV2_1.html deleted file mode 100644 index 6e7cd359..00000000 --- a/docs/apig/api-ref/ShowDetailsOfDomainNameCertificateV2_1.html +++ /dev/null @@ -1,485 +0,0 @@ - - -

Querying Details of the Certificate Bound to a Domain Name

-

Function

This API is used to query the details of the certificate bound to a domain name.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

domain_id

-

Yes

-

String

-

Domain ID.

-

certificate_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

id

-

String

-

Certificate ID.

-

name

-

String

-

Certificate name.

-

type

-

String

-

Certificate type. Options:

-

  • global: Global certificate.

    -

  • instance: Gateway certificate.

    -
-

Enumeration values:

-

  • global

    -

  • instance

    -
-

instance_id

-

String

-

Gateway ID.

-

  • If type is set to global, the default value is common.

    -

  • If type is set to instance, a gateway ID is displayed.

    -
-

project_id

-

String

-

Project ID.

-

create_time

-

String

-

Creation time.

-

update_time

-

String

-

Update time.

-

common_name

-

String

-

Certificate domain name.

-

san

-

Array of strings

-

Subject alternative names.

-

version

-

Integer

-

Certificate version.

-

organization

-

Array of strings

-

Company or organization.

-

organizational_unit

-

Array of strings

-

Department.

-

locality

-

Array of strings

-

City.

-

state

-

Array of strings

-

State or province.

-

country

-

Array of strings

-

Country or region.

-

not_before

-

String

-

Start time of the certificate validity period.

-

not_after

-

String

-

End time of the certificate validity period.

-

serial_number

-

String

-

Serial No.

-

issuer

-

Array of strings

-

Certificate issuer.

-

signature_algorithm

-

String

-

Signature algorithm.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "serial_number" : "219450666855693268010130472645821723203",
-  "version" : 3,
-  "san" : [ "www.company.com" ],
-  "not_before" : "2019-06-01T00:00:00Z",
-  "issuer" : [ "mkcert development CA" ],
-  "not_after" : "2030-08-04T07:41:19Z",
-  "organization" : [ "mkcert development certificate" ],
-  "signature_algorithm" : "SHA256-RSA",
-  "organizational_unit" : [ "XXX\\\\DESKTOP-L2TFOFH" ]
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:domain_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.3020",
-  "error_msg" : "The URL domain does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfEnvironmentVariableV2_1.html b/docs/apig/api-ref/ShowDetailsOfEnvironmentVariableV2_1.html deleted file mode 100644 index a5ba6aee..00000000 --- a/docs/apig/api-ref/ShowDetailsOfEnvironmentVariableV2_1.html +++ /dev/null @@ -1,314 +0,0 @@ - - -

Querying Variable Details

-

Function

This API is used to query the details of an environment variable.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_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.

-

env_variable_id

-

Yes

-

String

-

Environment variable 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

variable_value

-

String

-

The variable value can contain 1 to 255 characters. Only letters, digits, and special characters (_-/.:) are allowed.

-

env_id

-

String

-

Environment ID.

-

Minimum: 1

-

Maximum: 65

-

group_id

-

String

-

API group ID.

-

Minimum: 1

-

Maximum: 65

-

variable_name

-

String

-

Variable name, which can contain 3 to 32 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. The variable name is equivalent to "#Name#" in API definitions. Characters between the number signs are case-sensitive. The variable name will be replaced with the variable value after API publication.

-

id

-

String

-

Environment variable ID.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "variable_value" : "192.168.1.5",
-  "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "id" : "25054838a624400bbf2267cf5b3a3f70",
-  "variable_name" : "address"
-}
-

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.3011",
-  "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Variable Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfGatewayResponseTypeV2_1.html b/docs/apig/api-ref/ShowDetailsOfGatewayResponseTypeV2_1.html deleted file mode 100644 index 7cdf18de..00000000 --- a/docs/apig/api-ref/ShowDetailsOfGatewayResponseTypeV2_1.html +++ /dev/null @@ -1,374 +0,0 @@ - - -

Querying the Response of an Error Type

-

Function

This API is used to query the response of an error type defined for an API group.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type}

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

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

Response ID.

-

response_type

-

Yes

-

String

-

Error type. Options:

-
  • AUTH_FAILURE: IAM or app authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: A custom authorizer error has occurred. For example, communication failed or an error response was returned.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the frontend custom authorizer is missing or invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable due to communication error.
  • BACKEND_TIMEOUT: Communication with the backend timed out.
  • THROTTLED: The request was rejected due to throttling.
  • UNAUTHORIZED: The credential you use is not authorized to call the API.
  • ACCESS_DENIED: Access denied. For example, the access control policy is triggered or an attack is detected.
  • NOT_FOUND: No API is matched.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter or unsupported HTTP method.
  • DEFAULT_4XX: Another 4XX error occurred.
  • DEFAULT_5XX: Another 5XX error occurred.
-

Enumeration values:

-
  • AUTH_FAILURE
  • AUTH_HEADER_MISSING
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONF_FAILURE
  • AUTHORIZER_IDENTITIES_FAILURE
  • BACKEND_UNAVAILABLE
  • BACKEND_TIMEOUT
  • THROTTLED
  • UNAUTHORIZED
  • ACCESS_DENIED
  • NOT_FOUND
  • REQUEST_PARAMETERS_FAILURE
  • DEFAULT_4XX
  • DEFAULT_5XX
-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

{User defined key}

-

Map<String,ResponseInfoResp>

-

OK

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 4 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

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

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "ACCESS_DENIED" : {
-    "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-    "default" : true,
-    "status" : 403
-  }
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfGatewayResponseV2_1.html b/docs/apig/api-ref/ShowDetailsOfGatewayResponseV2_1.html deleted file mode 100644 index 120afac6..00000000 --- a/docs/apig/api-ref/ShowDetailsOfGatewayResponseV2_1.html +++ /dev/null @@ -1,470 +0,0 @@ - - -

Querying Group Response Details

-

Function

This API is used to query the details of a response defined for an API group.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

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

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

Response name.

-

responses

-

Map<String,ResponseInfoResp>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-

id

-

String

-

Response ID.

-

default

-

Boolean

-

Indicates whether the group response is the default response.

-

create_time

-

String

-

Creation time.

-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 4 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

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

None

-
-

Example Responses

Status code: 200

-

Created

-
{
-  "create_time" : "2020-08-12T06:52:02Z",
-  "update_time" : "2020-08-12T06:52:02Z",
-  "default" : false,
-  "id" : "e839b367e10f4ab19d1c5008e476b83a",
-  "name" : "response_demo",
-  "responses" : {
-    "ACCESS_DENIED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 403
-    },
-    "AUTHORIZER_CONF_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_IDENTITIES_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_HEADER_MISSING" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "BACKEND_TIMEOUT" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 504
-    },
-    "BACKEND_UNAVAILABLE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 502
-    },
-    "DEFAULT_4XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "DEFAULT_5XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "NOT_FOUND" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 404
-    },
-    "REQUEST_PARAMETERS_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 400
-    },
-    "THROTTLED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 429
-    },
-    "UNAUTHORIZED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    }
-
-  }
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

Created

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfInstanceProgressV2_1.html b/docs/apig/api-ref/ShowDetailsOfInstanceProgressV2_1.html deleted file mode 100644 index 5a6a61ea..00000000 --- a/docs/apig/api-ref/ShowDetailsOfInstanceProgressV2_1.html +++ /dev/null @@ -1,364 +0,0 @@ - - -

Querying the Creation Progress of a Dedicated Gateway

-

Function

This API is used to query the creation progress of a dedicated gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/progress

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

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

progress

-

Integer

-

Gateway creation progress.

-

Unit: %

-

Enumeration values:

-

  • 30

    -

  • 50

    -

  • 80

    -

  • 90

    -

  • 100

    -
-

status

-

String

-

Gateway creation status.

-

  • creating

    -

  • success

    -

  • failed

    -
-

Enumeration values:

-

  • creating

    -

  • success

    -

  • failed

    -
-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-

start_time

-

Long

-

Time when the gateway creation starts. The time is in the Unix timestamp format.

-

end_time

-

Long

-

Time when the gateway creation is completed. The time is in the Unix timestamp format.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-

  • Gateway created.

    -
    {
-  "end_time" : 1597390224911,
-  "error_code" : null,
-  "error_msg" : null,
-  "progress" : 100,
-  "start_time" : 1597389901161,
-  "status" : "success"
-}
    -

  • Gateway is being created.

    -
    {
-  "end_time" : 1597390224911,
-  "error_code" : null,
-  "error_msg" : null,
-  "progress" : 50,
-  "start_time" : 1597389901161,
-  "status" : "creating"
-}
    -

  • Gateway creation failed due to insufficient quota.

    -
    {
-  "end_time" : 1597390224911,
-  "error_code" : "APIC.9218",
-  "error_msg" : "create failed...",
-  "progress" : 0,
-  "start_time" : 1597389901161,
-  "status" : "failed"
-}
    -

  • Gateway creation failed due to insufficient resources.

    -
    {
-  "end_time" : 1597390224911,
-  "error_code" : "APIC.9219",
-  "error_msg" : "create failed...",
-  "progress" : 0,
-  "start_time" : 1597389901161,
-  "status" : "failed"
-}
    -

  • Gateway creation failed due to other reasons.

    -
    {
-  "end_time" : 1597390224911,
-  "error_code" : "APIC.9206",
-  "error_msg" : "create failed...",
-  "progress" : 0,
-  "start_time" : 1597389901161,
-  "status" : "failed"
-}
    -
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfInstanceV2_1.html b/docs/apig/api-ref/ShowDetailsOfInstanceV2_1.html deleted file mode 100644 index ca387078..00000000 --- a/docs/apig/api-ref/ShowDetailsOfInstanceV2_1.html +++ /dev/null @@ -1,666 +0,0 @@ - - -

Querying Dedicated Gateway Details

-

Function

This API is used to query the details of a dedicated gateway.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_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.

-
-
-
-

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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

id

-

String

-

Gateway ID.

-

project_id

-

String

-

ID of the tenant to which the gateway belongs.

-

instance_name

-

String

-

Gateway name.

-

status

-

String

-

Instance status:

-
  • Creating: The instance is being created.
  • CreateSuccess: The instance is created successfully.
  • CreateFail: The instance fails to be created.
  • Initing: The instance is being initialized.
  • Registering: The instance is being registered.
  • Running: The instance is running.
  • InitingFailed: The instance fails to be initialized.
  • RegisterFailed: The instance fails to be registered.
  • Installing: The instance is being installed.
  • InstallFailed: The instance fails to be installed.
  • Updating: The instance is being upgraded.
  • UpdateFailed: The instance fails to be upgraded.
  • Rollbacking: The instance is being rolled back.
  • RollbackSuccess: The instance is rolled back successfully.
  • RollbackFailed: The instance fails to be rolled back.
  • Deleting: The instance is being deleted.
  • DeleteFailed: The instance fails to be deleted.
  • Unregistering: The instance is being deregistered.
  • UnRegisterFailed: The instance fails to be deregistered.
  • CreateTimeout: Creation of the instance times out.
  • InitTimeout: Initialization of the instance times out.
  • RegisterTimeout: Registration of the instance times out.
  • InstallTimeout: Installation of the instance times out.
  • UpdateTimeout: Upgrading of the instance times out.
  • RollbackTimeout: Rollback of the instance times out.
  • DeleteTimeout: Deletion of the instance times out.
  • UnregisterTimeout: Deregistration of the instance times out.
  • Starting: The instance is being started.
  • Freezing: The instance is being frozen.
  • Frozen: The instance is frozen.
  • Restarting: The instance is being restarted.
  • RestartFail: The instance fails to be restarted.
  • Unhealthy: The instance is abnormal.
  • RestartTimeout: Restart of the instance times out.
-

Enumeration values:

-
  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
-

instance_status

-

Integer

-

Instance status ID:

-
  • 1: Creating
  • 2: Created successfully
  • 3: Creation failed
  • 4: Initializing
  • 5: Registering
  • 6: Running
  • 7: Initialization failed
  • 8: Registration failed
  • 10: Installing
  • 11: Installation failed
  • 12: Upgrading
  • 13: Upgrade failed
  • 20: Rolling back
  • 21: Rolled back
  • 22: Rollback failed
  • 23: Deleting
  • 24: Deletion failed
  • 25: Deregistering
  • 26: Deregistration failed
  • 27: Creation timed out
  • 28: Initialization timed out
  • 29: Registration timed out
  • 30: Installation timed out
  • 31: Upgrade timed out
  • 32: Rollback timed out
  • 33: Deletion timed out
  • 34: Deregistration timed out
  • 35: Starting
  • 36: Freezing
  • 37: Frozen
  • 38: Restarting
  • 39: Restart failed
  • 40: Abnormal
  • 41: Restart timed out
-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 10
  • 11
  • 12
  • 13
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
-

type

-

String

-

Gateway type.

-

The default value is apig.

-

spec

-

String

-

Gateway edition.

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

Enumeration values:

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

create_time

-

Long

-

Time when the gateway is created. The time is in the Unix timestamp format.

-

enterprise_project_id

-

String

-

Enterprise project ID. This parameter is required if you are using an enterprise account.

-

eip_address

-

String

-

EIP bound to the gateway.

-

charging_mode

-

Integer

-

Billing mode of the gateway.

-
  • 0: pay-per-use
  • 1: This parameter is not used currently.
-

Enumeration values:

-
  • 0
  • 1
-

loadbalancer_provider

-

String

-

Type of the load balancer used by the gateway.

-
  • ELB
-

description

-

String

-

Description about the gateway.

-

vpc_id

-

String

-

VPC ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console, and click the name of a VPC to view the VPC ID on the displayed details page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying VPCs" in the VPC API Reference.
-

subnet_id

-

String

-

Subnet network ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Subnets" in the VPC API Reference.
-

security_group_id

-

String

-

ID of the security group to which the gateway belongs.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the Security Groups page, click the target security group. Then view the security group ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Security Groups" in the VPC API Reference.
-

maintain_begin

-

String

-

Start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.

-

During the maintenance time period, the O&M personnel can perform maintenance operations on the gateway. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

maintain_end

-

String

-

End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.

-

During the maintenance time period, the O&M personnel can perform maintenance operations on the gateway. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

ingress_ip

-

String

-

VPC ingress address.

-

user_id

-

String

-

ID of the account to which the gateway belongs.

-

nat_eip_address

-

String

-

IP address for public outbound access.

-

bandwidth_size

-

Integer

-

Outbound access bandwidth.

-

bandwidth_charging_mode

-

String

-

Billing mode of the public outbound access bandwidth.

-

available_zone_ids

-

String

-

AZ.

-

instance_version

-

String

-

Gateway version.

-

virsubnet_id

-

String

-

Subnet network ID.

-

Currently, this parameter is not supported.

-

roma_eip_address

-

String

-

ROMA EIP.

-

Currently, this parameter is not supported.

-

listeners

-

Object

-

Listener information.

-

Currently, this parameter is not supported.

-

supported_features

-

Array of strings

-

Supported features.

-

endpoint_service

-

EndpointService object

-

VPC endpoint service details.

-

This parameter will be deprecated. Use endpoint_services instead.

-

endpoint_services

-

Array of EndpointService objects

-

VPC endpoint services.

-

node_ips

-

NodeIps object

-

VPC endpoint ID.

-

publicips

-

Array of IpDetails objects

-

Public inbound access addresses.

-

privateips

-

Array of IpDetails objects

-

Private inbound access addresses.

-

is_releasable

-

Boolean

-

Whether the gateway can be released.

-
  • true: The gateway can be released.
  • false: The gateway cannot be released.
-

ingress_bandwidth_charging_mode

-

String

-

Billing mode of the public inbound access bandwidth.

-
-
- -
- - - - - - - - - - - - - -
Table 4 EndpointService

Parameter

-

Type

-

Description

-

service_name

-

String

-

VPC endpoint service name.

-

created_at

-

String

-

Creation time.

-
-
- -
- - - - - - - - - - - - - -
Table 5 NodeIps

Parameter

-

Type

-

Description

-

livedata

-

Array of strings

-

LiveData node IP addresses.

-

shubao

-

Array of strings

-

Shubao node IP addresses.

-
-
- -
- - - - - - - - - - - - - -
Table 6 IpDetails

Parameter

-

Type

-

Description

-

ip_address

-

String

-

IP address.

-

bandwidth_size

-

Integer

-

Bandwidth.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "id" : "8dfxxxxxxxxxxxxxxxxxxxxxxxxxx00p",
-  "spec" : "BASIC",
-  "project_id" : "78xxxxxxxxxxxxxxxxxxxxxxxxxxxxoi",
-  "instance_name" : "apig-demo",
-  "status" : "Running",
-  "instance_status" : 6,
-  "eip_address" : null,
-  "type" : null,
-  "create_time" : 1635890506328,
-  "charging_mode" : 0,
-  "enterprise_project_id" : "0",
-  "loadbalancer_provider" : "elb",
-  "description" : "test create instance",
-  "instance_version" : "acc6d368a3cb4d47840380bf62b0ab32",
-  "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
-  "user_id" : "e966ff7227ef4df49df7d57aaf00f8ed",
-  "vpc_id" : "0402ea19-5457-4032-9d1b-eb48b98f6c66",
-  "subnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
-  "virsubnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
-  "security_group_id" : "4b95a790-5cfc-463d-8de5-42199e55371c",
-  "maintain_begin" : "22:00:00",
-  "maintain_end" : "02:00:00",
-  "ingress_ip" : "192.168.0.152",
-  "ingress_ip_v6" : null,
-  "nat_eip_address" : "198.162.159.18",
-  "roma_eip_address" : null,
-  "bandwidth_size" : 5,
-  "bandwidth_charging_mode" : "traffic",
-  "supported_features" : [ "lts", "gateway_responses", "ratelimit", "request_body_size", "backend_timeout", "app_token", "app_basic", "app_secret", "multi_auth", "route", "sign_basic", "app_route", "backend_client_certificate", "ssl_ciphers", "cors", "app_quota", "app_acl", "real_ip_from_xff", "set_resp_headers", "vpc_backup", "throttle_strategy", "watch_instance", "sign_aes", "mock_status_code_and_header", "backend_retry_count", "custom_log", "real_ip_header_getter", "policy_sys_param", "vpc_name_modifiable", "breaker", "default_group_host_trustlist" ],
-  "node_ips" : {
-    "livedata" : [ ],
-    "shubao" : [ "192.168.0.123", "192.168.0.114" ]
-  },
-  "endpoint_service" : null,
-  "endpoint_services" : [ {
-    "service_name" : "xx-xxx-7a.apig.20bc4a91-1542-43s2-a278-b1e49c0hh6f9",
-    "created_at" : "2021-8-03 06:04:43"
-  } ],
-  "publicips" : [ {
-    "ip_address" : "198.162.156.198",
-    "bandwidth_size" : 5
-  } ],
-  "privateips" : [ {
-    "ip_address" : "198.162.156.198",
-    "bandwidth_size" : 5
-  } ],
-  "ingress_bandwidth_charging_mode" : "traffic"
-
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/ShowDetailsOfRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/ShowDetailsOfRequestThrottlingPolicyV2_1.html deleted file mode 100644 index 6da469ad..00000000 --- a/docs/apig/api-ref/ShowDetailsOfRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,406 +0,0 @@ - - -

Querying Details of a Request Throttling Policy

-

Function

This API is used to query the details of a request throttling policy.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_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.

-

throttle_id

-

Yes

-

String

-

Request throttling policy 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

app_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

String

-

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

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

id

-

String

-

Request throttling policy ID.

-

bind_num

-

Integer

-

Number of APIs to which the request throttling policy has been bound.

-

is_inclu_special_throttle

-

Integer

-

Indicates whether an excluded request throttling configuration has been created.

-

  • 1: yes

    -

  • 2: no

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

create_time

-

String

-

Creation time.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "throttle_demo",
-  "create_time" : "2020-07-31T08:44:02.205366118Z",
-  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-  "type" : 1,
-  "time_interval" : 1,
-  "ip_call_limits" : 600,
-  "app_call_limits" : 300,
-  "time_unit" : "SECOND",
-  "api_call_limits" : 800,
-  "id" : "3437448ad06f4e0c91a224183116e965",
-  "user_call_limits" : 500,
-  "enable_adaptive_control" : "FALSE",
-  "bind_num" : 0,
-  "is_inclu_special_throttle" : 2
-}
-

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.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/ShowDetailsOfVpcChannelV2_1.html b/docs/apig/api-ref/ShowDetailsOfVpcChannelV2_1.html deleted file mode 100644 index 969a3d99..00000000 --- a/docs/apig/api-ref/ShowDetailsOfVpcChannelV2_1.html +++ /dev/null @@ -1,1186 +0,0 @@ - - -

Querying VPC Channel Details

-

Function

This API is used to query the details of a VPC channel.

-
-

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_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.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel 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.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

VPC channel name.

-

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

-

port

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

create_time

-

String

-

Time when the VPC channel is created.

-

id

-

String

-

VPC channel ID.

-

status

-

Integer

-

VPC channel status.

-
  • 1: normal
  • 2: abnormal
-

Enumeration values:

-
  • 1
  • 2
-

member_groups

-

Array of MemberGroupInfo objects

-

Backend server groups.

-

microservice_info

-

MicroServiceInfo object

-

Microservice information.

-

members

-

Array of VpcMemberInfo objects

-

Backend instances.

-

vpc_health_config

-

VpcHealthConfigInfo object

-

Health check details.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 MemberGroupInfo

Parameter

-

Type

-

Description

-

member_group_name

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

member_group_id

-

String

-

ID of the backend server group of the VPC channel.

-

create_time

-

String

-

Time when the backend server group is created.

-

update_time

-

String

-

Time when the backend server group is updated.

-
-
- -
- - - - - - - - - - - - - -
Table 5 MicroserviceLabel

Parameter

-

Type

-

Description

-

label_name

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 MicroServiceInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Microservice ID.

-

instance_id

-

String

-

Gateway ID.

-

service_type

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

MicroServiceInfoCSE object

-

CSE microservice details.

-

cce_info

-

MicroServiceInfoCCE object

-

CCE microservice workload details.

-

cce_service_info

-

MicroServiceInfoCCEService object

-

CCE microservice Service details.

-

update_time

-

String

-

Microservice update time.

-

create_time

-

String

-

Microservice creation time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 MicroServiceInfoCSE

Parameter

-

Type

-

Description

-

engine_id

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

String

-

Microservice ID.

-

Maximum: 64

-

engine_name

-

String

-

Microservice engine name.

-

service_name

-

String

-

Microservice name.

-

register_address

-

String

-

Registration center address.

-

cse_app_id

-

String

-

App to which the microservice belongs.

-

version

-

String

-

Microservice version, which has been discarded and is reflected in the version of the backend server group.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 MicroServiceInfoCCE

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 9 MicroServiceInfoCCEService

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 VpcMemberInfo

Parameter

-

Type

-

Description

-

host

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

Integer

-

Backend server status.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

port

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-

id

-

String

-

Backend instance ID.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

create_time

-

String

-

Time when the backend server is added to the VPC channel.

-

member_group_id

-

String

-

Backend server group ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 VpcHealthConfigInfo

Parameter

-

Type

-

Description

-

protocol

-

String

-

Protocol for performing health checks on backend servers in the VPC channel.

-
  • TCP
  • HTTP
  • HTTPS
-

Enumeration values:

-
  • TCP
  • HTTP
  • HTTPS
-

path

-

String

-

Destination path for health checks. This parameter is required if protocol is set to http or https.

-

method

-

String

-

Request method for health checks.

-

Default: GET

-

Enumeration values:

-
  • GET
  • HEAD
-

port

-

Integer

-

Destination port for health checks. If this parameter is not specified or set to 0, the host port of the VPC channel is used.

-

If this parameter is set to a non-zero value, the corresponding port is used for health checks.

-

Minimum: 0

-

Maximum: 65535

-

threshold_normal

-

Integer

-

Healthy threshold. It refers to the number of consecutive successful checks required for a backend server to be considered healthy.

-

Minimum: 1

-

Maximum: 10

-

threshold_abnormal

-

Integer

-

Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy.

-

Minimum: 1

-

Maximum: 10

-

time_interval

-

Integer

-

Interval between consecutive checks. Unit: s. The value must be greater than the value of timeout.

-

Minimum: 1

-

Maximum: 300

-

http_code

-

String

-

Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats:

-
  • Multiple values, for example, 200,201,202
  • Range, for example, 200-299
  • Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.
-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication. If this function is enabled, the certificate specified in the backend_client_certificate configuration item of the gateway is used.

-

Default: false

-

status

-

Integer

-

Health check result.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

timeout

-

Integer

-

Timeout for determining whether a health check fails. Unit: s. The value must be less than the value of time_interval.

-

Minimum: 1

-

Maximum: 30

-

vpc_channel_id

-

String

-

VPC channel ID.

-

id

-

String

-

Health check ID.

-

create_time

-

String

-

Creation time.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 13 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 14 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 15 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 16 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

None

-
-

Example Responses

Status code: 200

-

OK

-
  • Example 1
    {
-  "name" : "VPC_demo",
-  "port" : 22,
-  "balance_strategy" : 1,
-  "member_type" : "ip",
-  "dict_code" : "",
-  "create_time" : "2020-07-23T07:11:57.244829604Z",
-  "id" : "56a7d7358e1b42459c9d730d65b14e59",
-  "status" : 1,
-  "member_groups" : [ ],
-  "type" : 2,
-  "members" : [ {
-    "host" : "192.168.0.5",
-    "weight" : 1,
-    "is_backup" : false,
-    "member_group_name" : "",
-    "status" : 1,
-    "port" : 22,
-    "ecs_id" : "192.168.0.5",
-    "ecs_name" : "192.168.0.5",
-    "id" : "be63c6260a1043888187f84af39c9f0e",
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "create_time" : "2020-07-23T07:11:57Z",
-    "member_group_id" : ""
-  }, {
-    "host" : "192.168.1.124",
-    "weight" : 2,
-    "is_backup" : false,
-    "member_group_name" : "",
-    "status" : 1,
-    "port" : 22,
-    "ecs_id" : "192.168.1.124",
-    "ecs_name" : "192.168.1.124",
-    "id" : "a57b13f1b89b417ca8acd76909e6df67",
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "create_time" : "2020-07-23T07:11:57Z",
-    "member_group_id" : ""
-  } ],
-  "vpc_health_config" : {
-    "protocol" : "http",
-    "path" : "/vpc/demo",
-    "method" : "GET",
-    "port" : 22,
-    "threshold_normal" : 2,
-    "threshold_abnormal" : 5,
-    "time_interval" : 10,
-    "http_code" : "200",
-    "enable_client_ssl" : false,
-    "status" : 1,
-    "timeout" : 5,
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "id" : "3b3d02026c5f402d85e8645ea95b0816",
-    "create_time" : "2020-07-23T07:11:57Z"
-  },
-  "microservice_info" : {
-    "id" : "",
-    "instance_id" : "",
-    "service_type" : "",
-    "cse_info" : {
-      "cse_app_id" : "",
-      "engine_id" : "",
-      "engine_name" : "",
-      "register_address" : "",
-      "service_id" : "",
-      "service_name" : ""
-    },
-    "cce_info" : {
-      "cluster_id" : "",
-      "cluster_name" : "",
-      "namespace" : "",
-      "workload_type" : "",
-      "app_name" : ""
-    },
-    "create_time" : "",
-    "update_time" : ""
-  }
-}
    -
  • Example 2
    {
-  "name" : "VPC_demo",
-  "id" : "105c6902457144a4820dff8b1ad63331",
-  "balance_strategy" : 1,
-  "dict_code" : "",
-  "create_time" : "2020-07-23T07:11:57.244829604Z",
-  "member_type" : "ip",
-  "port" : 22,
-  "status" : 1,
-  "member_groups" : [ {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe16",
-    "member_group_name" : "test",
-    "member_group_weight" : 1,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z",
-    "microservice_version" : "v1",
-    "microservice_port" : 80
-  }, {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe17",
-    "member_group_name" : "default",
-    "member_group_weight" : 2,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z",
-    "microservice_version" : "v2",
-    "microservice_port" : 80
-  } ],
-  "type" : 3,
-  "vpc_health_config" : {
-    "protocol" : "http",
-    "path" : "/vpc/demo",
-    "method" : "GET",
-    "port" : 22,
-    "threshold_normal" : 2,
-    "threshold_abnormal" : 5,
-    "time_interval" : 10,
-    "http_code" : "200",
-    "enable_client_ssl" : false,
-    "status" : 1,
-    "timeout" : 5,
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "id" : "3b3d02026c5f402d85e8645ea95b0816",
-    "create_time" : "2020-07-23T07:11:57Z"
-  },
-  "microservice_info" : {
-    "id" : "9483afa235be45158a70c19ab817ac65",
-    "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
-    "service_type" : "CCE",
-    "cse_info" : {
-      "cse_app_id" : "",
-      "engine_id" : "",
-      "engine_name" : "",
-      "register_address" : "",
-      "service_id" : "",
-      "service_name" : ""
-    },
-    "cce_info" : {
-      "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
-      "cluster_name" : "cce-test",
-      "namespace" : "default",
-      "workload_type" : "deployment",
-      "app_name" : "testapp"
-    },
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z"
-  }
-}
    -
-

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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/SignatureKeyBindingManagement_1.html b/docs/apig/api-ref/SignatureKeyBindingManagement_1.html deleted file mode 100644 index b7363555..00000000 --- a/docs/apig/api-ref/SignatureKeyBindingManagement_1.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Binding/Unbinding Signature Keys

-

-
- - diff --git a/docs/apig/api-ref/SignatureKeyManagement_1.html b/docs/apig/api-ref/SignatureKeyManagement_1.html deleted file mode 100644 index 80e3ded7..00000000 --- a/docs/apig/api-ref/SignatureKeyManagement_1.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Signature Key Management

-

-
- - diff --git a/docs/apig/api-ref/SpecialThrottlingSetting_0.html b/docs/apig/api-ref/SpecialThrottlingSetting_0.html deleted file mode 100644 index a0607fb7..00000000 --- a/docs/apig/api-ref/SpecialThrottlingSetting_0.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Excluded Request Throttling Configuration

-

-
- - diff --git a/docs/apig/api-ref/ThrottlingPolicyBinding_1.html b/docs/apig/api-ref/ThrottlingPolicyBinding_1.html deleted file mode 100644 index 661e1c76..00000000 --- a/docs/apig/api-ref/ThrottlingPolicyBinding_1.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Binding/Unbinding Request Throttling Policies

-

-
- - diff --git a/docs/apig/api-ref/ThrottlingPolicyManagement_1.html b/docs/apig/api-ref/ThrottlingPolicyManagement_1.html deleted file mode 100644 index a8782d7e..00000000 --- a/docs/apig/api-ref/ThrottlingPolicyManagement_1.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Request Throttling Policy Management

-

-
- - diff --git a/docs/apig/api-ref/UpdateAclStrategyV2_1.html b/docs/apig/api-ref/UpdateAclStrategyV2_1.html deleted file mode 100644 index 25b9a880..00000000 --- a/docs/apig/api-ref/UpdateAclStrategyV2_1.html +++ /dev/null @@ -1,439 +0,0 @@ - - -

Modifying an Access Control Policy

-

Function

This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_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.

-

acl_id

-

Yes

-

String

-

Access control policy 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

-

acl_name

-

Yes

-

String

-

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

-

acl_type

-

Yes

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

Enumeration values:

-

  • PERMIT

    -

  • DENY

    -
-

acl_value

-

Yes

-

String

-

One or more objects from which the access will be controlled. Separate multiple objects with commas.

-

  • If entity_type is set to IP, enter up to 100 IP addresses.

    -

  • If entity_type is set to DOMAIN, enter account names. Each account name can contain up to 64 ASCII characters except commas (,). Do not use only digits. The total length cannot exceed 1024 characters.

    -

  • If entity_type is set to DOMAIN_ID, enter account IDs. For details about how to obtain an account ID, see "Appendix" > "Obtaining an Account Name and Account ID" in this document.

    -
-

entity_type

-

Yes

-

String

-

Object type.

-

  • IP: IP address.

    -

  • DOMAIN: Account name.

    -

  • DOMAIN_ID: Account ID.

    -
-

Enumeration values:

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

acl_name

-

String

-

Name.

-

acl_type

-

String

-

Type.

-

  • PERMIT (whitelist)

    -

  • DENY (blacklist)

    -
-

acl_value

-

String

-

Access control objects.

-

entity_type

-

String

-

Object type.

-

  • IP

    -

  • DOMAIN

    -

  • DOMAIN_ID

    -
-

id

-

String

-

ID.

-

update_time

-

String

-

Update time.

-
-
-

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

Updating an access control policy to allow access from specified IP addresses

-
{
-  "acl_name" : "acl_demo",
-  "entity_type" : "IP",
-  "acl_type" : "PERMIT",
-  "acl_value" : "192.168.1.5,192.168.10.1"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "id" : "7eb619ecf2a24943b099833cd24a01ba",
-  "acl_name" : "acl_demo",
-  "entity_type" : "IP",
-  "acl_type" : "PERMIT",
-  "acl_value" : "192.168.1.5,192.168.10.1",
-  "update_time" : "2020-08-04T08:54:55.975856802Z"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2011",
-  "error_msg" : "Invalid parameter value,parameterName:acl_type. 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.3006",
-  "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Access Control Policy Management
-
-
- diff --git a/docs/apig/api-ref/UpdateApiGroupV2_1.html b/docs/apig/api-ref/UpdateApiGroupV2_1.html deleted file mode 100644 index 11ca1557..00000000 --- a/docs/apig/api-ref/UpdateApiGroupV2_1.html +++ /dev/null @@ -1,564 +0,0 @@ - - -

Modifying an API Group

-

Function

This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_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.

-

group_id

-

Yes

-

String

-

API group 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

-

API group name.

-

The value can contain 3 to 255 characters, including letters, digits, and special characters (-_./():). It must start with a letter or digit.

-

Minimum: 3

-

Maximum: 255

-

remark

-

No

-

String

-

API group description.

-

Maximum: 1000

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-

sl_domains

-

Array of strings

-

Automatically allocated subdomain names.

-

remark

-

String

-

Description.

-

call_limits

-

Integer

-

Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls.

-

Currently, this parameter is not supported.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Currently, this parameter is not supported.

-

is_default

-

Integer

-

Indicates whether the API group is the default group.

-

version

-

String

-

Group version.

-
  • V1: global group
  • V2: application-level group
-

The default value is V1. This parameter is not supported currently.

-

roma_app_id

-

String

-

ID of the integration application to which the API group belongs.

-

This parameter is required when the group version is V2.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the integration application to which the API group belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Modifying an API group

-
{
-  "name" : "api_group_001",
-  "remark" : "API group 1"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "update_time" : "2020-07-31T06:55:55Z.866474185Z",
-  "name" : "api_group_001",
-  "on_sell_status" : 2,
-  "remark" : "API group 1",
-  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
-  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
-  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "register_time" : "2020-07-31T06:55:55Z",
-  "status" : 1,
-  "is_default" : 2
-}
-

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

-
{
-  "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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Group Management
-
-
- diff --git a/docs/apig/api-ref/UpdateApiV2_1.html b/docs/apig/api-ref/UpdateApiV2_1.html deleted file mode 100644 index 63f61997..00000000 --- a/docs/apig/api-ref/UpdateApiV2_1.html +++ /dev/null @@ -1,3256 +0,0 @@ - - -

Modifying an API

-

Function

This API is used to modify the information about an API, including its backend information.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_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.

-

api_id

-

Yes

-

String

-

API 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

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Yes

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

No

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

Yes

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

Yes

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

Yes

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

No

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

No

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

No

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

Yes

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

No

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

Yes

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

No

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

No

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

No

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

tags

-

No

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

No

-

String

-

Group response ID.

-

roma_app_id

-

No

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

No

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

No

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

No

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

mock_info

-

No

-

ApiMockCreate object

-

Mock backend details.

-

func_info

-

No

-

ApiFuncCreate object

-

FunctionGraph backend details.

-

req_params

-

No

-

Array of ReqParamBase objects

-

Request parameters.

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

policy_mocks

-

No

-

Array of ApiPolicyMockCreate objects

-

Mock backend policies.

-

policy_functions

-

No

-

Array of ApiPolicyFunctionCreate objects

-

FunctionGraph backend policies.

-

backend_api

-

No

-

BackendApiCreate object

-

Web backend details.

-

policy_https

-

No

-

Array of ApiPolicyHttpCreate objects

-

Web backend policies.

-
-
- -
- - - - - - - - - - - -
Table 4 AuthOpt

Parameter

-

Mandatory

-

Type

-

Description

-

app_code_auth_type

-

No

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ApiMockCreate

Parameter

-

Mandatory

-

Type

-

Description

-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

No

-

String

-

Response.

-

version

-

No

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

No

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ApiFuncCreate

Parameter

-

Mandatory

-

Type

-

Description

-

function_urn

-

Yes

-

String

-

Function URN.

-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

Yes

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

Yes

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Yes

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

No

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ReqParamBase

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

Yes

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

Yes

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

No

-

String

-

Default value.

-

sample_value

-

No

-

String

-

Example value.

-

required

-

No

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

No

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

No

-

String

-

Enumerated value.

-

min_num

-

No

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

No

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

No

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

No

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

No

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

No

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

No

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 ApiPolicyMockCreate

Parameter

-

Mandatory

-

Type

-

Description

-

result_content

-

No

-

String

-

Response.

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ApiPolicyFunctionCreate

Parameter

-

Mandatory

-

Type

-

Description

-

function_urn

-

Yes

-

String

-

Function URN.

-

invocation_type

-

Yes

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

Yes

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

No

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 BackendApiCreate

Parameter

-

Mandatory

-

Type

-

Description

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

url_domain

-

No

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

Yes

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

No

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

Yes

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

No

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Yes

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

No

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

No

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

No

-

ApiBackendVpcReq object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

No

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 ApiPolicyHttpCreate

Parameter

-

Mandatory

-

Type

-

Description

-

url_domain

-

No

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

Yes

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

Yes

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY. Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

Yes

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

No

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

No

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

effect_mode

-

Yes

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

Yes

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

No

-

Array of BackendParamBase objects

-

Backend parameters.

-

conditions

-

Yes

-

Array of ApiConditionBase objects

-

Policy conditions.

-

authorizer_id

-

No

-

String

-

Custom authorizer ID.

-

vpc_channel_info

-

No

-

ApiBackendVpcReq object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

No

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-

Enumeration values:

-
  • 1
  • 2
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 BackendParamBase

Parameter

-

Mandatory

-

Type

-

Description

-

origin

-

Yes

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

Yes

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

No

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

Yes

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

Yes

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 ApiConditionBase

Parameter

-

Mandatory

-

Type

-

Description

-

req_param_name

-

No

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

No

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

Yes

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

Yes

-

String

-

Condition value.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 14 ApiBackendVpcReq

Parameter

-

Mandatory

-

Type

-

Description

-

vpc_channel_proxy_host

-

No

-

String

-

Proxy host.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel ID.

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

API name.

-

It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()

-

type

-

Integer

-

API type.

-
  • 1: public API
  • 2: private API
-

Enumeration values:

-
  • 1
  • 2
-

version

-

String

-

API version.

-

Maximum: 16

-

req_protocol

-

String

-

API request protocol:

-
  • HTTP
  • HTTPS
  • BOTH: Both HTTP and HTTPS are supported.
-

Default: HTTPS

-

Enumeration values:

-
  • HTTP
  • HTTPS
  • BOTH
-

req_method

-

String

-

API request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-
NOTE:

The address must comply with the URI specifications.

-
-

auth_type

-

String

-

API authentication mode. Options:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.
-

-

Enumeration values:

-
  • NONE
  • APP
  • IAM
  • AUTHORIZER
-

auth_opt

-

AuthOpt object

-

Security authentication parameter.

-

cors

-

Boolean

-

Indicates whether CORS is supported.

-
  • TRUE: supported
  • FALSE: not supported
-

Default: false

-

Enumeration values:

-
  • true
  • false
-

match_mode

-

String

-

API matching mode:

-
  • SWA: Prefix match
  • NORMAL: Exact match Default value: NORMAL
-

Enumeration values:

-
  • SWA
  • NORMAL
-

backend_type

-

String

-

Backend type. Options:

-
  • HTTP: web backend
  • FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.
  • MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.
-

Enumeration values:

-
  • HTTP
  • FUNCTION
  • MOCK
-

remark

-

String

-

API description. It cannot exceed 255 characters.

-

group_id

-

String

-

ID of the API group to which the API belongs.

-

body_remark

-

String

-

API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.

-

result_normal_sample

-

String

-

Example response for a successful request. Ensure that the response does not exceed 20,480 characters.

-

-

result_failure_sample

-

String

-

Example response for a failed request. Ensure that the response does not exceed 20,480 characters.

-

-

authorizer_id

-

String

-

Custom authorizer ID.

-

tags

-

Array of strings

-

Tag.

-

Use letters, digits, and special characters (-*#%.:_) and start with a letter.

-

By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.

-

Minimum: 1

-

Maximum: 128

-

response_id

-

String

-

Group response ID.

-

roma_app_id

-

String

-

Integration application ID.

-

Currently, this parameter is not supported.

-

domain_name

-

String

-

Custom domain name bound to the API.

-

Currently, this parameter is not supported.

-

tag

-

String

-

Tag.

-

This field will be deprecated. You can use the tags field instead.

-

content_type

-

String

-

Request content type:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

Coming soon.

-

Enumeration values:

-
  • application/json
  • application/xml
  • multipart/form-data
  • text/plain
-

id

-

String

-

API ID.

-

status

-

Integer

-

App status.

-
  • 1: valid
-

arrange_necessary

-

Integer

-

Indicates whether to enable orchestration.

-

register_time

-

String

-

Time when the API is registered.

-

update_time

-

String

-

Time when the API was last modified.

-

group_name

-

String

-

Name of the API group to which the API belongs.

-

group_version

-

String

-

Version of the API group to which the API belongs.

-

The default value is V1. Other versions are not supported.

-

Default: V1

-

run_env_id

-

String

-

ID of the environment in which the API has been published.

-

Separate multiple environment IDs with vertical bars (|).

-

run_env_name

-

String

-

Name of the environment in which the API has been published.

-

Separate multiple environment names with vertical bars (|).

-

publish_id

-

String

-

Publication record ID.

-

Separate multiple publication record IDs with vertical bars (|).

-

publish_time

-

String

-

Publication time.

-

Separate the time of multiple publication records with vertical bars (|).

-

roma_app_name

-

String

-

Name of the integration application to which the API belongs.

-

Currently, this parameter is not supported.

-

ld_api_id

-

String

-

ID of the corresponding custom backend API.

-

Currently, this parameter is not supported.

-

backend_api

-

BackendApi object

-

Web backend details.

-

api_group_info

-

ApiGroupCommonInfo object

-

API group information.

-

func_info

-

ApiFunc object

-

FunctionGraph backend details.

-

mock_info

-

ApiMock object

-

Mock backend details.

-

req_params

-

Array of ReqParam objects

-

Request parameters.

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

policy_functions

-

Array of ApiPolicyFunctionResp objects

-

FunctionGraph backend policies.

-

policy_mocks

-

Array of ApiPolicyMockResp objects

-

Mock backend policies.

-

policy_https

-

Array of ApiPolicyHttpResp objects

-

Web backend policies.

-
-
- -
- - - - - - - - - -
Table 16 AuthOpt

Parameter

-

Type

-

Description

-

app_code_auth_type

-

String

-

Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.

-
  • DISABLE: AppCode authentication is disabled.
  • HEADER: AppCode authentication is enabled and the AppCode is located in the header.
-

Default: DISABLE

-

Enumeration values:

-
  • DISABLE
  • HEADER
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 BackendApi

Parameter

-

Type

-

Description

-

authorizer_id

-

String

-

Custom authorizer ID.

-

url_domain

-

String

-

Backend service address.

-

A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

req_method

-

String

-

Request method.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

version

-

String

-

Web backend version, which can contain a maximum of 16 characters.

-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

enable_client_ssl

-

Boolean

-

Indicates whether to enable two-way authentication.

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

id

-

String

-

ID.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

register_time

-

String

-

Registration time.

-

update_time

-

String

-

Update time.

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 18 ApiGroupCommonInfo

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

name

-

String

-

API group name.

-

status

-

Integer

-

Status.

-
  • 1: valid
-

Enumeration values:

-
  • 1
-

sl_domain

-

String

-

Subdomain name that APIG automatically allocates to the API group.

-

register_time

-

String

-

Creation time.

-

update_time

-

String

-

Last modification time.

-

on_sell_status

-

Integer

-

Indicates whether the API group has been listed on KooGallery.

-
  • 1: listed
  • 2: not listed
  • 3: under review
-

Not supported currently.

-

url_domains

-

Array of UrlDomain objects

-

Independent domain names bound to the API group.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 19 UrlDomain

Parameter

-

Type

-

Description

-

id

-

String

-

Domain ID.

-

domain

-

String

-

Domain name.

-

cname_status

-

Integer

-

CNAME resolution status of the domain name.

-
  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed
-

ssl_id

-

String

-

SSL certificate ID.

-

ssl_name

-

String

-

SSL certificate name.

-

min_ssl_version

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-
  • TLSv1.1
  • TLSv1.2
-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-

is_has_trusted_root_ca

-

Boolean

-

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

-

Default: false

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 20 ApiFunc

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, only the alias URN will be used.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 21 ApiMock

Parameter

-

Type

-

Description

-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

result_content

-

String

-

Response.

-

version

-

String

-

Function version. It cannot exceed 64 characters.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

id

-

String

-

ID.

-

register_time

-

String

-

Registration time.

-

status

-

Integer

-

Backend service status.

-
  • 1: valid
-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 22 ReqParam

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

-

type

-

String

-

Parameter type.

-

Enumeration values:

-
  • STRING
  • NUMBER
-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

default_value

-

String

-

Default value.

-

sample_value

-

String

-

Example value.

-

required

-

Integer

-

Indicates whether the parameter is required. 1: yes 2: no

-

The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.

-

Enumeration values:

-
  • 1
  • 2
-

valid_enable

-

Integer

-

Indicates whether validity check is enabled.

-
  • 1: enabled
  • 2: disabled
-

Default: 2

-

Enumeration values:

-
  • 1
  • 2
-

remark

-

String

-

Description. It cannot exceed 255 characters.

-

enumerations

-

String

-

Enumerated value.

-

min_num

-

Integer

-

Minimum value.

-

This parameter is valid when type is set to NUMBER.

-

max_num

-

Integer

-

Maximum value.

-

This parameter is valid when type is set to NUMBER.

-

min_size

-

Integer

-

Minimum length.

-

This parameter is valid when type is set to STRING.

-

max_size

-

Integer

-

Maximum length.

-

This parameter is valid when type is set to STRING.

-

regular

-

String

-

Regular expression validation rule.

-

Currently, this parameter is not supported.

-

json_schema

-

String

-

JSON validation rule.

-

Currently, this parameter is not supported.

-

pass_through

-

Integer

-

Indicates whether to transparently transfer the parameter. 1: yes 2: no

-

Enumeration values:

-
  • 1
  • 2
-

id

-

String

-

Parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 23 ApiPolicyFunctionResp

Parameter

-

Type

-

Description

-

function_urn

-

String

-

Function URN.

-

invocation_type

-

String

-

Invocation mode.

-
  • async: asynchronous
  • sync: synchronous
-

Enumeration values:

-
  • async
  • sync
-

network_type

-

String

-

Function network architecture.

-
  • V1: non-VPC
  • V2: VPC
-

Enumeration values:

-
  • V1
  • V2
-

version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

alias_urn

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.

-

Unit: ms.

-

Minimum: 1

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 24 ApiPolicyMockResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

result_content

-

String

-

Response.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 25 ApiPolicyHttpResp

Parameter

-

Type

-

Description

-

id

-

String

-

ID.

-

effect_mode

-

String

-

Effective mode of the backend policy.

-
  • ALL: All conditions are met.
  • ANY: Any condition is met.
-

Enumeration values:

-
  • ALL
  • ANY
-

name

-

String

-

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

-

Minimum: 3

-

Maximum: 64

-

backend_params

-

Array of BackendParam objects

-

Backend parameters.

-

conditions

-

Array of CoditionResp objects

-

Policy conditions.

-

authorizer_id

-

String

-

Backend custom authorizer ID.

-

url_domain

-

String

-

Endpoint of the policy backend.

-

An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-

req_protocol

-

String

-

Request protocol. Options include HTTP, HTTPS.

-

Enumeration values:

-
  • HTTP
  • HTTPS
-

req_method

-

String

-

Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY.

-

Enumeration values:

-
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY
-

req_uri

-

String

-

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

-

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:

The address must comply with the URI specifications.

-
-

-

timeout

-

Integer

-

Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.

-

Unit: ms.

-

Minimum: 1

-

retry_count

-

String

-

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

-

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

-

Default: -1

-

vpc_channel_info

-

VpcInfo object

-

VPC channel details. This parameter is required if vpc_channel_status is set to 1.

-

vpc_channel_status

-

Integer

-

Indicates whether to use a VPC channel.

-
  • 1: A VPC channel is used.
  • 2: No VPC channel is used.
-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 26 BackendParam

Parameter

-

Type

-

Description

-

origin

-

String

-

Parameter type.

-
  • REQUEST: backend parameter
  • CONSTANT: constant parameter
  • SYSTEM: system parameter
-

Enumeration values:

-
  • REQUEST
  • CONSTANT
  • SYSTEM
-

name

-

String

-

Parameter name.

-

The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 1

-

Maximum: 32

-

remark

-

String

-

Description, which can contain a maximum of 255 characters.

-

location

-

String

-

Parameter location. The value can be PATH, QUERY, or HEADER.

-

Enumeration values:

-
  • PATH
  • QUERY
  • HEADER
-

value

-

String

-

Parameter value, which can contain a maximum of 255 characters.

-

If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.

-

If the origin type is CONSTANT, the value is a constant.

-

If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.

-

The gateway parameters are as follows:

-
  • $context.sourceIp: source IP address of the API caller.
  • $context.stage: deployment environment in which the API is called.
  • $context.apiId: API ID.
  • $context.appId: ID of the app used by the API caller.
  • $context.requestId: request ID generated when the API is called.
  • $context.serverAddr: address of the gateway server.
  • $context.serverName: name of the gateway server.
  • $context.handleTime: time when the API request is processed.
  • $context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.
-

Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".

-

Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".

-

id

-

String

-

Parameter ID.

-

req_param_id

-

String

-

Request parameter ID.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 27 CoditionResp

Parameter

-

Type

-

Description

-

req_param_name

-

String

-

Input parameter name. This parameter is required if the policy type is param.

-

condition_type

-

String

-

Policy condition.

-
  • exact: exact match
  • enum: enumeration
  • pattern: regular expression
-

This parameter is required if the policy type is param.

-

Enumeration values:

-
  • exact
  • enum
  • pattern
-

condition_origin

-

String

-

Policy type.

-
  • param: input parameter
  • source: source IP address
-

Enumeration values:

-
  • param
  • source
-

condition_value

-

String

-

Condition value.

-

id

-

String

-

ID.

-

req_param_id

-

String

-

Input parameter ID.

-

req_param_location

-

String

-

Input parameter location.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 28 VpcInfo

Parameter

-

Type

-

Description

-

ecs_id

-

String

-

Cloud server ID.

-

ecs_name

-

String

-

Cloud server name.

-

cascade_flag

-

Boolean

-

Indicates whether to use the cascading mode.

-

Currently, this parameter is not supported.

-

vpc_channel_proxy_host

-

String

-

Proxy host.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

vpc_channel_port

-

Integer

-

VPC channel port.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 29 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 30 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 31 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 32 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 33 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Modifying an API (authentication mode: app; backend: VPC channel)

-
{
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "match_mode" : "NORMAL",
-  "name" : "Api_http",
-  "auth_type" : "APP",
-  "backend_type" : "HTTP",
-  "backend_api" : {
-    "vpc_channel_status" : 1,
-    "vpc_channel_info" : {
-      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-      "vpc_channel_proxy_host" : "www.example.com"
-    },
-    "req_protocol" : "HTTPS",
-    "req_method" : "GET",
-    "req_uri" : "/test/benchmark",
-    "timeout" : 5000,
-    "retry_count" : "-1"
-  },
-  "cors" : false,
-  "req_protocol" : "HTTPS",
-  "req_uri" : "/test/http",
-  "remark" : "Web backend API",
-  "type" : 1,
-  "req_method" : "GET",
-  "result_normal_sample" : "Example success response",
-  "result_failure_sample" : "Example failure response",
-  "backend_params" : [ {
-    "name" : "X-CONSTANT-HEADER",
-    "value" : "demo",
-    "location" : "HEADER",
-    "origin" : "CONSTANT",
-    "remark" : "constant_demo"
-  }, {
-    "name" : "app-id",
-    "value" : "$context.appId",
-    "location" : "HEADER",
-    "origin" : "SYSTEM",
-    "remark" : "App ID of the API caller"
-  } ],
-  "tags" : [ "webApi" ]
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "id" : "5f918d104dc84480a75166ba99efff21",
-  "tags" : [ "webApi" ],
-  "arrange_necessary" : 2,
-  "backend_type" : "HTTP",
-  "auth_type" : "APP",
-  "auth_opt" : {
-    "app_code_auth_type" : "DISABLE"
-  },
-  "backend_api" : {
-    "update_time" : "2020-08-02T16:32:47.077028841Z",
-    "vpc_channel_status" : 1,
-    "vpc_channel_info" : {
-      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-      "vpc_channel_proxy_host" : "www.example.com"
-    },
-    "url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
-    "req_protocol" : "HTTPS",
-    "id" : "1ce8fda3586d4371bd83c955df37e102",
-    "req_method" : "GET",
-    "register_time" : "2020-07-31T12:42:51Z",
-    "req_uri" : "/test/benchmark",
-    "timeout" : 5000,
-    "status" : 1,
-    "retry_count" : "-1"
-  },
-  "cors" : false,
-  "status" : 1,
-  "group_name" : "api_group_001",
-  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
-  "group_version" : "V1",
-  "match_mode" : "NORMAL",
-  "name" : "Api_http",
-  "req_protocol" : "HTTPS",
-  "req_method" : "GET",
-  "req_uri" : "/test/http",
-  "type" : 1,
-  "version" : "V0.0.1",
-  "result_normal_sample" : "Example success response",
-  "result_failure_sample" : "Example failure response",
-  "register_time" : "2020-07-31T12:42:51Z",
-  "update_time" : "2020-08-02T16:32:47.046288842Z",
-  "remark" : "Web backend API",
-  "backend_params" : [ {
-    "name" : "X-CONSTANT-HEADER",
-    "value" : "demo",
-    "location" : "HEADER",
-    "origin" : "CONSTANT",
-    "remark" : "constant_demo",
-    "id" : "8cb2eba19e7a4423a4e835647a8b8d76"
-  }, {
-    "name" : "app-id",
-    "value" : "$context.appId",
-    "location" : "HEADER",
-    "origin" : "SYSTEM",
-    "remark" : "App ID of the API caller",
-    "id" : "216ddda836e74d528f364ff589d9dd21"
-  } ]
-}
-

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3002",
-  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: API Management
-
-
- diff --git a/docs/apig/api-ref/UpdateAppV2_1.html b/docs/apig/api-ref/UpdateAppV2_1.html deleted file mode 100644 index 105cf66c..00000000 --- a/docs/apig/api-ref/UpdateAppV2_1.html +++ /dev/null @@ -1,474 +0,0 @@ - - -

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.

-
-

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

-

OK

-
{
-  "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.

-
-
-
-
-
Parent topic: Credential Management
-
-
- diff --git a/docs/apig/api-ref/UpdateBackendInstancesV2_1.html b/docs/apig/api-ref/UpdateBackendInstancesV2_1.html deleted file mode 100644 index 7a40cd6f..00000000 --- a/docs/apig/api-ref/UpdateBackendInstancesV2_1.html +++ /dev/null @@ -1,642 +0,0 @@ - - -

Updating Backend Instances

-

Function

This API is used to update the backend instances of a specified VPC channel. During the update, the request parameters overwrite the backend instances of the corresponding cloud server group. If no cloud server group is specified, all cloud server groups are overwritten.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

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

-

vpc_channel_id

-

Yes

-

String

-

VPC channel 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

-

members

-

No

-

Array of MemberInfo objects

-

Backend instances.

-

member_group_name

-

No

-

String

-

Backend server group to be modified.

-

If this parameter is not specified, all backends defined by members for the VPC channel are modified.

-

If this parameter is specified, only the backend instances in the backend server group defined by members are modified. Input parameters of other backend server groups are ignored. For example, if member_group_name=primary is passed, only backend instances of backend server group 105c6902457144a4820dff8b1ad63331 in members are modified.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 MemberInfo

Parameter

-

Mandatory

-

Type

-

Description

-

host

-

No

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

No

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

No

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

No

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

No

-

Integer

-

Backend server status.

-

  • 1: available

    -

  • 2: unavailable

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

port

-

No

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

No

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

No

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

size

-

Integer

-

Length of the returned resource list.

-

total

-

Long

-

Number of resources that match the query conditions.

-

members

-

Array of VpcMemberInfo objects

-

Cloud server list.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 VpcMemberInfo

Parameter

-

Type

-

Description

-

host

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

Integer

-

Backend server status.

-

  • 1: available

    -

  • 2: unavailable

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

port

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-

id

-

String

-

Backend instance ID.

-

vpc_channel_id

-

String

-

VPC channel ID.

-

create_time

-

String

-

Time when the backend server is added to the VPC channel.

-

member_group_id

-

String

-

Backend server group ID.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

  • Updating non-standby backend instances of a VPC channel

    -
    {
-  "member_group_name" : "primary",
-  "members" : [ {
-    "host" : "192.168.2.25",
-    "weight" : 1,
-    "is_backup" : false,
-    "member_group_name" : "primary"
-  } ]
-}
    -

  • Updating all backend instances of a VPC channel

    -
    {
-  "members" : [ {
-    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
-    "ecs_name" : "APIGtest02",
-    "weight" : 2
-  } ]
-}
    -
-
-

Example Responses

Status code: 200

-

OK

-

  • Example 1

    -
    {
-  "total" : 1,
-  "size" : 1,
-  "members" : [ {
-    "host" : "192.168.2.25",
-    "weight" : 1,
-    "is_backup" : false,
-    "member_group_name" : "primary",
-    "port" : 22,
-    "status" : 1,
-    "ecs_id" : "192.168.2.25",
-    "ecs_name" : "192.168.2.25",
-    "id" : "683b6807cad54122a6777ad047a6178e",
-    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
-    "create_time" : "2020-07-23T09:13:24Z",
-    "member_group_id" : "631b551cddda40478ef720163a9412ed"
-  } ]
-}
    -

  • Example 2

    -
    {
-  "total" : 1,
-  "size" : 1,
-  "members" : [ {
-    "host" : "192.168.0.17",
-    "weight" : 2,
-    "is_backup" : false,
-    "member_group_name" : "primary",
-    "port" : 22,
-    "status" : 1,
-    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
-    "ecs_name" : "APIGtest02",
-    "id" : "5c868f0224084710a1e188b7d3057c52",
-    "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331",
-    "create_time" : "2020-07-23T09:03:53Z",
-    "member_group_id" : "631b551cddda40478ef720163a9412ed"
-  } ]
-}
    -
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2001",
-  "error_msg" : "The request parameters must be specified, parameter name:members"
-}
-

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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/UpdateCustomAuthorizerV2_1.html b/docs/apig/api-ref/UpdateCustomAuthorizerV2_1.html deleted file mode 100644 index e75bbc9c..00000000 --- a/docs/apig/api-ref/UpdateCustomAuthorizerV2_1.html +++ /dev/null @@ -1,617 +0,0 @@ - - -

Modifying a Custom Authorizer

-

Function

This API is used to modify a custom authorizer.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_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.

-

authorizer_id

-

Yes

-

String

-

Custom authorizer 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

-

Custom authorizer name.

-

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

-

type

-

Yes

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

Yes

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

Yes

-

String

-

Function URN.

-

authorizer_version

-

No

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

No

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

No

-

Array of Identity objects

-

Identity source.

-

ttl

-

No

-

Integer

-

Maximum cache age.

-

user_data

-

No

-

String

-

User data.

-

ld_api_id

-

No

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

No

-

Boolean

-

Indicates whether to send the body.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 4 Identity

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Parameter name.

-

location

-

Yes

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

No

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

name

-

String

-

Custom authorizer name.

-

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

-

type

-

String

-

Custom authorizer type.

-
  • FRONTEND
  • BACKEND
-

Modification is not allowed.

-

Enumeration values:

-
  • FRONTEND
  • BACKEND
-

authorizer_type

-

String

-

Value: FUNC.

-

Enumeration values:

-
  • FUNC
-

authorizer_uri

-

String

-

Function URN.

-

authorizer_version

-

String

-

Function version.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

Maximum: 64

-

authorizer_alias_uri

-

String

-

Function alias URN.

-

If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.

-

identities

-

Array of Identity objects

-

Identity source.

-

ttl

-

Integer

-

Maximum cache age.

-

user_data

-

String

-

User data.

-

ld_api_id

-

String

-

Custom backend ID.

-

Currently, this parameter is not supported.

-

need_body

-

Boolean

-

Indicates whether to send the body.

-

id

-

String

-

Custom authorizer ID.

-

create_time

-

String

-

Creation time.

-

roma_app_id

-

String

-

ID of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-

roma_app_name

-

String

-

Name of the application to which the custom authorizer belongs.

-

Currently, this parameter is not supported.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 Identity

Parameter

-

Type

-

Description

-

name

-

String

-

Parameter name.

-

location

-

String

-

Parameter location.

-

Enumeration values:

-
  • HEADER
  • QUERY
-

validation

-

String

-

Parameter verification expression. The default value is null, indicating that no verification is performed.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Updating a frontend custom authorizer

-
{
-  "name" : "Authorizer_demo",
-  "type" : "FRONTEND",
-  "authorizer_type" : "FUNC",
-  "authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-  "authorizer_version" : "v1",
-  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-  "user_data" : "authorizer_test",
-  "identities" : [ {
-    "name" : "header",
-    "location" : "HEADER"
-  } ]
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "Authorizer_demo",
-  "type" : "FRONTEND",
-  "authorizer_type" : "FUNC",
-  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
-  "authorizer_version" : "v1",
-  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
-  "identities" : [ {
-    "name" : "header",
-    "location" : "HEADER"
-  } ],
-  "ttl" : 5,
-  "user_data" : "authorizer_test",
-  "id" : "0d982c1ac3da493dae47627b6439fc5c",
-  "create_time" : "2020-07-08T03:27:52.000+0000"
-}
-

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.3081",
-  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Custom Authorizer Management
-
-
- diff --git a/docs/apig/api-ref/UpdateDomainV2_1.html b/docs/apig/api-ref/UpdateDomainV2_1.html deleted file mode 100644 index 00bc414a..00000000 --- a/docs/apig/api-ref/UpdateDomainV2_1.html +++ /dev/null @@ -1,429 +0,0 @@ - - -

Modifying a Domain Name

-

Function

This API is used to modify the configuration of a domain name bound to an API group.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

domain_id

-

Yes

-

String

-

Domain 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

-

min_ssl_version

-

Yes

-

String

-

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

-

Default: TLSv1.1

-

Enumeration values:

-

  • TLSv1.1

    -

  • TLSv1.2

    -
-

is_http_redirect_to_https

-

No

-

Boolean

-

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

-

Default: false

-

verified_client_certificate_enabled

-

No

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-
-
-
-

Response Parameters

Status code: 201

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

Parameter

-

Type

-

Description

-

url_domain

-

String

-

Custom domain name.

-

id

-

String

-

Domain ID.

-

status

-

Integer

-

CNAME resolution status.

-

  • 1: not resolved

    -

  • 2: resolving

    -

  • 3: resolved

    -

  • 4: resolution failed

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -

  • 3

    -

  • 4

    -
-

min_ssl_version

-

String

-

Minimum SSL version supported.

-

is_http_redirect_to_https

-

Boolean

-

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

-

Default: false

-

verified_client_certificate_enabled

-

Boolean

-

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

-

Default: false

-
-
-

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 a domain name

-
{
-  "min_ssl_version" : "TLSv1.2"
-}
-
-

Example Responses

Status code: 201

-

Created

-
{
-  "id" : "0a515af69f4e4dcca84fbf85f68c0e27",
-  "url_domain" : "www.example.com",
-  "status" : 3,
-  "min_ssl_version" : "TLSv1.2",
-  "is_http_redirect_to_https" : false,
-  "verified_client_certificate_enabled" : false
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.3474",
-  "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound"
-}
-

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.3020",
-  "error_msg" : "The URL domain does not exist"
-}
-

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.

-
-
-
-
-
Parent topic: Domain Name Management
-
-
- diff --git a/docs/apig/api-ref/UpdateEngressEipV2_1.html b/docs/apig/api-ref/UpdateEngressEipV2_1.html deleted file mode 100644 index d0c4147a..00000000 --- a/docs/apig/api-ref/UpdateEngressEipV2_1.html +++ /dev/null @@ -1,327 +0,0 @@ - - -

Updating the Outbound Access Bandwidth of a Dedicated Gateway

-

Function

This API is used to update the outbound access bandwidth of a dedicated gateway.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eip

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

-
-
-
-

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

-

bandwidth_size

-

No

-

String

-

Outbound access bandwidth.

-

Unit: Mbit/s

-

bandwidth_charging_mode

-

No

-

String

-

Billing type of the public outbound access bandwidth.

-

  • bandwidth: billed by bandwidth

    -

  • traffic: billed by traffic

    -
-

Default: bandwidth

-

Enumeration values:

-

  • bandwidth

    -

  • traffic

    -
-
-
-
-

Response Parameters

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Updating the outbound access bandwidth of a gateway

-
{
-  "bandwidth_size" : 5,
-  "bandwidth_charging_mode" : "traffic"
-}
-
-

Example Responses

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIC.9211",
-  "error_msg" : "update bandwidth size failed"
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/UpdateEnvironmentV2_1.html b/docs/apig/api-ref/UpdateEnvironmentV2_1.html deleted file mode 100644 index 040f94f2..00000000 --- a/docs/apig/api-ref/UpdateEnvironmentV2_1.html +++ /dev/null @@ -1,379 +0,0 @@ - - -

Modifying an Environment

-

Function

This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_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.

-

env_id

-

Yes

-

String

-

Environment 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

-

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

-

Minimum: 3

-

Maximum: 64

-

remark

-

No

-

String

-

Description.

-

Maximum: 255

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

create_time

-

String

-

Creation time.

-

name

-

String

-

Environment name.

-

remark

-

String

-

Description.

-

id

-

String

-

Environment ID.

-
-
-

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 environment

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

Example Responses

Status code: 200

-

OK

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

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

-
{
-  "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.3003",
-  "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Environment Management
-
-
- diff --git a/docs/apig/api-ref/UpdateGatewayResponseTypeV2_1.html b/docs/apig/api-ref/UpdateGatewayResponseTypeV2_1.html deleted file mode 100644 index e295d958..00000000 --- a/docs/apig/api-ref/UpdateGatewayResponseTypeV2_1.html +++ /dev/null @@ -1,410 +0,0 @@ - - -

Modifying the Response of an Error Type

-

Function

This API is used to modify the response of an error type defined for an API group.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type}

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

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

Response ID.

-

response_type

-

Yes

-

String

-

Error type. Options:

-
  • AUTH_FAILURE: IAM or app authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: A custom authorizer error has occurred. For example, communication failed or an error response was returned.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the frontend custom authorizer is missing or invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable due to communication error.
  • BACKEND_TIMEOUT: Communication with the backend timed out.
  • THROTTLED: The request was rejected due to throttling.
  • UNAUTHORIZED: The credential you use is not authorized to call the API.
  • ACCESS_DENIED: Access denied. For example, the access control policy is triggered or an attack is detected.
  • NOT_FOUND: No API is matched.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter or unsupported HTTP method.
  • DEFAULT_4XX: Another 4XX error occurred.
  • DEFAULT_5XX: Another 5XX error occurred.
-

Enumeration values:

-
  • AUTH_FAILURE
  • AUTH_HEADER_MISSING
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONF_FAILURE
  • AUTHORIZER_IDENTITIES_FAILURE
  • BACKEND_UNAVAILABLE
  • BACKEND_TIMEOUT
  • THROTTLED
  • UNAUTHORIZED
  • ACCESS_DENIED
  • NOT_FOUND
  • REQUEST_PARAMETERS_FAILURE
  • DEFAULT_4XX
  • DEFAULT_5XX
-
-
-
-

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

-

status

-

No

-

Integer

-

HTTP status code of the response.

-

body

-

No

-

String

-

Response body template.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

{User defined key}

-

Map<String,ResponseInfoResp>

-

OK

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 5 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Modifying the response of an error type defined for an API group

-
{
-  "body" : "body: \"{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}\"",
-  "status" : 403
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "ACCESS_DENIED" : {
-    "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-    "default" : true,
-    "status" : 403
-  }
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2012",
-  "error_msg" : "Invalid parameter value,parameterName:group_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.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/UpdateGatewayResponseV2_1.html b/docs/apig/api-ref/UpdateGatewayResponseV2_1.html deleted file mode 100644 index bea714db..00000000 --- a/docs/apig/api-ref/UpdateGatewayResponseV2_1.html +++ /dev/null @@ -1,538 +0,0 @@ - - -

Modifying a Group Response

-

Function

This API is used to modify a response of an API group.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_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.

-

group_id

-

Yes

-

String

-

API group ID.

-

response_id

-

Yes

-

String

-

Response 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

-

No

-

String

-

Response name.

-

responses

-

No

-

Map<String,ResponseInfo>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 4 ResponseInfo

Parameter

-

Mandatory

-

Type

-

Description

-

status

-

No

-

Integer

-

HTTP status code of the response.

-

body

-

No

-

String

-

Response body template.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

name

-

String

-

Response name.

-

responses

-

Map<String,ResponseInfoResp>

-

Response type definition. key indicates the error type. Options of key:

-
  • AUTH_FAILURE: Authentication failed.
  • AUTH_HEADER_MISSING: The identity source is missing.
  • AUTHORIZER_FAILURE: Custom authentication failed.
  • AUTHORIZER_CONF_FAILURE: Custom authorizer error.
  • AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.
  • BACKEND_UNAVAILABLE: The backend is unavailable.
  • BACKEND_TIMEOUT: Backend timed out.
  • THROTTLED: The request was rejected due to request throttling.
  • UNAUTHORIZED: The app you are using has not been authorized to call the API.
  • ACCESS_DENIED: Access denied.
  • NOT_FOUND: No API is found.
  • REQUEST_PARAMETERS_FAILURE: Invalid request parameter.
  • DEFAULT_4XX: Default 4XX error occurred.
  • DEFAULT_5XX: Default 5XX error occurred.
-

Each error type is in JSON format.

-

id

-

String

-

Response ID.

-

default

-

Boolean

-

Indicates whether the group response is the default response.

-

create_time

-

String

-

Creation time.

-

update_time

-

String

-

Update time.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 6 ResponseInfoResp

Parameter

-

Type

-

Description

-

status

-

Integer

-

HTTP status code of the response.

-

body

-

String

-

Response body template.

-

default

-

Boolean

-

Indicates whether the response is the default response.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Modifying a response of an API group

-
{
-  "name" : "response_demo"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "create_time" : "2020-08-12T06:52:02Z",
-  "update_time" : "2020-08-12T15:22:21.929863859+08:00",
-  "default" : false,
-  "id" : "e839b367e10f4ab19d1c5008e476b83a",
-  "name" : "response_demo",
-  "responses" : {
-    "ACCESS_DENIED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 403
-    },
-    "AUTHORIZER_CONF_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 500
-    },
-    "AUTHORIZER_IDENTITIES_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "AUTH_HEADER_MISSING" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    },
-    "BACKEND_TIMEOUT" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 504
-    },
-    "BACKEND_UNAVAILABLE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 502
-    },
-    "DEFAULT_4XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "DEFAULT_5XX" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true
-    },
-    "NOT_FOUND" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 404
-    },
-    "REQUEST_PARAMETERS_FAILURE" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 400
-    },
-    "THROTTLED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 429
-    },
-    "UNAUTHORIZED" : {
-      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
-      "default" : true,
-      "status" : 401
-    }
-  }
-}
-

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3001",
-  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Group Response Management
-
-
- diff --git a/docs/apig/api-ref/UpdateInstanceV2_1.html b/docs/apig/api-ref/UpdateInstanceV2_1.html deleted file mode 100644 index 6f46d719..00000000 --- a/docs/apig/api-ref/UpdateInstanceV2_1.html +++ /dev/null @@ -1,748 +0,0 @@ - - -

Updating a Dedicated Gateway

-

Function

This API is used to update a dedicated gateway.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_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.

-
-
-
-

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

-

description

-

No

-

String

-

Gateway description.

-

maintain_begin

-

No

-

String

-

Start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.

-

During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

maintain_end

-

No

-

String

-

End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.

-

During the maintenance time period, O&M personnel perform maintenance on the gateway. During this period, services can still be used, but occasionally there may be temporary interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

instance_name

-

No

-

String

-

Gateway name.

-

Minimum: 3

-

Maximum: 64

-

security_group_id

-

No

-

String

-

Security group to which the gateway belongs.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the Security Groups page, click the target security group. Then view the security group ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Security Groups" in the VPC API Reference.
-

vpcep_service_name

-

No

-

String

-

Name of a VPC endpoint service.

-

It can contain max. 16 characters, including letters, digits, hyphens (-), and underscores.

-

If this parameter is not specified, the system automatically generates a name in the "{region}.{service_id}" format.

-

If this parameter is specified, the system automatically generates a name in the "{region}.{vpcep_service_name}.{service_id}" format.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

id

-

String

-

Gateway ID.

-

project_id

-

String

-

ID of the tenant to which the gateway belongs.

-

instance_name

-

String

-

Gateway name.

-

status

-

String

-

Instance status:

-
  • Creating: The instance is being created.
  • CreateSuccess: The instance is created successfully.
  • CreateFail: The instance fails to be created.
  • Initing: The instance is being initialized.
  • Registering: The instance is being registered.
  • Running: The instance is running.
  • InitingFailed: The instance fails to be initialized.
  • RegisterFailed: The instance fails to be registered.
  • Installing: The instance is being installed.
  • InstallFailed: The instance fails to be installed.
  • Updating: The instance is being upgraded.
  • UpdateFailed: The instance fails to be upgraded.
  • Rollbacking: The instance is being rolled back.
  • RollbackSuccess: The instance is rolled back successfully.
  • RollbackFailed: The instance fails to be rolled back.
  • Deleting: The instance is being deleted.
  • DeleteFailed: The instance fails to be deleted.
  • Unregistering: The instance is being deregistered.
  • UnRegisterFailed: The instance fails to be deregistered.
  • CreateTimeout: Creation of the instance times out.
  • InitTimeout: Initialization of the instance times out.
  • RegisterTimeout: Registration of the instance times out.
  • InstallTimeout: Installation of the instance times out.
  • UpdateTimeout: Upgrading of the instance times out.
  • RollbackTimeout: Rollback of the instance times out.
  • DeleteTimeout: Deletion of the instance times out.
  • UnregisterTimeout: Deregistration of the instance times out.
  • Starting: The instance is being started.
  • Freezing: The instance is being frozen.
  • Frozen: The instance is frozen.
  • Restarting: The instance is being restarted.
  • RestartFail: The instance fails to be restarted.
  • Unhealthy: The instance is abnormal.
  • RestartTimeout: Restart of the instance times out.
  • Resizing: The instance specification is changing.
  • ResizeFailed: The instance specification fails to be changed.
  • ResizeTimeout: The instance specification change times out.
-

Enumeration values:

-
  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
  • Resizing
  • ResizeFailed
  • ResizeTimeout
-

instance_status

-

Integer

-

Instance status ID:

-
  • 1: Creating
  • 2: Created successfully
  • 3: Creation failed
  • 4: Initializing
  • 5: Registering
  • 6: Running
  • 7: Initialization failed
  • 8: Registration failed
  • 10: Installing
  • 11: Installation failed
  • 12: Upgrading
  • 13: Upgrade failed
  • 20: Rolling back
  • 21: Rolled back
  • 22: Rollback failed
  • 23: Deleting
  • 24: Deletion failed
  • 25: Deregistering
  • 26: Deregistration failed
  • 27: Creation timed out
  • 28: Initialization timed out
  • 29: Registration timed out
  • 30: Installation timed out
  • 31: Upgrade timed out
  • 32: Rollback timed out
  • 33: Deletion timed out
  • 34: Deregistration timed out
  • 35: Starting
  • 36: Freezing
  • 37: Frozen
  • 38: Restarting
  • 39: Restart failed
  • 40: Abnormal
  • 41: Restart timed out
  • 42: Changing specification
  • 43: Specification change failed
  • 44: Specification change timed out
-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 10
  • 11
  • 12
  • 13
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
-

type

-

String

-

Gateway type.

-

The default value is apig.

-

spec

-

String

-

Gateway edition.

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

Enumeration values:

-
  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM
-

create_time

-

Long

-

Time when the gateway is created. The time is in the Unix timestamp format.

-

enterprise_project_id

-

String

-

Enterprise project ID. This parameter is required if you are using an enterprise account.

-

eip_address

-

String

-

EIP bound to the gateway.

-

charging_mode

-

Integer

-

Billing mode of the gateway.

-
  • 0: pay-per-use
  • 1: This parameter is not used currently.
-

Enumeration values:

-
  • 0
  • 1
-

loadbalancer_provider

-

String

-

Type of the load balancer used by the gateway.

-
  • ELB
-

description

-

String

-

Description about the gateway.

-

vpc_id

-

String

-

VPC ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console, and click the name of a VPC to view the VPC ID on the displayed details page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying VPCs" in the VPC API Reference.
-

subnet_id

-

String

-

Subnet network ID.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Subnets" in the VPC API Reference.
-

security_group_id

-

String

-

ID of the security group to which the gateway belongs.

-

You can obtain it in either of the following ways:

-
  • Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the Security Groups page, click the target security group. Then view the security group ID on the displayed page.
  • Method 2: Call the corresponding VPC API. For details, see section "Querying Security Groups" in the VPC API Reference.
-

maintain_begin

-

String

-

Start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.

-

During the maintenance time period, the O&M personnel can perform maintenance operations on the gateway. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

maintain_end

-

String

-

End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.

-

During the maintenance time period, the O&M personnel can perform maintenance operations on the gateway. During maintenance, services can still be used, but occasionally there may be temporary service interruptions. Scheduled maintenance occurs infrequently (typically once every several months).

-

ingress_ip

-

String

-

VPC ingress address.

-

user_id

-

String

-

ID of the account to which the gateway belongs.

-

nat_eip_address

-

String

-

IP address for public outbound access.

-

bandwidth_size

-

Integer

-

Outbound access bandwidth.

-

bandwidth_charging_mode

-

String

-

Billing mode of the public outbound access bandwidth.

-

available_zone_ids

-

String

-

AZ.

-

instance_version

-

String

-

Gateway version.

-

virsubnet_id

-

String

-

Subnet network ID.

-

Currently, this parameter is not supported.

-

roma_eip_address

-

String

-

ROMA EIP.

-

Currently, this parameter is not supported.

-

listeners

-

Object

-

Listener information.

-

Currently, this parameter is not supported.

-

supported_features

-

Array of strings

-

Supported features.

-

endpoint_service

-

EndpointService object

-

VPC endpoint service details.

-

This parameter will be deprecated. Use endpoint_services instead.

-

endpoint_services

-

Array of EndpointService objects

-

VPC endpoint services.

-

node_ips

-

NodeIps object

-

VPC endpoint ID.

-

publicips

-

Array of IpDetails objects

-

Public inbound access addresses.

-

privateips

-

Array of IpDetails objects

-

Private inbound access addresses.

-

is_releasable

-

Boolean

-

Whether the gateway can be released.

-
  • true: The gateway can be released.
  • false: The gateway cannot be released.
-

ingress_bandwidth_charging_mode

-

String

-

Billing mode of the public inbound access bandwidth.

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

Parameter

-

Type

-

Description

-

service_name

-

String

-

VPC endpoint service name.

-

created_at

-

String

-

Creation time.

-
-
- -
- - - - - - - - - - - - - -
Table 6 NodeIps

Parameter

-

Type

-

Description

-

livedata

-

Array of strings

-

LiveData node IP addresses.

-

shubao

-

Array of strings

-

Shubao node IP addresses.

-
-
- -
- - - - - - - - - - - - - -
Table 7 IpDetails

Parameter

-

Type

-

Description

-

ip_address

-

String

-

IP address.

-

bandwidth_size

-

Integer

-

Bandwidth.

-
-
-

Status code: 400

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

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

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

Modifying a gateway

-
{
-  "description" : "test create instance",
-  "instance_name" : "apig-demo"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
-  "bandwidth_size" : 5,
-  "description" : "test create instance",
-  "enterprise_project_id" : "0",
-  "instance_name" : "apig-demo",
-  "maintain_begin" : "22:00:00",
-  "maintain_end" : "02:00:00",
-  "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
-  "spec" : "PROFESSIONAL",
-  "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
-  "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIC.7211",
-  "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]"
-}
-

Status code: 401

-

Unauthorized

-
{
-  "error_code" : "APIC.7102",
-  "error_msg" : "Incorrect token or token resolution failed"
-}
-

Status code: 403

-

Forbidden

-
{
-  "error_code" : "APIC.7106",
-  "error_msg" : "No permissions to request for the method"
-}
-

Status code: 404

-

Not Found

-
{
-  "error_code" : "APIC.7302",
-  "error_msg" : "Instance not found"
-}
-

Status code: 500

-

Internal Server Error

-
{
-  "error_code" : "APIC.9000",
-  "error_msg" : "Failed to request internal service"
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Gateway Management
-
-
- diff --git a/docs/apig/api-ref/UpdateRequestThrottlingPolicyV2_1.html b/docs/apig/api-ref/UpdateRequestThrottlingPolicyV2_1.html deleted file mode 100644 index efca8b0f..00000000 --- a/docs/apig/api-ref/UpdateRequestThrottlingPolicyV2_1.html +++ /dev/null @@ -1,576 +0,0 @@ - - -

Modifying a Request Throttling Policy

-

Function

This API is used to modify the information about a request throttling policy.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_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.

-

throttle_id

-

Yes

-

String

-

Request throttling policy 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

-

app_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

Yes

-

String

-

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

-

time_unit

-

Yes

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

No

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Yes

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

No

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

No

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Yes

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

No

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

app_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter cannot exceed the user call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

name

-

String

-

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

-

time_unit

-

String

-

Time unit for limiting the number of API calls.

-

Enumeration values:

-

  • SECOND

    -

  • MINUTE

    -

  • HOUR

    -

  • DAY

    -
-

remark

-

String

-

Description of the request throttling policy, which can contain a maximum of 255 characters.

-

api_call_limits

-

Integer

-

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. Enter a positive integer.

-

type

-

Integer

-

Type of the request throttling policy.

-

  • 1: API-based, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

    -

  • 2: API-shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

enable_adaptive_control

-

String

-

Indicates whether to enable dynamic request throttling.

-

  • TRUE

    -

  • FALSE

    -
-

Currently, this parameter is not supported.

-

user_call_limits

-

Integer

-

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter cannot exceed the Max. API Requests. The maximum value is 2,147,483,647. Enter a positive integer.

-

time_interval

-

Integer

-

Period of time for limiting the number of API calls. This parameter applies with each API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

ip_call_limits

-

Integer

-

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter cannot exceed the API call limit. The maximum value is 2,147,483,647. Enter a positive integer.

-

id

-

String

-

Request throttling policy ID.

-

bind_num

-

Integer

-

Number of APIs to which the request throttling policy has been bound.

-

is_inclu_special_throttle

-

Integer

-

Indicates whether an excluded request throttling configuration has been created.

-

  • 1: yes

    -

  • 2: no

    -
-

Enumeration values:

-

  • 1

    -

  • 2

    -
-

create_time

-

String

-

Creation time.

-
-
-

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 a request throttling policy (max. API requests: 800; max. user requests: 500; max. app requests: 300; max. IP address requests: 600; period: 1s)

-
{
-  "name" : "throttle_demo",
-  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-  "type" : 1,
-  "time_interval" : 1,
-  "ip_call_limits" : 600,
-  "app_call_limits" : 300,
-  "time_unit" : "SECOND",
-  "api_call_limits" : 800,
-  "user_call_limits" : 500
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "name" : "throttle_demo",
-  "create_time" : "2020-07-31T08:44:02.205366118Z",
-  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
-  "type" : 1,
-  "time_interval" : 1,
-  "ip_call_limits" : 600,
-  "app_call_limits" : 300,
-  "time_unit" : "SECOND",
-  "api_call_limits" : 800,
-  "id" : "3437448ad06f4e0c91a224183116e965",
-  "user_call_limits" : 500,
-  "enable_adaptive_control" : "FALSE",
-  "bind_num" : 0,
-  "is_inclu_special_throttle" : 2
-}
-

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3005",
-  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/UpdateSignatureKeyV2_1.html b/docs/apig/api-ref/UpdateSignatureKeyV2_1.html deleted file mode 100644 index 379d150a..00000000 --- a/docs/apig/api-ref/UpdateSignatureKeyV2_1.html +++ /dev/null @@ -1,493 +0,0 @@ - - -

Modifying a Signature Key

-

Function

This API is used to modify the information about a signature key.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_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.

-

sign_id

-

Yes

-

String

-

Signature key 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

-

Signature key name. It can contain letters, digits, and underscores(_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

-

sign_type

-

No

-

String

-

Signature key type.

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

sign_key

-

No

-

String

-

Signature key.

-

  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.

    -

  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_secret

-

No

-

String

-

Signature secret.

-

  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • public_key: The value can contain 16 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_algorithm

-

No

-

String

-

Signature algorithm. Specify a signature algorithm only when using an AES signature key. By default, no algorithm is used.

-

Enumeration values:

-

  • aes-128-cfb

    -

  • aes-256-cfb

    -
-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

name

-

String

-

Signature key name. It can contain letters, digits, and underscores(_) and must start with a letter.

-

Minimum: 3

-

Maximum: 64

-

sign_type

-

String

-

Signature key type.

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

To use a basic signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

To use a public_key signature key, ensure that the public_key feature has been configured for your gateway. For details, see "Appendix" > "Supported Features". If your gateway does not support this feature, contact technical support to enable it.

-

To use an AES signature key, ensure that your gateway version supports it. If your gateway does not support this type of signature key, contact technical support to upgrade your gateway.

-

Enumeration values:

-

  • hmac

    -

  • basic

    -

  • public_key

    -

  • aes

    -
-

sign_key

-

String

-

Signature key.

-

  • hmac: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). It must start with a letter. If not specified, a key is automatically generated.

    -

  • public_key: The value contains 8 to 512 characters, including letters, digits, and special characters (_-+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_secret

-

String

-

Signature secret.

-

  • hmac: The value contains 16 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • basic: The value contains 8 to 64 characters. Letters, digits, and special characters (_-!@#$%) are allowed. It must start with a letter or digit. If not specified, a key is automatically generated.

    -

  • public_key: The value can contain 16 to 2048 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -

  • aes: The value contains 16 characters, including letters, digits, and special characters (_-!@#$%+/=). It must start with a letter, digit, plus sign (+), or slash (/). If not specified, a key is automatically generated.

    -
-

sign_algorithm

-

String

-

Signature algorithm. Specify a signature algorithm only when using an AES signature key. By default, no algorithm is used.

-

Enumeration values:

-

  • aes-128-cfb

    -

  • aes-256-cfb

    -
-

update_time

-

String

-

Update time.

-

create_time

-

String

-

Creation time.

-

id

-

String

-

Signature key ID.

-
-
-

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

Creating a signature key

-
{
-  "name" : "signature_demo"
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "sign_secret" : "dc0************2b3",
-  "update_time" : "2020-08-03T03:50:14.989785802Z",
-  "create_time" : "2020-08-03T03:39:38Z",
-  "name" : "signature_demo",
-  "id" : "0b0e8f456b8742218af75f945307173c",
-  "sign_key" : "a071a20d460a4f639a636c3d7e3d8163",
-  "sign_type" : "hmac"
-}
-

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: 404

-

Not Found

-
{
-  "error_code" : "APIG.3017",
-  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: Signature Key Management
-
-
- diff --git a/docs/apig/api-ref/UpdateSpecialThrottlingConfigurationV2_0.html b/docs/apig/api-ref/UpdateSpecialThrottlingConfigurationV2_0.html deleted file mode 100644 index 9daf76da..00000000 --- a/docs/apig/api-ref/UpdateSpecialThrottlingConfigurationV2_0.html +++ /dev/null @@ -1,415 +0,0 @@ - - -

Modifying an Excluded Request Throttling Configuration

-

Function

This API is used to modify an excluded configuration of a request throttling policy.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_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.

-

throttle_id

-

Yes

-

String

-

Request throttling policy ID.

-

strategy_id

-

Yes

-

String

-

Excluded configuration 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

-

call_limits

-

Yes

-

Long

-

Maximum number of times an excluded object can access an API within the throttling period.

-
-
-
-

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

id

-

String

-

Excluded configuration ID.

-

call_limits

-

Integer

-

Maximum number of times an excluded object can access an API within the throttling period.

-

apply_time

-

String

-

Throttling period.

-

app_name

-

String

-

App name.

-

app_id

-

String

-

App ID.

-

object_id

-

String

-

ID of an object specified in the excluded configuration.

-

object_type

-

String

-

Excluded object type, which can be APP or USER.

-

object_name

-

String

-

Name of an app or a tenant to which the excluded configuration applies.

-

throttle_id

-

String

-

Request throttling policy ID.

-
-
-

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 excluded configuration of a request throttling policy

-
{
-  "call_limits" : 200
-}
-
-

Example Responses

Status code: 200

-

OK

-
{
-  "call_limits" : 200,
-  "app_name" : "app_demo",
-  "object_name" : "app_demo",
-  "object_id" : "356de8eb7a8742168586e5daf5339965",
-  "throttle_id" : "3437448ad06f4e0c91a224183116e965",
-  "apply_time" : "2020-08-04T02:40:56Z",
-  "id" : "a3e9ff8db55544ed9db91d8b048770c0",
-  "app_id" : "356de8eb7a8742168586e5daf5339965",
-  "object_type" : "APP"
-}
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2003",
-  "error_msg" : "The parameter value is too large,parameterName:call_limits. 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.3013",
-  "error_msg" : "Excluded request throttling configuration a3e9ff8db55544ed9db91d8b048770c0 does not exist"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
- - diff --git a/docs/apig/api-ref/UpdateVpcChannelV2_1.html b/docs/apig/api-ref/UpdateVpcChannelV2_1.html deleted file mode 100644 index b76dd5dc..00000000 --- a/docs/apig/api-ref/UpdateVpcChannelV2_1.html +++ /dev/null @@ -1,1675 +0,0 @@ - - -

Updating a VPC Channel

-

Function

This API is used to update the parameters of a VPC channel.

-

If the VPC channel is overwritten with an empty backend instance list, all the existing backend instances will be deleted.

-

If the VPC channel is overwritten with an empty backend server group list, all the existing backend server groups will be deleted.

-
-

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_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.

-

vpc_channel_id

-

Yes

-

String

-

VPC channel 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

-

VPC channel name.

-

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

-

port

-

Yes

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Yes

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

Yes

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

No

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

No

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

member_groups

-

No

-

Array of MemberGroupCreate objects

-

Backend server groups of the VPC channel.

-

members

-

No

-

Array of MemberInfo objects

-

Backend instances of the VPC channel.

-

vpc_health_config

-

No

-

VpcHealthConfig object

-

Health check details.

-

microservice_info

-

No

-

MicroServiceCreate object

-

Microservice details.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 MemberGroupCreate

Parameter

-

Mandatory

-

Type

-

Description

-

member_group_name

-

Yes

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

No

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

No

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

No

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

No

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

No

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

No

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 MicroserviceLabel

Parameter

-

Mandatory

-

Type

-

Description

-

label_name

-

Yes

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

Yes

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 MemberInfo

Parameter

-

Mandatory

-

Type

-

Description

-

host

-

No

-

String

-

Backend server address.

-

This parameter is required when the member type is IP address.

-

Maximum: 64

-

weight

-

No

-

Integer

-

Weight.

-

The higher the weight is, the more requests a backend service will receive.

-

Minimum: 0

-

Maximum: 10000

-

is_backup

-

No

-

Boolean

-

Indicates whether the backend service is a standby node.

-

After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty.

-

This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support.

-

Default: false

-

member_group_name

-

No

-

String

-

Backend server group name. The server group facilitates backend service address modification.

-

status

-

No

-

Integer

-

Backend server status.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

port

-

No

-

Integer

-

Backend server port.

-

Minimum: 0

-

Maximum: 65535

-

ecs_id

-

No

-

String

-

Backend server ID.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

-

Maximum: 255

-

ecs_name

-

No

-

String

-

Backend server name.

-

This parameter is required if the backend instance type is ecs. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 VpcHealthConfig

Parameter

-

Mandatory

-

Type

-

Description

-

protocol

-

Yes

-

String

-

Protocol for performing health checks on backend servers in the VPC channel.

-
  • TCP
  • HTTP
  • HTTPS
-

Enumeration values:

-
  • TCP
  • HTTP
  • HTTPS
-

path

-

No

-

String

-

Destination path for health checks. This parameter is required if protocol is set to http or https.

-

method

-

No

-

String

-

Request method for health checks.

-

Default: GET

-

Enumeration values:

-
  • GET
  • HEAD
-

port

-

No

-

Integer

-

Destination port for health checks. If this parameter is not specified or set to 0, the host port of the VPC channel is used.

-

If this parameter is set to a non-zero value, the corresponding port is used for health checks.

-

Minimum: 0

-

Maximum: 65535

-

threshold_normal

-

Yes

-

Integer

-

Healthy threshold. It refers to the number of consecutive successful checks required for a backend server to be considered healthy.

-

Minimum: 1

-

Maximum: 10

-

threshold_abnormal

-

Yes

-

Integer

-

Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy.

-

Minimum: 1

-

Maximum: 10

-

time_interval

-

Yes

-

Integer

-

Interval between consecutive checks. Unit: s. The value must be greater than the value of timeout.

-

Minimum: 1

-

Maximum: 300

-

http_code

-

No

-

String

-

Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats:

-
  • Multiple values, for example, 200,201,202
  • Range, for example, 200-299
  • Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.
-

enable_client_ssl

-

No

-

Boolean

-

Indicates whether to enable two-way authentication. If this function is enabled, the certificate specified in the backend_client_certificate configuration item of the gateway is used.

-

Default: false

-

status

-

No

-

Integer

-

Health check result.

-
  • 1: available
  • 2: unavailable
-

Enumeration values:

-
  • 1
  • 2
-

timeout

-

Yes

-

Integer

-

Timeout for determining whether a health check fails. Unit: s. The value must be less than the value of time_interval.

-

Minimum: 1

-

Maximum: 30

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 MicroServiceCreate

Parameter

-

Mandatory

-

Type

-

Description

-

service_type

-

No

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

No

-

MicroServiceInfoCSEBase object

-

CSE microservice details. This parameter is required if service_type is set to CSE.

-

cce_info

-

No

-

MicroServiceInfoCCEBase object

-

CCE workload details. This parameter is required if service_type is set to CCE. Either app_name or any of label_key and label_value must be set. If only app_name is set, label_key='app' and label_value=app_name.

-

cce_service_info

-

No

-

MicroServiceInfoCCEServiceBase object

-

CCE Service details.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 9 MicroServiceInfoCSEBase

Parameter

-

Mandatory

-

Type

-

Description

-

engine_id

-

Yes

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

Yes

-

String

-

Microservice ID.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 MicroServiceInfoCCEBase

Parameter

-

Mandatory

-

Type

-

Description

-

cluster_id

-

Yes

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

Yes

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

Yes

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

No

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

No

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

No

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 11 MicroServiceInfoCCEServiceBase

Parameter

-

Mandatory

-

Type

-

Description

-

cluster_id

-

Yes

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

Yes

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

Yes

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

VPC channel name.

-

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

-

port

-

Integer

-

Host port of the VPC channel.

-

Range: 1–65535.

-

balance_strategy

-

Integer

-

Distribution algorithm.

-
  • 1: Weighted round robin (WRR).
  • 2: Weighted least connections (WLC).
  • 3: Source hashing.
  • 4: URI hashing.
-

Default: 1

-

Enumeration values:

-
  • 1
  • 2
  • 3
  • 4
-

member_type

-

String

-

Member type of the VPC channel.

-
  • ip
  • ecs
-

Default: ecs

-

Enumeration values:

-
  • ip
  • ecs
-

type

-

Integer

-

VPC channel type. The default type is server.

-
  • 2: Server type.
  • 3: Microservice type.
-

Default: 2

-

Enumeration values:

-
  • 2
  • 3
-

dict_code

-

String

-

Dictionary code of the VPC channel.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

This parameter is currently not supported.

-

Minimum: 3

-

Maximum: 64

-

create_time

-

String

-

Time when the VPC channel is created.

-

id

-

String

-

VPC channel ID.

-

status

-

Integer

-

VPC channel status.

-
  • 1: normal
  • 2: abnormal
-

Enumeration values:

-
  • 1
  • 2
-

member_groups

-

Array of MemberGroupInfo objects

-

Backend server groups.

-

microservice_info

-

MicroServiceInfo object

-

Microservice information.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 MemberGroupInfo

Parameter

-

Type

-

Description

-

member_group_name

-

String

-

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

-

member_group_remark

-

String

-

Description of the backend server group.

-

Maximum: 255

-

member_group_weight

-

Integer

-

Weight of the backend server group.

-

If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group.

-

Minimum: 0

-

Maximum: 100

-

dict_code

-

String

-

Dictionary code of the backend server group.

-

The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).

-

Currently, this parameter is not supported.

-

Minimum: 3

-

Maximum: 64

-

microservice_version

-

String

-

Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

Maximum: 64

-

microservice_port

-

Integer

-

Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.

-

Minimum: 0

-

Maximum: 65535

-

microservice_labels

-

Array of MicroserviceLabel objects

-

Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.

-

member_group_id

-

String

-

ID of the backend server group of the VPC channel.

-

create_time

-

String

-

Time when the backend server group is created.

-

update_time

-

String

-

Time when the backend server group is updated.

-
-
- -
- - - - - - - - - - - - - -
Table 14 MicroserviceLabel

Parameter

-

Type

-

Description

-

label_name

-

String

-

Tag name.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-

label_value

-

String

-

Tag value.

-

Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

-

Minimum: 1

-

Maximum: 63

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 MicroServiceInfo

Parameter

-

Type

-

Description

-

id

-

String

-

Microservice ID.

-

instance_id

-

String

-

Gateway ID.

-

service_type

-

String

-

Microservice type. Options:

-
  • CSE: CSE microservice registration center
  • CCE: CCE workload
-

Enumeration values:

-
  • CSE
  • CCE
-

cse_info

-

MicroServiceInfoCSE object

-

CSE microservice details.

-

cce_info

-

MicroServiceInfoCCE object

-

CCE microservice workload details.

-

cce_service_info

-

MicroServiceInfoCCEService object

-

CCE microservice Service details.

-

update_time

-

String

-

Microservice update time.

-

create_time

-

String

-

Microservice creation time.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 16 MicroServiceInfoCSE

Parameter

-

Type

-

Description

-

engine_id

-

String

-

Microservice engine ID.

-

Maximum: 64

-

service_id

-

String

-

Microservice ID.

-

Maximum: 64

-

engine_name

-

String

-

Microservice engine name.

-

service_name

-

String

-

Microservice name.

-

register_address

-

String

-

Registration center address.

-

cse_app_id

-

String

-

App to which the microservice belongs.

-

version

-

String

-

Microservice version, which has been discarded and is reflected in the version of the backend server group.

-

Maximum: 64

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 MicroServiceInfoCCE

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace.

-

Maximum: 64

-

workload_type

-

String

-

Workload type.

-
  • deployment
  • statefulset
  • daemonset
-

Enumeration values:

-
  • deployment
  • statefulset
  • daemonset
-

app_name

-

String

-

App name. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_key

-

String

-

Service label key. Start with a letter or digit, and use only letters, digits, and these special characters: -_./:(). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

label_value

-

String

-

Service label value. Start with a letter, and include only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 18 MicroServiceInfoCCEService

Parameter

-

Type

-

Description

-

cluster_id

-

String

-

CCE cluster ID.

-

Maximum: 64

-

namespace

-

String

-

Namespace. 1 to 63 characters. Use lowercase letters, digits, and hyphens (-). Start with a letter and end with a letter or digit.

-

Minimum: 1

-

Maximum: 63

-

service_name

-

String

-

Service name. Start with a letter, and use only letters, digits, periods (.), hyphens (-), and underscores (_). (1 to 64 characters)

-

Minimum: 1

-

Maximum: 64

-

cluster_name

-

String

-

CCE cluster name.

-
-
-

Status code: 400

- -
- - - - - - - - - - - - - -
Table 19 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 401

- -
- - - - - - - - - - - - - -
Table 20 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 403

- -
- - - - - - - - - - - - - -
Table 21 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 404

- -
- - - - - - - - - - - - - -
Table 22 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-

Status code: 500

- -
- - - - - - - - - - - - - -
Table 23 Response body parameters

Parameter

-

Type

-

Description

-

error_code

-

String

-

Error code.

-

error_msg

-

String

-

Error message.

-
-
-
-

Example Requests

  • Updating a VPC channel of the server type
    {
-  "balance_strategy" : 2,
-  "member_type" : "ip",
-  "name" : "VPC_demo",
-  "port" : 22,
-  "type" : 2,
-  "vpc_health_config" : {
-    "http_code" : "200",
-    "path" : "/vpc/demo",
-    "port" : 22,
-    "protocol" : "http",
-    "threshold_abnormal" : 5,
-    "threshold_normal" : 2,
-    "time_interval" : 10,
-    "timeout" : 5,
-    "enable_client_ssl" : false
-  },
-  "member_groups" : [ {
-    "member_group_name" : "test",
-    "member_group_weight" : 1,
-    "member_group_remark" : "remark"
-  }, {
-    "member_group_name" : "default",
-    "member_group_weight" : 2,
-    "member_group_remark" : "remark"
-  } ],
-  "members" : [ {
-    "host" : "192.168.0.5",
-    "weight" : 1,
-    "member_group_name" : "test"
-  }, {
-    "host" : "192.168.1.124",
-    "weight" : 2,
-    "member_group_name" : "default"
-  } ]
-}
    -
  • Updating a VPC channel of the microservice type
    {
-  "balance_strategy" : 1,
-  "member_type" : "ip",
-  "name" : "VPC_demo",
-  "port" : 22,
-  "type" : 3,
-  "vpc_health_config" : {
-    "http_code" : "200",
-    "path" : "/vpc/demo",
-    "port" : 22,
-    "protocol" : "http",
-    "threshold_abnormal" : 5,
-    "threshold_normal" : 2,
-    "time_interval" : 10,
-    "timeout" : 5,
-    "enable_client_ssl" : false
-  },
-  "member_groups" : [ {
-    "member_group_name" : "test",
-    "member_group_weight" : 1,
-    "member_group_remark" : "remark",
-    "microservice_version" : "v1",
-    "microservice_port" : 80
-  }, {
-    "member_group_name" : "default",
-    "member_group_weight" : 2,
-    "member_group_remark" : "remark",
-    "microservice_version" : "v2",
-    "microservice_port" : 80,
-    "microservice_labels" : [ {
-      "label_name" : "cluster_id",
-      "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113"
-    } ]
-  } ],
-  "members" : [ {
-    "host" : "192.168.0.5",
-    "weight" : 1,
-    "member_group_name" : "test"
-  }, {
-    "host" : "192.168.1.124",
-    "weight" : 2,
-    "member_group_name" : "default"
-  } ],
-  "microservice_info" : {
-    "service_type" : "CCE",
-    "cce_info" : {
-      "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
-      "namespace" : "default",
-      "workload_type" : "deployment",
-      "app_name" : "testapp"
-    }
-  }
-}
    -
-
-

Example Responses

Status code: 200

-

OK

-
  • Example 1
    {
-  "name" : "VPC_demo",
-  "port" : 22,
-  "balance_strategy" : 2,
-  "member_type" : "ip",
-  "dict_code" : "",
-  "create_time" : "2020-07-23T07:11:57Z",
-  "id" : "18174f5f4f1a4dc29f33aeadd9788e5f",
-  "status" : 1,
-  "member_groups" : [ {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe16",
-    "member_group_name" : "test",
-    "member_group_weight" : 1,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z"
-  }, {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe17",
-    "member_group_name" : "default",
-    "member_group_weight" : 2,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z"
-  } ],
-  "type" : 2,
-  "microservice_info" : {
-    "id" : "",
-    "instance_id" : "",
-    "service_type" : "",
-    "cse_info" : {
-      "cse_app_id" : "",
-      "engine_id" : "",
-      "engine_name" : "",
-      "register_address" : "",
-      "service_id" : "",
-      "service_name" : ""
-    },
-    "cce_info" : {
-      "cluster_id" : "",
-      "cluster_name" : "",
-      "namespace" : "",
-      "workload_type" : "",
-      "app_name" : ""
-    },
-    "create_time" : "",
-    "update_time" : ""
-  }
-}
    -
  • Example 2
    {
-  "name" : "VPC_demo",
-  "id" : "105c6902457144a4820dff8b1ad63331",
-  "balance_strategy" : 1,
-  "dict_code" : "",
-  "create_time" : "2020-07-23T07:11:57.244829604Z",
-  "member_type" : "ip",
-  "port" : 22,
-  "status" : 1,
-  "member_groups" : [ {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe16",
-    "member_group_name" : "test",
-    "member_group_weight" : 1,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z",
-    "microservice_version" : "v1",
-    "microservice_port" : 80
-  }, {
-    "member_group_id" : "c1ce135c705c4066853a0460b318fe17",
-    "member_group_name" : "default",
-    "member_group_weight" : 2,
-    "member_group_remark" : "remark",
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z",
-    "microservice_version" : "v2",
-    "microservice_port" : 80,
-    "microservice_labels" : [ {
-      "label_name" : "cluster_id",
-      "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113"
-    } ]
-  } ],
-  "type" : 3,
-  "microservice_info" : {
-    "id" : "9483afa235be45158a70c19ab817ac65",
-    "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
-    "service_type" : "CCE",
-    "cse_info" : {
-      "cse_app_id" : "",
-      "engine_id" : "",
-      "engine_name" : "",
-      "register_address" : "",
-      "service_id" : "",
-      "service_name" : ""
-    },
-    "cce_info" : {
-      "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
-      "cluster_name" : "cce-test",
-      "namespace" : "default",
-      "workload_type" : "deployment",
-      "app_name" : "testapp"
-    },
-    "create_time" : "2020-07-23T07:11:57.244829604Z",
-    "update_time" : "2020-07-23T07:11:57.244829604Z"
-  }
-}
    -
-

Status code: 400

-

Bad Request

-
{
-  "error_code" : "APIG.2001",
-  "error_msg" : "The request parameters must be specified, parameter name:members"
-}
-

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.3023",
-  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
-}
-

Status code: 500

-

Internal Server Error

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

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

200

-

OK

-

400

-

Bad Request

-

401

-

Unauthorized

-

403

-

Forbidden

-

404

-

Not Found

-

500

-

Internal Server Error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
-
-
Parent topic: VPC Channel Management
-
-
- diff --git a/docs/apig/api-ref/VpcChannelManagement_1.html b/docs/apig/api-ref/VpcChannelManagement_1.html deleted file mode 100644 index 8c693f05..00000000 --- a/docs/apig/api-ref/VpcChannelManagement_1.html +++ /dev/null @@ -1,32 +0,0 @@ - - -

VPC Channel Management

-

-
- - diff --git a/docs/apig/api-ref/api-grant-policy.html b/docs/apig/api-ref/api-grant-policy.html index 64db8cd7..05b0c256 100644 --- a/docs/apig/api-ref/api-grant-policy.html +++ b/docs/apig/api-ref/api-grant-policy.html @@ -1,941 +1,1758 @@

Permissions Policies and Supported Actions

-

This chapter describes fine-grained permissions management for your APIG.

-
  • If your account does not require individual IAM users, skip this section.
  • Only dedicated gateways support fine-grained permissions management.
+

This chapter describes fine-grained permissions management for your APIG.

+
  • If your account does not require individual IAM users, skip this section.
  • Only dedicated gateways support fine-grained permissions management.
-

By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles (in JSON format) to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

-

An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only IAM users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to create APIs using an API, the user must have been granted permissions that allow the apig:apis:create action.

-

Supported Actions

Operations supported by policies are specific to APIs. The following are common concepts related to policies:

-
  • Permission: A statement in a policy that allows or denies certain operations.
  • Action: Specific operations that are allowed or denied.
  • API: REST APIs that can be called by a user who has been granted specific permissions.
  • Authorization scope: Type of projects in which policies can be used to grant permissions. A policy can be applied to IAM projects, enterprise projects, or both. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.
-

APIG supports actions that can be defined in custom policies. Permissions must be obtained before calling APIs provided by APIG.

+

By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles (in JSON format) to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

+

An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only IAM users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to create APIs using an API, the user must have been granted permissions that allow the apig:apis:create action.

+

Supported Actions

Operations supported by policies are specific to APIs. The following are common concepts related to policies:

+
  • Permission: A statement in a policy that allows or denies certain operations.
  • Action: Specific operations that are allowed or denied.
  • API: REST APIs that can be called by a user who has been granted specific permissions.
  • Authorization scope: Type of projects in which policies can be used to grant permissions. A policy can be applied to IAM projects, enterprise projects, or both. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.
+

APIG supports actions that can be defined in custom policies. Permissions must be obtained before calling APIs provided by APIG.

-
Table 1 Supported actions

Description

+
- - - - + - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - + + + + + + + + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - - - - - + - + - - - - - + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - diff --git a/docs/apig/api-ref/apig-api-180713005.html b/docs/apig/api-ref/apig-api-180713005.html index 7e975e78..f37a7841 100644 --- a/docs/apig/api-ref/apig-api-180713005.html +++ b/docs/apig/api-ref/apig-api-180713005.html @@ -1,8 +1,8 @@

Obtaining an Account Name and Account ID

-

An account name and account ID are required for some URLs when an API is called. To obtain an account name and account ID, perform the following operations:

-
  1. Log in to the management console.
  2. Hover the mouse pointer over the username, click the username, and choose My Credentials from the drop-down list.

    View the account name and account ID.

    +

    An account name and account ID are required for some URLs when an API is called. To obtain an account name and account ID, perform the following operations:

    +
    1. Log in to the management console.
    2. Hover the mouse pointer over the username, click the username, and choose My Credentials from the drop-down list.

      View the account name and account ID.

    diff --git a/docs/apig/api-ref/apig-api-180713009.html b/docs/apig/api-ref/apig-api-180713009.html index 83855879..864fd228 100644 --- a/docs/apig/api-ref/apig-api-180713009.html +++ b/docs/apig/api-ref/apig-api-180713009.html @@ -1,10 +1,10 @@

    Obtaining a Project ID

    -

    Calling an API

    You can also obtain a project ID by calling the IAM API used to query project information.

    -

    The API used to obtain a project ID is "GET https://{Endpoint}/v3/projects/". {Endpoint} is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see Authentication.

    -

    The following is an example response. The value of id in the projects field is the project ID.

    -
    {
+
    Calling an API
    You can also obtain a project ID by calling the IAM API used to query project information.
    
+
    The API used to obtain a project ID is "GET https://{Endpoint}/v3/projects/". {Endpoint} is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see Authentication.
    
+
    The following is an example response. The value of id in the projects field is the project ID.
    
+
    {
     "projects": [
         {
             "domain_id": "65382450e8f64ac0870cd180d14e684b",
@@ -17,7 +17,7 @@
                 "previous": null,
                 "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
             },
-            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
             "enabled": true
         }
     ],
@@ -28,9 +28,9 @@
     }
 }
    
 
    
-
    Obtaining a Project ID on the Console
    A project ID needs to be specified in the URLs of some APIs. Therefore, you need to obtain a project ID before calling such APIs. To obtain a project ID, perform the following operations:
    
-
    1. Log in to the management console.
    2. Hover the mouse pointer over the username, click the username, and choose My Credentials from the drop-down list.
      On the My Credentials page, view project IDs in the project list.
      
-
      If there are multiple projects in one region, expand Region and view subproject IDs in the Project ID column.
      
+
      Obtaining a Project ID on the Console
      A project ID needs to be specified in the URLs of some APIs. Therefore, you need to obtain a project ID before calling such APIs. To obtain a project ID, perform the following operations:
      
+
      1. Log in to the management console.
      2. Hover the mouse pointer over the username, click the username, and choose My Credentials from the drop-down list.
        On the API Credentials page, view project IDs in the project list.
        
+
        If there are multiple projects in one region, expand Region and view subproject IDs in the Project ID column.
        
 
      
 
      
 
    
diff --git a/docs/apig/api-ref/apig-api-190529263.html b/docs/apig/api-ref/apig-api-190529263.html
index 430f7303..c380e8a8 100644
--- a/docs/apig/api-ref/apig-api-190529263.html
+++ b/docs/apig/api-ref/apig-api-190529263.html
@@ -1,13 +1,24 @@
 
 
-
    Overview
    
-
    API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.
    
-
    This document describes how to use REST APIs to perform operations on APIG, such as creating, deleting, and modify your own APIs. 
    
-
    If you plan to access APIG through APIs, ensure that you are familiar with APIG concepts. For details, see the API Gateway User Guide.
    
+
    Before You Start
    
+
    API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.
    
+
    This document describes how to use REST APIs to perform operations on APIG, such as creating, deleting, and modify your own APIs. 
    
+
    If you plan to access API Gateway through APIs, ensure that you are familiar with API Gateway concepts. For details, see the User Guide.
    
+
    Endpoints
    An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support engineers.
    
 
    
-
    
-
    
-
    Parent topic: Before You Start
    
+
    Concepts
    • Account
      An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.
      
+
    • IAM user
      A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).
      
+
      An IAM user can view the account ID and user ID on the My Credentials page of the console. The domain name, username, and password will be required for API authentication.
      
+
    • Region
      Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.
      
+
      For details, see Help Center > Others > FAQs > Regions and AZs.
      
+
    • Availability zone (AZ)
      An Availability Zone (AZ) contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
      
+
    • Project
      Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.
      
+
      Figure 1 Project isolating model
      
+
      An IAM user can view the project ID on the My Credentials page of the console.
      
+
    
+
    • Enterprise project
      Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.
      
+
      For details about how to obtain enterprise project IDs and features, see the Enterprise Management Service User Guide.
      
+
    
 
    
 
    
 
diff --git a/docs/apig/api-ref/apig-api-190529264.html b/docs/apig/api-ref/apig-api-190529264.html
deleted file mode 100644
index 332e6c7d..00000000
--- a/docs/apig/api-ref/apig-api-190529264.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-
    API Calling
    
-
    APIG supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
    
-
    
-
    
-
    
-
    Parent topic: Before You Start
    
-
    
-
    
-
diff --git a/docs/apig/api-ref/apig-api-190529265.html b/docs/apig/api-ref/apig-api-190529265.html
deleted file mode 100644
index 823799a7..00000000
--- a/docs/apig/api-ref/apig-api-190529265.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-
    Endpoints
    
-
    An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support.
    
-
    
-
    
-
    
-
    Parent topic: Before You Start
    
-
    
-
    
-
diff --git a/docs/apig/api-ref/apig-api-190529266.html b/docs/apig/api-ref/apig-api-190529266.html
deleted file mode 100644
index fb2d17d7..00000000
--- a/docs/apig/api-ref/apig-api-190529266.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-
    Constraints
    
-
    • The number of APIG resources that you can create is determined by your quota. To increase your quota, contact technical support.
    • For more constraints, see API description.
    
-
    
-
    
-
    
-
    Parent topic: Before You Start
    
-
    
-
    
-
diff --git a/docs/apig/api-ref/apig-api-190529267.html b/docs/apig/api-ref/apig-api-190529267.html
deleted file mode 100644
index 835fee17..00000000
--- a/docs/apig/api-ref/apig-api-190529267.html
+++ /dev/null
@@ -1,25 +0,0 @@
-
-
-
    Concepts
    
-
    • Account
      An account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.
      
-
    • IAM user
      An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).
      
-
      An IAM user can view the account ID and user ID on the My Credentials page of the console. The account name, username, and password will be required for API authentication.
      
-
    • Region
      Regions are defined by their geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), and Object Storage Service (OBS), are shared within the same region. There are universal regions and dedicated regions. A universal region serves all tenants, while a dedicated region serves specific tenants.
      
-
    • AZ
      AZs are physically isolated locations in a region, but are interconnected through an internal network for enhanced application availability.
      
-
    • Project
      Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project. Users can then be assigned permissions to access only specific resources in the subprojects.
      
-
      Figure 1 Project isolating model
      
-
    
-
    
-
    
-
    
-
    Parent topic: Before You Start
    
-
    
-
    
-
-
-
\ No newline at end of file
diff --git a/docs/apig/api-ref/apig-api-190529268.html b/docs/apig/api-ref/apig-api-190529268.html
index 06ae852d..9473126f 100644
--- a/docs/apig/api-ref/apig-api-190529268.html
+++ b/docs/apig/api-ref/apig-api-190529268.html
@@ -1,96 +1,112 @@
 
 
 
    Authentication
    
-
    Requests for calling an API can be authenticated using either of the following methods:
    
-
    • Token-based authentication: Requests are authenticated using a token.
      
-
    • AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it provides higher security than token-based authentication. 
    
-
    Token-based Authentication
     
    The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
    
+
    Requests for calling an API can be authenticated using either of the following methods:
    
+
    • AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it provides higher security than token-based authentication. 
    • Token-based authentication: Requests are authenticated using a token.
      
+
    
+
    AK/SK-based Authentication
    An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.
    
+
     
    AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
    
+
    SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
    
 
    
-
    A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
    
-
    Making an API Request describes the process of calling the API used to create an API group (dedicated gateways). After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
    
-
    -POST https://{apig_endpoint}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
-Content-Type: application/json
-X-Auth-Token: ABCDEFJ....
    
-
    
-
    AK/SK-based Authentication
    An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.
    
-
     
    AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
    
-
    SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
    
+
    The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.
    
+
    Download the demo project at https://github.com/api-gate-way/SdkDemo.
    
+
    If you do not need the demo, obtain the APIG signing SDK from technical support personnel.
    
+
    AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
    
+
    Figure 1 Adding the APIG signing SDK
    
+
    1. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be credentials.csv.)
      1. Register an account and log in to the management console.
      2. Hover over the username and choose My Credentials from the drop-down list.
      1. Choose Access Keys from the navigation pane.
      2. Click Create Access Key.
      3. Enter the login password.
      4. Enter the verification code received by email or SMS message.
         
        For users created in IAM that have not bound any email address or mobile number, only the login password needs to be entered.
        
 
        
-
        The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.
        
-
        Download the demo project at https://github.com/api-gate-way/SdkDemo.
        
-
        If you do not need the demo, obtain the APIG signing SDK from technical support personnel.
        
-
        AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
        
-
        Figure 1 Adding the APIG signing SDK
        
-
        1. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be credentials.csv.)
          1. Register an account and log in to the management console.
          2. Hover over the username and choose My Credentials from the drop-down list.
          1. Click the Access Keys tab.
          2. Click Create Access Key.
          3. Enter the login password.
          4. Enter the verification code received by email or SMS message.
             
            For users created in IAM that have not bound any email address or mobile number, only the login password needs to be entered.
            
-
            
-
          5. Click OK to download the access key.
             
            Keep the access key secure.
            
+
          6. Click OK to download the access key.
             
            Keep the access key secure.
            
 
            
 
          
-
        2. Download and decompress the demo project.
        3. Import the demo project to Eclipse.
          Figure 2 Selecting Existing Projects into Workspace
          
-
          Figure 3 Selecting the demo project
          
-
          Figure 4 Structure of the demo project
          
-
        4. Sign the request.
          The request signing method is integrated in the JAR files imported in 3. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.
          
-
          The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:
          
-
          • AccessService: An abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.
          • Demo: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.
          • AccessServiceImpl: Implements the access method, which contains the code required for communication with APIG.
          
-
          1. Edit the main() method in the Demo.java file, and replace the bold text with actual values.
            As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment.
            
-
            Specify region, serviceName, ak/sk, and url as the actual values. In this demo, the URLs for accessing VPC resources are used.
            
-
            To obtain the project ID in the URLs, see Obtaining a Project ID.
            
-
            Obtain the endpoint from the enterprise administrator.
            
-
            //TODO: Replace region with the name of the region in which the service to be accessed is located. 
-private static final String region = "";
+
          2. Download and decompress the demo project.
          3. Import the demo project to Eclipse.
            Figure 2 Selecting Existing Projects into Workspace
            
+
            Figure 3 Selecting the demo project
            
+
            Figure 4 Structure of the demo project
            
+
          4. Sign the request.
            The request signing method is integrated in the JAR files imported in 3. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.
            
+
            The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:
            
+
            • AccessService: an abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.
            • Demo: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.
            • AccessServiceImpl: Implements the access method, which contains the code required for communication with APIG.
            
+
            1. Edit the main() method in the Demo.java file, and replace the bold text with actual values.
              As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment.
              
+
              Specify region, serviceName, ak/sk, and url as the actual values. In this demo, the URLs for accessing VPC resources are used.
              
+
              To obtain the project ID in the URLs, see Obtaining a Project ID. To obtain the endpoint, contact the enterprise administrator.
              
+
              //TODO: Replace region with the name of the region in which the service to be accessed is located. 
+private static final String region = "";
 
-//TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb.
-private static final String serviceName = "";
+//TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb.
+private static final String serviceName = "";
 
-public static void main(String[] args) throws UnsupportedEncodingException
+public static void main(String[] args) throws UnsupportedEncodingException
 {
-//TODO: Replace the AK and SK with those obtained on the My Credential page.
-String ak = "ZIRRKMTWP******1WKNKB";
-String sk = "Us0mdMNHk******YrRCnW0ecfzl";
+//TODO: Replace the AK and SK with those obtained on the My Credential page.
+String ak = "ZIRRKMTWP******1WKNKB";
+String sk = "Us0mdMNHk******YrRCnW0ecfzl";
 
-//TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header.
-//TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID.
-//TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file.
+//TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header.
+//TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID.
+//TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file.
 
-//TODO: Test the API
-String url = "https://{Endpoint}/v1/{project_id}/vpcs";
-get(ak, sk, url);
+//TODO: Test the API
+String url = "https://{Endpoint}/v1/{project_id}/vpcs";
+get(ak, sk, url);
 
-//TODO: When creating a VPC, replace {project_id} in postUrl with the actual value.
+//TODO: When creating a VPC, replace {project_id} in postUrl with the actual value.
 //String postUrl = "https://serviceEndpoint/v1/{project_id}/cloudservers";
-//String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}";
+//String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}";
 //post(ak, sk, postUrl, postbody);
 
-//TODO: When querying a VPC, replace {project_id} in url with the actual value.
+//TODO: When querying a VPC, replace {project_id} in url with the actual value.
 //String url = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
 //get(ak, sk, url);
 
-//TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values.
+//TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values.
 //String putUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
 //String putbody ="{\"vpc\":{\"name\": \"vpc1\",\"cidr\": \"192.168.0.0/16\"}}";
 //put(ak, sk, putUrl, putbody);
 
-//TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values.
+//TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values.
 //String deleteUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}";
 //delete(ak, sk, deleteUrl);
 }
              
-
            2. Compile the code and call the API.
              In the Package Explorer area on the left, right-click Demo.java, choose Run AS > Java Application from the shortcut menu to run the demo code.
              
-
              You can view the API call logs on the console.
              
+
            3. Compile the code and call the API.
              In the Package Explorer area on the left, right-click Demo.java, choose Run AS > Java Application from the shortcut menu to run the demo code.
              
+
              You can view the API call logs on the console.
              
 
            
 
          
 
    
+
    Token-based Authentication
     
    • The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
    • Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.
    
+
    
+
    A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
    
+
    When calling an API to obtain a user token, you must set auth.scope in the request body to project.
    
+
    { 
+    "auth": { 
+        "identity": { 
+            "methods": [ 
+                "password" 
+            ], 
+            "password": { 
+                "user": { 
+                    "name": "username", 
+                    "password": "********", 
+                    "domain": { 
+                        "name": "domainname" 
+                    } 
+                } 
+            } 
+        }, 
+        "scope": { 
+            "project": { 
+                "name": "xxxxxxxx" 
+            } 
+        } 
+    } 
+}
    
+
    After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
    
+
    +POST https://{apig_endpoint}/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
+Content-Type: application/json
+X-Auth-Token: ABCDEFJ....
    
+
    
 
    
 
    
 
    
-
    Parent topic: Calling APIs
    
+
    Parent topic: Calling APIs
    
 
    
 
    
 
-
-
\ No newline at end of file
diff --git a/docs/apig/api-ref/apig-api-190529269.html b/docs/apig/api-ref/apig-api-190529269.html
index 12c50b71..d2a6a605 100644
--- a/docs/apig/api-ref/apig-api-190529269.html
+++ b/docs/apig/api-ref/apig-api-190529269.html
@@ -1,31 +1,48 @@
 
 
 
    Response
    
-
    Status Code
    After sending a request, you will receive a response, including a status code, response header, and response body.
    
-
    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see HTTP Status Codes.
    
-
    For example, if status code 201 is returned for calling the API used to create an API group (dedicated gateways), the request is successful.
    
+
    After sending a request, you will receive a response, including a status code, response header, and response body.
    
+
    Status Code
    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see HTTP Status Codes.
    
+
    For example, if status code 201 is returned for calling the API used to create an API group, the request is successful.
    
 
    
-
    Response Header
    Similar to a request, a response also has a header, for example, Content-Type.
    
+
    Response Header
    Similar to a request, a response also has a header, for example, Content-Type.
    
+
    For example, when calling the API used to create an API group (dedicated gateways), the response headers are shown below.
    
+
    Figure 1 Response headers for creating an API group
    
 
    
-
    (Optional) Response Body
    The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
    
-
    The following is part of the response body for the API used to create an API group (dedicated gateways).
    
-
    {
-	"id": "abcdef...",
-	"name": "APIGroup_test",
-	"remark": "api group remark",
-......
+
    Response Body
    The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
    
+
    The following is part of the response body for the API used to create an API group.
    
+
    {
+ "id": "41e08fbaca9f4d64bde467d0dd89ff51",
+ "name": "aaa",
+ "status": 1,
+ "sl_domain": "41e08fbaca9f4d64bde467d0dd89ff51.example.cloudapis.com",
+ "register_time": "2024-05-23T08:03:56.419897855Z",
+ "update_time": "2024-05-23T08:03:56.419897962Z",
+ "on_sell_status": 2,
+ "url_domains": [],
+ "sl_domain_access_enabled": true,
+ "sl_domains": [
+  "41e08fbaca9f4d64bde467d0dd89ff51.example.cloudapis.com"
+ ],
+ "remark": "",
+ "call_limits": 0,
+ "time_interval": 0,
+ "time_unit": "",
+ "is_default": 2,
+ "version": "",
 }
    
-
    If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
    
-
    {
+
    
+
    If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
    
+
    {
     "error_msg": "The token is missing.",
     "error_code": "APIG.1000"
 }
    
-
    In the response body, error_code is an error code, and error_msg provides information about the error.
    
+
    In the response body, error_code is an error code, and error_msg provides information about the error.
    
 
    
 
    
 
    
 
    
-
    Parent topic: Calling APIs
    
+
    Parent topic: Calling APIs
    
 
    
 
    
 
diff --git a/docs/apig/api-ref/apig-api-190529271.html b/docs/apig/api-ref/apig-api-190529271.html
index 5680f232..a69033fe 100644
--- a/docs/apig/api-ref/apig-api-190529271.html
+++ b/docs/apig/api-ref/apig-api-190529271.html
@@ -1,22 +1,19 @@
 
 
-
-  
    Appendix
    
-
-  
    
+
    Appendix
    
+
    
 
    
-
Table 1 Supported actions

Permission

Action

+

API

API

+

Action

IAM Project

+

Dependencies

Enterprise Project

+

IAM Project

+

Enterprise Project

Creating a dedicated gateway

+

Creating a dedicated gateway

apig:instances:create

+

POST /v2/{project_id}/apigw/instances

POST /v2/{project_id}/apigw/instances

+

apig:instances:create

√

+

-

√

+

√

+

√

Deleting a dedicated gateway

+

Deleting a dedicated gateway

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}

apig:instances:delete

+

apig:instances:delete

DELETE /v2/{project_id}/apigw/instances/{instance_id}

+

-

√

+

√

√

+

√

Updating a dedicated gateway

+

Updating a dedicated gateway

+

PUT

+

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

apig:instances:update

+

apig:instances:update

PUT

-

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

+

-

√

+

√

√

+

√

Querying details of a dedicated gateway

+

Querying details of a dedicated gateway

apig:instances:get

+

GET

+

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

GET

-

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

+

apig:instances:get

√

+

-

√

+

√

+

√

Querying a dedicated gateway list

+

Querying dedicated gateways

+

GET /v2/{project_id}/apigw/instances

apig:instances:list

+

apig:instances:list

GET /v2/{project_id}/apigw/instances

+

-

√

+

√

√

+

√

Creating an API group

+

Querying gateways by tag

+

POST

+

/V2/{project_id}/apigw/resource-instances/filter

apig:groups:create

+

apig:instance:listByTags

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups

+

-

√

+

√

√

+

x

Deleting an API group

+

Querying the number of gateways by tag

apig:groups:delete

+

POST

+

/V2/{project_id}/apigw/resource-instances/count

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}

+

apig:instance:getNumByTags

√

+

-

√

+

√

+

x

Querying details of an API group

+

Querying tags of a gateway

+

GET /v2/{project_id}/apigw/instance-tags

apig:groups:get

+

apig:instanceTags:list

GET

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}

+

-

√

+

√

√

+

x

Querying an API group list

+

Deleting tags of a gateway

+

POST /v2/{project_id}/apigw/instances/{instance_id}/instance-tags/action

apig:groups:list

+

apig:instanceTags:delete

GET

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups

+

apig:instances:get

√

+

√

√

+

√

Binding a domain name to an API group

+

Creating a gateway tag

apig:domains:create

+

POST

+

/V2/{project_id}/apigw/instances/{instance_id}/instance-tags/action

POST

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains

+

apig:instanceTags:create

√

+

apig:instances:get

√

+

√

+

√

Deleting a domain name bound to an API group

+

Creating an API group

+

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups

apig:domains:delete

+

apig:groups:create

DELETE

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

+

apig:instances:get

√

+

√

√

+

√

Adding a certificate to a domain name

+

Deleting an API group

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}

apig:domains:bindCertificate

+

apig:groups:delete

POST

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate

+

apig:instances:get

√

+

√

√

+

√

Deleting a certificate bound to a domain name

+

Querying details of an API group

apig:domains:unbindCertificate

+

GET

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}

DELETE

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}

+

apig:groups:get

√

+

apig:instances:get

√

+

√

+

√

Querying details of a certificate bound to a domain name

+

Querying API groups

+

GET

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups

apig:domains:getCertificate

+

apig:groups:list

GET

-

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}

+

apig:instances:get

√

+

√

√

+

√

Creating an environment variable

+

Updating an API group

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}

apig:variables:create

+

apig:groups:update

POST

-

/v2/{project_id}/apigw/instances/{instance_id}/env-variables

+

apig:instances:get

√

+

√

√

+

√

Deleting an environment variable

+

Binding a domain name to an API group

apig:variables:delete

+

POST

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains

DELETE

-

/v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}

+

apig:domains:create

√

+

apig:instances:get

+

apig:groups:get

√

+

√

+

√

Querying details of an environment variable

+

Unbinding a domain name from an API group

+

DELETE

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

apig:variables:get

+

apig:domains:delete

GET

-

/v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Querying an environment variable list

+

Adding a certificate to a domain name

+

POST

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate

apig:variables:list

+

apig:domains:bindCertificate

GET

-

/v2/{project_id}/apigw/instances/{instance_id}/env-variables

+

apig:instances:get

+

apig:groups:get

+

apig:domains:get

√

+

√

√

+

√

Creating an API

+

Deleting a certificate of a domain name

apig:apis:create

+

DELETE

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}

POST

-

/v2/{project_id}/apigw/instances/{instance_id}/apis

+

apig:domains:unbindCertificate

√

+

apig:instances:get

+

apig:groups:get

+

apig:domains:get

√

+

√

+

√

Deleting an API

+

Querying details of a certificate bound to a domain name

+

GET

+

/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}

apig:apis:delete

+

apig:domains:getCertificate

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

+

apig:instances:get

+

apig:groups:get

+

apig:domains:get

√

+

√

√

+

√

Publishing an API

+

Setting accessibility of a debugging domain name

+

PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/sl-domain-access-settings

apig:apis:publish

+

apig:domains:updateSLDomainSetting

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

+

apig:instances:get

+

apig:groups:get

+

√

+

√

√

+

√

Taking an API offline

+

Creating an environment variable

apig:apis:offline

+

POST

+

/v2/{project_id}/apigw/instances/{instance_id}/env-variables

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

+

apig:variables:create

√

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

+

√

Debugging an API

+

Deleting an environment variable

+

DELETE

+

/v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}

apig:apis:debug

+

apig:variables:delete

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id}

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

√

+

√

Importing an API

+

Querying details of an environment variable

+

GET

+

/v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id}

apig:apis:import

+

apig:variables:get

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/import

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

√

+

√

Exporting an API

+

Querying environment variables

apig:apis:export

+

GET

+

/v2/{project_id}/apigw/instances/{instance_id}/env-variables

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export

+

apig:variables:list

√

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

+

√

Authorizing an app to access an API

+

Creating an API

+

POST

+

/v2/{project_id}/apigw/instances/{instance_id}/apis

apig:apis:grantAppAccess

+

apig:apis:create

POST /v2/{project_id}/apigw/instances/{instance_id}/app-auths

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Canceling the authorization of an app for accessing an API

+

Deleting an API

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

apig:apis:relieveAppAccess

+

apig:apis:delete

DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_id}

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Binding a signature key to an API

+

Publishing an API

apig:apis:bindSigns

+

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

POST /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings

+

apig:apis:publish

√

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

+

√

Unbinding a signature key from an API

+

Taking an API offline

+

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action

apig:apis:unbindSigns

+

apig:apis:offline

DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id}

+

apig:instances:get

+

apig:groups:get

+

apig:envs:list

√

+

√

√

+

√

Binding an access control policy to an API

+

Debugging an API

+

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id}

apig:apis:bindAcls

+

apig:apis:debug

POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Unbinding an access control policy from an API

+

Importing an API

apig:apis:unbindAcls

+

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/import

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}

+

apig:apis:import

√

+

apig:instances:get

+

apig:apis:create

+

apig:apis:bindAcls

+

apig:apis:bindThrottles

+

apig:groups:get

+

apig:acls:create

+

apig:throttles:create

√

+

√

+

√

Binding a request throttling policy to an API

+

Exporting an API

+

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export

apig:apis:bindThrottles

+

apig:apis:export

POST /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings

+

apig:instances:get

+

apig:apis:list

+

apig:apis:get

+

apig:apis:listBindedTrottles

+

apig:apis:listBindedAcls

+

apig:groups:get

+

apig:acls:get

+

apig:throttles:get

√

+

√

√

+

√

Unbinding a request throttling policy from an API

+

Updating an API

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

apig:apis:unbindThrottles

+

apig:apis:update

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_id}

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Querying details of an API

+

Authorizing access to an API

apig:apis:get

+

POST /v2/{project_id}/apigw/instances/{instance_id}/app-auths

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

+

apig:apis:grantAppAccess

√

+

apig:instances:get

+

apig:apps:get

+

apig:apis:get

√

+

√

+

√

Querying an API list

+

Canceling access authorization for an API

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_id}

apig:apis:list

+

apig:apis:relieveAppAccess

GET /v2/{project_id}/apigw/instances/{instance_id}/apis

+

apig:instances:get

+

apig:apps:get

+

apig:apis:get

√

+

√

√

+

√

Querying the list of apps bound to an API

+

Binding a signature key to an API

+

POST /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings

apig:apis:listBindedApps

+

apig:apis:bindSigns

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps

+

apig:instances:get

+

apig:apis:get

+

apig:signs:list

√

+

√

√

+

√

Querying the list of signature keys bound to an API

+

Unbinding a signature key from an API

apig:apis:listBindedSigns

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id}

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-signs

+

apig:apis:unbindSigns

√

+

apig:instances:get

+

apig:apis:get

+

apig:signs:list

√

+

√

+

√

Querying the list of access control policies bound to an API

+

Binding an access control policy to an API

+

POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

apig:apis:listBindedAcls

+

apig:apis:bindAcls

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-acls

+

apig:instances:get

+

apig:apis:get

+

apig:acls:get

√

+

√

√

+

√

Querying the list of request throttling policies bound to an API

+

Unbinding an access control policy from an API

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}

apig:apis:listBindedTrottles

+

apig:apis:unbindAcls

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-throttles

+

apig:instances:get

+

apig:apis:get

+

apig:acls:get

√

+

√

√

+

√

Creating an environment

+

Binding a request throttling policy to an API

apig:envs:create

+

POST /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings

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

+

apig:apis:bindThrottles

√

+

apig:instances:get

+

apig:apis:get

+

apig:throttles:get

√

+

√

+

√

Deleting an environment

+

Unbinding a request throttling policy from an API

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_id}

apig:envs:delete

+

apig:apis:unbindThrottles

DELETE /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id}

+

apig:instances:get

+

apig:apis:get

+

apig:throttles:get

√

+

√

√

+

√

Querying an environment list

+

Querying details of an API

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

apig:envs:list

+

apig:apis:get

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

+

apig:instances:get

+

apig:groups:get

√

+

√

√

+

√

Creating an app

+

Querying APIs

apig:apps:create

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apis

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

+

apig:apis:list

√

+

apig:instances:get

+

apig:groups:get

√

+

√

+

√

Deleting an app

+

Querying apps bound to an API

+

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps

apig:apps:delete

+

apig:apis:listBindedApps

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

+

apig:instances:get

+

apig:apis:get

√

+

√

√

+

√

Querying details of an app

+

Querying signature keys bound to an API

+

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-signs

apig:apps:get

+

apig:apis:listBindedSigns

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

+

apig:instances:get

+

apig:apis:get

√

+

√

√

+

√

Querying an app list

+

Querying access control policies bound to an API

apig:apps:list

+

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-acls

GET /v2/{project_id}/apigw/instances/{instance_id}/apps

+

apig:apis:listBindedAcls

√

+

apig:instances:get

+

apig:apis:get

√

+

√

+

√

Querying the list of APIs bound to an app

+

Querying request throttling policies bound to an API

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-throttles

apig:apps:listBindedApis

+

apig:apis:listBindedThrottles

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis

+

apig:instances:get

+

apig:apis:get

√

+

√

√

+

√

Querying the list of APIs not bound to an app

+

Querying plug-ins bound with an API

apig:apps:listUnbindedApis

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attached-plugins

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis

+

apig:apis:listBindedPlugins

√

+

apig:instances:get

+

apig:apis:get

√

+

√

+

√

Creating a signature key

+

Binding a plug-in to an API

+

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/plugins/attach

apig:signs:create

+

apig:apis:bindPlugins

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

+

apig:instances:get

+

apig:plugins:get

+

apig:apis:get

√

+

√

√

+

√

Deleting a signature key

+

Unbinding an API's plug-ins

+

PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/detach

apig:signs:delete

+

apig:apis:unbindPlugins

DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}

+

apig:instances:get

+

apig:plugins:get

+

apig:apis:get

√

+

√

√

+

√

Querying a signature key list

+

Creating an environment

apig:signs:list

+

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

GET /v2/{project_id}/apigw/instances/{instance_id}/signs

+

apig:envs:create

√

+

apig:instances:get

√

+

√

+

√

Querying the list of APIs bound to a signature key

+

Deleting an environment

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id}

apig:signs:listBindedApis

+

apig:envs:delete

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apis

+

apig:instances:get

√

+

√

√

+

√

Querying the list of APIs not bound to a signature key

+

Querying environments

+

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

apig:signs:listUnbindedApis

+

apig:envs:list

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis

+

apig:instances:get

√

+

√

√

+

√

Creating an access control policy

+

Updating an environment

apig:acls:create

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/envs/{env_id}

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

+

apig:envs:update

√

+

apig:instances:get

√

+

√

+

√

Deleting an access control policy

+

Creating an app

+

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

apig:acls:delete

+

apig:apps:create

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}

+

apig:instances:get

√

+

√

√

+

√

Querying details of an access control policy

+

Deleting an app

+

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

apig:acls:get

+

apig:apps:delete

GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}

+

apig:instances:get

√

+

√

√

+

√

Querying an access control policy list

+

Querying details of an app

apig:acls:list

+

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

GET /v2/{project_id}/apigw/instances/{instance_id}/acls

+

apig:apps:get

√

+

apig:instances:get

√

+

√

+

√

Querying the list of APIs bound to an access control policy

+

Querying apps

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apps

apig:acls:listBindedApis

+

apig:apps:list

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apis

+

apig:instances:get

√

+

√

√

+

√

Querying the list of APIs not bound to an access control policy

+

Querying APIs bound with an app

+

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis

apig:acls:listUnbindedApis

+

apig:apps:listBindedApis

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded-apis

+

apig:instances:get

+

apig:apps:get

√

+

√

√

+

√

Creating a request throttling policy

+

Querying APIs not bound with an app

apig:throttles:create

+

GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis

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

+

apig:apps:listUnbindedApis

√

+

apig:instances:get

+

apig:apps:get

√

+

√

+

√

Deleting a request throttling policy

+

Updating an application

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}

apig:throttles:delete

+

apig:apps:update

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

+

apig:instances:get

√

+

√

√

+

√

Querying details of a request throttling policy

+

Creating a signature key

+

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

apig:throttles:get

+

apig:signs:create

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

+

apig:instances:get

√

+

√

√

+

√

Querying a request control policy list

+

Deleting a signature key

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}

+

apig:signs:delete

+

apig:instances:get

+

√

+

√

+

Querying signature keys

+

GET /v2/{project_id}/apigw/instances/{instance_id}/signs

apig:throttles:list

+

apig:signs:list

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles

+

apig:instances:get

√

+

√

√

+

√

Querying the list of APIs bound to a request control policy

+

Querying APIs bound with a signature key

apig:throttles:listBindedApis

+

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apis

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis

+

apig:signs:listBindedApis

√

+

apig:instances:get

+

apig:signs:list

√

+

√

+

√

Querying the list of APIs not bound to a request control policy

+

Querying APIs not bound with a signature key

+

GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis

apig:throttles:listUnbindedApis

+

apig:signs:listUnbindedApis

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis

+

apig:instances:get

+

apig:signs:list

√

+

√

√

+

√

Creating an excluded request throttling configuration

+

Updating a signature key

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}

apig:specialThrottles:create

+

apig:signs:update

POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

+

apig:instances:get

√

+

√

√

+

√

Deleting an excluded request throttling configuration

+

Creating an access control policy

apig:specialThrottles:delete

+

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

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}

+

apig:acls:create

√

+

apig:instances:get

√

+

√

+

√

Querying excluded request throttling configurations

+

Deleting an access control policy

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}

apig:specialThrottles:get

+

apig:acls:delete

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

+

apig:instances:get

√

+

√

√

+

√

Creating a VPC channel

+

Querying details of an access control policy

+

GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}

apig:vpcChannels:create

+

apig:acls:get

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

+

apig:instances:get

√

+

√

√

+

√

Deleting a VPC channel

+

Querying access control policies

apig:vpcChannels:delete

+

GET /v2/{project_id}/apigw/instances/{instance_id}/acls

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:acls:list

√

+

apig:instances:get

√

+

√

+

√

Updating a VPC channel

+

Querying APIs bound with an access control policy

+

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apis

apig:vpcChannels:update

+

apig:acl:listBoundApi

PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:instances:get

+

apig:acls:get

√

+

√

√

+

√

Creating a backend instance

+

Querying APIs not bound with an access control policy

+

GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded-apis

apig:vpcChannels:addInstance

+

apig:acls:listUnbindedApis

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

+

apig:instances:get

+

apig:acls:get

√

+

√

√

+

√

Deleting a backend instance

+

Updating an access control policy

apig:vpcChannels:deleteInstance

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/{member_id}

+

apig:acls:update

√

+

apig:instances:get

√

+

√

+

√

Querying details of a VPC channel

+

Creating a request throttling policy

+

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

apig:vpcs:get

+

apig:throttles:create

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:instances:get

√

+

√

√

+

√

Querying a VPC channel list

+

Deleting a request throttling policy

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

apig:vpcs:list

+

apig:throttles:delete

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

+

apig:instances:get

√

+

√

√

+

√

Creating a custom authorizer

+

Querying details of a request throttling policy

apig:authorizers:create

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

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

+

apig:specialThrottles:get

√

+

apig:instances:get

√

+

√

+

√

Deleting a custom authorizer

+

Querying request control policies

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles

apig:authorizers:delete

+

apig:throttles:list

DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

+

apig:instances:get

√

+

√

√

+

√

Querying details of a custom authorizer

+

Querying APIs bound with a request throttling policy

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis

apig:authorizers:get

+

apig:throttles:listBindedApis

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

+

apig:instances:get

+

apig:throttles:get

√

+

√

√

+

√

Query a custom authorizer list

+

Querying APIs not bound with a request throttling policy

apig:authorizers:list

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers

+

apig:throttles:listUnbindedApis

√

+

apig:instances:get

+

apig:throttles:get

√

+

√

+

√

Querying a tag list

+

Updating a request throttling policy

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

apig:tags:list

+

apig:throttles:update

GET /v2/{project_id}/apigw/instances/{instance_id}/tags

+

apig:instances:get

√

+

√

√

+

√

Querying an instance feature list

+

Creating an excluded request throttling configuration

+

POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

apig:features:list

+

apig:specialThrottles:create

GET /v2/{project_id}/apigw/instances/{instance_id}/features

+

apig:instances:get

+

apig:throttles:get

√

+

√

√

+

√

Creating an instance feature

+

Deleting an excluded request throttling configuration

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}

+

apig:specialThrottles:delete

+

apig:instances:get

+

apig:throttles:get

+

√

+

√

+

Querying excluded request throttling configurations

+

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

+

apig:specialThrottles:get

+

apig:instances:get

+

apig:throttles:get

+

√

+

√

+

Updating an excluded request throttling configuration

+

PUT

+

/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}

+

apig:specialThrottles:update

+

apig:instances:get

+

apig:throttles:get

+

√

+

√

+

Creating a load balance channel

+

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

+

apig:vpcChannels:create

+

apig:instances:get

+

√

+

√

+

Deleting a load balance channel

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:vpcChannels:delete

+

apig:instances:get

+

√

+

√

+

Updating a load balance channel

+

PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:vpcChannels:update

+

apig:instances:get

+

√

+

√

+

Adding a backend instance to a load balance channel

+

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members

+

apig:vpcChannels:addInstance

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Deleting a backend instance

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/{member_id}

+

apig:vpcChannels:deleteInstance

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Querying load balance channel details

+

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}

+

apig:vpcChannels:get

+

apig:instances:get

+

√

+

√

+

Querying load balance channels

+

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

+

apig:vpcChannels:list

+

apig:instances:get

+

√

+

√

+

Updating a backend server group of a VPC channel

+

PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups/{member_group_id}

+

apig:vpcChannels:updateMemberGroup

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Adding or updating a backend server group of a VPC channel

+

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups

+

apig:vpcChannels:addOrUpdateMemberGroups

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Disabling backend servers

+

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/batch-disable

+

apig:vpcChannels:batchEnableInstance

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Deleting a backend server group of a VPC channel

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups/{member_group_id}

+

apig:vpcChannels:deleteMemberGroup

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Enabling backend servers

+

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/batch-enable

+

apig:vpcChannels:batchDisableInstance

+

apig:instances:get

+

apig:vpcChannels:get

+

√

+

√

+

Creating a custom authorizer

+

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

+

apig:authorizers:create

+

functiongraph:function:getConfig

+

apig:instances:get

+

√

+

√

+

Deleting a custom authorizer

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

+

apig:authorizers:delete

+

apig:instances:get

+

√

+

√

+

Querying details of a custom authorizer

+

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

+

apig:authorizers:get

+

apig:instances:get

+

√

+

√

+

Querying custom authorizers

+

GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers

+

apig:authorizers:list

+

apig:instances:get

+

√

+

√

+

Updating a custom authorizer

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

+

apig:authorizers:update

+

apig:instances:get

+

√

+

√

+

Querying tags

+

GET /v2/{project_id}/apigw/instances/{instance_id}/tags

+

apig:tags:list

+

apig:instances:get

+

√

+

√

+

Querying gateway features

+

GET /v2/{project_id}/apigw/instances/{instance_id}/features

+

apig:features:list

+

apig:instances:get

+

√

+

√

+

Creating a gateway feature

+

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

+

apig:features:create

+

apig:instances:get

+

√

+

√

+

Viewing monitoring data

+

GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data

+

apig:metricData:get

+

apig:instances:get

+

√

+

√

+

Creating a gateway response

+

POST

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

+

apig:gatewayResponses:create

+

apig:instances:get

+

apig:groups:get

+

√

+

√

+

Querying details of a gateway response

+

GET

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}

+

apig:gatewayResponses:get

+

apig:instances:get

+

apig:groups:get

+

√

+

√

+

Updating a gateway response

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}

+

apig:gatewayResponses:update

+

apig:instances:get

+

apig:groups:get

+

√

+

√

+

Deleting a gateway response

+

DELETE

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}

+

apig:gatewayResponses:delete

+

apig:instances:get

+

apig:groups:get

+

√

+

√

+

Querying a gateway response list

+

GET

+

/V2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

+

apig:gatewayResponses:list

+

apig:instances:get

+

apig:groups:get

+

√

+

√

+

Creating an AppCode

+

POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

+

apig:appCodes:create

+

apig:instances:get

+

apig:apps:get

+

√

+

√

+

Querying AppCodes of an app

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

+

apig:appCodes:list

+

apig:instances:get

+

apig:apps:get

+

√

+

√

+

Querying AppCode details

+

GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_id}

+

apig:appCodes:get

+

apig:instances:get

+

apig:apps:get

+

√

+

√

+

Updating AppCodes of an app

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

+

apig:appCodes:update

+

apig:instances:get

+

apig:apps:get

+

√

+

√

+

Deleting an AppCode

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_id}

+

apig:appCodes:delete

+

apig:instances:get

+

apig:apps:get

+

√

+

√

+

Creating a plug-in

+

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

+

apig:plugins:create

+

apig:instances:get

+

√

+

√

+

Updating a plugin

+

PUT

+

/V2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}

+

apig:plugins:update

+

apig:instances:get

+

√

+

√

+

Querying the plug-ins

+

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins

+

apig:plugins:list

+

apig:instances:get

+

√

+

√

+

Querying APIs bound with a plug-in

+

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attached-apis

+

apig:plugins:listBindedApis

+

apig:instances:get

+

apig:plugins:get

+

√

+

√

+

Querying plug-ins

+

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}

+

apig:plugins:get

+

apig:instances:get

+

√

+

√

+

Querying APIs not bound with a plug-in

+

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attachable-apis

+

+

apig:plugins:listUnbindedApis

+

apig:instances:get

+

apig:plugins:get

+

√

+

√

+

Deleting a plug-in

+

DELETE /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}

apig:features:create

+

apig:plugins:delete

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

+

apig:instances:get

√

+

√

√

+

√
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Feature Name

-

Feature Description

-

Configurable

-

Feature Configuration Example

-

Configuration Parameter

-

Parameter Description

-

Default Value

-

Value Range

-

lts

-

Reporting of Shubao access logs

-

Yes

-

{"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"}

-

group_id

-

Log group ID.

-

-

-

-

-

topic_id

-

Log stream ID.

-

log_group

-

Name of a log group.

-

log_stream

-

Name of a log stream.

-

gateway_responses

-

Custom gateway responses

-

No

-

-

-

-

-

-

-

-

-

-

-

ratelimit

-

Request throttling limit configuration

-

Yes

-

{"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"}

-

api_limits

-

Default request throttling value applied to all APIs. Set this parameter properly to meet service requirements. A small value may constantly throttle your services.

-

200 calls per second

-

1–1,000,000 calls per second

-

request_body_size

-

Configuration of the maximum request body size

-

Yes

-

{"name":"request_body_size","enable":true,"config": "104857600"}

-

request_body_size

-

Maximum size of the body allowed in an API request.

-

12 MB

-

1–9536 MB

-

backend_timeout

-

Maximum backend timeout configuration

-

Yes

-

{"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"}

-

max_timeout

-

Maximum timeout for APIG to request a backend service.

-

60,000 ms

-

1-600,000 ms

-

app_token

-

app_token authentication

-

Yes

-

{"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"}

-

enable

-

Whether to enable this feature.

-

Off

-

On/Off

-

app_token_expire_time

-

Validity period of the access token.

-

3600s

-

1–72,000s

-

refresh_token_expire_time

-

Validity period of the refresh token.

-

7200s

-

1–72,000s

-

app_token_uri

-

URI used for obtaining the token.

-

/v1/apigw/oauth2/token

-

-

-

app_token_key

-

Token encryption key.

-

-

-

-

-

app_api_key

-

app_api_key authentication

-

Yes

-

{"name":"app_api_key","enable":true,"config": "on"}

-

-

-

-

-

Off

-

On/Off

-

app_basic

-

app_basic authentication

-

Yes

-

{"name":"app_basic","enable":true,"config": "on"}

-

-

-

-

-

Off

-

On/Off

-

app_secret

-

app_secret authentication

-

Yes

-

{"name":"app_secret","enable":true,"config": "on"}

-

-

-

-

-

Off

-

On/Off

-

app_jwt

-

app_jwt authentication

-

Yes

-

{"name":"app_jwt","enable":true,"config": "{\"enable\": \"on\", \"auth_header\": \"Authorization\"}"}

-

enable

-

Whether to enable app_jwt authentication.

-

Off

-

On/Off

-

auth_header

-

app_jwt authentication header.

-

Authorization

-

-

-

public_key

-

Public_key backend signatures

-

Yes

-

{"name":"public_key","enable":true,"config": "{\"enable\": \"on\", \"public_key_uri_prefix\": \"/apigw/authadv/v2/public-key/\"}"}

-

enable

-

Whether to enable public_key authentication.

-

Off

-

On/Off

-

public_key_uri_prefix

-

URI prefix used for obtaining the public key.

-

/apigw/authadv/v2/public-key/

-

-

-

backend_token_allow

-

Allowing tenants to transparently transmit tokens to the backend

-

Yes

-

{"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"user_name\"]}"}

-

backend_token_allow_users

-

Regular expression for transparently transmitting the token to the common tenant whitelist of the tenant to match the domain name of the common tenant.

-

-

-

-

-

sign_basic

-

Basic signature keys

-

No

-

-

-

-

-

-

-

-

-

-

-

multi_auth

-

Two-factor authentication

-

No

-

-

-

-

-

-

-

-

-

-

-

backend_client_certificate

-

Backend two-way authentication

-

Yes

-

{"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"}

-

enable

-

Whether to enable this feature.

-

Off

-

On/Off

-

ca

-

CA file of two-way authentication.

-

-

-

-

-

content

-

Two-way authentication file.

-

-

-

-

-

key

-

Private key of two-way authentication.

-

-

-

-

-

ssl_ciphers

-

HTTPS cipher suites

-

Yes

-

{"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"}

-

ssl_ciphers

-

Encryption and decryption suites supported. The ssl_ciphers parameter cannot be left blank and can contain only the options in the default value.

-

-

-

ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256

-

route

-

Custom routes

-

No

-

-

-

-

-

-

-

-

-

-

-

cors

-

Plug-ins

-

No

-

-

-

-

-

-

-

-

-

-

-

real_ip_from_xff

-

X-Forwarded-For header for identifying IP addresses during access control and request throttling

-

Yes

-

{"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}}

-

enable

-

Whether to enable this feature.

-

Off

-

On/Off

-

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.

-

-1

-

Valid Int32 value

-

app_route

-

IP address access

-

Yes

-

{"name":"app_route","enable":true,"config": "on"}

-

-

-

-

-

Off

-

On/Off

-

vpc_name_modifiable

-

Load balance channel name modification

-

Yes

-

{"name":"vpc_name_modifiable","enable":true,"config": "on"}

-

-

-

-

-

on

-

On/Off

-

default_group_host_trustlist

-

-

Access to the DEFAULT group from IP addresses that are not inbound access addresses of the current gateway

-

-

Yes

-

{"name":"default_group_host_trustlist","enable": true,"config": "{\"enable\":\"on\",\"hosts\":[\"123.2.2.2\",\"202.2.2.2\"]}"}

-

-

enable

-

Whether to enable this feature.

-

-

-

-

On/Off

-

-

hosts

-

IP addresses that are not inbound access addresses of the current gateway.

-

-

-

-

-

throttle_strategy

-

-

Whether to enable request throttling.

-

-

Yes

-

{"name":"throttle_strategy","enable":true,"config": "{\"enable\": \"on\",\"strategy\": \"local\"}"}

-

-

enable

-

Whether to enable this feature.

-

Off

-

-

On/Off

-

strategy

-

Request throttling mode.

-

-

-

cluster/local

-

custom_log

-

-

-

Printing custom request headers, query strings, and cookies in logs

-

-

-

Yes

-

{"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"a1234\"}]}"}

-

-

-

custom_logs

-

Custom logs.

-

-

-

-

-

Max. 10 items.

-

location

-

Location.

-

header/query/cookie

-

name

-

Name.

-

-

-

real_ip_header_getter

-

-

Using a custom header to obtain source IP addresses

-

-

Yes

-

{"name":"real_ip_header_getter","enable":true,"config": "{\"enable\": \"on\",\"header_getter\": \"header:testIP\"}"}

-

enable

-

Whether to enable this feature.

-

Off

-

-

On/Off

-

-

header_getter

-

Custom header for obtaining source IP addresses.

-

-

-

-

-

policy_cookie_param

-

Using cookies in backend policy conditions

-

Yes

-

{"name":"policy_cookie_param","enable":true,"config": "on"}

-

-

-

-

-

Off

-

On/Off

-

app_quota

-

Client quotas

-

No

-

-

-

-

-

-

-

-

-

-

-

app_acl

-

Request throttling policies

-

No

-

-

-

-

-

-

-

-

-

-

-

set_resp_headers

-

Response header management plug-ins

-

No

-

-

-

-

-

-

-

-

-

-

-

vpc_backup

-

Primary/Standby VPC channels

-

No

-

-

-

-

-

-

-

-

-

-

-

sign_aes

-

AES signature keys

-

No

-

-

-

-

-

-

-

-

-

-

-

kafka_log

-

Adding, deleting, modifying, and querying Kafka log push plug-ins

-

No

-

-

-

-

-

-

-

-

-

-

-

backend_retry_count

-

Backend retry configuration

-

No

-

-

-

-

-

-

-

-

-

-

-

policy_sys_param

-

Using system parameters in backend policy conditions

-

No

-

-

-

-

-

-

-

-

-

-

-

breaker

-

Circuit breakers

-

No

-

-

-

-

-

-

-

-

-

-

-

content_type_configurable

-

Returning request parameter type (Content-Type) when querying APIs

-

No

-

-

-

-

-

-

-

-

-

-

-

rate_limit_plugin

-

Request throttling plug-ins

-

No

-

-

-

-

-

-

-

-

-

-

-

breakerv2

-

Circuit breakers for degrading services in case of overload

-

No

-

-

-

-

-

-

-

-

-

-

-

sm_cipher_type

-

Encrypting local sensitive data with commercial cryptographic algorithms

-

No

-

-

-

-

-

-

-

-

-

-

-

rate_limit_algorithm

-

Request throttling algorithm switchover

-

No

-

-

-

-

-

-

-

-

-

-

-
-
- -
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/apig/api-ref/apig-en-api-180713001.html b/docs/apig/api-ref/apig-en-api-180713001.html deleted file mode 100644 index 7c07f985..00000000 --- a/docs/apig/api-ref/apig-en-api-180713001.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Before You Start

-
- - diff --git a/docs/apig/api-ref/apig-en-api-180713003.html b/docs/apig/api-ref/apig-en-api-180713003.html deleted file mode 100644 index e023c487..00000000 --- a/docs/apig/api-ref/apig-en-api-180713003.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Calling APIs

-
- - diff --git a/docs/apig/api-ref/apig-en-api-180713011.html b/docs/apig/api-ref/apig-en-api-180713011.html deleted file mode 100644 index 96fd4cf1..00000000 --- a/docs/apig/api-ref/apig-en-api-180713011.html +++ /dev/null @@ -1,76 +0,0 @@ - - -

Making an API Request

-

This section describes the structure of a REST API request, and uses the APIG API for creating an API group (dedicated gateways) as an example to demonstrate how to call an API.

-

Request URI

A request URI is in the following format:

-

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

-

Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.

- -
- - - - - - - - - - - - - - - - -
Table 1 URI parameters

Parameter

-

Description

-

URI-scheme

-

Protocol used to transmit requests. All APIs use HTTPS.

-

Endpoint

-

Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Endpoints.

-

resource-path

-

Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to create an API group in a dedicated gateway is /v2/{project_id}/apigw/instances/{instance_id}/api-groups. {project_id} indicates a project ID and {instance_id} indicates a gateway ID. The two IDs can be obtained from the gateway information on the APIG console.

-

query-string

-

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ?limit=10 indicates that a maximum of 10 data records will be displayed. Separate multiple query parameters with ampersands (&).

-
-
-

For example, to create an API group in a region, combine the parameters in the URI. apig_endpoint indicates the endpoint of APIG.

-
https://{apig_endpoint}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
-

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

-
-
-

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server:

-
  • GET: requests the server to return specified resources.
  • PUT: requests the server to update specified resources.
  • POST: requests the server to add resources or perform special operations.
  • DELETE: requests the server to delete specified resources, for example, an object.
  • HEAD: same as GET except that the server must return only the response header.
  • PATCH: requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created.
-

For example, in the case of the API used to create an API group (dedicated gateways), the request method is POST. The request is as follows:

-
POST https://{apig_endpoint}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
-
-

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

-

Common request header fields are as follows:

-
  • Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field will be provided for specific APIs if any.
  • X-Auth-Token: specifies a user token only for token-based API authentication. The user token is a response to the API used to obtain a user token.

    In addition to supporting token-based authentication, APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the Authorization (signature information) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.

    -

    For more information, see AK/SK-based Authentication.

    -
    -

    The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

    -
    POST https://{iam_endpoint}/v3/auth/tokens
-Content-Type: application/json
    -
-
-

Request Body

The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.

-

The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

-

In the case of the API used to create an API group (dedicated gateways), the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace name (API group name) and remark (API group description) with the actual values.

-
POST https://{apig_endpoint}/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
-Content-Type: application/json
-X-Auth-Token: xxxx
-{
-	"name": "APIGroup_test",
-	"remark": "api group remark"
-}
-

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding.

-
-
-
-
-
Parent topic: Calling APIs
-
-
- diff --git a/docs/apig/api-ref/apig-en-api-180713204.html b/docs/apig/api-ref/apig-en-api-180713204.html deleted file mode 100644 index ed202488..00000000 --- a/docs/apig/api-ref/apig-en-api-180713204.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Pagination Query

-

APIG supports pagination query of resource lists, such as an API list.

-

To perform a pagination query, add the following parameters to the URL:

-
  • page_size: number of records to be displayed on each page. If this parameter is not specified, the default value 20 is used. The maximum value is 500.
  • page_no: page number for displaying query results.
-

Example:

-
GET /v1.0/apigw/apis?page_size=10&page_no=5
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/apig/api-ref/apig-en-api-180713205.html b/docs/apig/api-ref/apig-en-api-180713205.html deleted file mode 100644 index 0797027d..00000000 --- a/docs/apig/api-ref/apig-en-api-180713205.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

Result Filtering

-

APIG filters query results by object attribute when you query a resource list, such as an API list.

-

Example:

-
GET /v1.0/apigw/apis?id=xxxx
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/apig/api-ref/apig-en-api-180713206.html b/docs/apig/api-ref/apig-en-api-180713206.html deleted file mode 100644 index 0bf2fc9e..00000000 --- a/docs/apig/api-ref/apig-en-api-180713206.html +++ /dev/null @@ -1,112 +0,0 @@ - - -

HTTP Status Codes

-

Table 1 describes common status codes.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 HTTP status codes

Status Code & Message

-

Description

-

200 OK

-

The request has been processed successfully.

-

204 No Content

-

The server successfully processed the request and is not returning any content.

-

400 Bad Request

-

The server failed to process the request. Possible causes include:

-
  1. Malformed request syntax
  2. Invalid request message framing
-

401 Unauthorized

-

The request requires user authentication. For example, the username and password are required.

-

403 Forbidden

-

The server understood the request, but is refusing to fulfill it.

-

404 Not Found

-

The server has not found anything matching the request URI.

-

405 Method Not Allowed

-

The method specified in the request line is not allowed for the resource identified by the request URI.

-

406 Not Acceptable

-

The response generated by the server could not be accepted by the client.

-

407 Proxy Authentication Required

-

You must first authenticate yourself with the proxy.

-

408 Request Timeout

-

The server timed out waiting for the request.

-

409 Conflict

-

The request could not be completed due to a conflict with the current state of the resource.

-

410 Gone

-

The requested resource is no longer available at the server and no forwarding address is known.

-

412 Precondition Failed

-

The server does not meet one of the preconditions that the requester put on the request.

-

500 Internal Server Error

-

The server encountered an unexpected condition which prevented it from fulfilling the request.

-

501 Not Implemented

-

The server does not support the functionality required to fulfill the request.

-

502 Bad Gateway

-

The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

-

503 Service Unavailable

-

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

-

504 Gateway Timeout

-

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

-
-
-
-
-
-
Parent topic: Appendix
-
-
- diff --git a/docs/apig/api-ref/apig-en-api-180713215.html b/docs/apig/api-ref/apig-en-api-180713215.html deleted file mode 100644 index 07015592..00000000 --- a/docs/apig/api-ref/apig-en-api-180713215.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Change History

-
-
- - - - - - - - - - -
Table 1 Change history

Released On

-

Description

-

2023-10-26

-

This issue incorporates the following change:

-

Updated the APIs for creating a dedicated gateway and querying gateway configurations.

-

2022-12-30

-

This issue is the first official release.

-
-
-
- diff --git a/docs/apig/api-ref/apig-phapi-20070101.html b/docs/apig/api-ref/apig-phapi-20070101.html index 8c411bf7..8d7ce4d9 100644 --- a/docs/apig/api-ref/apig-phapi-20070101.html +++ b/docs/apig/api-ref/apig-phapi-20070101.html @@ -1,57 +1,71 @@

Dedicated Gateway APIs (V2)

-

+

diff --git a/docs/apig/api-ref/en-us_image_0172290304.gif b/docs/apig/api-ref/en-us_image_0172290304.gif deleted file mode 100644 index 8d50ba8c..00000000 Binary files a/docs/apig/api-ref/en-us_image_0172290304.gif and /dev/null differ diff --git a/docs/apig/api-ref/public_sys-resources/imageclose.gif b/docs/apig/api-ref/public_sys-resources/imageclose.gif deleted file mode 100644 index 3a3344af..00000000 Binary files a/docs/apig/api-ref/public_sys-resources/imageclose.gif and /dev/null differ diff --git a/docs/apig/api-ref/public_sys-resources/imageclosehover.gif b/docs/apig/api-ref/public_sys-resources/imageclosehover.gif deleted file mode 100644 index 8699d5e3..00000000 Binary files a/docs/apig/api-ref/public_sys-resources/imageclosehover.gif and /dev/null differ diff --git a/docs/apig/api-ref/public_sys-resources/imagemax.gif b/docs/apig/api-ref/public_sys-resources/imagemax.gif deleted file mode 100644 index 99c07dc2..00000000 Binary files a/docs/apig/api-ref/public_sys-resources/imagemax.gif and /dev/null differ diff --git a/docs/apig/api-ref/public_sys-resources/imagemaxhover.gif b/docs/apig/api-ref/public_sys-resources/imagemaxhover.gif deleted file mode 100644 index d01d77d6..00000000 Binary files a/docs/apig/api-ref/public_sys-resources/imagemaxhover.gif and /dev/null differ diff --git a/docs/apig/api-ref/public_sys-resources/macFFBgHack.png b/docs/apig/api-ref/public_sys-resources/macFFBgHack.png deleted file mode 100644 index ec811470..00000000 Binary files a/docs/apig/api-ref/public_sys-resources/macFFBgHack.png and /dev/null differ