doc-exports/docs/apig/api-ref/CLASS.TXT.json
Chen, Junjie 2fc8a34abd APIG API 20240125 version
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-10-25 11:19:06 +00:00

2216 lines
87 KiB
JSON

[
{
"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-api-190529263.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"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":"API Usage",
"uri":"apig-api-0001.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"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-api-180713003.html",
"doc_type":"api",
"p_code":"",
"code":"3"
},
{
"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-api-180713011.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"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":"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 ",
"product_code":"apig",
"title":"Response",
"uri":"apig-api-190529269.html",
"doc_type":"api",
"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.",
"product_code":"apig",
"title":"Dedicated Gateway APIs (V2)",
"uri":"apig-phapi-20070101.html",
"doc_type":"api",
"p_code":"",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.For details, see Calling APIs.PUT /v2/{proj",
"product_code":"apig",
"title":"Modifying an API Group",
"uri":"UpdateApiGroupV2.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"8",
"code":"11"
},
{
"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.html",
"doc_type":"api",
"p_code":"8",
"code":"12"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.For details, see Calling APIs.PUT /",
"product_code":"apig",
"title":"Modifying an Environment",
"uri":"UpdateEnvironmentV2.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"15",
"code":"18"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Modifying a Variable",
"uri":"UpdateEnvironmentVariableV2.html",
"doc_type":"api",
"p_code":"20",
"code":"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":"Request Throttling Policy Management",
"uri":"ThrottlingPolicyManagement.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Querying Request Throttling Policies",
"uri":"ListRequestThrottlingPolicyV2.html",
"doc_type":"api",
"p_code":"26",
"code":"30"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"32",
"code":"33"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Verifying the API Definition",
"uri":"CheckApisV2.html",
"doc_type":"api",
"p_code":"32",
"code":"39"
},
{
"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":"Debugging an API",
"uri":"DebugApiV2.html",
"doc_type":"api",
"p_code":"32",
"code":"40"
},
{
"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":"Publishing APIs or Taking APIs Offline",
"uri":"BatchPublishOrOfflineApiV2.html",
"doc_type":"api",
"p_code":"32",
"code":"41"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Deleting a Signature Key",
"uri":"DeleteSignatureKeyV2.html",
"doc_type":"api",
"p_code":"47",
"code":"50"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Querying Signature Keys Bound to an API",
"uri":"ListSignatureKeysBindedToApiV2.html",
"doc_type":"api",
"p_code":"52",
"code":"55"
},
{
"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 APIs Not Bound with a Signature Key",
"uri":"ListApisNotBoundWithSignatureKeyV2.html",
"doc_type":"api",
"p_code":"52",
"code":"56"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Querying APIs Bound with a Request Throttling Policy",
"uri":"ListApisBindedToRequestThrottlingPolicyV2.html",
"doc_type":"api",
"p_code":"58",
"code":"61"
},
{
"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 Not Bound with a Request Throttling Policy",
"uri":"ListApisUnbindedToRequestThrottlingPolicyV2.html",
"doc_type":"api",
"p_code":"58",
"code":"62"
},
{
"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 Request Throttling Policies Bound to an API",
"uri":"ListRequestThrottlingPoliciesBindedToApiV2.html",
"doc_type":"api",
"p_code":"58",
"code":"63"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Deleting an Excluded Request Throttling Configuration",
"uri":"DeleteSpecialThrottlingConfigurationV2.html",
"doc_type":"api",
"p_code":"65",
"code":"68"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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":"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":"Canceling Authorization",
"uri":"CancelingAuthorizationV2.html",
"doc_type":"api",
"p_code":"70",
"code":"72"
},
{
"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":"Querying APIs Bound with an App",
"uri":"ListApisBindedToAppV2.html",
"doc_type":"api",
"p_code":"70",
"code":"73"
},
{
"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 Not Bound with an App",
"uri":"ListApisUnbindedToAppV2.html",
"doc_type":"api",
"p_code":"70",
"code":"74"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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 Group Quantities",
"uri":"ListApiGroupsQuantitiesV2.html",
"doc_type":"api",
"p_code":"76",
"code":"78"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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 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":"Unbinding a Domain Name",
"uri":"DisassociateDomainV2.html",
"doc_type":"api",
"p_code":"80",
"code":"84"
},
{
"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":"Setting Accessibility of a Debugging Domain Name",
"uri":"UpdateSlDomainSettingV2.html",
"doc_type":"api",
"p_code":"80",
"code":"85"
},
{
"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.html",
"doc_type":"api",
"p_code":"80",
"code":"86"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.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.For details, see Calling APIs.PUT /v2/{project_id}/",
"product_code":"apig",
"title":"Modifying an Access Control Policy",
"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.For details, see Calling APIs.DELETE /v2/{project_id}/apigw/i",
"product_code":"apig",
"title":"Deleting an Access Control Policy",
"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.For details, see Calling APIs.PUT /v2/{project_id}/api",
"product_code":"apig",
"title":"Deleting Multiple Access Control Policies",
"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.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.html",
"doc_type":"api",
"p_code":"88",
"code":"93"
},
{
"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.html",
"doc_type":"api",
"p_code":"88",
"code":"94"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"95",
"code":"96"
},
{
"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.html",
"doc_type":"api",
"p_code":"95",
"code":"97"
},
{
"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.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.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.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.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.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.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.html",
"doc_type":"api",
"p_code":"95",
"code":"101"
},
{
"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.html",
"doc_type":"api",
"p_code":"7",
"code":"102"
},
{
"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.html",
"doc_type":"api",
"p_code":"102",
"code":"103"
},
{
"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.html",
"doc_type":"api",
"p_code":"102",
"code":"104"
},
{
"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.html",
"doc_type":"api",
"p_code":"102",
"code":"105"
},
{
"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.html",
"doc_type":"api",
"p_code":"102",
"code":"106"
},
{
"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.html",
"doc_type":"api",
"p_code":"102",
"code":"107"
},
{
"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.html",
"doc_type":"api",
"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.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 of APIG, see section",
"product_code":"apig",
"title":"Importing APIs",
"uri":"ImportApiDefinitionsV2.html",
"doc_type":"api",
"p_code":"108",
"code":"110"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"112"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"113"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"114"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"115"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"116"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"117"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"118"
},
{
"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.html",
"doc_type":"api",
"p_code":"111",
"code":"119"
},
{
"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.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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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":"Group Response Management",
"uri":"GroupResponseManagement.html",
"doc_type":"api",
"p_code":"7",
"code":"133"
},
{
"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":"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"7",
"code":"148"
},
{
"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.html",
"doc_type":"api",
"p_code":"148",
"code":"149"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"7",
"code":"151"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"152"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"153"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"154"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"155"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"158"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"159"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"160"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"164"
},
{
"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.html",
"doc_type":"api",
"p_code":"151",
"code":"165"
},
{
"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.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"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.For details, see Calling APIs.POST ",
"product_code":"apig",
"title":"Creating an App",
"uri":"CreateAnAppV2.html",
"doc_type":"api",
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"208"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"209"
},
{
"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.html",
"doc_type":"api",
"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.For",
"product_code":"apig",
"title":"Verifying an App",
"uri":"CheckAppV2.html",
"doc_type":"api",
"p_code":"206",
"code":"211"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"212"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"213"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"214"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"215"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"216"
},
{
"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.html",
"doc_type":"api",
"p_code":"206",
"code":"217"
},
{
"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.html",
"doc_type":"api",
"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 ",
"product_code":"apig",
"title":"Permissions Policies and Supported Actions",
"uri":"api-grant-policy.html",
"doc_type":"api",
"p_code":"",
"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.",
"product_code":"apig",
"title":"Appendix",
"uri":"apig-api-190529271.html",
"doc_type":"api",
"p_code":"",
"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-api-180713204.html",
"doc_type":"api",
"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-api-180713205.html",
"doc_type":"api",
"p_code":"238",
"code":"240"
},
{
"desc":"Table 1 describes common status codes.",
"product_code":"apig",
"title":"HTTP Status Codes",
"uri":"apig-api-180713206.html",
"doc_type":"api",
"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.",
"product_code":"apig",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"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-20200402.html",
"doc_type":"api",
"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",
"product_code":"apig",
"title":"Obtaining a Project ID",
"uri":"apig-api-180713009.html",
"doc_type":"api",
"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 ",
"product_code":"apig",
"title":"Obtaining an Account Name and Account ID",
"uri":"apig-api-180713005.html",
"doc_type":"api",
"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-api-180713215.html",
"doc_type":"api",
"p_code":"",
"code":"246"
}
]