ModifyApiRequest (cloudapi20160714 2.2.14 API)

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

public class ModifyApiRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`allowSignatureMethod` The returned description of the API.
`String`	`apiId` The name of the API.
`String`	`apiName` The description of the API.
`String`	`appCodeAuthType` Specifies whether to enable backend services.
`String`	`authType` The configuration items of API requests sent by API Gateway to the backend service.
`Boolean`	`backendEnable` auditing
`String`	`backendId` The ID of the request.
`String`	`constantParameters` 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`	`description` Specifies whether the API is public.
`Boolean`	`disableInternet` The ID of the backend service.
`String`	`errorCodeSamples` The configuration items of the third-party OpenID Connect authentication method.
`String`	`failResultSample` The returned description of the API.
`Boolean`	`forceNonceCheck` The AppCode authentication type supported.
`String`	`groupId` The ID of the API.
`String`	`openIdConnectConfig` The type of the two-way communication API.
`String`	`requestConfig` The parameters of API requests sent by the consumer to API Gateway.
`String`	`requestParameters` System parameter
`String`	`resultBodyModel` * Specifies whether to set DisableInternet to true to limit API calls to within the VPC.
`String`	`resultDescriptions` The client-side request signature method of the API.
`String`	`resultSample` The sample error codes returned by the backend service.
`String`	`resultType` The sample error response from the backend service.
`String`	`securityToken`
`String`	`serviceConfig` \[{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"age","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"gender","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"Client IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]
`String`	`serviceParameters` The format of the response from the backend service.
`String`	`serviceParametersMap` The sample response from the backend service.
`String`	`systemParameters` The parameters of API requests sent by API Gateway to the backend service.
`String`	`visibility` The configuration items of API requests sent by the consumer to API Gateway.
`String`	`webSocketApiType` * Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request.

构造器概要

构造器
构造器和说明

ModifyApiRequest()

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

方法概要

方法
限定符和类型	方法和说明
`static ModifyApiRequest`	`build(Map<String,?> map)`
`String`	`getAllowSignatureMethod()`
`String`	`getApiId()`
`String`	`getApiName()`
`String`	`getAppCodeAuthType()`
`String`	`getAuthType()`
`Boolean`	`getBackendEnable()`
`String`	`getBackendId()`
`String`	`getConstantParameters()`
`String`	`getDescription()`
`Boolean`	`getDisableInternet()`
`String`	`getErrorCodeSamples()`
`String`	`getFailResultSample()`
`Boolean`	`getForceNonceCheck()`
`String`	`getGroupId()`
`String`	`getOpenIdConnectConfig()`
`String`	`getRequestConfig()`
`String`	`getRequestParameters()`
`String`	`getResultBodyModel()`
`String`	`getResultDescriptions()`
`String`	`getResultSample()`
`String`	`getResultType()`
`String`	`getSecurityToken()`
`String`	`getServiceConfig()`
`String`	`getServiceParameters()`
`String`	`getServiceParametersMap()`
`String`	`getSystemParameters()`
`String`	`getVisibility()`
`String`	`getWebSocketApiType()`
`ModifyApiRequest`	`setAllowSignatureMethod(String allowSignatureMethod)`
`ModifyApiRequest`	`setApiId(String apiId)`
`ModifyApiRequest`	`setApiName(String apiName)`
`ModifyApiRequest`	`setAppCodeAuthType(String appCodeAuthType)`
`ModifyApiRequest`	`setAuthType(String authType)`
`ModifyApiRequest`	`setBackendEnable(Boolean backendEnable)`
`ModifyApiRequest`	`setBackendId(String backendId)`
`ModifyApiRequest`	`setConstantParameters(String constantParameters)`
`ModifyApiRequest`	`setDescription(String description)`
`ModifyApiRequest`	`setDisableInternet(Boolean disableInternet)`
`ModifyApiRequest`	`setErrorCodeSamples(String errorCodeSamples)`
`ModifyApiRequest`	`setFailResultSample(String failResultSample)`
`ModifyApiRequest`	`setForceNonceCheck(Boolean forceNonceCheck)`
`ModifyApiRequest`	`setGroupId(String groupId)`
`ModifyApiRequest`	`setOpenIdConnectConfig(String openIdConnectConfig)`
`ModifyApiRequest`	`setRequestConfig(String requestConfig)`
`ModifyApiRequest`	`setRequestParameters(String requestParameters)`
`ModifyApiRequest`	`setResultBodyModel(String resultBodyModel)`
`ModifyApiRequest`	`setResultDescriptions(String resultDescriptions)`
`ModifyApiRequest`	`setResultSample(String resultSample)`
`ModifyApiRequest`	`setResultType(String resultType)`
`ModifyApiRequest`	`setSecurityToken(String securityToken)`
`ModifyApiRequest`	`setServiceConfig(String serviceConfig)`
`ModifyApiRequest`	`setServiceParameters(String serviceParameters)`
`ModifyApiRequest`	`setServiceParametersMap(String serviceParametersMap)`
`ModifyApiRequest`	`setSystemParameters(String systemParameters)`
`ModifyApiRequest`	`setVisibility(String visibility)`
`ModifyApiRequest`	`setWebSocketApiType(String webSocketApiType)`

从类继承的方法 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
```
    The returned description of the API.
  - apiId
```
@NameInMap(value="ApiId")
public String apiId
```
    The name of the API. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\_).
  - apiName
```
@NameInMap(value="ApiName")
public String apiName
```
    The description of the API. The description can be up to 180 characters in length.
  - appCodeAuthType
```
@NameInMap(value="AppCodeAuthType")
public String appCodeAuthType
```
    Specifies whether to enable backend services.
  - authType
```
@NameInMap(value="AuthType")
public String authType
```
    The configuration items of API requests sent by API Gateway to the backend service.
  - backendEnable
```
@NameInMap(value="BackendEnable")
public Boolean backendEnable
```
    auditing
  - backendId
```
@NameInMap(value="BackendId")
public String backendId
```
    The ID of the request.
  - constantParameters
```
@NameInMap(value="ConstantParameters")
public String constantParameters
```
    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.
  - description
```
@NameInMap(value="Description")
public String description
```
    Specifies whether the API is 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.
  - disableInternet
```
@NameInMap(value="DisableInternet")
public Boolean disableInternet
```
    The ID of the backend service.
  - errorCodeSamples
```
@NameInMap(value="ErrorCodeSamples")
public String errorCodeSamples
```
    The configuration items of the third-party OpenID Connect authentication method.
  - failResultSample
```
@NameInMap(value="FailResultSample")
public String failResultSample
```
    The returned description of the API.
  - forceNonceCheck
```
@NameInMap(value="ForceNonceCheck")
public Boolean forceNonceCheck
```
    The AppCode authentication type supported. Valid values:
    
    * DEFAULT: supported after being made available in Alibaba Cloud Marketplace
    
    * DISABLE: not supported
    
    * HEADER : supported only in the Header parameter
    
    * HEADER_QUERY: supported in the Header or Query parameter
  - groupId
```
@NameInMap(value="GroupId")
public String groupId
```
    The ID of the API.
  - openIdConnectConfig
```
@NameInMap(value="OpenIdConnectConfig")
public String openIdConnectConfig
```
    The type of the two-way communication API. Valid values:
    
    * **COMMON**: general APIs
    
    * **REGISTER**: registered APIs
    
    * **UNREGISTER**: unregistered APIs
    
    * **NOTIFY**: downstream notification
  - requestConfig
```
@NameInMap(value="RequestConfig")
public String requestConfig
```
    The parameters of API requests sent by the consumer to API Gateway.
  - requestParameters
```
@NameInMap(value="RequestParameters")
public String requestParameters
```
    System parameter
  - resultBodyModel
```
@NameInMap(value="ResultBodyModel")
public String resultBodyModel
```
    * 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.
    
    > If you do not set this parameter, the original value is used.
  - resultDescriptions
```
@NameInMap(value="ResultDescriptions")
public String resultDescriptions
```
    The client-side request signature method of the API. Valid values:
    
    * HmacSHA256
    
    * HmacSHA1,HmacSHA256
  - resultSample
```
@NameInMap(value="ResultSample")
public String resultSample
```
    The sample error codes returned by the backend service.
  - resultType
```
@NameInMap(value="ResultType")
public String resultType
```
    The sample error response from the backend service.
  - securityToken
```
@NameInMap(value="SecurityToken")
public String securityToken
```
  - serviceConfig
```
@NameInMap(value="ServiceConfig")
public String serviceConfig
```
    \[{"ParameterType":"Number","Required":"OPTIONAL","isHide":false,"ApiParameterName":"age","DefaultValue":"20","DemoValue":"20","Description":"age","MinValue":18,"MaxValue":100,"Location":"Head"},{"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"sex","DefaultValue":"boy","DemoValue":"boy","Description":"gender","EnumValue":"boy,girl","Location":"Query"},{"ParameterType":"Number","Required":"REQUIRED","isHide":false,"ApiParameterName":"userId","MaxLength":10,"MinValue":10000000,"MaxValue":100000000,"Location":"Path"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","Description":"Client IP"},{"ApiParameterName":"constance","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"constance","Description":"constance"}]
  - serviceParameters
```
@NameInMap(value="ServiceParameters")
public String serviceParameters
```
    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 results.
  - serviceParametersMap
```
@NameInMap(value="ServiceParametersMap")
public String serviceParametersMap
```
    The sample response from the backend service.
  - systemParameters
```
@NameInMap(value="SystemParameters")
public String systemParameters
```
    The parameters of API requests sent by API Gateway to the backend service.
  - visibility
```
@NameInMap(value="Visibility")
public String visibility
```
    The configuration items of API requests sent by the consumer to API Gateway.
  - webSocketApiType
```
@NameInMap(value="WebSocketApiType")
public String webSocketApiType
```
    * 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.
- 构造器详细资料
  - ModifyApiRequest
```
public ModifyApiRequest()
```
- 方法详细资料
  - build
```
public static ModifyApiRequest build(Map<String,?> map)
                              throws Exception
```
    抛出:
    
    Exception
  - setAllowSignatureMethod
```
public ModifyApiRequest setAllowSignatureMethod(String allowSignatureMethod)
```
  - getAllowSignatureMethod
```
public String getAllowSignatureMethod()
```
  - setApiId
```
public ModifyApiRequest setApiId(String apiId)
```
  - getApiId
```
public String getApiId()
```
  - setApiName
```
public ModifyApiRequest setApiName(String apiName)
```
  - getApiName
```
public String getApiName()
```
  - setAppCodeAuthType
```
public ModifyApiRequest setAppCodeAuthType(String appCodeAuthType)
```
  - getAppCodeAuthType
```
public String getAppCodeAuthType()
```
  - setAuthType
```
public ModifyApiRequest setAuthType(String authType)
```
  - getAuthType
```
public String getAuthType()
```
  - setBackendEnable
```
public ModifyApiRequest setBackendEnable(Boolean backendEnable)
```
  - getBackendEnable
```
public Boolean getBackendEnable()
```
  - setBackendId
```
public ModifyApiRequest setBackendId(String backendId)
```
  - getBackendId
```
public String getBackendId()
```
  - setConstantParameters
```
public ModifyApiRequest setConstantParameters(String constantParameters)
```
  - getConstantParameters
```
public String getConstantParameters()
```
  - setDescription
```
public ModifyApiRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDisableInternet
```
public ModifyApiRequest setDisableInternet(Boolean disableInternet)
```
  - getDisableInternet
```
public Boolean getDisableInternet()
```
  - setErrorCodeSamples
```
public ModifyApiRequest setErrorCodeSamples(String errorCodeSamples)
```
  - getErrorCodeSamples
```
public String getErrorCodeSamples()
```
  - setFailResultSample
```
public ModifyApiRequest setFailResultSample(String failResultSample)
```
  - getFailResultSample
```
public String getFailResultSample()
```
  - setForceNonceCheck
```
public ModifyApiRequest setForceNonceCheck(Boolean forceNonceCheck)
```
  - getForceNonceCheck
```
public Boolean getForceNonceCheck()
```
  - setGroupId
```
public ModifyApiRequest setGroupId(String groupId)
```
  - getGroupId
```
public String getGroupId()
```
  - setOpenIdConnectConfig
```
public ModifyApiRequest setOpenIdConnectConfig(String openIdConnectConfig)
```
  - getOpenIdConnectConfig
```
public String getOpenIdConnectConfig()
```
  - setRequestConfig
```
public ModifyApiRequest setRequestConfig(String requestConfig)
```
  - getRequestConfig
```
public String getRequestConfig()
```
  - setRequestParameters
```
public ModifyApiRequest setRequestParameters(String requestParameters)
```
  - getRequestParameters
```
public String getRequestParameters()
```
  - setResultBodyModel
```
public ModifyApiRequest setResultBodyModel(String resultBodyModel)
```
  - getResultBodyModel
```
public String getResultBodyModel()
```
  - setResultDescriptions
```
public ModifyApiRequest setResultDescriptions(String resultDescriptions)
```
  - getResultDescriptions
```
public String getResultDescriptions()
```
  - setResultSample
```
public ModifyApiRequest setResultSample(String resultSample)
```
  - getResultSample
```
public String getResultSample()
```
  - setResultType
```
public ModifyApiRequest setResultType(String resultType)
```
  - getResultType
```
public String getResultType()
```
  - setSecurityToken
```
public ModifyApiRequest setSecurityToken(String securityToken)
```
  - getSecurityToken
```
public String getSecurityToken()
```
  - setServiceConfig
```
public ModifyApiRequest setServiceConfig(String serviceConfig)
```
  - getServiceConfig
```
public String getServiceConfig()
```
  - setServiceParameters
```
public ModifyApiRequest setServiceParameters(String serviceParameters)
```
  - getServiceParameters
```
public String getServiceParameters()
```
  - setServiceParametersMap
```
public ModifyApiRequest setServiceParametersMap(String serviceParametersMap)
```
  - getServiceParametersMap
```
public String getServiceParametersMap()
```
  - setSystemParameters
```
public ModifyApiRequest setSystemParameters(String systemParameters)
```
  - getSystemParameters
```
public String getSystemParameters()
```
  - setVisibility
```
public ModifyApiRequest setVisibility(String visibility)
```
  - getVisibility
```
public String getVisibility()
```
  - setWebSocketApiType
```
public ModifyApiRequest setWebSocketApiType(String webSocketApiType)
```
  - getWebSocketApiType
```
public String getWebSocketApiType()
```

类 ModifyApiRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

allowSignatureMethod

apiId

apiName

appCodeAuthType

authType

backendEnable

backendId

constantParameters

description

disableInternet

errorCodeSamples

failResultSample

forceNonceCheck

groupId

openIdConnectConfig

requestConfig

requestParameters

resultBodyModel

resultDescriptions

resultSample

resultType

securityToken

serviceConfig

serviceParameters

serviceParametersMap

systemParameters

visibility

webSocketApiType

构造器详细资料

ModifyApiRequest

方法详细资料

build

setAllowSignatureMethod

getAllowSignatureMethod

setApiId

getApiId

setApiName

getApiName

setAppCodeAuthType

getAppCodeAuthType

setAuthType

getAuthType

setBackendEnable

getBackendEnable

setBackendId

getBackendId

setConstantParameters

getConstantParameters

setDescription

getDescription

setDisableInternet

getDisableInternet

setErrorCodeSamples

getErrorCodeSamples

setFailResultSample

getFailResultSample

setForceNonceCheck

getForceNonceCheck

setGroupId

getGroupId

setOpenIdConnectConfig

getOpenIdConnectConfig

setRequestConfig

getRequestConfig

setRequestParameters

getRequestParameters

setResultBodyModel

getResultBodyModel

setResultDescriptions

getResultDescriptions

setResultSample

getResultSample

setResultType