检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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.
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
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 The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS request method and URI
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, SSL certificates, and release information) directly or indirectly associated with the group
Querying Historical API Versions 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 The following table lists the HTTP/HTTPS request method and URI of the API. Table 1 HTTP/HTTPS
Creating an Environment Variable Function Publishing an API in different environments may involve various environment variables, such as API service deployment address and request version. Define environment variables when creating an API. When the API is called, the environment variables
Deleting an Environment Variable Function This API is used to delete a specified environment variable. 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/env-variables/{id}
Object Model This section describes the request throttling policy object model. Operation Type indicates the operation that can be performed on a field. C: create; U: update; R: read Mandatory indicates whether a field with the Operation Type of C is mandatory. Table 1 Request throttling
Object Model This section describes the object model for binding a request throttling policy to an API. Operation Type indicates the operation that can be performed on a field. C: create; U: update; R: read Mandatory indicates whether a field with the Operation Type of C is mandatory
Object Model This section describes the object model for excluded request throttling configurations. Operation Type indicates the operation that can be performed on a field. C: create; U: update; R: read Mandatory indicates whether a field with the Operation Type of C is mandatory
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
