ApiProps

Properties for defining a Api.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Apigateway;
new ApiProps {
    object ApiName,
    object GroupId,
    object RequestConfig,
    object ServiceConfig,
    object Visibility,
    object AllowSignatureMethod = null,
    object AppCodeAuthType = null,
    object AuthType = null,
    object ConstParameters = null,
    object Description = null,
    object DisableInternet = null,
    object ErrorCodeSamples = null,
    object FailResultSample = null,
    object ForceNonceCheck = null,
    object OpenIdConnectConfig = null,
    object RequestParameters = null,
    object ResultBodyModel = null,
    object ResultDescriptions = null,
    object ResultSample = null,
    object ResultType = null,
    object ServiceParameters = null,
    object ServiceParametersMap = null,
    object SystemParameters = null,
    TagsProperty[] Tags = null,
    object WebSocketApiType = null
};

Properties

Name	Type	Description
ApiName	object	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	object	Property groupId: The id of the Group.
RequestConfig	object	Property requestConfig: The configuration of the request.
ServiceConfig	object	Property serviceConfig: The configuration of the service.
Visibility	object	Property visibility: Whether to make the API public.
AllowSignatureMethod	object	Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm.
AppCodeAuthType	object	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	object	Property authType: Type of authorization of the API .
ConstParameters	object	Property constParameters: The const parameters.
Description	object	Property description: Description of the API, less than 180 characters.
DisableInternet	object	Property disableInternet: Set DisableInternet to true, only support intranet to call API.
ErrorCodeSamples	object	Property errorCodeSamples: The Error Code samples.
FailResultSample	object	Property failResultSample: The sample of the fail result.
ForceNonceCheck	object	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	object	Property openIdConnectConfig: The configuration of the open id.
RequestParameters	object	Property requestParameters: The request parameters.
ResultBodyModel	object	Property resultBodyModel: The return result of the API.
ResultDescriptions	object	Property resultDescriptions: The return description of the API.
ResultSample	object	Property resultSample: The sample of the result.
ResultType	object	Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH".
ServiceParameters	object	Property serviceParameters: The service parameters.
ServiceParametersMap	object	Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters.
SystemParameters	object	Property systemParameters: The system parameters.
Tags	TagsProperty[]	Property tags: Tags to attach to instance.
WebSocketApiType	object	Property webSocketApiType: The type of the two-way communication API.

---

ApiName^Required

public object ApiName { get; set; }

• Type: object

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 object GroupId { get; set; }

• Type: object

Property groupId: The id of the Group.

---

RequestConfig^Required

public object RequestConfig { get; set; }

• Type: object

Property requestConfig: The configuration of the request.

---

ServiceConfig^Required

public object ServiceConfig { get; set; }

• Type: object

Property serviceConfig: The configuration of the service.

---

Visibility^Required

public object Visibility { get; set; }

• Type: object

Property visibility: Whether to make the API public.

"PUBLIC" or "PRIVATE".

---

AllowSignatureMethod^Optional

public object AllowSignatureMethod { get; set; }

• Type: object

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 object AppCodeAuthType { get; set; }

• Type: object

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 object AuthType { get; set; }

• Type: object

Property authType: Type of authorization of the API .

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

---

ConstParameters^Optional

public object ConstParameters { get; set; }

• Type: object

Property constParameters: The const parameters.

---

Description^Optional

public object Description { get; set; }

• Type: object

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

---

DisableInternet^Optional

public object DisableInternet { get; set; }

• Type: object

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 object ErrorCodeSamples { get; set; }

• Type: object

Property errorCodeSamples: The Error Code samples.

---

FailResultSample^Optional

public object FailResultSample { get; set; }

• Type: object

Property failResultSample: The sample of the fail result.

---

ForceNonceCheck^Optional

public object ForceNonceCheck { get; set; }

• Type: object

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 object OpenIdConnectConfig { get; set; }

• Type: object

Property openIdConnectConfig: The configuration of the open id.

---

RequestParameters^Optional

public object RequestParameters { get; set; }

• Type: object

Property requestParameters: The request parameters.

---

ResultBodyModel^Optional

public object ResultBodyModel { get; set; }

• Type: object

Property resultBodyModel: The return result of the API.

---

ResultDescriptions^Optional

public object ResultDescriptions { get; set; }

• Type: object

Property resultDescriptions: The return description of the API.

---

ResultSample^Optional

public object ResultSample { get; set; }

• Type: object

Property resultSample: The sample of the result.

---

ResultType^Optional

public object ResultType { get; set; }

• Type: object

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

Default is "JSON".

---

ServiceParameters^Optional

public object ServiceParameters { get; set; }

• Type: object

Property serviceParameters: The service parameters.

---

ServiceParametersMap^Optional

public object ServiceParametersMap { get; set; }

• Type: object

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

---

SystemParameters^Optional

public object SystemParameters { get; set; }

• Type: object

Property systemParameters: The system parameters.

---

Tags^Optional

public TagsProperty[] Tags { get; set; }

• Type: 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 object WebSocketApiType { get; set; }

• Type: object

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

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

---