检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
String Description of the API request body, which can be an example request body, media type, or parameter information result_normal_sample String Example response for a successful request result_failure_sample String Example response for a failed request response_id String ID of the gateway
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. task_id Yes String Asynchronous task ID.
Object Model To improve access security of a published API, you can control the access from certain IP addresses by configuring a blacklist or whitelist. This section describes the object model for blacklist/whitelist (access control policy) management, as shown in object model for
Object Model An access control policy can protect access security of an API only after being bound to the API. This section describes the object model for binding an access control policy to an API, as shown in Table 1. Operation Type indicates the operation that can be performed
Querying API Group Quantities Function This API is used to query the number of API groups that have been listed and the number of API groups that have not been listed. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method
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
Modifying a Signature Key Function This API is used to modify the information about a signature key. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI PUT /v1.0/apigw/signs/{id} The following
Deleting a Signature Key Function This API is used to delete a specified signature key. This operation will invalidate the signature key and unbind it from relevant APIs. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method
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
Unbinding a Signature Key Function This API is used to unbind a signature key from an API. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI DELETE /v1.0/apigw/sign-bindings/{id} The following
Binding a Domain Name Function Domain names are user-defined, and take effect only after CNAME records are added to point the domain names to subdomain names of API groups. For details, see Adding a CNAME Record Set. An API group can be bound to a maximum of five domain names. After
Unbinding a Domain Name Function This API is used to unbind a custom domain name from an API group. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI DELETE /v1.0/apigw/api-groups/{group_id}
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
Updating a VPC Channel Function This API is used to update the parameters of a specified VPC channel. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI PUT /v1.0/apigw/vpc-channels/{id} The
Deleting a VPC Channel Function This API is used to delete a specified VPC channel. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI DELETE /v1.0/apigw/vpc-channels/{id} The following table
Exporting All APIs in an API Group Function This API is used to export definitions of APIs in a specified API group. The basic, full, or extended Swagger definitions of APIs belonging to the API group and published in a specified environment will be imported. URI The following table
Importing APIs to a New API Group Function This API is used to import Swagger APIs to a new API group. Swagger files in JSON or YAML format are supported. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 Request Method URI POST /v1.0/apigw/openapi
Importing APIs to an Existing API Group Function This API is used to create or update APIs in an API group by importing Swagger definitions. Swagger files in JSON or YAML format are supported. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1
Creating a Custom Authorizer Function This API is used to create a custom authorizer. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI POST /v1.0/apigw/authorizers Request Table 2 Parameter
Modifying a Custom Authorizer Function This API is used to modify a specified custom authorizer. URI The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI Request Method URI PUT /v1.0/apigw/authorizers/{id} The following
