ApiProps

Properties for defining a Api.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api

Initializer

import com.aliyun.ros.cdk.apigateway.ApiProps;
ApiProps.builder()
    .apiName(java.lang.String)
    .apiName(IResolvable)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .requestConfig(IResolvable)
    .requestConfig(RequestConfigProperty)
    .serviceConfig(IResolvable)
    .serviceConfig(ServiceConfigProperty)
    .visibility(java.lang.String)
    .visibility(IResolvable)
//  .allowSignatureMethod(java.lang.String)
//  .allowSignatureMethod(IResolvable)
//  .appCodeAuthType(java.lang.String)
//  .appCodeAuthType(IResolvable)
//  .authType(java.lang.String)
//  .authType(IResolvable)
//  .constParameters(IResolvable)
//  .constParameters(java.util.List<IResolvable)
//  .constParameters(ConstParametersProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableInternet(java.lang.Boolean)
//  .disableInternet(IResolvable)
//  .errorCodeSamples(IResolvable)
//  .errorCodeSamples(java.util.List<IResolvable)
//  .errorCodeSamples(ErrorCodeSamplesProperty>)
//  .failResultSample(java.lang.String)
//  .failResultSample(IResolvable)
//  .forceNonceCheck(java.lang.Boolean)
//  .forceNonceCheck(IResolvable)
//  .openIdConnectConfig(IResolvable)
//  .openIdConnectConfig(OpenIdConnectConfigProperty)
//  .requestParameters(IResolvable)
//  .requestParameters(java.util.List<IResolvable)
//  .requestParameters(RequestParametersProperty>)
//  .resultBodyModel(java.lang.String)
//  .resultBodyModel(IResolvable)
//  .resultDescriptions(java.lang.String)
//  .resultDescriptions(IResolvable)
//  .resultSample(java.lang.String)
//  .resultSample(IResolvable)
//  .resultType(java.lang.String)
//  .resultType(IResolvable)
//  .serviceParameters(IResolvable)
//  .serviceParameters(java.util.List<IResolvable)
//  .serviceParameters(ServiceParametersProperty>)
//  .serviceParametersMap(IResolvable)
//  .serviceParametersMap(java.util.List<IResolvable)
//  .serviceParametersMap(ServiceParametersMapProperty>)
//  .systemParameters(IResolvable)
//  .systemParameters(java.util.List<IResolvable)
//  .systemParameters(SystemParametersProperty>)
//  .tags(java.util.List<TagsProperty>)
//  .webSocketApiType(java.lang.String)
//  .webSocketApiType(IResolvable)
    .build();

Properties

Name	Type	Description
apiName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.
groupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property groupId: The id of the Group.
requestConfig	com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty	Property requestConfig: The configuration of the request.
serviceConfig	com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty	Property serviceConfig: The configuration of the service.
visibility	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property visibility: Whether to make the API public.
allowSignatureMethod	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
appCodeAuthType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group).
authType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property authType: Type of authorization of the API .
constParameters	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>	Property constParameters: The const parameters.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Description of the API, less than 180 characters.
disableInternet	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property disableInternet: Set DisableInternet to true, only support intranet to call API.
errorCodeSamples	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>	Property errorCodeSamples: The Error Code samples.
failResultSample	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property failResultSample: The sample of the fail result.
forceNonceCheck	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify.
openIdConnectConfig	com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty	Property openIdConnectConfig: The configuration of the open id.
requestParameters	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>	Property requestParameters: The request parameters.
resultBodyModel	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resultBodyModel: The return result of the API.
resultDescriptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resultDescriptions: The return description of the API.
resultSample	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resultSample: The sample of the result.
resultType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".
serviceParameters	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>	Property serviceParameters: The service parameters.
serviceParametersMap	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>	Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.
systemParameters	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>	Property systemParameters: The system parameters.
tags	java.util.List<TagsProperty>	Property tags: Tags to attach to instance.
webSocketApiType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property webSocketApiType: The type of the two-way communication API.

---

apiName^Required

public java.lang.Object getApiName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.

---

groupId^Required

public java.lang.Object getGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupId: The id of the Group.

---

requestConfig^Required

public java.lang.Object getRequestConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR RequestConfigProperty

Property requestConfig: The configuration of the request.

---

serviceConfig^Required

public java.lang.Object getServiceConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR ServiceConfigProperty

Property serviceConfig: The configuration of the service.

---

visibility^Required

public java.lang.Object getVisibility();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property visibility: Whether to make the API public.

"PUBLIC" or "PRIVATE".

---

allowSignatureMethod^Optional

public java.lang.Object getAllowSignatureMethod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property 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

---

appCodeAuthType^Optional

public java.lang.Object getAppCodeAuthType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group).

DISABLE: Not allowed HEADER: Allow AppCode header authentication HEADER_QUERY: Allow AppCode header and query authentication

---

authType^Optional

public java.lang.Object getAuthType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property authType: Type of authorization of the API .

"APP","ANONYMOUS", or "APPOPENID"

---

constParameters^Optional

public java.lang.Object getConstParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConstParametersProperty>

Property constParameters: The const parameters.

---

description^Optional

public java.lang.Object getDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Description of the API, less than 180 characters.

---

disableInternet^Optional

public java.lang.Object getDisableInternet();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property disableInternet: Set DisableInternet to true, only support intranet to call API.

Set DisableInternet to false, then the call is not restricted.

---

errorCodeSamples^Optional

public java.lang.Object getErrorCodeSamples();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListErrorCodeSamplesProperty>

Property errorCodeSamples: The Error Code samples.

---

failResultSample^Optional

public java.lang.Object getFailResultSample();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property failResultSample: The sample of the fail result.

---

forceNonceCheck^Optional

public java.lang.Object getForceNonceCheck();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify.

The API gateway will verify the validity of this parameter after receiving this parameter. The same value can only be used once within 15 minutes. It can effectively prevent API replay attacks. Set ForceNonceCheck to false, then no check.

---

openIdConnectConfig^Optional

public java.lang.Object getOpenIdConnectConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR OpenIdConnectConfigProperty

Property openIdConnectConfig: The configuration of the open id.

---

requestParameters^Optional

public java.lang.Object getRequestParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRequestParametersProperty>

Property requestParameters: The request parameters.

---

resultBodyModel^Optional

public java.lang.Object getResultBodyModel();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resultBodyModel: The return result of the API.

---

resultDescriptions^Optional

public java.lang.Object getResultDescriptions();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resultDescriptions: The return description of the API.

---

resultSample^Optional

public java.lang.Object getResultSample();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resultSample: The sample of the result.

---

resultType^Optional

public java.lang.Object getResultType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".

Default is "JSON".

---

serviceParameters^Optional

public java.lang.Object getServiceParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersProperty>

Property serviceParameters: The service parameters.

---

serviceParametersMap^Optional

public java.lang.Object getServiceParametersMap();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServiceParametersMapProperty>

Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.

---

systemParameters^Optional

public java.lang.Object getSystemParameters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemParametersProperty>

Property systemParameters: The system parameters.

---

tags^Optional

public java.util.List<TagsProperty> getTags();

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

webSocketApiType^Optional

public java.lang.Object getWebSocketApiType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property webSocketApiType: The type of the two-way communication API.

COMMON: common API REGISTER: registered API UNREGISTER: unregistered API NOTIFY: downstream notification API

---