Skip to content

RosApiProps

Properties for defining a RosApi.

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

Initializer 

import { RosApiProps } from '@alicloud/ros-cdk-apigateway'
const rosApiProps: RosApiProps = { ... }

Properties

Name Type Description
apiName string | @alicloud/ros-cdk-core.IResolvable No description.
groupId string | @alicloud/ros-cdk-core.IResolvable No description.
requestConfig @alicloud/ros-cdk-core.IResolvable | RequestConfigProperty No description.
serviceConfig @alicloud/ros-cdk-core.IResolvable | ServiceConfigProperty No description.
visibility string | @alicloud/ros-cdk-core.IResolvable No description.
allowSignatureMethod string | @alicloud/ros-cdk-core.IResolvable No description.
appCodeAuthType string | @alicloud/ros-cdk-core.IResolvable No description.
authType string | @alicloud/ros-cdk-core.IResolvable No description.
constParameters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ConstParametersProperty[] No description.
description string | @alicloud/ros-cdk-core.IResolvable No description.
disableInternet boolean | @alicloud/ros-cdk-core.IResolvable No description.
errorCodeSamples @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ErrorCodeSamplesProperty[] No description.
failResultSample string | @alicloud/ros-cdk-core.IResolvable No description.
forceNonceCheck boolean | @alicloud/ros-cdk-core.IResolvable No description.
openIdConnectConfig @alicloud/ros-cdk-core.IResolvable | OpenIdConnectConfigProperty No description.
requestParameters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | RequestParametersProperty[] No description.
resultBodyModel string | @alicloud/ros-cdk-core.IResolvable No description.
resultDescriptions string | @alicloud/ros-cdk-core.IResolvable No description.
resultSample string | @alicloud/ros-cdk-core.IResolvable No description.
resultType string | @alicloud/ros-cdk-core.IResolvable No description.
serviceParameters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ServiceParametersProperty[] No description.
serviceParametersMap @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ServiceParametersMapProperty[] No description.
systemParameters @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SystemParametersProperty[] No description.
tags TagsProperty[] No description.
webSocketApiType string | @alicloud/ros-cdk-core.IResolvable No description.

apiNameRequired 

public readonly apiName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

groupIdRequired 

public readonly groupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

requestConfigRequired 

public readonly requestConfig: IResolvable | RequestConfigProperty;

serviceConfigRequired 

public readonly serviceConfig: IResolvable | ServiceConfigProperty;

visibilityRequired 

public readonly visibility: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

allowSignatureMethodOptional 

public readonly allowSignatureMethod: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

appCodeAuthTypeOptional 

public readonly appCodeAuthType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

authTypeOptional 

public readonly authType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

constParametersOptional 

public readonly constParameters: IResolvable | IResolvable | ConstParametersProperty[];

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

disableInternetOptional 

public readonly disableInternet: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

errorCodeSamplesOptional 

public readonly errorCodeSamples: IResolvable | IResolvable | ErrorCodeSamplesProperty[];

failResultSampleOptional 

public readonly failResultSample: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

forceNonceCheckOptional 

public readonly forceNonceCheck: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

openIdConnectConfigOptional 

public readonly openIdConnectConfig: IResolvable | OpenIdConnectConfigProperty;

requestParametersOptional 

public readonly requestParameters: IResolvable | IResolvable | RequestParametersProperty[];

resultBodyModelOptional 

public readonly resultBodyModel: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

resultDescriptionsOptional 

public readonly resultDescriptions: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

resultSampleOptional 

public readonly resultSample: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

resultTypeOptional 

public readonly resultType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

serviceParametersOptional 

public readonly serviceParameters: IResolvable | IResolvable | ServiceParametersProperty[];

serviceParametersMapOptional 

public readonly serviceParametersMap: IResolvable | IResolvable | ServiceParametersMapProperty[];

systemParametersOptional 

public readonly systemParameters: IResolvable | IResolvable | SystemParametersProperty[];

tagsOptional 

public readonly tags: TagsProperty[];

webSocketApiTypeOptional 

public readonly webSocketApiType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable