API Gateway:ModifyApiConfiguration

The ID of the API.

The name of the API.

The description of the API.

Specifies whether to make the API public. Valid values:

• PUBLIC: The API is public. If this parameter is set to PUBLIC, the API is displayed on the APIs page for all users after the API is published to the production environment.
• PRIVATE: The API is private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.

• Specifies whether to forcibly check X-Ca-Nonce. If the ForceNonceCheck parameter is set to true, X-Ca-Nonce is forcibly checked. X-Ca-Nonce is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.
• If the ForceNonceCheck parameter is set to false, X-Ca-Nonce is not checked. If you do not modify this parameter when you modify an API, the original value is used.

• Specifies whether to call the API only in an internal network. If the DisableInternet parameter is set to true, the API can be called only in an internal network.
• If the DisableInternet parameter is set to false, the API can be called over the Internet and in an internal network.

If the AuthType parameter is set to APP, the valid values are:

• DEFAULT: The default value that is used if no other values are passed. This value indicates that the settings of the group are used.
• DISABLE: The authentication is disabled.
• HEADER: AppCode can be placed in the Header parameter for authentication.
• HEADER_QUERY: AppCode can be placed in the Header or Query parameter for authentication.

If the AuthType parameter is set to APP, you must include this parameter to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:

• HmacSHA256
• HmacSHA1,HmacSHA256

API 安全认证类型，目前可以取值：

• APP：只允许已授权的 APP 调用
• ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：
  • 任何能够获取该 API 服务信息的人，都将能够调用该 API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该 API 请设置好按 API 的流量控制；
  • AppCodeAuthType 的值不会生效。

The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".

The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.

The path of the API request. If the complete API URL is http://api.a.com:8080/object/add?key1=value1&key2=value2, the path of the API request is /object/add.

The request mode. Valid values:

• MAPPING: Parameters are mapped. Unknown parameters are filtered out.
• PASSTHROUGH: Parameters are passed through.
• MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.

This parameter takes effect only when the RequestMode parameter is set to MAPPING.

The format in which data is transmitted to the server for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data is transmitted in the key-value pair format. STREAM indicates that data is transmitted as byte streams.

The description of the request body.

The body model.

The name of the model.

The name of the backend service. This parameter takes effect only when the UseBackendService parameter is set to TRUE.

The protocol that is used to access backend services. Valid values:

• Http: for backend services that use HTTP or HTTPS
• Vpc: for backend services that use VPC
• FC: for Function Compute
• OSS: for Object Storage Service
• Mock: for backend services that use the Mock mode
• EventBridge: for EventBridge

You must specify the config value for the corresponding backend service.

The HTTP configuration.

The VPC configuration.

The Function Compute configuration.

The OSS configuration.

The Mock configuration.

The timeout period of the backend service. Unit: milliseconds.

The ContentType configuration of the backend request.

• DEFAULT: the default configuration in API Gateway
• CUSTOM: a custom configuration

The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.

The parameters of API requests sent by the consumer to API Gateway.

For more information, see RequestParameter .

The parameters of API requests sent by API Gateway to the backend service.

For more information, see ServiceParameter .

The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.

For more information, see ServiceParameterMap .

The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. This value is used only to generate documents. It does not affect the returned result.

The sample response from the backend service. This value is used only to generate documents. It does not affect the returned result.

The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.

The sample error codes returned by the backend service.

For more information, see ErrorCodeSample .

Specifies whether to use the information about the created backend service. Valid values:

• TRUE: uses the information about the created backend service.
• FALSE: uses the information about the custom backend service.