import * as $dara from '@darabonba/typescript'; export declare class DescribeDeployedApiResponseBodyConstantParametersConstantParameter extends $dara.Model { constantValue?: string; description?: string; location?: string; serviceParameterName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyConstantParameters extends $dara.Model { constantParameter?: DescribeDeployedApiResponseBodyConstantParametersConstantParameter[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyCustomSystemParametersCustomSystemParameter extends $dara.Model { demoValue?: string; description?: string; location?: string; parameterName?: string; serviceParameterName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyCustomSystemParameters extends $dara.Model { customSystemParameter?: DescribeDeployedApiResponseBodyCustomSystemParametersCustomSystemParameter[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyErrorCodeSamplesErrorCodeSample extends $dara.Model { code?: string; description?: string; message?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyErrorCodeSamples extends $dara.Model { errorCodeSample?: DescribeDeployedApiResponseBodyErrorCodeSamplesErrorCodeSample[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyOpenIdConnectConfig extends $dara.Model { /** * @remarks * The name of the parameter that corresponds to the token. * * @example * xxx */ idTokenParamName?: string; /** * @remarks * The configuration of OpenID Connect authentication. Valid values: * * * **IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.** * * **BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required. * * @example * IDTOKEN */ openIdApiType?: string; /** * @remarks * The public key of the API. * * @example * EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92 */ publicKey?: string; /** * @remarks * The ID of the public key. * * @example * 88483727556929326703309904351185815489 */ publicKeyId?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyRequestConfig extends $dara.Model { /** * @remarks * This parameter takes effect only when the RequestMode parameter is set to MAPPING. * * The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams. * * @example * STREAM */ bodyFormat?: string; /** * @remarks * The body model. * * @example * https://apigateway.aliyun.com/models/3a240a127dccXXXXXXXX947b4095/9e2df550e85b4121a79XXXXXxaab */ bodyModel?: string; /** * @remarks * The description of the request body. * * @example * fwefwef */ postBodyDescription?: string; /** * @remarks * The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS. * * @example * POST */ requestHttpMethod?: string; /** * @remarks * The request mode. Valid values: * * * MAPPING: Parameters are mapped. Unknown parameters are filtered out. * * PASSTHROUGH: Parameters are passed through. * * MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through. * * @example * MAPPING */ requestMode?: string; /** * @remarks * The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is ` /object/add `. * * @example * /api/billing/test/[type] */ requestPath?: string; /** * @remarks * The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS". * * @example * HTTP */ requestProtocol?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyRequestParametersRequestParameter extends $dara.Model { apiParameterName?: string; arrayItemsType?: string; defaultValue?: string; demoValue?: string; description?: string; docOrder?: number; docShow?: string; enumValue?: string; jsonScheme?: string; location?: string; maxLength?: number; maxValue?: number; minLength?: number; minValue?: number; parameterType?: string; regularExpression?: string; required?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyRequestParameters extends $dara.Model { requestParameter?: DescribeDeployedApiResponseBodyRequestParametersRequestParameter[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyResultDescriptionsResultDescription extends $dara.Model { description?: string; hasChild?: boolean; id?: string; key?: string; mandatory?: boolean; name?: string; pid?: string; type?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyResultDescriptions extends $dara.Model { resultDescription?: DescribeDeployedApiResponseBodyResultDescriptionsResultDescription[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceConfigFunctionComputeConfig extends $dara.Model { /** * @remarks * The ContentType header type used when you call the backend service over HTTP. * * * **DEFAULT: the default header type in API Gateway.** * * **CUSTOM: a custom header type.** * * **CLIENT: the ContentType header type of the client. * * @example * DEFAULT */ contentTypeCatagory?: string; /** * @remarks * The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM. * * @example * application/x-www-form-urlencoded; charset=UTF-8 */ contentTypeValue?: string; /** * @remarks * The root path of Function Compute. * * @example * https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/ */ fcBaseUrl?: string; /** * @remarks * The type of the Function Compute instance. * * @example * HttpTrigger */ fcType?: string; /** * @remarks * The function name defined in Function Compute. * * @example * domain_business_control */ functionName?: string; /** * @remarks * The request method. * * @example * GET */ method?: string; /** * @remarks * The backend only receives the service path. * * @example * false */ onlyBusinessPath?: boolean; /** * @remarks * The API request path. * * @example * /api/offline/cacheData */ path?: string; /** * @remarks * The alias of the function. * * @example * 2 */ qualifier?: string; /** * @remarks * The region where the API is located. * * @example * cn-beijing */ regionId?: string; /** * @remarks * The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute. * * @example * acs:ram::111***:role/aliyunserviceroleforsas */ roleArn?: string; /** * @remarks * The service name defined in Function Compute. * * @example * fcservicename */ serviceName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceConfigMockHeadersMockHeader extends $dara.Model { headerName?: string; headerValue?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceConfigMockHeaders extends $dara.Model { mockHeader?: DescribeDeployedApiResponseBodyServiceConfigMockHeadersMockHeader[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceConfigVpcConfig extends $dara.Model { /** * @remarks * The IDs of the ELB and SLB instances in the VPC. * * @example * i-bp1h497hkijewv2*** */ instanceId?: string; /** * @remarks * The name of the VPC access authorization. * * @example * glmall-app-test */ name?: string; /** * @remarks * The port number that corresponds to the instance. * * @example * 8080 */ port?: number; /** * @remarks * The ID of the VPC. * * @example * vpc-2zeafsc3fygk1*** */ vpcId?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceConfig extends $dara.Model { /** * @remarks * Backend configuration items when the backend service is Function Compute */ functionComputeConfig?: DescribeDeployedApiResponseBodyServiceConfigFunctionComputeConfig; /** * @remarks * Specifies whether to enable the Mock mode. Valid values: * * * **TRUE: The Mock mode is enabled.** * * **FALSE: The Mock mode is not enabled. * * @example * TRUE */ mock?: string; mockHeaders?: DescribeDeployedApiResponseBodyServiceConfigMockHeaders; /** * @remarks * The result returned when the Mock mode is enabled. * * @example * test result */ mockResult?: string; /** * @remarks * The status code returned for service mocking. * * @example * 200 */ mockStatusCode?: number; /** * @remarks * The URL used to call the back-end service. If the complete back-end service URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the value of ServiceAddress is **http://api.a.com:8080**.`` * * @example * http://api.a.com:8080 */ serviceAddress?: string; /** * @remarks * The HTTP method used to call a backend service. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS. * * @example * POST */ serviceHttpMethod?: string; /** * @example * /object/add */ servicePath?: string; /** * @remarks * The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported. * * @example * HTTP */ serviceProtocol?: string; /** * @remarks * The timeout period of the backend service, in millisecond. * * @example * 1000 */ serviceTimeout?: number; /** * @remarks * Specifies whether to enable the VPC channel. Valid values: * * * **TRUE**: The VPC channel is enabled. You must create the corresponding VPC access authorization before you can enable a VPC channel. * * **FALSE**: The VPC channel is not enabled. * * @example * TRUE */ serviceVpcEnable?: string; /** * @remarks * Configuration items related to VPC channels */ vpcConfig?: DescribeDeployedApiResponseBodyServiceConfigVpcConfig; /** * @remarks * The ID of the VPC. * * @example * vpc-uf6kg9x8sx2tbxxxx */ vpcId?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceParametersServiceParameter extends $dara.Model { location?: string; parameterType?: string; serviceParameterName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceParameters extends $dara.Model { serviceParameter?: DescribeDeployedApiResponseBodyServiceParametersServiceParameter[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceParametersMapServiceParameterMap extends $dara.Model { requestParameterName?: string; serviceParameterName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodyServiceParametersMap extends $dara.Model { serviceParameterMap?: DescribeDeployedApiResponseBodyServiceParametersMapServiceParameterMap[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodySystemParametersSystemParameter extends $dara.Model { demoValue?: string; description?: string; location?: string; parameterName?: string; serviceParameterName?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBodySystemParameters extends $dara.Model { systemParameter?: DescribeDeployedApiResponseBodySystemParametersSystemParameter[]; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); } export declare class DescribeDeployedApiResponseBody extends $dara.Model { /** * @remarks * The signature method used by the client. Valid values: * * * HmacSHA256 * * HmacSHA1,HmacSHA256 * * @example * HmacSHA256 */ allowSignatureMethod?: string; /** * @remarks * The ID of the API. * * @example * 4eed13a57d4e42fbb51316be8a5329ff */ apiId?: string; /** * @remarks * The name of the API * * @example * weather */ apiName?: string; /** * @remarks * The security authentication method of the API. Valid values: * * * **APP: Only authorized applications can call the API.** * * * **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:** * * * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies. * * @example * APP */ authType?: string; constantParameters?: DescribeDeployedApiResponseBodyConstantParameters; customSystemParameters?: DescribeDeployedApiResponseBodyCustomSystemParameters; /** * @remarks * The deployment time. Format: yyyy-mm-ddhh:mm:ss. * * @example * 2022-07-25T17:47:51Z */ deployedTime?: string; /** * @remarks * The description. * * @example * Api description */ description?: string; /** * @remarks * * 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. * * > If you do not set this parameter, the original value is not modified. * * @example * true */ disableInternet?: boolean; errorCodeSamples?: DescribeDeployedApiResponseBodyErrorCodeSamples; /** * @remarks * The sample error response from the backend service. * * @example * {"errorCode":"fail","errorMessage":"param invalid"} */ failResultSample?: string; /** * @remarks * * 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. * * @example * true */ forceNonceCheck?: boolean; /** * @remarks * The ID of the API group. * * @example * bc77f5b49c974437a9912ea3755cd834 */ groupId?: string; /** * @remarks * The name of the API group. * * @example * Weather */ groupName?: string; /** * @remarks * The configuration items of the third-party OpenID Connect authentication method. */ openIdConnectConfig?: DescribeDeployedApiResponseBodyOpenIdConnectConfig; /** * @remarks * The region to which the API group belongs. * * @example * cn-beijing */ regionId?: string; /** * @remarks * Configuration items of API requests sent by the consumer to API Gateway. * * For more information, see [RequestConfig](https://help.aliyun.com/document_detail/43985.html). */ requestConfig?: DescribeDeployedApiResponseBodyRequestConfig; /** * @remarks * The ID of the request. * * @example * EF924FE4-2EDD-4CD3-89EC-34E4708574E7 */ requestId?: string; requestParameters?: DescribeDeployedApiResponseBodyRequestParameters; /** * @remarks * The return description of the API. * * @example * {} */ resultBodyModel?: string; resultDescriptions?: DescribeDeployedApiResponseBodyResultDescriptions; /** * @remarks * The sample response from the backend service. * * @example * {code: 200, message:\\"success\\", data: \\"\\"} */ resultSample?: string; /** * @remarks * The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON. * * @example * HTML */ resultType?: string; /** * @remarks * The configuration items of API requests sent by API Gateway to the backend service. * * For more information, see [ServiceConfig](https://help.aliyun.com/document_detail/43987.html). */ serviceConfig?: DescribeDeployedApiResponseBodyServiceConfig; serviceParameters?: DescribeDeployedApiResponseBodyServiceParameters; serviceParametersMap?: DescribeDeployedApiResponseBodyServiceParametersMap; /** * @remarks * The name of the runtime environment. Valid values: * * * **RELEASE** * * **PRE: the pre-release environment** * * **TEST** * * @example * RELEASE */ stageName?: string; systemParameters?: DescribeDeployedApiResponseBodySystemParameters; /** * @remarks * 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. * * @example * PUBLIC */ visibility?: string; static names(): { [key: string]: string; }; static types(): { [key: string]: any; }; validate(): void; constructor(map?: { [key: string]: any; }); }