CreateApiRequest (cloudapi20160714 2.2.14 API)

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

public class CreateApiRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`allowSignatureMethod` If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
`String`	`apiName` The name of the API that you want to create.
`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。
`Boolean`	`backendEnable` Specifies whether to enable backend services.
`String`	`backendId` The IDof the backend service
`String`	`constantParameters` The parameters of the API.
`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`	`groupId` The ID of the API group.
`String`	`openIdConnectConfig` The switch status of ACL.
`String`	`requestConfig` The configuration items of API requests sent by the consumer to API Gateway.
`String`	`requestParameters` The parameters of API requests sent by the consumer to API Gateway.
`String`	`resultBodyModel` The return description of the API.
`String`	`resultDescriptions` The return description of 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`	`serviceConfig` The configuration items of API requests sent by API Gateway to the backend service.
`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`	`systemParameters` The common parameters of APIs in JSON format.
`String`	`visibility` Specifies whether to make the API public.
`String`	`webSocketApiType` The type of the two-way communication API.

构造器概要

构造器
构造器和说明

CreateApiRequest()

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

方法概要

方法
限定符和类型	方法和说明
`static CreateApiRequest`	`build(Map<String,?> map)`
`String`	`getAllowSignatureMethod()`
`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()`
`CreateApiRequest`	`setAllowSignatureMethod(String allowSignatureMethod)`
`CreateApiRequest`	`setApiName(String apiName)`
`CreateApiRequest`	`setAppCodeAuthType(String appCodeAuthType)`
`CreateApiRequest`	`setAuthType(String authType)`
`CreateApiRequest`	`setBackendEnable(Boolean backendEnable)`
`CreateApiRequest`	`setBackendId(String backendId)`
`CreateApiRequest`	`setConstantParameters(String constantParameters)`
`CreateApiRequest`	`setDescription(String description)`
`CreateApiRequest`	`setDisableInternet(Boolean disableInternet)`
`CreateApiRequest`	`setErrorCodeSamples(String errorCodeSamples)`
`CreateApiRequest`	`setFailResultSample(String failResultSample)`
`CreateApiRequest`	`setForceNonceCheck(Boolean forceNonceCheck)`
`CreateApiRequest`	`setGroupId(String groupId)`
`CreateApiRequest`	`setOpenIdConnectConfig(String openIdConnectConfig)`
`CreateApiRequest`	`setRequestConfig(String requestConfig)`
`CreateApiRequest`	`setRequestParameters(String requestParameters)`
`CreateApiRequest`	`setResultBodyModel(String resultBodyModel)`
`CreateApiRequest`	`setResultDescriptions(String resultDescriptions)`
`CreateApiRequest`	`setResultSample(String resultSample)`
`CreateApiRequest`	`setResultType(String resultType)`
`CreateApiRequest`	`setSecurityToken(String securityToken)`
`CreateApiRequest`	`setServiceConfig(String serviceConfig)`
`CreateApiRequest`	`setServiceParameters(String serviceParameters)`
`CreateApiRequest`	`setServiceParametersMap(String serviceParametersMap)`
`CreateApiRequest`	`setSystemParameters(String systemParameters)`
`CreateApiRequest`	`setVisibility(String visibility)`
`CreateApiRequest`	`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
```
    If the **AuthType** is **APP** authentication, you need to pass this value to specify the signature algorithm. If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:
    
    * HmacSHA256
    
    * HmacSHA1,HmacSHA256
  - apiName
```
@NameInMap(value="ApiName")
public String apiName
```
    The name of the API that you want to create. 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 (\_).
  - 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的流量控制。
  - backendEnable
```
@NameInMap(value="BackendEnable")
public Boolean backendEnable
```
    Specifies whether to enable backend services.
  - backendId
```
@NameInMap(value="BackendId")
public String backendId
```
    The IDof the backend service
  - constantParameters
```
@NameInMap(value="ConstantParameters")
public String constantParameters
```
    The parameters of the API.
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the API. The description can be up to 180 characters in length.
  - 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 is lifted. The default value is false when you create an API.
  - 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.
  - 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. The default value is false when you create an API.
  - groupId
```
@NameInMap(value="GroupId")
public String groupId
```
    The ID of the API group.
  - openIdConnectConfig
```
@NameInMap(value="OpenIdConnectConfig")
public String openIdConnectConfig
```
    The switch status of ACL. Valid values:- **on** and **off**.
  - requestConfig
```
@NameInMap(value="RequestConfig")
public String requestConfig
```
    The configuration items of API requests sent by the consumer to API Gateway.
    
    For more information, see [RequestConfig](~~43985~~).
  - 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~~).
  - resultBodyModel
```
@NameInMap(value="ResultBodyModel")
public String resultBodyModel
```
    The return description of the API.
  - resultDescriptions
```
@NameInMap(value="ResultDescriptions")
public String resultDescriptions
```
    The return description of the API.
  - resultSample
```
@NameInMap(value="ResultSample")
public String resultSample
```
    The sample response from the backend service.
  - resultType
```
@NameInMap(value="ResultType")
public String resultType
```
    The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.
  - securityToken
```
@NameInMap(value="SecurityToken")
public String securityToken
```
  - serviceConfig
```
@NameInMap(value="ServiceConfig")
public String serviceConfig
```
    The configuration items of API requests sent by API Gateway to the backend service.
    
    For more information, see [ServiceConfig](~~43987~~).
  - 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~~).
  - systemParameters
```
@NameInMap(value="SystemParameters")
public String systemParameters
```
    The common parameters of APIs in JSON format.
  - 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.
  - webSocketApiType
```
@NameInMap(value="WebSocketApiType")
public String webSocketApiType
```
    The type of the two-way communication API.
    
    * **COMMON**: normal APIs
    
    * **REGISTER**: registered APIs
    
    * **UNREGISTER**: unregistered APIs
    
    * **NOTIFY**: downstream notification APIs
    
    For more information, see [Two-way communication](~~66031~~).
- 构造器详细资料
  - CreateApiRequest
```
public CreateApiRequest()
```
- 方法详细资料
  - build
```
public static CreateApiRequest build(Map<String,?> map)
                              throws Exception
```
    抛出:
    
    Exception
  - setAllowSignatureMethod
```
public CreateApiRequest setAllowSignatureMethod(String allowSignatureMethod)
```
  - getAllowSignatureMethod
```
public String getAllowSignatureMethod()
```
  - setApiName
```
public CreateApiRequest setApiName(String apiName)
```
  - getApiName
```
public String getApiName()
```
  - setAppCodeAuthType
```
public CreateApiRequest setAppCodeAuthType(String appCodeAuthType)
```
  - getAppCodeAuthType
```
public String getAppCodeAuthType()
```
  - setAuthType
```
public CreateApiRequest setAuthType(String authType)
```
  - getAuthType
```
public String getAuthType()
```
  - setBackendEnable
```
public CreateApiRequest setBackendEnable(Boolean backendEnable)
```
  - getBackendEnable
```
public Boolean getBackendEnable()
```
  - setBackendId
```
public CreateApiRequest setBackendId(String backendId)
```
  - getBackendId
```
public String getBackendId()
```
  - setConstantParameters
```
public CreateApiRequest setConstantParameters(String constantParameters)
```
  - getConstantParameters
```
public String getConstantParameters()
```
  - setDescription
```
public CreateApiRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setDisableInternet
```
public CreateApiRequest setDisableInternet(Boolean disableInternet)
```
  - getDisableInternet
```
public Boolean getDisableInternet()
```
  - setErrorCodeSamples
```
public CreateApiRequest setErrorCodeSamples(String errorCodeSamples)
```
  - getErrorCodeSamples
```
public String getErrorCodeSamples()
```
  - setFailResultSample
```
public CreateApiRequest setFailResultSample(String failResultSample)
```
  - getFailResultSample
```
public String getFailResultSample()
```
  - setForceNonceCheck
```
public CreateApiRequest setForceNonceCheck(Boolean forceNonceCheck)
```
  - getForceNonceCheck
```
public Boolean getForceNonceCheck()
```
  - setGroupId
```
public CreateApiRequest setGroupId(String groupId)
```
  - getGroupId
```
public String getGroupId()
```
  - setOpenIdConnectConfig
```
public CreateApiRequest setOpenIdConnectConfig(String openIdConnectConfig)
```
  - getOpenIdConnectConfig
```
public String getOpenIdConnectConfig()
```
  - setRequestConfig
```
public CreateApiRequest setRequestConfig(String requestConfig)
```
  - getRequestConfig
```
public String getRequestConfig()
```
  - setRequestParameters
```
public CreateApiRequest setRequestParameters(String requestParameters)
```
  - getRequestParameters
```
public String getRequestParameters()
```
  - setResultBodyModel
```
public CreateApiRequest setResultBodyModel(String resultBodyModel)
```
  - getResultBodyModel
```
public String getResultBodyModel()
```
  - setResultDescriptions
```
public CreateApiRequest setResultDescriptions(String resultDescriptions)
```
  - getResultDescriptions
```
public String getResultDescriptions()
```
  - setResultSample
```
public CreateApiRequest setResultSample(String resultSample)
```
  - getResultSample
```
public String getResultSample()
```
  - setResultType
```
public CreateApiRequest setResultType(String resultType)
```
  - getResultType
```
public String getResultType()
```
  - setSecurityToken
```
public CreateApiRequest setSecurityToken(String securityToken)
```
  - getSecurityToken
```
public String getSecurityToken()
```
  - setServiceConfig
```
public CreateApiRequest setServiceConfig(String serviceConfig)
```
  - getServiceConfig
```
public String getServiceConfig()
```
  - setServiceParameters
```
public CreateApiRequest setServiceParameters(String serviceParameters)
```
  - getServiceParameters
```
public String getServiceParameters()
```
  - setServiceParametersMap
```
public CreateApiRequest setServiceParametersMap(String serviceParametersMap)
```
  - getServiceParametersMap
```
public String getServiceParametersMap()
```
  - setSystemParameters
```
public CreateApiRequest setSystemParameters(String systemParameters)
```
  - getSystemParameters
```
public String getSystemParameters()
```
  - setVisibility
```
public CreateApiRequest setVisibility(String visibility)
```
  - getVisibility
```
public String getVisibility()
```
  - setWebSocketApiType
```
public CreateApiRequest setWebSocketApiType(String webSocketApiType)
```
  - getWebSocketApiType
```
public String getWebSocketApiType()
```

类 CreateApiRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

allowSignatureMethod

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

构造器详细资料

CreateApiRequest

方法详细资料

build

setAllowSignatureMethod

getAllowSignatureMethod

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

getResultType

setSecurityToken

getSecurityToken