ModifyApiConfigurationRequest (cloudapi20160714 2.2.14 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.cloudapi20160714.models.ModifyApiConfigurationRequest

public class ModifyApiConfigurationRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`allowSignatureMethod` If AuthType is set to APP, this value must be passed to specify the signature algorithm.
`String`	`apiId` The ID of the API.
`String`	`apiName` The name of the API.
`String`	`appCodeAuthType` If AuthType is set to APP, the valid values are: * DEFAULT: The default value that is used if no other values are passed.
`String`	`authType` API安全认证类型，目前可以取值： - APP：只允许已授权的APP调用 - ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意： - 任何能够获取该API服务信息的人，都将能够调用该API。
`String`	`backendName` The name of the backend service.
`String`	`bodyFormat` This parameter takes effect only when the RequestMode parameter is set to MAPPING.
`String`	`bodyModel` The body model.
`String`	`contentTypeCategory` The ContentType configuration of the backend request.
`String`	`contentTypeValue` The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.
`String`	`description` The description of the API.
`Boolean`	`disableInternet` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`String`	`errorCodeSamples` The sample error codes returned by the backend service.
`String`	`failResultSample` The sample error response from the backend service.
`Boolean`	`forceNonceCheck` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.
`String`	`functionComputeConfig` The Function Compute configuration.
`String`	`httpConfig` The HTTP configuration.
`String`	`mockConfig` The Mock configuration.
`String`	`modelName` The name of the model.
`String`	`ossConfig` The OSS configuration.
`String`	`postBodyDescription` The description of the request body.
`String`	`requestHttpMethod` The HTTP method used to make the request.
`String`	`requestMode` The request mode.
`String`	`requestParameters` The parameters of API requests sent by the consumer to API Gateway.
`String`	`requestPath` The API request path.
`String`	`requestProtocol` The protocol type supported by the API.
`String`	`resultSample` The sample response from the backend service.
`String`	`resultType` The format of the response from the backend service.
`String`	`securityToken`
`String`	`serviceParameters` The parameters of API requests sent by API Gateway to the backend service.
`String`	`serviceParametersMap` 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.
`String`	`serviceProtocol` The protocols that are used to access backend services.
`Integer`	`serviceTimeout` The timeout period of the backend service, in millisecond.
`Boolean`	`useBackendService` Specifies whether to use the created backend service.
`String`	`visibility` Specifies whether to make the API public.
`String`	`vpcConfig` The VPC configuration.

构造器概要

构造器
构造器和说明

ModifyApiConfigurationRequest()

构造器
构造器和说明
`ModifyApiConfigurationRequest()`

方法概要

方法
限定符和类型	方法和说明
`static ModifyApiConfigurationRequest`	`build(Map<String,?> map)`
`String`	`getAllowSignatureMethod()`
`String`	`getApiId()`
`String`	`getApiName()`
`String`	`getAppCodeAuthType()`
`String`	`getAuthType()`
`String`	`getBackendName()`
`String`	`getBodyFormat()`
`String`	`getBodyModel()`
`String`	`getContentTypeCategory()`
`String`	`getContentTypeValue()`
`String`	`getDescription()`
`Boolean`	`getDisableInternet()`
`String`	`getErrorCodeSamples()`
`String`	`getFailResultSample()`
`Boolean`	`getForceNonceCheck()`
`String`	`getFunctionComputeConfig()`
`String`	`getHttpConfig()`
`String`	`getMockConfig()`
`String`	`getModelName()`
`String`	`getOssConfig()`
`String`	`getPostBodyDescription()`
`String`	`getRequestHttpMethod()`
`String`	`getRequestMode()`
`String`	`getRequestParameters()`
`String`	`getRequestPath()`
`String`	`getRequestProtocol()`
`String`	`getResultSample()`
`String`	`getResultType()`
`String`	`getSecurityToken()`
`String`	`getServiceParameters()`
`String`	`getServiceParametersMap()`
`String`	`getServiceProtocol()`
`Integer`	`getServiceTimeout()`
`Boolean`	`getUseBackendService()`
`String`	`getVisibility()`
`String`	`getVpcConfig()`
`ModifyApiConfigurationRequest`	`setAllowSignatureMethod(String allowSignatureMethod)`
`ModifyApiConfigurationRequest`	`setApiId(String apiId)`
`ModifyApiConfigurationRequest`	`setApiName(String apiName)`
`ModifyApiConfigurationRequest`	`setAppCodeAuthType(String appCodeAuthType)`
`ModifyApiConfigurationRequest`	`setAuthType(String authType)`
`ModifyApiConfigurationRequest`	`setBackendName(String backendName)`
`ModifyApiConfigurationRequest`	`setBodyFormat(String bodyFormat)`
`ModifyApiConfigurationRequest`	`setBodyModel(String bodyModel)`
`ModifyApiConfigurationRequest`	`setContentTypeCategory(String contentTypeCategory)`
`ModifyApiConfigurationRequest`	`setContentTypeValue(String contentTypeValue)`
`ModifyApiConfigurationRequest`	`setDescription(String description)`
`ModifyApiConfigurationRequest`	`setDisableInternet(Boolean disableInternet)`
`ModifyApiConfigurationRequest`	`setErrorCodeSamples(String errorCodeSamples)`
`ModifyApiConfigurationRequest`	`setFailResultSample(String failResultSample)`
`ModifyApiConfigurationRequest`	`setForceNonceCheck(Boolean forceNonceCheck)`
`ModifyApiConfigurationRequest`	`setFunctionComputeConfig(String functionComputeConfig)`
`ModifyApiConfigurationRequest`	`setHttpConfig(String httpConfig)`
`ModifyApiConfigurationRequest`	`setMockConfig(String mockConfig)`
`ModifyApiConfigurationRequest`	`setModelName(String modelName)`
`ModifyApiConfigurationRequest`	`setOssConfig(String ossConfig)`
`ModifyApiConfigurationRequest`	`setPostBodyDescription(String postBodyDescription)`
`ModifyApiConfigurationRequest`	`setRequestHttpMethod(String requestHttpMethod)`
`ModifyApiConfigurationRequest`	`setRequestMode(String requestMode)`
`ModifyApiConfigurationRequest`	`setRequestParameters(String requestParameters)`
`ModifyApiConfigurationRequest`	`setRequestPath(String requestPath)`
`ModifyApiConfigurationRequest`	`setRequestProtocol(String requestProtocol)`
`ModifyApiConfigurationRequest`	`setResultSample(String resultSample)`
`ModifyApiConfigurationRequest`	`setResultType(String resultType)`
`ModifyApiConfigurationRequest`	`setSecurityToken(String securityToken)`
`ModifyApiConfigurationRequest`	`setServiceParameters(String serviceParameters)`
`ModifyApiConfigurationRequest`	`setServiceParametersMap(String serviceParametersMap)`
`ModifyApiConfigurationRequest`	`setServiceProtocol(String serviceProtocol)`
`ModifyApiConfigurationRequest`	`setServiceTimeout(Integer serviceTimeout)`
`ModifyApiConfigurationRequest`	`setUseBackendService(Boolean useBackendService)`
`ModifyApiConfigurationRequest`	`setVisibility(String visibility)`
`ModifyApiConfigurationRequest`	`setVpcConfig(String vpcConfig)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - allowSignatureMethod
```
@NameInMap(value="AllowSignatureMethod")
public String allowSignatureMethod
```
    If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:
    
    * HmacSHA256
    
    * HmacSHA1,HmacSHA256
  - apiId
```
@NameInMap(value="ApiId")
public String apiId
```
    The ID of the API.
  - apiName
```
@NameInMap(value="ApiName")
public String apiName
```
    The name of the API.
  - appCodeAuthType
```
@NameInMap(value="AppCodeAuthType")
public String appCodeAuthType
```
    If **AuthType** is set to **APP**, the valid values are:
    
    * **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is 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.
  - authType
```
@NameInMap(value="AuthType")
public String authType
```
    API安全认证类型，目前可以取值：
    
    - **APP**：只允许已授权的APP调用
    
    - **ANONYMOUS**：允许匿名调用，设置为允许匿名调用需要注意：
    
    - 任何能够获取该API服务信息的人，都将能够调用该API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该API请设置好按API的流量控制；
    
    - AppCodeAuthType的值不会生效。
  - backendName
```
@NameInMap(value="BackendName")
public String backendName
```
    The name of the backend service. This parameter takes effect only when UseBackendService is set to TRUE.
  - bodyFormat
```
@NameInMap(value="BodyFormat")
public String bodyFormat
```
    This parameter takes effect only when the RequestMode parameter is set to MAPPING.********
    
    The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.
  - bodyModel
```
@NameInMap(value="BodyModel")
public String bodyModel
```
    The body model.
  - contentTypeCategory
```
@NameInMap(value="ContentTypeCategory")
public String contentTypeCategory
```
    The ContentType configuration of the backend request.
    
    * DEFAULT: the default configuration in API Gateway
    
    * CUSTOM: a custom configuration
  - contentTypeValue
```
@NameInMap(value="ContentTypeValue")
public String contentTypeValue
```
    The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the API.
  - disableInternet
```
@NameInMap(value="DisableInternet")
public Boolean disableInternet
```
    * Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.
    
    * If you set **DisableInternet** to **false**, the limit if lifted.
  - errorCodeSamples
```
@NameInMap(value="ErrorCodeSamples")
public String errorCodeSamples
```
    The sample error codes returned by the backend service.
    
    For more information, see [ErrorCodeSample](~~44392~~).
  - failResultSample
```
@NameInMap(value="FailResultSample")
public String failResultSample
```
    The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.
  - forceNonceCheck
```
@NameInMap(value="ForceNonceCheck")
public Boolean forceNonceCheck
```
    * Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This 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 you set **ForceNonceCheck** to **false**, the check is not performed. If you do not set this parameter, the original value is used.
  - functionComputeConfig
```
@NameInMap(value="FunctionComputeConfig")
public String functionComputeConfig
```
    The Function Compute configuration.
  - httpConfig
```
@NameInMap(value="HttpConfig")
public String httpConfig
```
    The HTTP configuration.
  - mockConfig
```
@NameInMap(value="MockConfig")
public String mockConfig
```
    The Mock configuration.
  - modelName
```
@NameInMap(value="ModelName")
public String modelName
```
    The name of the model.
  - ossConfig
```
@NameInMap(value="OssConfig")
public String ossConfig
```
    The OSS configuration.
  - postBodyDescription
```
@NameInMap(value="PostBodyDescription")
public String postBodyDescription
```
    The description of the request body.
  - requestHttpMethod
```
@NameInMap(value="RequestHttpMethod")
public String requestHttpMethod
```
    The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.
  - requestMode
```
@NameInMap(value="RequestMode")
public String requestMode
```
    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.
  - requestParameters
```
@NameInMap(value="RequestParameters")
public String requestParameters
```
    The parameters of API requests sent by the consumer to API Gateway.
    
    For more information, see [RequestParameter](~~43986~~).
  - requestPath
```
@NameInMap(value="RequestPath")
public String requestPath
```
    The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is ` /object/add `.
  - requestProtocol
```
@NameInMap(value="RequestProtocol")
public String requestProtocol
```
    The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".
  - resultSample
```
@NameInMap(value="ResultSample")
public String resultSample
```
    The sample response from the backend service. This value is used only to generate documents. It does not affect the returned result.
  - resultType
```
@NameInMap(value="ResultType")
public String resultType
```
    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.
  - securityToken
```
@NameInMap(value="SecurityToken")
public String securityToken
```
  - serviceParameters
```
@NameInMap(value="ServiceParameters")
public String serviceParameters
```
    The parameters of API requests sent by API Gateway to the backend service.
    
    For more information, see [ServiceParameter](~~43988~~).
  - serviceParametersMap
```
@NameInMap(value="ServiceParametersMap")
public String serviceParametersMap
```
    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](~~43989~~).
  - serviceProtocol
```
@NameInMap(value="ServiceProtocol")
public String serviceProtocol
```
    The protocols that are 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.
  - serviceTimeout
```
@NameInMap(value="ServiceTimeout")
public Integer serviceTimeout
```
    The timeout period of the backend service, in millisecond.
  - useBackendService
```
@NameInMap(value="UseBackendService")
public Boolean useBackendService
```
    Specifies whether to use the created backend service. Valid values:
    
    * TRUE: The created backend service is used.
    
    * FALSE: The custom backend service information is used.
  - visibility
```
@NameInMap(value="Visibility")
public String visibility
```
    Specifies whether to make the API public. Valid values:
    
    * **PUBLIC: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.**
    
    * **PRIVATE: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.
  - vpcConfig
```
@NameInMap(value="VpcConfig")
public String vpcConfig
```
    The VPC configuration.
- 构造器详细资料
  - ModifyApiConfigurationRequest
```
public ModifyApiConfigurationRequest()
```
- 方法详细资料
  - build
```
public static ModifyApiConfigurationRequest build(Map<String,?> map)
                                           throws Exception
```
    抛出:
    
    Exception
  - setAllowSignatureMethod
```
public ModifyApiConfigurationRequest setAllowSignatureMethod(String allowSignatureMethod)
```
  - getAllowSignatureMethod
```
public String getAllowSignatureMethod()
```
  - setApiId
```
public ModifyApiConfigurationRequest setApiId(String apiId)
```
  - getApiId
```
public String getApiId()
```
  - setApiName
```
public ModifyApiConfigurationRequest setApiName(String apiName)
```
  - getApiName
```
public String getApiName()
```
  - setAppCodeAuthType
```
public ModifyApiConfigurationRequest setAppCodeAuthType(String appCodeAuthType)
```
  - getAppCodeAuthType
```
public String getAppCodeAuthType()
```
  - setAuthType
```
public ModifyApiConfigurationRequest setAuthType(String authType)
```
  - getAuthType
```
public String getAuthType()
```
  - setBackendName
```
public ModifyApiConfigurationRequest setBackendName(String backendName)
```
  - getBackendName
```
public String getBackendName()
```
  - setBodyFormat
```
public ModifyApiConfigurationRequest setBodyFormat(String bodyFormat)
```
  - getBodyFormat
```
public String getBodyFormat()
```
  - setBodyModel
```
public ModifyApiConfigurationRequest setBodyModel(String bodyModel)
```
  - getBodyModel
```
public String getBodyModel()
```
  - setContentTypeCategory
```
public ModifyApiConfigurationRequest setContentTypeCategory(String contentTypeCategory)
```
  - getContentTypeCategory
```
public String getContentTypeCategory()
```
  - setContentTypeValue
```
public ModifyApiConfigurationRequest setContentTypeValue(String contentTypeValue)
```
  - getContentTypeValue
```
public String getContentTypeValue()
```
  - setDescription
```
public ModifyApiConfigurationRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDisableInternet
```
public ModifyApiConfigurationRequest setDisableInternet(Boolean disableInternet)
```
  - getDisableInternet
```
public Boolean getDisableInternet()
```
  - setErrorCodeSamples
```
public ModifyApiConfigurationRequest setErrorCodeSamples(String errorCodeSamples)
```
  - getErrorCodeSamples
```
public String getErrorCodeSamples()
```
  - setFailResultSample
```
public ModifyApiConfigurationRequest setFailResultSample(String failResultSample)
```
  - getFailResultSample
```
public String getFailResultSample()
```
  - setForceNonceCheck
```
public ModifyApiConfigurationRequest setForceNonceCheck(Boolean forceNonceCheck)
```
  - getForceNonceCheck
```
public Boolean getForceNonceCheck()
```
  - setFunctionComputeConfig
```
public ModifyApiConfigurationRequest setFunctionComputeConfig(String functionComputeConfig)
```
  - getFunctionComputeConfig
```
public String getFunctionComputeConfig()
```
  - setHttpConfig
```
public ModifyApiConfigurationRequest setHttpConfig(String httpConfig)
```
  - getHttpConfig
```
public String getHttpConfig()
```
  - setMockConfig
```
public ModifyApiConfigurationRequest setMockConfig(String mockConfig)
```
  - getMockConfig
```
public String getMockConfig()
```
  - setModelName
```
public ModifyApiConfigurationRequest setModelName(String modelName)
```
  - getModelName
```
public String getModelName()
```
  - setOssConfig
```
public ModifyApiConfigurationRequest setOssConfig(String ossConfig)
```
  - getOssConfig
```
public String getOssConfig()
```
  - setPostBodyDescription
```
public ModifyApiConfigurationRequest setPostBodyDescription(String postBodyDescription)
```
  - getPostBodyDescription
```
public String getPostBodyDescription()
```
  - setRequestHttpMethod
```
public ModifyApiConfigurationRequest setRequestHttpMethod(String requestHttpMethod)
```
  - getRequestHttpMethod
```
public String getRequestHttpMethod()
```
  - setRequestMode
```
public ModifyApiConfigurationRequest setRequestMode(String requestMode)
```
  - getRequestMode
```
public String getRequestMode()
```
  - setRequestParameters
```
public ModifyApiConfigurationRequest setRequestParameters(String requestParameters)
```
  - getRequestParameters
```
public String getRequestParameters()
```
  - setRequestPath
```
public ModifyApiConfigurationRequest setRequestPath(String requestPath)
```
  - getRequestPath
```
public String getRequestPath()
```
  - setRequestProtocol
```
public ModifyApiConfigurationRequest setRequestProtocol(String requestProtocol)
```
  - getRequestProtocol
```
public String getRequestProtocol()
```
  - setResultSample
```
public ModifyApiConfigurationRequest setResultSample(String resultSample)
```
  - getResultSample
```
public String getResultSample()
```
  - setResultType
```
public ModifyApiConfigurationRequest setResultType(String resultType)
```
  - getResultType
```
public String getResultType()
```
  - setSecurityToken
```
public ModifyApiConfigurationRequest setSecurityToken(String securityToken)
```
  - getSecurityToken
```
public String getSecurityToken()
```
  - setServiceParameters
```
public ModifyApiConfigurationRequest setServiceParameters(String serviceParameters)
```
  - getServiceParameters
```
public String getServiceParameters()
```
  - setServiceParametersMap
```
public ModifyApiConfigurationRequest setServiceParametersMap(String serviceParametersMap)
```
  - getServiceParametersMap
```
public String getServiceParametersMap()
```
  - setServiceProtocol
```
public ModifyApiConfigurationRequest setServiceProtocol(String serviceProtocol)
```
  - getServiceProtocol
```
public String getServiceProtocol()
```
  - setServiceTimeout
```
public ModifyApiConfigurationRequest setServiceTimeout(Integer serviceTimeout)
```
  - getServiceTimeout
```
public Integer getServiceTimeout()
```
  - setUseBackendService
```
public ModifyApiConfigurationRequest setUseBackendService(Boolean useBackendService)
```
  - getUseBackendService
```
public Boolean getUseBackendService()
```
  - setVisibility
```
public ModifyApiConfigurationRequest setVisibility(String visibility)
```
  - getVisibility
```
public String getVisibility()
```
  - setVpcConfig
```
public ModifyApiConfigurationRequest setVpcConfig(String vpcConfig)
```
  - getVpcConfig
```
public String getVpcConfig()
```

类 ModifyApiConfigurationRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

allowSignatureMethod

apiId

apiName

appCodeAuthType

authType

backendName

bodyFormat

bodyModel

contentTypeCategory

contentTypeValue

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

functionComputeConfig

httpConfig

mockConfig

modelName

ossConfig

postBodyDescription

requestHttpMethod

requestMode

requestParameters

requestPath

requestProtocol

resultSample

resultType

securityToken

serviceParameters

serviceParametersMap

serviceProtocol

serviceTimeout

useBackendService

visibility

vpcConfig

构造器详细资料

ModifyApiConfigurationRequest

方法详细资料

build

setAllowSignatureMethod

getAllowSignatureMethod

setApiId

getApiId

setApiName

getApiName

setAppCodeAuthType

getAppCodeAuthType

setAuthType

getAuthType

setBackendName

getBackendName

setBodyFormat

getBodyFormat

setBodyModel

getBodyModel

setContentTypeCategory

getContentTypeCategory

setContentTypeValue

getContentTypeValue

setDescription

getDescription

setDisableInternet

getDisableInternet

setErrorCodeSamples

getErrorCodeSamples

setFailResultSample

getFailResultSample

setForceNonceCheck

getForceNonceCheck

setFunctionComputeConfig

getFunctionComputeConfig

setHttpConfig