tencentcloud-sdk-nodejs-intl-en
Version:
15,831 lines • 439 kB
JavaScript
/*
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* Details of API bound to IP policy
* @class
*/
class IPStrategyApiStatus extends AbstractModel {
constructor(){
super();
/**
* Number of APIs bound to environment.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Details of APIs bound to environment.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<IPStrategyApi> || null}
*/
this.ApiIdStatusSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiIdStatusSet) {
this.ApiIdStatusSet = new Array();
for (let z in params.ApiIdStatusSet) {
let obj = new IPStrategyApi();
obj.deserialize(params.ApiIdStatusSet[z]);
this.ApiIdStatusSet.push(obj);
}
}
}
}
/**
* UnBindSubDomain response structure.
* @class
*/
class UnBindSubDomainResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the custom domain name is successfully unbound.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Upstream details
* @class
*/
class UpstreamInfo extends AbstractModel {
constructor(){
super();
/**
* Unique upstream ID
* @type {string || null}
*/
this.UpstreamId = null;
/**
* Upstream name
* @type {string || null}
*/
this.UpstreamName = null;
/**
* Upstream description
* @type {string || null}
*/
this.UpstreamDescription = null;
/**
* Backend protocol. Valid values: `HTTP`, `HTTPS`
* @type {string || null}
*/
this.Scheme = null;
/**
* Load balancing algorithm. Valid value: `ROUND_ROBIN`
* @type {string || null}
*/
this.Algorithm = null;
/**
* Unique VPC ID
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* Number of retry attempts
* @type {number || null}
*/
this.Retries = null;
/**
* Backend nodes
* @type {Array.<UpstreamNode> || null}
*/
this.Nodes = null;
/**
* Creation time.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Label
Note: This field may return `null`, indicating that no valid value was found.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Health check configuration
Note: This field may return `null`, indicating that no valid value was found.
* @type {UpstreamHealthChecker || null}
*/
this.HealthChecker = null;
/**
* Upstream type. Valid values: `IP_PORT`, `K8S`
* @type {string || null}
*/
this.UpstreamType = null;
/**
* Configuration of TKE service
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {Array.<K8sService> || null}
*/
this.K8sServices = null;
/**
* The Host header that the gateway forwards to the upstream
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.UpstreamHost = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
this.UpstreamName = 'UpstreamName' in params ? params.UpstreamName : null;
this.UpstreamDescription = 'UpstreamDescription' in params ? params.UpstreamDescription : null;
this.Scheme = 'Scheme' in params ? params.Scheme : null;
this.Algorithm = 'Algorithm' in params ? params.Algorithm : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.Retries = 'Retries' in params ? params.Retries : null;
if (params.Nodes) {
this.Nodes = new Array();
for (let z in params.Nodes) {
let obj = new UpstreamNode();
obj.deserialize(params.Nodes[z]);
this.Nodes.push(obj);
}
}
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
if (params.HealthChecker) {
let obj = new UpstreamHealthChecker();
obj.deserialize(params.HealthChecker)
this.HealthChecker = obj;
}
this.UpstreamType = 'UpstreamType' in params ? params.UpstreamType : null;
if (params.K8sServices) {
this.K8sServices = new Array();
for (let z in params.K8sServices) {
let obj = new K8sService();
obj.deserialize(params.K8sServices[z]);
this.K8sServices.push(obj);
}
}
this.UpstreamHost = 'UpstreamHost' in params ? params.UpstreamHost : null;
}
}
/**
* UpdateApiKey request structure.
* @class
*/
class UpdateApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the key to be changed.
* @type {string || null}
*/
this.AccessKeyId = null;
/**
* Key to be updated, which is required when a custom key is updated. It can contain 10-50 letters, digits, and underscores.
* @type {string || null}
*/
this.AccessKeySecret = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
this.AccessKeySecret = 'AccessKeySecret' in params ? params.AccessKeySecret : null;
}
}
/**
* Service list display
* @class
*/
class Service extends AbstractModel {
constructor(){
super();
/**
* Port for HTTPS access over private network.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.InnerHttpsPort = null;
/**
* Custom service description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Service frontend request type, such as `http`, `https`, and `http&https`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Protocol = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Network types supported by service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
/**
* Dedicated cluster name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ExclusiveSetName = null;
/**
* Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* IP version.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IpVersion = null;
/**
* List of published environments, such as test, prepub, and release.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.AvailableEnvironments = null;
/**
* Custom service name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Public domain name assigned by the system for this service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.OuterSubDomain = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Port for HTTP access over private network.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.InnerHttpPort = null;
/**
* Private domain name automatically assigned by the system for this service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.InnerSubDomain = null;
/**
* Billing status of service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TradeIsolateStatus = null;
/**
* Tags bound to a service.
Note: this field may return null, indicating that no valid values found.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Dedicated instance
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Cluster type
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.SetType = null;
/**
* Cluster type for service deployment
Note: this field may return null, indicating that no valid values found.
* @type {string || null}
*/
this.DeploymentType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InnerHttpsPort = 'InnerHttpsPort' in params ? params.InnerHttpsPort : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
this.ExclusiveSetName = 'ExclusiveSetName' in params ? params.ExclusiveSetName : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.IpVersion = 'IpVersion' in params ? params.IpVersion : null;
this.AvailableEnvironments = 'AvailableEnvironments' in params ? params.AvailableEnvironments : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.OuterSubDomain = 'OuterSubDomain' in params ? params.OuterSubDomain : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.InnerHttpPort = 'InnerHttpPort' in params ? params.InnerHttpPort : null;
this.InnerSubDomain = 'InnerSubDomain' in params ? params.InnerSubDomain : null;
this.TradeIsolateStatus = 'TradeIsolateStatus' in params ? params.TradeIsolateStatus : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.SetType = 'SetType' in params ? params.SetType : null;
this.DeploymentType = 'DeploymentType' in params ? params.DeploymentType : null;
}
}
/**
* DeleteAPIDoc request structure.
* @class
*/
class DeleteAPIDocRequest extends AbstractModel {
constructor(){
super();
/**
* API document ID.
* @type {string || null}
*/
this.ApiDocId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
}
}
/**
* Information of bound plug-ins
* @class
*/
class AttachedPluginInfo extends AbstractModel {
constructor(){
super();
/**
* Plugin ID
* @type {string || null}
*/
this.PluginId = null;
/**
* Environment information
* @type {string || null}
*/
this.Environment = null;
/**
* Binding time
* @type {string || null}
*/
this.AttachedTime = null;
/**
* Plugin name
* @type {string || null}
*/
this.PluginName = null;
/**
* Plugin type
* @type {string || null}
*/
this.PluginType = null;
/**
* Plugin description
* @type {string || null}
*/
this.Description = null;
/**
* Plugin definition statement
* @type {string || null}
*/
this.PluginData = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.AttachedTime = 'AttachedTime' in params ? params.AttachedTime : null;
this.PluginName = 'PluginName' in params ? params.PluginName : null;
this.PluginType = 'PluginType' in params ? params.PluginType : null;
this.Description = 'Description' in params ? params.Description : null;
this.PluginData = 'PluginData' in params ? params.PluginData : null;
}
}
/**
* List of usage plans bound to API
* @class
*/
class ApiUsagePlanSet extends AbstractModel {
constructor(){
super();
/**
* Total number of usage plans bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of usage plans bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiUsagePlan> || null}
*/
this.ApiUsagePlanList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiUsagePlanList) {
this.ApiUsagePlanList = new Array();
for (let z in params.ApiUsagePlanList) {
let obj = new ApiUsagePlan();
obj.deserialize(params.ApiUsagePlanList[z]);
this.ApiUsagePlanList.push(obj);
}
}
}
}
/**
* DescribeAPIDocDetail request structure.
* @class
*/
class DescribeAPIDocDetailRequest extends AbstractModel {
constructor(){
super();
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
}
}
/**
* Response of API creation
* @class
*/
class CreateApiResultInfo extends AbstractModel {
constructor(){
super();
/**
* API ID
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* Path
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* Request method
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
/**
* Creation time
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
}
}
/**
* ModifyAPIDoc response structure.
* @class
*/
class ModifyAPIDocResponse extends AbstractModel {
constructor(){
super();
/**
* Basic information of API document
* @type {APIDoc || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new APIDoc();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* List of APIs bound with the plugin
* @class
*/
class AttachedApiSummary extends AbstractModel {
constructor(){
super();
/**
* Number of APIs bound with the plugin
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information of the API bound with the plugin
* @type {Array.<AttachedApiInfo> || null}
*/
this.AttachedApis = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.AttachedApis) {
this.AttachedApis = new Array();
for (let z in params.AttachedApis) {
let obj = new AttachedApiInfo();
obj.deserialize(params.AttachedApis[z]);
this.AttachedApis.push(obj);
}
}
}
}
/**
* DescribeUsagePlan request structure.
* @class
*/
class DescribeUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the usage plan to be queried.
* @type {string || null}
*/
this.UsagePlanId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
}
}
/**
* DeleteUsagePlan response structure.
* @class
*/
class DeleteUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ImportOpenApi response structure.
* @class
*/
class ImportOpenApiResponse extends AbstractModel {
constructor(){
super();
/**
* The result of importing the OpenAPI
* @type {CreateApiRspSet || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new CreateApiRspSet();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DisableApiKey response structure.
* @class
*/
class DisableApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the key is successfully disabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApi response structure.
* @class
*/
class DescribeApiResponse extends AbstractModel {
constructor(){
super();
/**
* API details.
* @type {ApiInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceForApiApp request structure.
* @class
*/
class DescribeServiceForApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Service region.
* @type {string || null}
*/
this.ApiRegion = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiRegion = 'ApiRegion' in params ? params.ApiRegion : null;
}
}
/**
* UnReleaseService request structure.
* @class
*/
class UnReleaseServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be deactivated.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Name of the environment to be deactivated. Valid values: test (test environment), prepub (pre-release environment), release (release environment).
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* List of APIs to be deactivated, which is a reserved field.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* DetachPlugin request structure.
* @class
*/
class DetachPluginRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the plugin to be unbound
* @type {string || null}
*/
this.PluginId = null;
/**
* Service ID
* @type {string || null}
*/
this.ServiceId = null;
/**
* API environment
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* ID of the API to unbind from the plugin
* @type {string || null}
*/
this.ApiId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
}
}
/**
* ModifySubDomain request structure.
* @class
*/
class ModifySubDomainRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom domain name whose path mapping is to be modified.
* @type {string || null}
*/
this.SubDomain = null;
/**
* Whether to change to the default path mapping. true: use the default path mapping; false: use the custom path mapping.
* @type {boolean || null}
*/
this.IsDefaultMapping = null;
/**
* Certificate ID, which is required if the HTTPS protocol is included.
* @type {string || null}
*/
this.CertificateId = null;
/**
* Custom domain name protocol type after modification. Valid values: http, https, http&https.
* @type {string || null}
*/
this.Protocol = null;
/**
* Path mapping list after modification.
* @type {Array.<PathMapping> || null}
*/
this.PathMappingSet = null;
/**
* Network type. Valid values: INNER, OUTER.
* @type {string || null}
*/
this.NetType = null;
/**
* Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.
* @type {boolean || null}
*/
this.IsForcedHttps = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SubDomain = 'SubDomain' in params ? params.SubDomain : null;
this.IsDefaultMapping = 'IsDefaultMapping' in params ? params.IsDefaultMapping : null;
this.CertificateId = 'CertificateId' in params ? params.CertificateId : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
if (params.PathMappingSet) {
this.PathMappingSet = new Array();
for (let z in params.PathMappingSet) {
let obj = new PathMapping();
obj.deserialize(params.PathMappingSet[z]);
this.PathMappingSet.push(obj);
}
}
this.NetType = 'NetType' in params ? params.NetType : null;
this.IsForcedHttps = 'IsForcedHttps' in params ? params.IsForcedHttps : null;
}
}
/**
* DescribeApiAppsStatus request structure.
* @class
*/
class DescribeApiAppsStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Number of returned results. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: ApiAppId, ApiAppName, KeyWord (match with `name` or ID).
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DescribeServiceUsagePlan request structure.
* @class
*/
class DescribeServiceUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeServiceEnvironmentList response structure.
* @class
*/
class DescribeServiceEnvironmentListResponse extends AbstractModel {
constructor(){
super();
/**
* Details of environments bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceEnvironmentSet || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceEnvironmentSet();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApiAppBindApisStatus request structure.
* @class
*/
class DescribeApiAppBindApisStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Application ID
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: ApiId, ApiName, ServiceId, Environment, KeyWord (match with `name` or ID).
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* ModifyApi response structure.
* @class
*/
class ModifyApiResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ServiceParameter
* @class
*/
class DescribeApiResultServiceParametersInfo extends AbstractModel {
constructor(){
super();
/**
* API backend service parameter name. This is only applicable when `ServiceType` is `HTTP`. Names of frontend and backend parameters can be different.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Name = null;
/**
* Location of the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`. Configurations of frontend and backend parameters can be different.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Position = null;
/**
* Location of the frontend parameter corresponding to the API backend service parameter, such as `head` This is only applicable when `ServiceType` is `HTTP`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterPosition = null;
/**
* Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when `ServiceType` is `HTTP`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterName = null;
/**
* Default value of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DefaultValue = null;
/**
* Description of API backend service parameter. This is only applicable when `ServiceType` is `HTTP`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterDesc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Position = 'Position' in params ? params.Position : null;
this.RelevantRequestParameterPosition = 'RelevantRequestParameterPosition' in params ? params.RelevantRequestParameterPosition : null;
this.RelevantRequestParameterName = 'RelevantRequestParameterName' in params ? params.RelevantRequestParameterName : null;
this.DefaultValue = 'DefaultValue' in params ? params.DefaultValue : null;
this.RelevantRequestParameterDesc = 'RelevantRequestParameterDesc' in params ? params.RelevantRequestParameterDesc : null;
}
}
/**
* Information of the APIs created
* @class
*/
class CreateApiRspSet extends AbstractModel {
constructor(){
super();
/**
* Total number of APIs
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information of created APIs
* @type {Array.<CreateApiRsp> || null}
*/
this.ApiSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiSet) {
this.ApiSet = new Array();
for (let z in params.ApiSet) {
let obj = new CreateApiRsp();
obj.deserialize(params.ApiSet[z]);
this.ApiSet.push(obj);
}
}
}
}
/**
* API information
* @class
*/
class ApiInfo extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Service name of API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service description of API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* API description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* API name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* API type. Valid values: NORMAL (general API), TSF (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiType = null;
/**
* API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Protocol = null;
/**
* API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthType = null;
/**
* OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Unique ID of the authorization API associated with OAuth business API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* OAuth configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* Whether to enable debugging after purchase (reserved field for the marketplace).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* Request frontend configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {RequestConfig || null}
*/
this.RequestConfig = null;
/**
* Return type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ResponseType = null;
/**
* Sample response for successful custom response configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ResponseSuccessExample = null;
/**
* Sample response for failed custom response configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ResponseFailExample = null;
/**
* Custom error code configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ErrorCodes> || null}
*/
this.ResponseErrorCodes = null;
/**
* Frontend request parameter.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ReqParameter> || null}
*/
this.RequestParameters = null;
/**
* API backend service timeout period in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.ServiceTimeout = null;
/**
* API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceType = null;
/**
* API backend service configuration.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceConfig || null}
*/
this.ServiceConfig = null;
/**
* API backend service parameter.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<DescribeApiResultServiceParametersInfo> || null}
*/
this.ServiceParameters = null;
/**
* Constant parameter.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ConstantParameter> || null}
*/
this.ConstantParameters = null;
/**
* Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceMockReturnMessage = null;
/**
* SCF function name, which takes effect if the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceScfFunctionName = null;
/**
* SCF function namespace, which takes effect if the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceScfFunctionNamespace = null;
/**
* SCF function version, which takes effect if the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceScfFunctionQualifier = null;
/**
* Whether integrated response is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.ServiceScfIsIntegratedResponse = null;
/**
* SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionName = null;
/**
* SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionQualifier = null;
/**
* SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionName = null;
/**
* SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionNamespace = null;
/**
* SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionQualifier = null;
/**
* WebSocket callback address.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.InternalDomain = null;
/**
* SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionName = null;
/**
* SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionQualifier = null;
/**
* List of microservices bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<MicroService> || null}
*/
this.MicroServices = null;
/**
* Microservice details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<number> || null}
*/
this.MicroServicesInfo = null;
/**
* Load balancing configuration of microservice.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {TsfLoadBalanceConfResp || null}
*/
this.ServiceTsfLoadBalanceConf = null;
/**
* Health check configuration of microservice.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {HealthCheckConf || null}
*/
this.ServiceTsfHealthCheckConf = null;
/**
* Whether to enable CORS.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.EnableCORS = null;
/**
* Information of tags bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Environment information published for API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.Environments = null;
/**
* Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF.
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsBase64Encoded = null;
/**
* Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF.
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsBase64Trigger = null;
/**
* Header trigger rules. The number of rules cannot exceed 10.
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {Array.<Base64EncodedTriggerRule> || null}
*/
this.Base64EncodedTriggerRules = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
if (params.RequestConfig) {
let obj = new RequestConfig();
obj.deserialize(params.RequestConfig)
this.RequestConfig = obj;
}
this.ResponseType = 'ResponseType' in params ? params.ResponseType : null;
this.ResponseSuccessExample = 'ResponseSuccessExample' in params ? params.ResponseSuccessExample : null;
this.ResponseFailExample = 'ResponseFailExample' in params ? params.ResponseFailExample : null;
if (params.ResponseErrorCodes) {
this.ResponseErrorCodes = new Array();
for (let z in params.ResponseErrorCodes) {
let obj = new ErrorCodes();
obj.deserialize(params.ResponseErrorCodes[z]);
this.ResponseErrorCodes.push(obj);
}
}
if (params.RequestParameters) {
this.RequestParameters = new Array();
for (let z in params.RequestParameters) {
let obj = new ReqParameter();
obj.deserialize(params.RequestParameters[z]);
this.RequestParameters.push(obj);
}
}
this.ServiceTimeout = 'ServiceTimeout' in params ? params.ServiceTimeout : null;
this.ServiceType = 'ServiceType' in params ? params.ServiceType : null;
if (params.ServiceConfig) {
let obj = new ServiceConfig();
obj.deserialize(params.ServiceConfig)
this.ServiceConfig = obj;
}
if (params.ServiceParameters) {
this.ServiceParameters = new Array();
for (let z in params.ServiceParameters) {
let obj = new DescribeApiResultServiceParametersInfo();
obj.deserialize(params.ServiceParameters[z]);
this.ServiceParameters.push(obj);
}
}
if (params.ConstantParameters) {
this.ConstantParameters = new Array();
for (let z in params.ConstantParameters) {
let obj = new ConstantParameter();
obj.deserialize(params.ConstantParameters[z]);
this.ConstantParameters.push(obj);
}
}
this.ServiceMockReturnMessage = 'ServiceMockReturnMessage' in params ? params.ServiceMockReturnMessage : null;
this.ServiceScfFunctionName = 'ServiceScfFunctionName' in params ? params.ServiceScfFunctionName : null;
this.ServiceScfFunctionNamespace = 'ServiceScfFunctionNamespace' in params ? params.ServiceScfFunctionNamespace : null;
this.ServiceScfFunctionQualifier = 'ServiceScfFunctionQualifier' in params ? params.ServiceScfFunctionQualifier : null;
this.ServiceScfIsIntegratedResponse = 'ServiceScfIsIntegratedResponse' in params ? params.ServiceScfIsIntegratedResponse : null;
this.ServiceWebsocketRegisterFunctionName = 'ServiceWebsocketRegisterFunctionName' in params ? params.ServiceWebsocketRegisterFunctionName : null;
this.ServiceWebsocketRegisterFunctionNamespace = 'ServiceWebsocketRegisterFunctionNamespace' in params ? params.ServiceWebsocketRegisterFunctionNamespace : null;
this.ServiceWebsocketRegisterFunctionQualifier = 'ServiceWebsocketRegisterFunctionQualifier' in params ? params.ServiceWebsocketRegisterFunctionQualifier : null;
this.ServiceWebsocketCleanupFunctionName = 'ServiceWebsocketCleanupFunctionName' in params ? params.ServiceWebsocketCleanupFunctionName : null;
this.ServiceWebsocketCleanupFunctionNamespace = 'ServiceWebsocketCleanupFunctionNamespace' in params ? params.ServiceWebsocketCleanupFunctionNamespace : null;
this.ServiceWebsocketCleanupFunctionQualifier = 'ServiceWebsocketCleanupFunctionQualifier' in params ? params.ServiceWebsocketCleanupFunctionQualifier : null;
this.InternalDomain = 'InternalDomain' in params ? params.InternalDomain : null;
this.ServiceWebsocketTransportFunctionName = 'ServiceWebsocketTransportFunctionName' in params ? params.ServiceWebsocketTransportFunctionName : null;
this.ServiceWebsocketTransportFunctionNamespace = 'ServiceWebsocketTransportFunctionNamespace' in params ? params.ServiceWebsocketTransportFunctionNamespace : null;
this.ServiceWebsocketTransportFunctionQualifier = 'ServiceWebsocketTransportFunctionQualifier' in params ? params.ServiceWebsocketTransportFunctionQualifier : null;
if (params.MicroServices) {
this.MicroServices = new Array();
for (let z in params.MicroServices) {
let obj = new MicroService();
obj.deserialize(params.MicroServices[z]);
this.MicroServices.push(obj);
}
}
this.MicroServicesInfo = 'MicroServicesInfo' in params ? params.MicroServicesInfo : null;
if (params.ServiceTsfLoadBalanceConf) {
let obj = new TsfLoadBalanceConfResp();
obj.deserialize(params.ServiceTsfLoadBalanceConf)
this.ServiceTsfLoadBalanceConf = obj;
}
if (params.ServiceTsfHealthCheckConf) {
let obj = new HealthCheckConf();
obj.deserialize(params.ServiceTsfHealthCheckConf)
this.ServiceTsfHealthCheckConf = obj;
}
this.EnableCORS = 'EnableCORS' in params ? params.EnableCORS : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.Environments = 'Environments' in params ? params.Environments : null;
this.IsBase64Encoded = 'IsBase64Encoded' in params ? params.IsBase64Encoded : null;
this.IsBase64Trigger = 'IsBase64Trigger' in params ? params.IsBase64Trigger : null;
if (params.Base64EncodedTriggerRules) {
this.Base64EncodedTriggerRules = new Array();
for (let z in params.Base64EncodedTriggerRules) {
let obj = new Base64EncodedTriggerRule();
obj.deserialize(params.Base64EncodedTriggerRules[z]);
this.Base64EncodedTriggerRules.push(obj);
}
}
}
}
/**
* TSF Serverless input parameters
* @class
*/
class TargetServicesReq extends AbstractModel {
constructor(){
super();
/**
* VM IP
* @type {string || null}
*/
this.VmIp = null;
/**
* VPC ID
* @type {string || null}
*/
this.VpcId = null;
/**
* VM Port
* @type {number || null}
*/
this.VmPort = null;
/**
* IP of the host where the CVM instance resides
* @type {string || null}
*/
this.HostIp = null;
/**
* Docker IP
* @type {string || null}
*/
this.DockerIp = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.VmIp = 'VmIp' in params ? params.VmIp : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.VmPort = 'VmPort' in params ? params.VmPort : null;
this.HostIp = 'HostIp' in params ? params.HostIp : null;
this.DockerIp = 'DockerIp' in params ? params.DockerIp : null;
}
}
/**
* DescribeUsagePlansStatus request structure.
* @class
*/
class DescribeUsagePlansStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Usage plan filter. Valid values: UsagePlanId, UsagePlanName, NotServiceId, NotApiId, Environment.
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* `TsfLoadBalanceConf` output parameter usage
* @class
*/
class TsfLoadBalanceConfResp extends AbstractModel {
constructor(){
super();
/**
* Whether load balancing is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsLoadBalance = null;
/**
* Load balancing method.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
/**
* Whether session persistence is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.SessionStickRequired = null;
/**
* Session persistence timeout period.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.SessionStickTimeout = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IsLoadBalance = 'IsLoadBalance' in params ? params.IsLoadBalance : null;
this.Method = 'Method' in params ? params.Method : null;
this.SessionStickRequired = 'SessionStickRequired' in params ? params.SessionStickRequired : null;
this.SessionStickTimeout = 'SessionStickTimeout' in params ? params.SessionStickTimeout : null;
}
}
/**
* CreateIPStrategy request structure.
* @class
*/
class CreateIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom policy name.
* @type {string || null}
*/
this.StrategyName = null;
/**
* Policy type. Valid values: WHITE (allowlist), BLACK (blocklist).
* @type {string || null}
*/
this.StrategyType = null;
/**
* Policy details. Multiple IPs are separated with \n.
* @type {string || null}
*/
this.StrategyData = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyName = 'StrategyName' in params ? params.StrategyName : null;
this.StrategyType = 'StrategyType' in params ? params.StrategyType : null;
this.StrategyData = 'StrategyData' in params ? params.StrategyData : null;
}
}
/**
* IP policy
* @class
*/
class IPStrategy extends AbstractModel {
constructor(){
super();
/**
* Unique policy ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Custom policy name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.StrategyName = null;
/**
* Policy type. Valid values: WHITE (allowlist), BLACK (blocklist).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.StrategyType = null;
/**
* IP list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.StrategyData = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Modification time
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of APIs bound to policy.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.BindApiTotalCount = null;
/**
* Bound API details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<DesApisStatus> || null}
*/
this.BindApis = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.StrategyName = 'StrategyName' in params ? params.StrategyName : null;
this.StrategyType = 'StrategyType' in params ? params.StrategyType : null;
this.StrategyData = 'StrategyData' in params ? params.StrategyData : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.BindApiTotalCount = 'BindApiTotalCount' in params ? params.BindApiTotalCount : null;
if (params.BindApis) {
this.BindApis = new Array();
for (let z in params.BindApis) {
let obj = new DesApisStatus();
obj.deserialize(params.BindApis[z]);
this.BindApis.push(obj);
}
}
}
}
/**
* DescribeUsagePlansStatus response structure.
* @class
*/
class DescribeUsagePlansStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Usage plan list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlansStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlansStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Health check configuration, including `TsfHealthCheckConf` and `TargetServicesHealthCheckConf`
* @class
*/
class HealthCheckConf extends AbstractModel {
constructor(){
super();
/**
* Whether health check is enabled.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsHealthCheck = null;
/**
* Health check threshold.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.RequestVolumeThreshold = null;
/**
* Window size.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.SleepWindowInMilliseconds = null;
/**
* Threshold percentage.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.ErrorThresholdPercentage = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IsHealthCheck = 'IsHealthCheck' in params ? params.IsHealthCheck : null;
this.RequestVolumeThreshold = 'RequestVolumeThreshold' in params ? params.RequestVolumeThreshold : null;
this.SleepWindowInMilliseconds = 'SleepWindowInMilliseconds' in params ? params.SleepWindowInMilliseconds : null;
this.ErrorThresholdPercentage = 'ErrorThresholdPercentage' in params ? params.ErrorThresholdPercentage : null;
}
}
/**
* DeleteUpstream request structure.
* @class
*/
class DeleteUpstreamRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the upstream to be deleted
* @type {string || null}
*/
this.UpstreamId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
}
}
/**
* Details of the API Gateway plugin
* @class
*/
class Plugin extends AbstractModel {
constructor(){
super();
/**
* Plugin ID
* @type {string || null}
*/
this.PluginId = null;
/**
* Plugin name
* @type {string || null}
*/
this.PluginName = null;
/**
* Plugin type
* @type {string || null}
*/
this.PluginType = null;
/**
* Plugin definition statement
* @type {string || null}
*/
this.PluginData = null;
/**
* Plugin description
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Description = null;
/**
* Plugin creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Plugin modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Total number of APIs bound with the plugin
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.AttachedApiTotalCount = null;
/**
* Information of the API bound with the plugin
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<AttachedApiInfo> || null}
*/
this.AttachedApis = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.PluginName = 'PluginName' in params ? params.PluginName : null;
this.PluginType = 'PluginType' in params ? params.PluginType : null;
this.PluginData = 'PluginData' in params ? params.PluginData : null;
this.Description = 'Description' in params ? params.Description : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.AttachedApiTotalCount = 'AttachedApiTotalCount' in params ? params.AttachedApiTotalCount : null;
if (params.AttachedApis) {
this.AttachedApis = new Array();
for (let z in params.AttachedApis) {
let obj = new AttachedApiInfo();
obj.deserialize(params.AttachedApis[z]);
this.AttachedApis.push(obj);
}
}
}
}
/**
* UnbindApiApp response structure.
* @class
*/
class UnbindApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Whether unbinding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyUpstream request structure.
* @class
*/
class ModifyUpstreamRequest extends AbstractModel {
constructor(){
super();
/**
* Unique upstream ID
* @type {string || null}
*/
this.UpstreamId = null;
/**
* Upstream name
* @type {string || null}
*/
this.UpstreamName = null;
/**
* Upstream description
* @type {string || null}
*/
this.UpstreamDescription = null;
/**
* Backend protocol. Valid values: `HTTP`, `HTTPS`
* @type {string || null}
*/
this.Scheme = null;
/**
* Upstream access type. Valid values: `IP_PORT`, `K8S`
* @type {string || null}
*/
this.UpstreamType = null;
/**
* Load balancing algorithm. Valid value: `ROUND_ROBIN`
* @type {string || null}
*/
this.Algorithm = null;
/**
* Unique VPC ID.
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* Retry attempts. It defaults to `3`.
* @type {number || null}
*/
this.Retries = null;
/**
* Gateway forwarding to the upstream Host request header
* @type {string || null}
*/
this.UpstreamHost = null;
/**
* List of backend nodes
* @type {Array.<UpstreamNode> || null}
*/
this.Nodes = null;
/**
* Health check configuration
* @type {UpstreamHealthChecker || null}
*/
this.HealthChecker = null;
/**
* Configuration of TKE service
* @type {Array.<K8sService> || null}
*/
this.K8sService = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
this.UpstreamName = 'UpstreamName' in params ? params.UpstreamName : null;
this.UpstreamDescription = 'UpstreamDescription' in params ? params.UpstreamDescription : null;
this.Scheme = 'Scheme' in params ? params.Scheme : null;
this.UpstreamType = 'UpstreamType' in params ? params.UpstreamType : null;
this.Algorithm = 'Algorithm' in params ? params.Algorithm : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.Retries = 'Retries' in params ? params.Retries : null;
this.UpstreamHost = 'UpstreamHost' in params ? params.UpstreamHost : null;
if (params.Nodes) {
this.Nodes = new Array();
for (let z in params.Nodes) {
let obj = new UpstreamNode();
obj.deserialize(params.Nodes[z]);
this.Nodes.push(obj);
}
}
if (params.HealthChecker) {
let obj = new UpstreamHealthChecker();
obj.deserialize(params.HealthChecker)
this.HealthChecker = obj;
}
if (params.K8sService) {
this.K8sService = new Array();
for (let z in params.K8sService) {
let obj = new K8sService();
obj.deserialize(params.K8sService[z]);
this.K8sService.push(obj);
}
}
}
}
/**
* DescribeApiUsagePlan response structure.
* @class
*/
class DescribeApiUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* List of usage plans bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiUsagePlanSet || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiUsagePlanSet();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteIPStrategy request structure.
* @class
*/
class DeleteIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of the IP policy to be deleted.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the IP policy to be deleted.
* @type {string || null}
*/
this.StrategyId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
}
}
/**
* DescribeApiApp request structure.
* @class
*/
class DescribeApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Application ID.
* @type {string || null}
*/
this.ApiAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
}
}
/**
* DescribePlugin response structure.
* @class
*/
class DescribePluginResponse extends AbstractModel {
constructor(){
super();
/**
* Plugin details
* @type {Plugin || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new Plugin();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeUpstreamBindApis request structure.
* @class
*/
class DescribeUpstreamBindApisRequest extends AbstractModel {
constructor(){
super();
/**
* Number of entries per page
* @type {number || null}
*/
this.Limit = null;
/**
* The starting position of paging
* @type {number || null}
*/
this.Offset = null;
/**
* Upstream ID
* @type {string || null}
*/
this.UpstreamId = null;
/**
* Filters the results by `ServiceId` and `ApiId`
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DescribePluginsByApi response structure.
* @class
*/
class DescribePluginsByApiResponse extends AbstractModel {
constructor(){
super();
/**
* List of plug-ins bound with the API
* @type {AttachedPluginSummary || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new AttachedPluginSummary();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Custom service domain name information
* @class
*/
class DomainSets extends AbstractModel {
constructor(){
super();
/**
* Number of custom domain names under service
* @type {number || null}
*/
this.TotalCount = null;
/**
* Custom service domain name list.
* @type {Array.<DomainSetList> || null}
*/
this.DomainSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.DomainSet) {
this.DomainSet = new Array();
for (let z in params.DomainSet) {
let obj = new DomainSetList();
obj.deserialize(params.DomainSet[z]);
this.DomainSet.push(obj);
}
}
}
}
/**
* Configuration of K8s service
* @class
*/
class K8sService extends AbstractModel {
constructor(){
super();
/**
* Weight
* @type {number || null}
*/
this.Weight = null;
/**
* K8s cluster ID
* @type {string || null}
*/
this.ClusterId = null;
/**
* Namespace of the container
* @type {string || null}
*/
this.Namespace = null;
/**
* Name of the service
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service port
* @type {number || null}
*/
this.Port = null;
/**
* The additional Label of the Pod
* @type {Array.<K8sLabel> || null}
*/
this.ExtraLabels = null;
/**
* (Optional) Custom name of the service
* @type {string || null}
*/
this.Name = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Weight = 'Weight' in params ? params.Weight : null;
this.ClusterId = 'ClusterId' in params ? params.ClusterId : null;
this.Namespace = 'Namespace' in params ? params.Namespace : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.Port = 'Port' in params ? params.Port : null;
if (params.ExtraLabels) {
this.ExtraLabels = new Array();
for (let z in params.ExtraLabels) {
let obj = new K8sLabel();
obj.deserialize(params.ExtraLabels[z]);
this.ExtraLabels.push(obj);
}
}
this.Name = 'Name' in params ? params.Name : null;
}
}
/**
* DeleteUsagePlan request structure.
* @class
*/
class DeleteUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the usage plan to be deleted.
* @type {string || null}
*/
this.UsagePlanId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
}
}
/**
* DeleteService request structure.
* @class
*/
class DeleteServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be deleted.
* @type {string || null}
*/
this.ServiceId = null;
/**
* A parameter used to set to skip the deletion precondition verification (only supported for services on dedicated instances).
* @type {number || null}
*/
this.SkipVerification = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SkipVerification = 'SkipVerification' in params ? params.SkipVerification : null;
}
}
/**
* DescribeApiEnvironmentStrategy request structure.
* @class
*/
class DescribeApiEnvironmentStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment list.
* @type {Array.<string> || null}
*/
this.EnvironmentNames = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentNames = 'EnvironmentNames' in params ? params.EnvironmentNames : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* The request header configuration of active upstream health check requests
* @class
*/
class UpstreamHealthCheckerReqHeaders extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* Service environment policy
* @class
*/
class ServiceEnvironmentStrategy extends AbstractModel {
constructor(){
super();
/**
* Environment name.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Access service environment URL.
* @type {string || null}
*/
this.Url = null;
/**
* Release status.
* @type {number || null}
*/
this.Status = null;
/**
* Published version number.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VersionName = null;
/**
* Throttling value.
* @type {number || null}
*/
this.Strategy = null;
/**
* Maximum quota value
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxStrategy = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Url = 'Url' in params ? params.Url : null;
this.Status = 'Status' in params ? params.Status : null;
this.VersionName = 'VersionName' in params ? params.VersionName : null;
this.Strategy = 'Strategy' in params ? params.Strategy : null;
this.MaxStrategy = 'MaxStrategy' in params ? params.MaxStrategy : null;
}
}
/**
* DescribeServiceForApiApp response structure.
* @class
*/
class DescribeServiceForApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Service environment list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.AvailableEnvironments = null;
/**
* Service name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Protocol supported by service. Valid values: http, https, http&https.
* @type {string || null}
*/
this.Protocol = null;
/**
* Service creation time.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Service modification time.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Network type list. INNER: private network access; OUTER: public network access.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
/**
* Subdomain name for private network access.
* @type {string || null}
*/
this.InternalSubDomain = null;
/**
* Subdomain name for public network access.
* @type {string || null}
*/
this.OuterSubDomain = null;
/**
* Service port number for HTTP access over private network.
* @type {number || null}
*/
this.InnerHttpPort = null;
/**
* Port number for HTTPS access over private network.
* @type {number || null}
*/
this.InnerHttpsPort = null;
/**
* Total number of APIs.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.ApiTotalCount = null;
/**
* API list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiIdStatus> || null}
*/
this.ApiIdStatusSet = null;
/**
* Total number of usage plans.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.UsagePlanTotalCount = null;
/**
* Usage plan array.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlan> || null}
*/
this.UsagePlanList = null;
/**
* IP version.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IpVersion = null;
/**
* Service user type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UserType = null;
/**
* Reserved field.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.SetId = null;
/**
* Tag bound to the service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.AvailableEnvironments = 'AvailableEnvironments' in params ? params.AvailableEnvironments : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
this.InternalSubDomain = 'InternalSubDomain' in params ? params.InternalSubDomain : null;
this.OuterSubDomain = 'OuterSubDomain' in params ? params.OuterSubDomain : null;
this.InnerHttpPort = 'InnerHttpPort' in params ? params.InnerHttpPort : null;
this.InnerHttpsPort = 'InnerHttpsPort' in params ? params.InnerHttpsPort : null;
this.ApiTotalCount = 'ApiTotalCount' in params ? params.ApiTotalCount : null;
if (params.ApiIdStatusSet) {
this.ApiIdStatusSet = new Array();
for (let z in params.ApiIdStatusSet) {
let obj = new ApiIdStatus();
obj.deserialize(params.ApiIdStatusSet[z]);
this.ApiIdStatusSet.push(obj);
}
}
this.UsagePlanTotalCount = 'UsagePlanTotalCount' in params ? params.UsagePlanTotalCount : null;
if (params.UsagePlanList) {
this.UsagePlanList = new Array();
for (let z in params.UsagePlanList) {
let obj = new UsagePlan();
obj.deserialize(params.UsagePlanList[z]);
this.UsagePlanList.push(obj);
}
}
this.IpVersion = 'IpVersion' in params ? params.IpVersion : null;
this.UserType = 'UserType' in params ? params.UserType : null;
this.SetId = 'SetId' in params ? params.SetId : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ServiceConfig information
* @class
*/
class ServiceConfig extends AbstractModel {
constructor(){
super();
/**
* The backend type. It’s available when `vpc` is enabled. Values: `clb`, `cvm` and `upstream`.
* @type {string || null}
*/
this.Product = null;
/**
* Unique VPC ID.
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* API backend service URL, which is required if `ServiceType` is `HTTP`.
* @type {string || null}
*/
this.Url = null;
/**
* API backend service path, such as `/path`, which is required if `ServiceType` is `HTTP`. The frontend and backend paths can be different.
* @type {string || null}
*/
this.Path = null;
/**
* API backend service request method, such as `GET`, which is required if `ServiceType` is `HTTP`. The frontend and backend methods can be different
* @type {string || null}
*/
this.Method = null;
/**
* It’s required for `upstream`.
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.UpstreamId = null;
/**
* API backend COS configuration. It’s required if the `ServiceType` is ·`COS`.
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {CosConfig || null}
*/
this.CosConfig = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Product = 'Product' in params ? params.Product : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.Url = 'Url' in params ? params.Url : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
if (params.CosConfig) {
let obj = new CosConfig();
obj.deserialize(params.CosConfig)
this.CosConfig = obj;
}
}
}
/**
* DeleteApiApp response structure.
* @class
*/
class DeleteApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeService response structure.
* @class
*/
class DescribeServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Service environment list.
* @type {Array.<string> || null}
*/
this.AvailableEnvironments = null;
/**
* Service name.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Protocol supported by service. Valid values: http, https, http&https.
* @type {string || null}
*/
this.Protocol = null;
/**
* Service creation time.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Service modification time.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Network type list. INNER: private network access; OUTER: public network access.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
/**
* Subdomain name for private network access.
* @type {string || null}
*/
this.InternalSubDomain = null;
/**
* Subdomain name for public network access.
* @type {string || null}
*/
this.OuterSubDomain = null;
/**
* Service port number for HTTP access over private network.
* @type {number || null}
*/
this.InnerHttpPort = null;
/**
* Port number for HTTPS access over private network.
* @type {number || null}
*/
this.InnerHttpsPort = null;
/**
* Total number of APIs.
* @type {number || null}
*/
this.ApiTotalCount = null;
/**
* API list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiIdStatus> || null}
*/
this.ApiIdStatusSet = null;
/**
* Total number of usage plans.
* @type {number || null}
*/
this.UsagePlanTotalCount = null;
/**
* Usage plan array.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlan> || null}
*/
this.UsagePlanList = null;
/**
* IP version.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IpVersion = null;
/**
* Service user type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UserType = null;
/**
* Reserved field.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.SetId = null;
/**
* Tags bound to a service.
Note: this field may return null, indicating that no valid values found.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Dedicated instance ID
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Dedicated instance name
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.InstanceName = null;
/**
* Cluster type
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.SetType = null;
/**
* Cluster type for service deployment
Note: this field may return null, indicating that no valid values found.
* @type {string || null}
*/
this.DeploymentType = null;
/**
* Whether the service if for special usage. Valid values: `DEFAULT` (general usage), `HTTP_DNS`.
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.SpecialUse = null;
/**
*
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.AvailableEnvironments = 'AvailableEnvironments' in params ? params.AvailableEnvironments : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
this.InternalSubDomain = 'InternalSubDomain' in params ? params.InternalSubDomain : null;
this.OuterSubDomain = 'OuterSubDomain' in params ? params.OuterSubDomain : null;
this.InnerHttpPort = 'InnerHttpPort' in params ? params.InnerHttpPort : null;
this.InnerHttpsPort = 'InnerHttpsPort' in params ? params.InnerHttpsPort : null;
this.ApiTotalCount = 'ApiTotalCount' in params ? params.ApiTotalCount : null;
if (params.ApiIdStatusSet) {
this.ApiIdStatusSet = new Array();
for (let z in params.ApiIdStatusSet) {
let obj = new ApiIdStatus();
obj.deserialize(params.ApiIdStatusSet[z]);
this.ApiIdStatusSet.push(obj);
}
}
this.UsagePlanTotalCount = 'UsagePlanTotalCount' in params ? params.UsagePlanTotalCount : null;
if (params.UsagePlanList) {
this.UsagePlanList = new Array();
for (let z in params.UsagePlanList) {
let obj = new UsagePlan();
obj.deserialize(params.UsagePlanList[z]);
this.UsagePlanList.push(obj);
}
}
this.IpVersion = 'IpVersion' in params ? params.IpVersion : null;
this.UserType = 'UserType' in params ? params.UserType : null;
this.SetId = 'SetId' in params ? params.SetId : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.InstanceName = 'InstanceName' in params ? params.InstanceName : null;
this.SetType = 'SetType' in params ? params.SetType : null;
this.DeploymentType = 'DeploymentType' in params ? params.DeploymentType : null;
this.SpecialUse = 'SpecialUse' in params ? params.SpecialUse : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* List of environments bound to usage plan.
* @class
*/
class UsagePlanEnvironmentStatus extends AbstractModel {
constructor(){
super();
/**
* Number of environments of the service bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Environment status of services bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlanEnvironment> || null}
*/
this.EnvironmentList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.EnvironmentList) {
this.EnvironmentList = new Array();
for (let z in params.EnvironmentList) {
let obj = new UsagePlanEnvironment();
obj.deserialize(params.EnvironmentList[z]);
this.EnvironmentList.push(obj);
}
}
}
}
/**
* ModifyIPStrategy response structure.
* @class
*/
class ModifyIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether modification succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindSubDomain response structure.
* @class
*/
class BindSubDomainResponse extends AbstractModel {
constructor(){
super();
/**
* Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindEnvironment response structure.
* @class
*/
class BindEnvironmentResponse extends AbstractModel {
constructor(){
super();
/**
* Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Information of tag bound to API.
* @class
*/
class Tag extends AbstractModel {
constructor(){
super();
/**
* Tag key
* @type {string || null}
*/
this.Key = null;
/**
* Tag value
* @type {string || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Key = 'Key' in params ? params.Key : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* DescribeApiBindApiAppsStatus response structure.
* @class
*/
class DescribeApiBindApiAppsStatusResponse extends AbstractModel {
constructor(){
super();
/**
* List of APIs bound to the application.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiAppApiInfos || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiAppApiInfos();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Constant parameter
* @class
*/
class ConstantParameter extends AbstractModel {
constructor(){
super();
/**
* Constant parameter name This is only applicable when `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Name = null;
/**
* Constant parameter description This is only applicable when `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Desc = null;
/**
* Constant paramter location This is only applicable when `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Position = null;
/**
* Default value of the constant parameter This is only applicable when `ServiceType` is `HTTP`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DefaultValue = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Desc = 'Desc' in params ? params.Desc : null;
this.Position = 'Position' in params ? params.Position : null;
this.DefaultValue = 'DefaultValue' in params ? params.DefaultValue : null;
}
}
/**
* DescribeApiForApiApp request structure.
* @class
*/
class DescribeApiForApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of the API
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID
* @type {string || null}
*/
this.ApiId = null;
/**
* API region
* @type {string || null}
*/
this.ApiRegion = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiRegion = 'ApiRegion' in params ? params.ApiRegion : null;
}
}
/**
* API document list
* @class
*/
class APIDocs extends AbstractModel {
constructor(){
super();
/**
* Number of API documents
* @type {number || null}
*/
this.TotalCount = null;
/**
* Basic information of API document
* @type {Array.<APIDoc> || null}
*/
this.APIDocSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.APIDocSet) {
this.APIDocSet = new Array();
for (let z in params.APIDocSet) {
let obj = new APIDoc();
obj.deserialize(params.APIDocSet[z]);
this.APIDocSet.push(obj);
}
}
}
}
/**
* Search criterion input parameter
* @class
*/
class LogQuery extends AbstractModel {
constructor(){
super();
/**
* Search field
* @type {string || null}
*/
this.Name = null;
/**
* Operator
* @type {string || null}
*/
this.Operator = null;
/**
* Search value
* @type {string || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Operator = 'Operator' in params ? params.Operator : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* ServiceParameter
* @class
*/
class ServiceParameter extends AbstractModel {
constructor(){
super();
/**
* API backend service parameter name, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names can be different.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Name = null;
/**
* Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions of frontend and backend parameters can be different.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Position = null;
/**
* Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterPosition = null;
/**
* Name of the API frontend parameter corresponding to the backend service parameter, which is used only if `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterName = null;
/**
* Default value of API backend service parameter, which is used only if `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DefaultValue = null;
/**
* API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterDesc = null;
/**
* API backend service parameter type, which is used only if `ServiceType` is `HTTP`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RelevantRequestParameterType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Position = 'Position' in params ? params.Position : null;
this.RelevantRequestParameterPosition = 'RelevantRequestParameterPosition' in params ? params.RelevantRequestParameterPosition : null;
this.RelevantRequestParameterName = 'RelevantRequestParameterName' in params ? params.RelevantRequestParameterName : null;
this.DefaultValue = 'DefaultValue' in params ? params.DefaultValue : null;
this.RelevantRequestParameterDesc = 'RelevantRequestParameterDesc' in params ? params.RelevantRequestParameterDesc : null;
this.RelevantRequestParameterType = 'RelevantRequestParameterType' in params ? params.RelevantRequestParameterType : null;
}
}
/**
* ModifyService response structure.
* @class
*/
class ModifyServiceResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DisableApiKey request structure.
* @class
*/
class DisableApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the key to be disabled.
* @type {string || null}
*/
this.AccessKeyId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
}
}
/**
* Custom domain name path mapping.
* @class
*/
class PathMapping extends AbstractModel {
constructor(){
super();
/**
* Path.
* @type {string || null}
*/
this.Path = null;
/**
* Release environment. Valid values: test, prepub, release.
* @type {string || null}
*/
this.Environment = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Path = 'Path' in params ? params.Path : null;
this.Environment = 'Environment' in params ? params.Environment : null;
}
}
/**
* UnBindIPStrategy response structure.
* @class
*/
class UnBindIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether unbinding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyPlugin request structure.
* @class
*/
class ModifyPluginRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the plugin to be modified
* @type {string || null}
*/
this.PluginId = null;
/**
* Plugin name to be modified. A plugin name can contain up to 50 characters out of `a-z`, `A-Z`, `0-9`, and `_`, which must begin with a letter and end with a letter or a number.
* @type {string || null}
*/
this.PluginName = null;
/**
* Plugin description to be modified. A description is within 200 characters.
* @type {string || null}
*/
this.Description = null;
/**
* Plugin definition statement to be modified. The json format is supported.
* @type {string || null}
*/
this.PluginData = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.PluginName = 'PluginName' in params ? params.PluginName : null;
this.Description = 'Description' in params ? params.Description : null;
this.PluginData = 'PluginData' in params ? params.PluginData : null;
}
}
/**
* BindIPStrategy response structure.
* @class
*/
class BindIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Information of the APIs that can use this plugin
* @class
*/
class AvailableApiInfo extends AbstractModel {
constructor(){
super();
/**
* API ID
* @type {string || null}
*/
this.ApiId = null;
/**
* API name
* @type {string || null}
*/
this.ApiName = null;
/**
* API type
* @type {string || null}
*/
this.ApiType = null;
/**
* API path
* @type {string || null}
*/
this.Path = null;
/**
* API method
* @type {string || null}
*/
this.Method = null;
/**
* Whether the API is bound with another plugin
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.AttachedOtherPlugin = null;
/**
* Whether the API is bound with the current plugin
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsAttached = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.AttachedOtherPlugin = 'AttachedOtherPlugin' in params ? params.AttachedOtherPlugin : null;
this.IsAttached = 'IsAttached' in params ? params.IsAttached : null;
}
}
/**
* DescribeApisStatus request structure.
* @class
*/
class DescribeApisStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* API filter. Valid values: `ApiId`, `ApiName`, `ApiPath`, `ApiType`, `AuthRelationApiId`, `AuthType`, `ApiBuniessType`, `NotUsagePlanId`, `Environment`, `Tags` (whose values are the list of `$tag_key:tag_value`), `TagKeys` (whose values are the list of tag keys). Note that `NotUsagePlanId` and `Environment` must be used in the same time.
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DeleteServiceSubDomainMapping request structure.
* @class
*/
class DeleteServiceSubDomainMappingRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom domain name bound to service.
* @type {string || null}
*/
this.SubDomain = null;
/**
* Name of the environment whose mapping is to be deleted. Valid values: test (test environment), prepub (pre-release environment), release (release environment).
* @type {string || null}
*/
this.Environment = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SubDomain = 'SubDomain' in params ? params.SubDomain : null;
this.Environment = 'Environment' in params ? params.Environment : null;
}
}
/**
* BindApiApp request structure.
* @class
*/
class BindApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the application to be bound.
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Environment to be bound.
* @type {string || null}
*/
this.Environment = null;
/**
* Unique ID of the service to be bound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the API to be bound.
* @type {string || null}
*/
this.ApiId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
}
}
/**
* DescribeIPStrategy response structure.
* @class
*/
class DescribeIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* IP policy details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {IPStrategy || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new IPStrategy();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribePlugin request structure.
* @class
*/
class DescribePluginRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the plugin to be queried
* @type {string || null}
*/
this.PluginId = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* Information of the API bound with the plugin
* @class
*/
class AttachedApiInfo extends AbstractModel {
constructor(){
super();
/**
* ID of the service to which the API belongs
* @type {string || null}
*/
this.ServiceId = null;
/**
* Name of the service to which the API belongs
* @type {string || null}
*/
this.ServiceName = null;
/**
* Description of the service to which the API belongs
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* API ID
* @type {string || null}
*/
this.ApiId = null;
/**
* API name
* @type {string || null}
*/
this.ApiName = null;
/**
* API description
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* Environment of the API bound with the plugin
* @type {string || null}
*/
this.Environment = null;
/**
* Time when the plugin was bound to the API
* @type {string || null}
*/
this.AttachedTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.AttachedTime = 'AttachedTime' in params ? params.AttachedTime : null;
}
}
/**
* CreateApi response structure.
* @class
*/
class CreateApiResponse extends AbstractModel {
constructor(){
super();
/**
* API information
Note: this field may return null, indicating that no valid values can be obtained.
* @type {CreateApiResultInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new CreateApiResultInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeIPStrategyApisStatus request structure.
* @class
*/
class DescribeIPStrategyApisStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique policy ID.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Policy environment.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: ApiPath, ApiName, KeyWord (fuzzy search by `Path` and `Name`).
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* UnBindEnvironment request structure.
* @class
*/
class UnBindEnvironmentRequest extends AbstractModel {
constructor(){
super();
/**
* Binding type. Valid values: API, SERVICE. Default value: SERVICE.
* @type {string || null}
*/
this.BindType = null;
/**
* List of unique IDs of the usage plans to be bound.
* @type {Array.<string> || null}
*/
this.UsagePlanIds = null;
/**
* Service environment to be unbound.
* @type {string || null}
*/
this.Environment = null;
/**
* Unique ID of the service to be unbound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID array, which is required if `BindType` is `API`.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BindType = 'BindType' in params ? params.BindType : null;
this.UsagePlanIds = 'UsagePlanIds' in params ? params.UsagePlanIds : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* The returned result of upstream query
* @class
*/
class DescribeUpstreamInfo extends AbstractModel {
constructor(){
super();
/**
* Total number of results
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of query result
* @type {Array.<UpstreamInfo> || null}
*/
this.UpstreamSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.UpstreamSet) {
this.UpstreamSet = new Array();
for (let z in params.UpstreamSet) {
let obj = new UpstreamInfo();
obj.deserialize(params.UpstreamSet[z]);
this.UpstreamSet.push(obj);
}
}
}
}
/**
* ModifyApiEnvironmentStrategy request structure.
* @class
*/
class ModifyApiEnvironmentStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Throttling value.
* @type {number || null}
*/
this.Strategy = null;
/**
* Environment name.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* API list.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Strategy = 'Strategy' in params ? params.Strategy : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* Service release history
* @class
*/
class ServiceReleaseHistory extends AbstractModel {
constructor(){
super();
/**
* Total number of published versions.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Historical version list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ServiceReleaseHistoryInfo> || null}
*/
this.VersionList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.VersionList) {
this.VersionList = new Array();
for (let z in params.VersionList) {
let obj = new ServiceReleaseHistoryInfo();
obj.deserialize(params.VersionList[z]);
this.VersionList.push(obj);
}
}
}
}
/**
* DescribeUpstreamBindApis response structure.
* @class
*/
class DescribeUpstreamBindApisResponse extends AbstractModel {
constructor(){
super();
/**
* Query results
* @type {DescribeUpstreamBindApis || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new DescribeUpstreamBindApis();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
*
* @class
*/
class IPStrategiesStatus extends AbstractModel {
constructor(){
super();
/**
*
* @type {number || null}
*/
this.TotalCount = null;
/**
*
* @type {Array.<IPStrategy> || null}
*/
this.StrategySet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.StrategySet) {
this.StrategySet = new Array();
for (let z in params.StrategySet) {
let obj = new IPStrategy();
obj.deserialize(params.StrategySet[z]);
this.StrategySet.push(obj);
}
}
}
}
/**
* CreateUsagePlan response structure.
* @class
*/
class CreateUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* Usage plan details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlanInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlanInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Request parameter
* @class
*/
class ReqParameter extends AbstractModel {
constructor(){
super();
/**
* API frontend parameter name.
* @type {string || null}
*/
this.Name = null;
/**
* Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`.
* @type {string || null}
*/
this.Position = null;
/**
* API frontend parameter type, such as `String` and `int`.
* @type {string || null}
*/
this.Type = null;
/**
* Default value of API frontend parameter.
* @type {string || null}
*/
this.DefaultValue = null;
/**
* Whether the API frontend parameter is required. True: yes; False: no.
* @type {boolean || null}
*/
this.Required = null;
/**
* API frontend parameter remarks.
* @type {string || null}
*/
this.Desc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Position = 'Position' in params ? params.Position : null;
this.Type = 'Type' in params ? params.Type : null;
this.DefaultValue = 'DefaultValue' in params ? params.DefaultValue : null;
this.Required = 'Required' in params ? params.Required : null;
this.Desc = 'Desc' in params ? params.Desc : null;
}
}
/**
* DeletePlugin request structure.
* @class
*/
class DeletePluginRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the plugin to be deleted
* @type {string || null}
*/
this.PluginId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
}
}
/**
* Header trigger rule for Base64 encoding.
* @class
*/
class Base64EncodedTriggerRule extends AbstractModel {
constructor(){
super();
/**
* Header for triggering encoding. Valid values are `Accept` and `Content_Type`, corresponding to the `Accept` and `Content-Type` headers in the data stream request, respectively.
* @type {string || null}
*/
this.Name = null;
/**
* Array of header values that can trigger the encoding. Each element in the array can be up to 40 characters, including digits, letters, and special characters (`.`, `+`, `*`, `-`, `/`, and `_`).
For example, [
"application/x-vpeg005",
"application/xhtml+xml",
"application/vnd.ms-project",
"application/vnd.rn-rn_music_package"
] are valid.
* @type {Array.<string> || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* Frontend path configuration
* @class
*/
class RequestConfig extends AbstractModel {
constructor(){
super();
/**
* API path, such as `/path`.
* @type {string || null}
*/
this.Path = null;
/**
* API request method, such as `GET`.
* @type {string || null}
*/
this.Method = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
}
}
/**
* DeleteApiKey response structure.
* @class
*/
class DeleteApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Environment throttling
* @class
*/
class EnvironmentStrategy extends AbstractModel {
constructor(){
super();
/**
* Environment name
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Throttling value
* @type {number || null}
*/
this.Quota = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Quota = 'Quota' in params ? params.Quota : null;
}
}
/**
* `usagePlan` details
* @class
*/
class UsagePlan extends AbstractModel {
constructor(){
super();
/**
* Environment name.
* @type {string || null}
*/
this.Environment = null;
/**
* Unique usage plan ID.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Usage plan name.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Usage plan description.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Usage plan QPS. `-1` indicates no limit.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
/**
* Usage plan time.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Usage plan modification time.
* @type {string || null}
*/
this.ModifiedTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Environment = 'Environment' in params ? params.Environment : null;
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
}
}
/**
* DescribeServiceReleaseVersion request structure.
* @class
*/
class DescribeServiceReleaseVersionRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeUsagePlanSecretIds request structure.
* @class
*/
class DescribeUsagePlanSecretIdsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of bound usage plan.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeLogSearch response structure.
* @class
*/
class DescribeLogSearchResponse extends AbstractModel {
constructor(){
super();
/**
* Cursor for getting more search results. If the value is `""`, there will be no subsequent results
* @type {string || null}
*/
this.ConText = null;
/**
* The returned result contains any number of logs, which are in the following format:
'[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]'
'[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]'
'[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]’
'[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local][req_id:$request_id]';
Note:
app_id: user ID.
env_name: environment name.
service_id: service ID.
http_host: domain name.
api_id: API ID.
uri: request path.
scheme: HTTP/HTTPS protocol.
rsp_st: request response status code.
ups_st: backend business server response status code (if the request is passed through to the backend, this variable will not be empty. If the request is blocked in API Gateway, this variable will be displayed as `-`).
cip: client IP.
uip: backend business service (upstream) IP.
vip: VIP requested to be accessed.
rsp_len: response length.
req_len: request length.
req_t: total request response time.
ups_rsp_t: total backend response time (time between connection establishment by API Gateway and backend response receipt).
ups_conn_t: time when the backend business server is successfully connected to.
ups_head_t: time when the backend response header arrives.
err_msg: error message.
tcp_rtt: client TCP connection information. RTT (Round Trip Time) consists of three parts: link propagation delay, end system processing delay, and queuing delay in router cache.
req_id: request ID.
* @type {Array.<string> || null}
*/
this.LogSet = null;
/**
* Number of logs returned for one search (`TotalCount <= Limit`)
* @type {number || null}
*/
this.TotalCount = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ConText = 'ConText' in params ? params.ConText : null;
this.LogSet = 'LogSet' in params ? params.LogSet : null;
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyAPIDoc request structure.
* @class
*/
class ModifyAPIDocRequest extends AbstractModel {
constructor(){
super();
/**
* API document name
* @type {string || null}
*/
this.ApiDocName = null;
/**
* Service name
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment name
* @type {string || null}
*/
this.Environment = null;
/**
* List of APIs for which to generate documents
* @type {Array.<string> || null}
*/
this.ApiIds = null;
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocName = 'ApiDocName' in params ? params.ApiDocName : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
}
}
/**
* UnBindIPStrategy request structure.
* @class
*/
class UnBindIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be unbound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the IP policy to be unbound.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Environment to be unbound.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* List of APIs to be unbound.
* @type {Array.<string> || null}
*/
this.UnBindApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.UnBindApiIds = 'UnBindApiIds' in params ? params.UnBindApiIds : null;
}
}
/**
* DescribeUpstreams response structure.
* @class
*/
class DescribeUpstreamsResponse extends AbstractModel {
constructor(){
super();
/**
* Query results
* @type {DescribeUpstreamInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new DescribeUpstreamInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribePluginApis request structure.
* @class
*/
class DescribePluginApisRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the plugin to be queried
* @type {string || null}
*/
this.PluginId = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* Error code input parameter
* @class
*/
class ResponseErrorCodeReq extends AbstractModel {
constructor(){
super();
/**
* Custom response configuration error code.
* @type {number || null}
*/
this.Code = null;
/**
* Custom response configuration error message.
* @type {string || null}
*/
this.Msg = null;
/**
* Custom response configuration error code remarks.
* @type {string || null}
*/
this.Desc = null;
/**
* Custom error code conversion.
* @type {number || null}
*/
this.ConvertedCode = null;
/**
* Whether to enable error code conversion.
* @type {boolean || null}
*/
this.NeedConvert = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Code = 'Code' in params ? params.Code : null;
this.Msg = 'Msg' in params ? params.Msg : null;
this.Desc = 'Desc' in params ? params.Desc : null;
this.ConvertedCode = 'ConvertedCode' in params ? params.ConvertedCode : null;
this.NeedConvert = 'NeedConvert' in params ? params.NeedConvert : null;
}
}
/**
* CreateService request structure.
* @class
*/
class CreateServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Custom service name.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service frontend request type, such as `http`, `https`, and `http&https`.
* @type {string || null}
*/
this.Protocol = null;
/**
* Custom service description.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Network type list, which is used to specify the supported network types. INNER: private network access; OUTER: public network access. Default value: OUTER.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
/**
* IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
* @type {string || null}
*/
this.IpVersion = null;
/**
* Cluster name, which is reserved and used by the `tsf serverless` type.
* @type {string || null}
*/
this.SetServerName = null;
/**
* User type, which is reserved and can be used by `serverless` users.
* @type {string || null}
*/
this.AppIdType = null;
/**
* Tag information.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Dedicated instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* VPC attribute
* @type {string || null}
*/
this.UniqVpcId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
this.IpVersion = 'IpVersion' in params ? params.IpVersion : null;
this.SetServerName = 'SetServerName' in params ? params.SetServerName : null;
this.AppIdType = 'AppIdType' in params ? params.AppIdType : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
}
}
/**
* DescribeIPStrategysStatus request structure.
* @class
*/
class DescribeIPStrategysStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Filter. Valid values: StrategyName.
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DemoteServiceUsagePlan response structure.
* @class
*/
class DemoteServiceUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* Whether demotion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribePluginApis response structure.
* @class
*/
class DescribePluginApisResponse extends AbstractModel {
constructor(){
super();
/**
* List of APIs bound with the plugin
* @type {AttachedApiSummary || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new AttachedApiSummary();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* EnableApiKey response structure.
* @class
*/
class EnableApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the key is successfully enabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteApiApp request structure.
* @class
*/
class DeleteApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique application ID.
* @type {string || null}
*/
this.ApiAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
}
}
/**
* UnReleaseService response structure.
* @class
*/
class UnReleaseServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deactivation succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateAPIDoc response structure.
* @class
*/
class CreateAPIDocResponse extends AbstractModel {
constructor(){
super();
/**
* Basic information of API document
* @type {APIDoc || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new APIDoc();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeService request structure.
* @class
*/
class DescribeServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
}
}
/**
* Usage plan list
* @class
*/
class UsagePlansStatus extends AbstractModel {
constructor(){
super();
/**
* Number of eligible usage plans.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Usage plan list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlanStatusInfo> || null}
*/
this.UsagePlanStatusSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.UsagePlanStatusSet) {
this.UsagePlanStatusSet = new Array();
for (let z in params.UsagePlanStatusSet) {
let obj = new UsagePlanStatusInfo();
obj.deserialize(params.UsagePlanStatusSet[z]);
this.UsagePlanStatusSet.push(obj);
}
}
}
}
/**
* CreateUsagePlan request structure.
* @class
*/
class CreateUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Custom usage plan name.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Custom usage plan description.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is `-1`, which indicates no limit.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Limit of requests per second. Valid values: -1, [1,2000]. The default value is `-1`, which indicates no limit.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
}
}
/**
* DescribeUsagePlanSecretIds response structure.
* @class
*/
class DescribeUsagePlanSecretIdsResponse extends AbstractModel {
constructor(){
super();
/**
* List of keys bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlanBindSecretStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlanBindSecretStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreatePlugin request structure.
* @class
*/
class CreatePluginRequest extends AbstractModel {
constructor(){
super();
/**
* Custom plugin name. A plugin name should contain 2-50 characters out of a-z, A-Z, 0-9, and _, which must begin with a letter and end with a letter or a number.
* @type {string || null}
*/
this.PluginName = null;
/**
* Plugin type. Valid values: `IPControl`, `TrafficControl`, `Cors`, `CustomReq`, `CustomAuth`, `Routing`, `TrafficControlByParameter`, `CircuitBreaker`, `ProxyCache`
* @type {string || null}
*/
this.PluginType = null;
/**
* Plugin definition statement in json format
* @type {string || null}
*/
this.PluginData = null;
/**
* Plugin description within 200 characters
* @type {string || null}
*/
this.Description = null;
/**
* Label
* @type {Array.<Tag> || null}
*/
this.Tags = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginName = 'PluginName' in params ? params.PluginName : null;
this.PluginType = 'PluginType' in params ? params.PluginType : null;
this.PluginData = 'PluginData' in params ? params.PluginData : null;
this.Description = 'Description' in params ? params.Description : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
}
}
/**
* TSF type input parameters
* @class
*/
class MicroServiceReq extends AbstractModel {
constructor(){
super();
/**
* Microservice cluster.
* @type {string || null}
*/
this.ClusterId = null;
/**
* Microservice namespace.
* @type {string || null}
*/
this.NamespaceId = null;
/**
* Microservice name.
* @type {string || null}
*/
this.MicroServiceName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ClusterId = 'ClusterId' in params ? params.ClusterId : null;
this.NamespaceId = 'NamespaceId' in params ? params.NamespaceId : null;
this.MicroServiceName = 'MicroServiceName' in params ? params.MicroServiceName : null;
}
}
/**
* ModifySubDomain response structure.
* @class
*/
class ModifySubDomainResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the custom domain name is successfully modified.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeExclusiveInstanceRegions response structure.
* @class
*/
class DescribeExclusiveInstanceRegionsResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindSecretIds request structure.
* @class
*/
class BindSecretIdsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the usage plan to be bound.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Array of IDs of the keys to be bound.
* @type {Array.<string> || null}
*/
this.AccessKeyIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.AccessKeyIds = 'AccessKeyIds' in params ? params.AccessKeyIds : null;
}
}
/**
* UnBindEnvironment response structure.
* @class
*/
class UnBindEnvironmentResponse extends AbstractModel {
constructor(){
super();
/**
* Whether unbinding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Upstream details
* @class
*/
class ModifyUpstreamResultInfo extends AbstractModel {
constructor(){
super();
/**
* Unique upstream ID
* @type {string || null}
*/
this.UpstreamId = null;
/**
* Upstream name
* @type {string || null}
*/
this.UpstreamName = null;
/**
* Upstream description
* @type {string || null}
*/
this.UpstreamDescription = null;
/**
* Backend protocol. Valid values: `HTTP`, `HTTPS`
* @type {string || null}
*/
this.Scheme = null;
/**
* Load balancing algorithm. Valid value: `ROUND_ROBIN`
* @type {string || null}
*/
this.Algorithm = null;
/**
* Unique VPC ID
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* Number of retry attempts
* @type {number || null}
*/
this.Retries = null;
/**
* Backend nodes
* @type {Array.<UpstreamNode> || null}
*/
this.Nodes = null;
/**
* Creation time
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Health check configuration
Note: This field may return null, indicating that no valid values can be obtained.
* @type {UpstreamHealthChecker || null}
*/
this.HealthChecker = null;
/**
* Upstream type. Valid values: `IP_PORT`, `K8S`
* @type {string || null}
*/
this.UpstreamType = null;
/**
* Configuration of TKE service
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<K8sService> || null}
*/
this.K8sServices = null;
/**
* The Host header that the gateway forwards to the upstream
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UpstreamHost = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
this.UpstreamName = 'UpstreamName' in params ? params.UpstreamName : null;
this.UpstreamDescription = 'UpstreamDescription' in params ? params.UpstreamDescription : null;
this.Scheme = 'Scheme' in params ? params.Scheme : null;
this.Algorithm = 'Algorithm' in params ? params.Algorithm : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.Retries = 'Retries' in params ? params.Retries : null;
if (params.Nodes) {
this.Nodes = new Array();
for (let z in params.Nodes) {
let obj = new UpstreamNode();
obj.deserialize(params.Nodes[z]);
this.Nodes.push(obj);
}
}
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
if (params.HealthChecker) {
let obj = new UpstreamHealthChecker();
obj.deserialize(params.HealthChecker)
this.HealthChecker = obj;
}
this.UpstreamType = 'UpstreamType' in params ? params.UpstreamType : null;
if (params.K8sServices) {
this.K8sServices = new Array();
for (let z in params.K8sServices) {
let obj = new K8sService();
obj.deserialize(params.K8sServices[z]);
this.K8sServices.push(obj);
}
}
this.UpstreamHost = 'UpstreamHost' in params ? params.UpstreamHost : null;
}
}
/**
* DeleteApiKey request structure.
* @class
*/
class DeleteApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the key to be deleted.
* @type {string || null}
*/
this.AccessKeyId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
}
}
/**
* API list status description
* @class
*/
class DescribeApisStatusResultInfo extends AbstractModel {
constructor(){
super();
/**
* Number of eligible APIs.
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of APIs
* @type {Array.<DescribeApisStatusResultApiIdStatusSetInfo> || null}
*/
this.ApiIdStatusSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiIdStatusSet) {
this.ApiIdStatusSet = new Array();
for (let z in params.ApiIdStatusSet) {
let obj = new DescribeApisStatusResultApiIdStatusSetInfo();
obj.deserialize(params.ApiIdStatusSet[z]);
this.ApiIdStatusSet.push(obj);
}
}
}
}
/**
* DescribeIPStrategyApisStatus response structure.
* @class
*/
class DescribeIPStrategyApisStatusResponse extends AbstractModel {
constructor(){
super();
/**
* List of APIs bound to environment.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {IPStrategyApiStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new IPStrategyApiStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyApiApp response structure.
* @class
*/
class ModifyApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Whether modification succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpdateApiAppKey request structure.
* @class
*/
class UpdateApiAppKeyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique application ID.
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Application Key.
* @type {string || null}
*/
this.ApiAppKey = null;
/**
* Application Secret.
* @type {string || null}
*/
this.ApiAppSecret = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.ApiAppKey = 'ApiAppKey' in params ? params.ApiAppKey : null;
this.ApiAppSecret = 'ApiAppSecret' in params ? params.ApiAppSecret : null;
}
}
/**
* key-value
* @class
*/
class ApigatewayTags extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* Custom service domain name list
* @class
*/
class DomainSetList extends AbstractModel {
constructor(){
super();
/**
* Domain name.
* @type {string || null}
*/
this.DomainName = null;
/**
* Domain name resolution status. `1`: normal, `0`: failed
* @type {number || null}
*/
this.Status = null;
/**
* Certificate ID.
* @type {string || null}
*/
this.CertificateId = null;
/**
* Whether the default path mapping is used.
* @type {boolean || null}
*/
this.IsDefaultMapping = null;
/**
* Custom domain name protocol type.
* @type {string || null}
*/
this.Protocol = null;
/**
* Network type. Valid values: INNER, OUTER.
* @type {string || null}
*/
this.NetType = null;
/**
* Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.
* @type {boolean || null}
*/
this.IsForcedHttps = null;
/**
* ICP filing status
* @type {boolean || null}
*/
this.RegistrationStatus = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DomainName = 'DomainName' in params ? params.DomainName : null;
this.Status = 'Status' in params ? params.Status : null;
this.CertificateId = 'CertificateId' in params ? params.CertificateId : null;
this.IsDefaultMapping = 'IsDefaultMapping' in params ? params.IsDefaultMapping : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.NetType = 'NetType' in params ? params.NetType : null;
this.IsForcedHttps = 'IsForcedHttps' in params ? params.IsForcedHttps : null;
this.RegistrationStatus = 'RegistrationStatus' in params ? params.RegistrationStatus : null;
}
}
/**
* Service list display
* @class
*/
class ServicesStatus extends AbstractModel {
constructor(){
super();
/**
* Total number of services in list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Service list details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<Service> || null}
*/
this.ServiceSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ServiceSet) {
this.ServiceSet = new Array();
for (let z in params.ServiceSet) {
let obj = new Service();
obj.deserialize(params.ServiceSet[z]);
this.ServiceSet.push(obj);
}
}
}
}
/**
* DescribeApiKey response structure.
* @class
*/
class DescribeApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Key details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiKey || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiKey();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyApiIncrement response structure.
* @class
*/
class ModifyApiIncrementResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyApi request structure.
* @class
*/
class ModifyApiRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
* @type {string || null}
*/
this.ServiceType = null;
/**
* Request frontend configuration.
* @type {RequestConfig || null}
*/
this.RequestConfig = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Custom API name.
* @type {string || null}
*/
this.ApiName = null;
/**
* Custom API description.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* API type. Valid values: NORMAL, TSF. Default value: NORMAL.
* @type {string || null}
*/
this.ApiType = null;
/**
* API authentication type. Valid values: SECRET, NONE, OAUTH, APP. Default value: NONE.
* @type {string || null}
*/
this.AuthType = null;
/**
* Whether signature authentication is required. True: yes; False: no. This parameter is to be disused.
* @type {boolean || null}
*/
this.AuthRequired = null;
/**
* API backend service timeout period in seconds.
* @type {number || null}
*/
this.ServiceTimeout = null;
/**
* API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
* @type {string || null}
*/
this.Protocol = null;
/**
* Whether to enable CORS. True: yes; False: no.
* @type {boolean || null}
*/
this.EnableCORS = null;
/**
* Constant parameter.
* @type {Array.<ConstantParameter> || null}
*/
this.ConstantParameters = null;
/**
* Frontend request parameter.
* @type {Array.<ReqParameter> || null}
*/
this.RequestParameters = null;
/**
* This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
* @type {string || null}
*/
this.ServiceMockReturnMessage = null;
/**
* List of microservices bound to API.
* @type {Array.<MicroServiceReq> || null}
*/
this.MicroServices = null;
/**
* Load balancing configuration of microservice.
* @type {TsfLoadBalanceConfResp || null}
*/
this.ServiceTsfLoadBalanceConf = null;
/**
* Health check configuration of microservice.
* @type {HealthCheckConf || null}
*/
this.ServiceTsfHealthCheckConf = null;
/**
* `target` type load balancing configuration (in beta test).
* @type {number || null}
*/
this.TargetServicesLoadBalanceConf = null;
/**
* `target` health check configuration (in beta test).
* @type {HealthCheckConf || null}
*/
this.TargetServicesHealthCheckConf = null;
/**
* SCF function name, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionName = null;
/**
* SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionName = null;
/**
* SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionName = null;
/**
* SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionName = null;
/**
* SCF function namespace, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionNamespace = null;
/**
* SCF function version, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionQualifier = null;
/**
* SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionQualifier = null;
/**
* SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionQualifier = null;
/**
* SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionNamespace = null;
/**
* SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionQualifier = null;
/**
* Whether to enable response integration, which takes effect if the backend type is `SCF`.
* @type {boolean || null}
*/
this.ServiceScfIsIntegratedResponse = null;
/**
* Billing after debugging starts (reserved field for marketplace).
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* Tag.
* @type {Tag || null}
*/
this.TagSpecifications = null;
/**
* Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
* @type {boolean || null}
*/
this.IsDeleteResponseErrorCodes = null;
/**
* Return type.
* @type {string || null}
*/
this.ResponseType = null;
/**
* Sample response for successful custom response configuration.
* @type {string || null}
*/
this.ResponseSuccessExample = null;
/**
* Sample response for failed custom response configuration.
* @type {string || null}
*/
this.ResponseFailExample = null;
/**
* API backend service configuration.
* @type {ServiceConfig || null}
*/
this.ServiceConfig = null;
/**
* Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* API backend service parameter.
* @type {Array.<ServiceParameter> || null}
*/
this.ServiceParameters = null;
/**
* OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* Custom error code configuration.
* @type {Array.<ResponseErrorCodeReq> || null}
*/
this.ResponseErrorCodes = null;
/**
* Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF.
* @type {boolean || null}
*/
this.IsBase64Encoded = null;
/**
* Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF.
* @type {boolean || null}
*/
this.IsBase64Trigger = null;
/**
* Header trigger rules. The number of rules cannot exceed 10.
* @type {Array.<Base64EncodedTriggerRule> || null}
*/
this.Base64EncodedTriggerRules = null;
/**
* Event bus ID.
* @type {string || null}
*/
this.EventBusId = null;
/**
* SCF function type, which takes effect when the backend type is `SCF`. Valid values: `EVENT` and `HTTP`.
* @type {string || null}
*/
this.ServiceScfFunctionType = null;
/**
* EIAM application type.
* @type {string || null}
*/
this.EIAMAppType = null;
/**
* EIAM application authentication type. Valid values: `AuthenticationOnly`, `Authentication`, `Authorization`.
* @type {string || null}
*/
this.EIAMAuthType = null;
/**
* Validity of the EIAM application token. Unit: second. Default value: `7200`.
* @type {string || null}
*/
this.EIAMAppId = null;
/**
* EIAM application ID.
* @type {number || null}
*/
this.TokenTimeout = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceType = 'ServiceType' in params ? params.ServiceType : null;
if (params.RequestConfig) {
let obj = new RequestConfig();
obj.deserialize(params.RequestConfig)
this.RequestConfig = obj;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.AuthRequired = 'AuthRequired' in params ? params.AuthRequired : null;
this.ServiceTimeout = 'ServiceTimeout' in params ? params.ServiceTimeout : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.EnableCORS = 'EnableCORS' in params ? params.EnableCORS : null;
if (params.ConstantParameters) {
this.ConstantParameters = new Array();
for (let z in params.ConstantParameters) {
let obj = new ConstantParameter();
obj.deserialize(params.ConstantParameters[z]);
this.ConstantParameters.push(obj);
}
}
if (params.RequestParameters) {
this.RequestParameters = new Array();
for (let z in params.RequestParameters) {
let obj = new ReqParameter();
obj.deserialize(params.RequestParameters[z]);
this.RequestParameters.push(obj);
}
}
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.ServiceMockReturnMessage = 'ServiceMockReturnMessage' in params ? params.ServiceMockReturnMessage : null;
if (params.MicroServices) {
this.MicroServices = new Array();
for (let z in params.MicroServices) {
let obj = new MicroServiceReq();
obj.deserialize(params.MicroServices[z]);
this.MicroServices.push(obj);
}
}
if (params.ServiceTsfLoadBalanceConf) {
let obj = new TsfLoadBalanceConfResp();
obj.deserialize(params.ServiceTsfLoadBalanceConf)
this.ServiceTsfLoadBalanceConf = obj;
}
if (params.ServiceTsfHealthCheckConf) {
let obj = new HealthCheckConf();
obj.deserialize(params.ServiceTsfHealthCheckConf)
this.ServiceTsfHealthCheckConf = obj;
}
this.TargetServicesLoadBalanceConf = 'TargetServicesLoadBalanceConf' in params ? params.TargetServicesLoadBalanceConf : null;
if (params.TargetServicesHealthCheckConf) {
let obj = new HealthCheckConf();
obj.deserialize(params.TargetServicesHealthCheckConf)
this.TargetServicesHealthCheckConf = obj;
}
this.ServiceScfFunctionName = 'ServiceScfFunctionName' in params ? params.ServiceScfFunctionName : null;
this.ServiceWebsocketRegisterFunctionName = 'ServiceWebsocketRegisterFunctionName' in params ? params.ServiceWebsocketRegisterFunctionName : null;
this.ServiceWebsocketCleanupFunctionName = 'ServiceWebsocketCleanupFunctionName' in params ? params.ServiceWebsocketCleanupFunctionName : null;
this.ServiceWebsocketTransportFunctionName = 'ServiceWebsocketTransportFunctionName' in params ? params.ServiceWebsocketTransportFunctionName : null;
this.ServiceScfFunctionNamespace = 'ServiceScfFunctionNamespace' in params ? params.ServiceScfFunctionNamespace : null;
this.ServiceScfFunctionQualifier = 'ServiceScfFunctionQualifier' in params ? params.ServiceScfFunctionQualifier : null;
this.ServiceWebsocketRegisterFunctionNamespace = 'ServiceWebsocketRegisterFunctionNamespace' in params ? params.ServiceWebsocketRegisterFunctionNamespace : null;
this.ServiceWebsocketRegisterFunctionQualifier = 'ServiceWebsocketRegisterFunctionQualifier' in params ? params.ServiceWebsocketRegisterFunctionQualifier : null;
this.ServiceWebsocketTransportFunctionNamespace = 'ServiceWebsocketTransportFunctionNamespace' in params ? params.ServiceWebsocketTransportFunctionNamespace : null;
this.ServiceWebsocketTransportFunctionQualifier = 'ServiceWebsocketTransportFunctionQualifier' in params ? params.ServiceWebsocketTransportFunctionQualifier : null;
this.ServiceWebsocketCleanupFunctionNamespace = 'ServiceWebsocketCleanupFunctionNamespace' in params ? params.ServiceWebsocketCleanupFunctionNamespace : null;
this.ServiceWebsocketCleanupFunctionQualifier = 'ServiceWebsocketCleanupFunctionQualifier' in params ? params.ServiceWebsocketCleanupFunctionQualifier : null;
this.ServiceScfIsIntegratedResponse = 'ServiceScfIsIntegratedResponse' in params ? params.ServiceScfIsIntegratedResponse : null;
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
if (params.TagSpecifications) {
let obj = new Tag();
obj.deserialize(params.TagSpecifications)
this.TagSpecifications = obj;
}
this.IsDeleteResponseErrorCodes = 'IsDeleteResponseErrorCodes' in params ? params.IsDeleteResponseErrorCodes : null;
this.ResponseType = 'ResponseType' in params ? params.ResponseType : null;
this.ResponseSuccessExample = 'ResponseSuccessExample' in params ? params.ResponseSuccessExample : null;
this.ResponseFailExample = 'ResponseFailExample' in params ? params.ResponseFailExample : null;
if (params.ServiceConfig) {
let obj = new ServiceConfig();
obj.deserialize(params.ServiceConfig)
this.ServiceConfig = obj;
}
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
if (params.ServiceParameters) {
this.ServiceParameters = new Array();
for (let z in params.ServiceParameters) {
let obj = new ServiceParameter();
obj.deserialize(params.ServiceParameters[z]);
this.ServiceParameters.push(obj);
}
}
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
if (params.ResponseErrorCodes) {
this.ResponseErrorCodes = new Array();
for (let z in params.ResponseErrorCodes) {
let obj = new ResponseErrorCodeReq();
obj.deserialize(params.ResponseErrorCodes[z]);
this.ResponseErrorCodes.push(obj);
}
}
this.IsBase64Encoded = 'IsBase64Encoded' in params ? params.IsBase64Encoded : null;
this.IsBase64Trigger = 'IsBase64Trigger' in params ? params.IsBase64Trigger : null;
if (params.Base64EncodedTriggerRules) {
this.Base64EncodedTriggerRules = new Array();
for (let z in params.Base64EncodedTriggerRules) {
let obj = new Base64EncodedTriggerRule();
obj.deserialize(params.Base64EncodedTriggerRules[z]);
this.Base64EncodedTriggerRules.push(obj);
}
}
this.EventBusId = 'EventBusId' in params ? params.EventBusId : null;
this.ServiceScfFunctionType = 'ServiceScfFunctionType' in params ? params.ServiceScfFunctionType : null;
this.EIAMAppType = 'EIAMAppType' in params ? params.EIAMAppType : null;
this.EIAMAuthType = 'EIAMAuthType' in params ? params.EIAMAuthType : null;
this.EIAMAppId = 'EIAMAppId' in params ? params.EIAMAppId : null;
this.TokenTimeout = 'TokenTimeout' in params ? params.TokenTimeout : null;
}
}
/**
* DescribeAllPluginApis response structure.
* @class
*/
class DescribeAllPluginApisResponse extends AbstractModel {
constructor(){
super();
/**
* List of APIs that ca use this plugin
* @type {ApiInfoSummary || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiInfoSummary();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyUsagePlan request structure.
* @class
*/
class ModifyUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Unique usage plan ID.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Custom usage plan name after modification.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Custom usage plan description after modification.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is `-1`, which indicates no limit.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Limit of requests per second. Valid values: -1, [1,2000]. The default value is `-1`, which indicates no limit.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
}
}
/**
* API request configuration
* @class
*/
class ApiRequestConfig extends AbstractModel {
constructor(){
super();
/**
* path
* @type {string || null}
*/
this.Path = null;
/**
* Method
* @type {string || null}
*/
this.Method = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
}
}
/**
* ModifyService request structure.
* @class
*/
class ModifyServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be modified.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Service name after modification.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Service description after modification.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Service frontend request type after modification, such as `http`, `https`, and `http&https`.
* @type {string || null}
*/
this.Protocol = null;
/**
* Network type list, which is used to specify the supported network types. INNER: private network access; OUTER: public network access. Default value: OUTER.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
}
}
/**
* DescribeAllPluginApis request structure.
* @class
*/
class DescribeAllPluginApisRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the service to be queried
* @type {string || null}
*/
this.ServiceId = null;
/**
* ID of the plugin to be queried
* @type {string || null}
*/
this.PluginId = null;
/**
* Environment information
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* API status
* @class
*/
class ApiIdStatus extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* API description
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* API path.
* @type {string || null}
*/
this.Path = null;
/**
* API method.
* @type {string || null}
*/
this.Method = null;
/**
* Service creation time.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Service modification time.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* API name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* API type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiType = null;
/**
* API protocol.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Protocol = null;
/**
* Whether to enable debugging after purchase.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* Authorization type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthType = null;
/**
* API business type.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Unique ID of associated authorization API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* List of business APIs associated with authorization API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.RelationBuniessApiIds = null;
/**
* OAuth configuration information.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* Token storage position, which is an OAuth 2.0 API request.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.TokenLocation = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
this.RelationBuniessApiIds = 'RelationBuniessApiIds' in params ? params.RelationBuniessApiIds : null;
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
this.TokenLocation = 'TokenLocation' in params ? params.TokenLocation : null;
}
}
/**
* CreateApi request structure.
* @class
*/
class CreateApiRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* API backend service type. Valid values: HTTP, MOCK, TSF, SCF, WEBSOCKET, TARGET (in beta test).
* @type {string || null}
*/
this.ServiceType = null;
/**
* API backend service timeout period in seconds.
* @type {number || null}
*/
this.ServiceTimeout = null;
/**
* API frontend request protocol. Valid values: HTTPS, WEBSOCKET.
* @type {string || null}
*/
this.Protocol = null;
/**
* Request frontend configuration.
* @type {ApiRequestConfig || null}
*/
this.RequestConfig = null;
/**
* Custom API name.
* @type {string || null}
*/
this.ApiName = null;
/**
* Custom API description.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
* @type {string || null}
*/
this.ApiType = null;
/**
* API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH, APP (application authentication). Default value: NONE.
* @type {string || null}
*/
this.AuthType = null;
/**
* Whether to enable CORS.
* @type {boolean || null}
*/
this.EnableCORS = null;
/**
* Constant parameter.
* @type {Array.<ConstantParameter> || null}
*/
this.ConstantParameters = null;
/**
* Frontend request parameter.
* @type {Array.<RequestParameter> || null}
*/
this.RequestParameters = null;
/**
* This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Returned message of API backend Mock, which is required if `ServiceType` is `Mock`.
* @type {string || null}
*/
this.ServiceMockReturnMessage = null;
/**
* List of microservices bound to API.
* @type {Array.<MicroServiceReq> || null}
*/
this.MicroServices = null;
/**
* Load balancing configuration of microservice.
* @type {TsfLoadBalanceConfResp || null}
*/
this.ServiceTsfLoadBalanceConf = null;
/**
* Health check configuration of microservice.
* @type {HealthCheckConf || null}
*/
this.ServiceTsfHealthCheckConf = null;
/**
* `target` type backend resource information (in beta test).
* @type {Array.<TargetServicesReq> || null}
*/
this.TargetServices = null;
/**
* `target` type load balancing configuration (in beta test).
* @type {number || null}
*/
this.TargetServicesLoadBalanceConf = null;
/**
* `target` health check configuration (in beta test).
* @type {HealthCheckConf || null}
*/
this.TargetServicesHealthCheckConf = null;
/**
* SCF function name, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionName = null;
/**
* SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionName = null;
/**
* SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionName = null;
/**
* SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionName = null;
/**
* SCF function namespace, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionNamespace = null;
/**
* SCF function version, which takes effect if the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceScfFunctionQualifier = null;
/**
* SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketRegisterFunctionQualifier = null;
/**
* SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionNamespace = null;
/**
* SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketTransportFunctionQualifier = null;
/**
* SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionNamespace = null;
/**
* SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`.
* @type {string || null}
*/
this.ServiceWebsocketCleanupFunctionQualifier = null;
/**
* Whether to enable response integration, which takes effect if the backend type is `SCF`.
* @type {boolean || null}
*/
this.ServiceScfIsIntegratedResponse = null;
/**
* Billing after debugging starts (reserved field for marketplace).
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted.
* @type {boolean || null}
*/
this.IsDeleteResponseErrorCodes = null;
/**
* Return type.
* @type {string || null}
*/
this.ResponseType = null;
/**
* Sample response for successful custom response configuration.
* @type {string || null}
*/
this.ResponseSuccessExample = null;
/**
* Sample response for failed custom response configuration.
* @type {string || null}
*/
this.ResponseFailExample = null;
/**
* API backend service configuration.
* @type {ServiceConfig || null}
*/
this.ServiceConfig = null;
/**
* Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* API backend service parameter.
* @type {Array.<ServiceParameter> || null}
*/
this.ServiceParameters = null;
/**
* OAuth configuration, which takes effect if `AuthType` is `OAUTH`.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* Custom error code configuration.
* @type {Array.<ResponseErrorCodeReq> || null}
*/
this.ResponseErrorCodes = null;
/**
* TSF Serverless namespace ID (in beta test).
* @type {string || null}
*/
this.TargetNamespaceId = null;
/**
* User type.
* @type {string || null}
*/
this.UserType = null;
/**
* Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF.
* @type {boolean || null}
*/
this.IsBase64Encoded = null;
/**
* Event bus ID.
* @type {string || null}
*/
this.EventBusId = null;
/**
* SCF function type, which takes effect if the backend type is `SCF`. Valid values: `EVENT` and `HTTP`.
* @type {string || null}
*/
this.ServiceScfFunctionType = null;
/**
* EIAM application type.
* @type {string || null}
*/
this.EIAMAppType = null;
/**
* EIAM application authentication type. Valid values: `AuthenticationOnly`, `Authentication`, `Authorization`.
* @type {string || null}
*/
this.EIAMAuthType = null;
/**
* Validity of the EIAM application token. Unit: second. Default value: `7200`.
* @type {number || null}
*/
this.TokenTimeout = null;
/**
* EIAM application ID.
* @type {string || null}
*/
this.EIAMAppId = null;
/**
* Owner of the resource
* @type {string || null}
*/
this.Owner = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceType = 'ServiceType' in params ? params.ServiceType : null;
this.ServiceTimeout = 'ServiceTimeout' in params ? params.ServiceTimeout : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
if (params.RequestConfig) {
let obj = new ApiRequestConfig();
obj.deserialize(params.RequestConfig)
this.RequestConfig = obj;
}
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.EnableCORS = 'EnableCORS' in params ? params.EnableCORS : null;
if (params.ConstantParameters) {
this.ConstantParameters = new Array();
for (let z in params.ConstantParameters) {
let obj = new ConstantParameter();
obj.deserialize(params.ConstantParameters[z]);
this.ConstantParameters.push(obj);
}
}
if (params.RequestParameters) {
this.RequestParameters = new Array();
for (let z in params.RequestParameters) {
let obj = new RequestParameter();
obj.deserialize(params.RequestParameters[z]);
this.RequestParameters.push(obj);
}
}
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.ServiceMockReturnMessage = 'ServiceMockReturnMessage' in params ? params.ServiceMockReturnMessage : null;
if (params.MicroServices) {
this.MicroServices = new Array();
for (let z in params.MicroServices) {
let obj = new MicroServiceReq();
obj.deserialize(params.MicroServices[z]);
this.MicroServices.push(obj);
}
}
if (params.ServiceTsfLoadBalanceConf) {
let obj = new TsfLoadBalanceConfResp();
obj.deserialize(params.ServiceTsfLoadBalanceConf)
this.ServiceTsfLoadBalanceConf = obj;
}
if (params.ServiceTsfHealthCheckConf) {
let obj = new HealthCheckConf();
obj.deserialize(params.ServiceTsfHealthCheckConf)
this.ServiceTsfHealthCheckConf = obj;
}
if (params.TargetServices) {
this.TargetServices = new Array();
for (let z in params.TargetServices) {
let obj = new TargetServicesReq();
obj.deserialize(params.TargetServices[z]);
this.TargetServices.push(obj);
}
}
this.TargetServicesLoadBalanceConf = 'TargetServicesLoadBalanceConf' in params ? params.TargetServicesLoadBalanceConf : null;
if (params.TargetServicesHealthCheckConf) {
let obj = new HealthCheckConf();
obj.deserialize(params.TargetServicesHealthCheckConf)
this.TargetServicesHealthCheckConf = obj;
}
this.ServiceScfFunctionName = 'ServiceScfFunctionName' in params ? params.ServiceScfFunctionName : null;
this.ServiceWebsocketRegisterFunctionName = 'ServiceWebsocketRegisterFunctionName' in params ? params.ServiceWebsocketRegisterFunctionName : null;
this.ServiceWebsocketCleanupFunctionName = 'ServiceWebsocketCleanupFunctionName' in params ? params.ServiceWebsocketCleanupFunctionName : null;
this.ServiceWebsocketTransportFunctionName = 'ServiceWebsocketTransportFunctionName' in params ? params.ServiceWebsocketTransportFunctionName : null;
this.ServiceScfFunctionNamespace = 'ServiceScfFunctionNamespace' in params ? params.ServiceScfFunctionNamespace : null;
this.ServiceScfFunctionQualifier = 'ServiceScfFunctionQualifier' in params ? params.ServiceScfFunctionQualifier : null;
this.ServiceWebsocketRegisterFunctionNamespace = 'ServiceWebsocketRegisterFunctionNamespace' in params ? params.ServiceWebsocketRegisterFunctionNamespace : null;
this.ServiceWebsocketRegisterFunctionQualifier = 'ServiceWebsocketRegisterFunctionQualifier' in params ? params.ServiceWebsocketRegisterFunctionQualifier : null;
this.ServiceWebsocketTransportFunctionNamespace = 'ServiceWebsocketTransportFunctionNamespace' in params ? params.ServiceWebsocketTransportFunctionNamespace : null;
this.ServiceWebsocketTransportFunctionQualifier = 'ServiceWebsocketTransportFunctionQualifier' in params ? params.ServiceWebsocketTransportFunctionQualifier : null;
this.ServiceWebsocketCleanupFunctionNamespace = 'ServiceWebsocketCleanupFunctionNamespace' in params ? params.ServiceWebsocketCleanupFunctionNamespace : null;
this.ServiceWebsocketCleanupFunctionQualifier = 'ServiceWebsocketCleanupFunctionQualifier' in params ? params.ServiceWebsocketCleanupFunctionQualifier : null;
this.ServiceScfIsIntegratedResponse = 'ServiceScfIsIntegratedResponse' in params ? params.ServiceScfIsIntegratedResponse : null;
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
this.IsDeleteResponseErrorCodes = 'IsDeleteResponseErrorCodes' in params ? params.IsDeleteResponseErrorCodes : null;
this.ResponseType = 'ResponseType' in params ? params.ResponseType : null;
this.ResponseSuccessExample = 'ResponseSuccessExample' in params ? params.ResponseSuccessExample : null;
this.ResponseFailExample = 'ResponseFailExample' in params ? params.ResponseFailExample : null;
if (params.ServiceConfig) {
let obj = new ServiceConfig();
obj.deserialize(params.ServiceConfig)
this.ServiceConfig = obj;
}
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
if (params.ServiceParameters) {
this.ServiceParameters = new Array();
for (let z in params.ServiceParameters) {
let obj = new ServiceParameter();
obj.deserialize(params.ServiceParameters[z]);
this.ServiceParameters.push(obj);
}
}
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
if (params.ResponseErrorCodes) {
this.ResponseErrorCodes = new Array();
for (let z in params.ResponseErrorCodes) {
let obj = new ResponseErrorCodeReq();
obj.deserialize(params.ResponseErrorCodes[z]);
this.ResponseErrorCodes.push(obj);
}
}
this.TargetNamespaceId = 'TargetNamespaceId' in params ? params.TargetNamespaceId : null;
this.UserType = 'UserType' in params ? params.UserType : null;
this.IsBase64Encoded = 'IsBase64Encoded' in params ? params.IsBase64Encoded : null;
this.EventBusId = 'EventBusId' in params ? params.EventBusId : null;
this.ServiceScfFunctionType = 'ServiceScfFunctionType' in params ? params.ServiceScfFunctionType : null;
this.EIAMAppType = 'EIAMAppType' in params ? params.EIAMAppType : null;
this.EIAMAuthType = 'EIAMAuthType' in params ? params.EIAMAuthType : null;
this.TokenTimeout = 'TokenTimeout' in params ? params.TokenTimeout : null;
this.EIAMAppId = 'EIAMAppId' in params ? params.EIAMAppId : null;
this.Owner = 'Owner' in params ? params.Owner : null;
}
}
/**
* DescribeServiceEnvironmentStrategy request structure.
* @class
*/
class DescribeServiceEnvironmentStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeInstancesNetworkConfig response structure.
* @class
*/
class DescribeInstancesNetworkConfigResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ReleaseService request structure.
* @class
*/
class ReleaseServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be published.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Name of the environment to be published. Valid values: test (test environment), prepub (pre-release environment), release (release environment).
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Release description.
* @type {string || null}
*/
this.ReleaseDesc = null;
/**
* `apiId` list, which is reserved. Full API release is used by default.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ReleaseDesc = 'ReleaseDesc' in params ? params.ReleaseDesc : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* DeleteService response structure.
* @class
*/
class DeleteServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceEnvironmentReleaseHistory response structure.
* @class
*/
class DescribeServiceEnvironmentReleaseHistoryResponse extends AbstractModel {
constructor(){
super();
/**
* Service release history.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceReleaseHistory || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceReleaseHistory();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Information of service release environment.
* @class
*/
class Environment extends AbstractModel {
constructor(){
super();
/**
* Environment name.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Access path.
* @type {string || null}
*/
this.Url = null;
/**
* Release status. 1: published. 0: not published.
* @type {number || null}
*/
this.Status = null;
/**
* Running version.
* @type {string || null}
*/
this.VersionName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Url = 'Url' in params ? params.Url : null;
this.Status = 'Status' in params ? params.Status : null;
this.VersionName = 'VersionName' in params ? params.VersionName : null;
}
}
/**
* DescribeAPIDocs request structure.
* @class
*/
class DescribeAPIDocsRequest extends AbstractModel {
constructor(){
super();
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribePluginsByApi request structure.
* @class
*/
class DescribePluginsByApiRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the API to query
* @type {string || null}
*/
this.ApiId = null;
/**
* ID of the service to query
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment information
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* Service release list details
* @class
*/
class ServiceReleaseHistoryInfo extends AbstractModel {
constructor(){
super();
/**
* Version ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VersionName = null;
/**
* Version description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VersionDesc = null;
/**
* Version release time.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ReleaseTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.VersionName = 'VersionName' in params ? params.VersionName : null;
this.VersionDesc = 'VersionDesc' in params ? params.VersionDesc : null;
this.ReleaseTime = 'ReleaseTime' in params ? params.ReleaseTime : null;
}
}
/**
* CreatePlugin response structure.
* @class
*/
class CreatePluginResponse extends AbstractModel {
constructor(){
super();
/**
* Details of the new plugin
* @type {Plugin || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new Plugin();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Key bound to usage plan
* @class
*/
class UsagePlanBindSecret extends AbstractModel {
constructor(){
super();
/**
* Key ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AccessKeyId = null;
/**
* Key name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.SecretName = null;
/**
* Key status. 0: disabled. 1: enabled.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.Status = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
this.SecretName = 'SecretName' in params ? params.SecretName : null;
this.Status = 'Status' in params ? params.Status : null;
}
}
/**
* K8s Label
* @class
*/
class K8sLabel extends AbstractModel {
constructor(){
super();
/**
* Key of the label
* @type {string || null}
*/
this.Key = null;
/**
* Value of the label
* @type {string || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Key = 'Key' in params ? params.Key : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* ReleaseService response structure.
* @class
*/
class ReleaseServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Release information.
* @type {ReleaseService || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ReleaseService();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* API document details
* @class
*/
class APIDocInfo extends AbstractModel {
constructor(){
super();
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
/**
* API document name
* @type {string || null}
*/
this.ApiDocName = null;
/**
* API document build status
* @type {string || null}
*/
this.ApiDocStatus = null;
/**
* Number of APIs with API documents
* @type {number || null}
*/
this.ApiCount = null;
/**
* Number of views of API document
* @type {number || null}
*/
this.ViewCount = null;
/**
* Number of releases of API document
* @type {number || null}
*/
this.ReleaseCount = null;
/**
* API document access URI
* @type {string || null}
*/
this.ApiDocUri = null;
/**
* API document password for sharing
* @type {string || null}
*/
this.SharePassword = null;
/**
* API document update time
* @type {string || null}
*/
this.UpdatedTime = null;
/**
* Service ID
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment information
* @type {string || null}
*/
this.Environment = null;
/**
* ID of the API for which to generate the API document
* @type {Array.<string> || null}
*/
this.ApiIds = null;
/**
* Service name
* @type {string || null}
*/
this.ServiceName = null;
/**
* Name of the API for which to generate the API document
* @type {Array.<string> || null}
*/
this.ApiNames = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
this.ApiDocName = 'ApiDocName' in params ? params.ApiDocName : null;
this.ApiDocStatus = 'ApiDocStatus' in params ? params.ApiDocStatus : null;
this.ApiCount = 'ApiCount' in params ? params.ApiCount : null;
this.ViewCount = 'ViewCount' in params ? params.ViewCount : null;
this.ReleaseCount = 'ReleaseCount' in params ? params.ReleaseCount : null;
this.ApiDocUri = 'ApiDocUri' in params ? params.ApiDocUri : null;
this.SharePassword = 'SharePassword' in params ? params.SharePassword : null;
this.UpdatedTime = 'UpdatedTime' in params ? params.UpdatedTime : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ApiNames = 'ApiNames' in params ? params.ApiNames : null;
}
}
/**
* COS-type API configuration
* @class
*/
class CosConfig extends AbstractModel {
constructor(){
super();
/**
* Specifies how the backend COS bucket is called by the API. The frontend request method and Action can be:
GET:GetObject
PUT:PutObject
POST:PostObject、AppendObject
HEAD: HeadObject
DELETE: DeleteObject
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Action = null;
/**
* Backend COS bucket of the API
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.BucketName = null;
/**
* Whether to enable the backend COS signature for the API. It defaults to `false`.
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Authorization = null;
/**
* The path matching mode of the backend COS service
`BackEndPath`: Match the backend path
`FullPath`: Match the full path
Default: `BackEndPath`
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PathMatchMode = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Action = 'Action' in params ? params.Action : null;
this.BucketName = 'BucketName' in params ? params.BucketName : null;
this.Authorization = 'Authorization' in params ? params.Authorization : null;
this.PathMatchMode = 'PathMatchMode' in params ? params.PathMatchMode : null;
}
}
/**
* ModifyApiIncrement request structure.
* @class
*/
class ModifyApiIncrementRequest extends AbstractModel {
constructor(){
super();
/**
* Service ID
* @type {string || null}
*/
this.ServiceId = null;
/**
* API ID
* @type {string || null}
*/
this.ApiId = null;
/**
* Authorization type of the API to be modified (you can select `OAUTH`, i.e., authorization API)
* @type {string || null}
*/
this.BusinessType = null;
/**
* Public key value to be modified by OAuth API
* @type {string || null}
*/
this.PublicKey = null;
/**
* OAuth API redirect address
* @type {string || null}
*/
this.LoginRedirectUrl = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.BusinessType = 'BusinessType' in params ? params.BusinessType : null;
this.PublicKey = 'PublicKey' in params ? params.PublicKey : null;
this.LoginRedirectUrl = 'LoginRedirectUrl' in params ? params.LoginRedirectUrl : null;
}
}
/**
* List of usage plans bound to service
* @class
*/
class ServiceUsagePlanSet extends AbstractModel {
constructor(){
super();
/**
* Total number of usage plans bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of usage plans bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiUsagePlan> || null}
*/
this.ServiceUsagePlanList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ServiceUsagePlanList) {
this.ServiceUsagePlanList = new Array();
for (let z in params.ServiceUsagePlanList) {
let obj = new ApiUsagePlan();
obj.deserialize(params.ServiceUsagePlanList[z]);
this.ServiceUsagePlanList.push(obj);
}
}
}
}
/**
* CreateUpstream request structure.
* @class
*/
class CreateUpstreamRequest extends AbstractModel {
constructor(){
super();
/**
* Backend protocol. Valid values: `HTTP`, `HTTPS`
* @type {string || null}
*/
this.Scheme = null;
/**
* Load balancing algorithm. Valid value: `ROUND-ROBIN`
* @type {string || null}
*/
this.Algorithm = null;
/**
* Unique VPC ID
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* Upstream name
* @type {string || null}
*/
this.UpstreamName = null;
/**
* Upstream description
* @type {string || null}
*/
this.UpstreamDescription = null;
/**
* Upstream access type. Valid values: `IP_PORT`, `K8S`
* @type {string || null}
*/
this.UpstreamType = null;
/**
* Retry attempts. It defaults to `3`.
* @type {number || null}
*/
this.Retries = null;
/**
* The Host request header that forwarded from the gateway to backend
* @type {string || null}
*/
this.UpstreamHost = null;
/**
* Backend nodes
* @type {Array.<UpstreamNode> || null}
*/
this.Nodes = null;
/**
* Label
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Health check configuration
* @type {UpstreamHealthChecker || null}
*/
this.HealthChecker = null;
/**
* Configuration of TKE service
* @type {Array.<K8sService> || null}
*/
this.K8sService = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Scheme = 'Scheme' in params ? params.Scheme : null;
this.Algorithm = 'Algorithm' in params ? params.Algorithm : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.UpstreamName = 'UpstreamName' in params ? params.UpstreamName : null;
this.UpstreamDescription = 'UpstreamDescription' in params ? params.UpstreamDescription : null;
this.UpstreamType = 'UpstreamType' in params ? params.UpstreamType : null;
this.Retries = 'Retries' in params ? params.Retries : null;
this.UpstreamHost = 'UpstreamHost' in params ? params.UpstreamHost : null;
if (params.Nodes) {
this.Nodes = new Array();
for (let z in params.Nodes) {
let obj = new UpstreamNode();
obj.deserialize(params.Nodes[z]);
this.Nodes.push(obj);
}
}
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
if (params.HealthChecker) {
let obj = new UpstreamHealthChecker();
obj.deserialize(params.HealthChecker)
this.HealthChecker = obj;
}
if (params.K8sService) {
this.K8sService = new Array();
for (let z in params.K8sService) {
let obj = new K8sService();
obj.deserialize(params.K8sService[z]);
this.K8sService.push(obj);
}
}
}
}
/**
* ModifyServiceEnvironmentStrategy response structure.
* @class
*/
class ModifyServiceEnvironmentStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether modification succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpdateApiKey response structure.
* @class
*/
class UpdateApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Key details after change.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiKey || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiKey();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApiBindApiAppsStatus request structure.
* @class
*/
class DescribeApiBindApiAppsStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Service ID
* @type {string || null}
*/
this.ServiceId = null;
/**
* Array of API IDs
* @type {Array.<string> || null}
*/
this.ApiIds = null;
/**
* Number of returned results. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: ApiAppId, Environment, KeyWord (match with `name` or ID).
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DescribeApisStatus response structure.
* @class
*/
class DescribeApisStatusResponse extends AbstractModel {
constructor(){
super();
/**
* List of API details.
* @type {DescribeApisStatusResultInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new DescribeApisStatusResultInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApiKeysStatus request structure.
* @class
*/
class DescribeApiKeysStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: AccessKeyId, AccessKeySecret, SecretName, NotUsagePlanId, Status, KeyWord (match with `name` or `path`).
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DemoteServiceUsagePlan request structure.
* @class
*/
class DemoteServiceUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Usage plan ID.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Unique ID of the service to be demoted.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment name.
* @type {string || null}
*/
this.Environment = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
}
}
/**
* BindSecretIds response structure.
* @class
*/
class BindSecretIdsResponse extends AbstractModel {
constructor(){
super();
/**
* Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Return of API creation
* @class
*/
class CreateApiRsp extends AbstractModel {
constructor(){
super();
/**
* API ID
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* Path
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* Request method
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
/**
* Creation time
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Status of the import task
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Status = null;
/**
* Details of the error
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ErrMsg = null;
/**
* API name
Note: This field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.Status = 'Status' in params ? params.Status : null;
this.ErrMsg = 'ErrMsg' in params ? params.ErrMsg : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
}
}
/**
* Information of environment bound to usage plan
* @class
*/
class UsagePlanBindEnvironment extends AbstractModel {
constructor(){
super();
/**
* Environment name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
}
}
/**
* DeleteApi request structure.
* @class
*/
class DeleteApiRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
}
}
/**
* DescribeExclusiveInstanceRegions request structure.
* @class
*/
class DescribeExclusiveInstanceRegionsRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* DescribeApiApp response structure.
* @class
*/
class DescribeApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Application details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiAppInfos || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiAppInfos();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceSubDomainMappings response structure.
* @class
*/
class DescribeServiceSubDomainMappingsResponse extends AbstractModel {
constructor(){
super();
/**
* Custom path mapping list.
* @type {ServiceSubDomainMappings || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceSubDomainMappings();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* OAuth authorization configuration information
* @class
*/
class OauthConfig extends AbstractModel {
constructor(){
super();
/**
* Public key for user token verification.
* @type {string || null}
*/
this.PublicKey = null;
/**
* Token delivery location.
* @type {string || null}
*/
this.TokenLocation = null;
/**
* Redirect address, which is used to guide user logins.
* @type {string || null}
*/
this.LoginRedirectUrl = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PublicKey = 'PublicKey' in params ? params.PublicKey : null;
this.TokenLocation = 'TokenLocation' in params ? params.TokenLocation : null;
this.LoginRedirectUrl = 'LoginRedirectUrl' in params ? params.LoginRedirectUrl : null;
}
}
/**
* DescribeApiAppsStatus response structure.
* @class
*/
class DescribeApiAppsStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Application list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiAppInfos || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiAppInfos();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Custom service domain name path mapping
* @class
*/
class ServiceSubDomainMappings extends AbstractModel {
constructor(){
super();
/**
* Whether the default path mapping is used. true: use the default path mapping; false: use the custom path mapping (`PathMappingSet` is required in this case).
* @type {boolean || null}
*/
this.IsDefaultMapping = null;
/**
* Custom path mapping list.
* @type {Array.<PathMapping> || null}
*/
this.PathMappingSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IsDefaultMapping = 'IsDefaultMapping' in params ? params.IsDefaultMapping : null;
if (params.PathMappingSet) {
this.PathMappingSet = new Array();
for (let z in params.PathMappingSet) {
let obj = new PathMapping();
obj.deserialize(params.PathMappingSet[z]);
this.PathMappingSet.push(obj);
}
}
}
}
/**
* DescribeApiKey request structure.
* @class
*/
class DescribeApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* API key ID.
* @type {string || null}
*/
this.AccessKeyId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
}
}
/**
* DescribeAPIDocDetail response structure.
* @class
*/
class DescribeAPIDocDetailResponse extends AbstractModel {
constructor(){
super();
/**
* API document details
* @type {APIDocInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new APIDocInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* >Key-value pair filter for conditional filtering queries, such as filtering ID, name, status, etc.
> * If there are multiple `Filter`, the relationship among them is logical `AND`.
> * If there are multiple `Values` in the same `Filter`, the relationship among them is logical `OR`.
>
* @class
*/
class Filter extends AbstractModel {
constructor(){
super();
/**
* Field to be filtered.
* @type {string || null}
*/
this.Name = null;
/**
* Filter value of field.
* @type {Array.<string> || null}
*/
this.Values = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Values = 'Values' in params ? params.Values : null;
}
}
/**
* BindApiApp response structure.
* @class
*/
class BindApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* Whether binding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* List of keys bound to usage plan.
* @class
*/
class UsagePlanBindSecretStatus extends AbstractModel {
constructor(){
super();
/**
* Number of keys bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of key details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlanBindSecret> || null}
*/
this.AccessKeyList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.AccessKeyList) {
this.AccessKeyList = new Array();
for (let z in params.AccessKeyList) {
let obj = new UsagePlanBindSecret();
obj.deserialize(params.AccessKeyList[z]);
this.AccessKeyList.push(obj);
}
}
}
}
/**
* DeleteServiceSubDomainMapping response structure.
* @class
*/
class DeleteServiceSubDomainMappingResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the path mapping of the custom domain name is successfully deleted.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateApiKey response structure.
* @class
*/
class CreateApiKeyResponse extends AbstractModel {
constructor(){
super();
/**
* New key details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiKey || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiKey();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeUpstreams request structure.
* @class
*/
class DescribeUpstreamsRequest extends AbstractModel {
constructor(){
super();
/**
* Number of entries per page
* @type {number || null}
*/
this.Limit = null;
/**
* The starting position of paging
* @type {number || null}
*/
this.Offset = null;
/**
* Filters. Valid values: `UpstreamId` and `UpstreamName`
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* Details of environments bound to usage plan.
* @class
*/
class UsagePlanEnvironment extends AbstractModel {
constructor(){
super();
/**
* Unique ID of bound service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* API name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* API path.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* API method.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
/**
* Name of bound environment.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Environment = null;
/**
* Used quota.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.InUseRequestNum = null;
/**
* Maximum number of requests.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Maximum number of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Service name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.InUseRequestNum = 'InUseRequestNum' in params ? params.InUseRequestNum : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
}
}
/**
* ModifyIPStrategy request structure.
* @class
*/
class ModifyIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of the policy to be modified.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the policy to be modified.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Details of the policy to be modified.
* @type {string || null}
*/
this.StrategyData = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.StrategyData = 'StrategyData' in params ? params.StrategyData : null;
}
}
/**
* ModifyPlugin response structure.
* @class
*/
class ModifyPluginResponse extends AbstractModel {
constructor(){
super();
/**
* Whether modification succeeded.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UnBindSecretIds request structure.
* @class
*/
class UnBindSecretIdsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the usage plan to be unbound.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Array of IDs of the keys to be unbound.
* @type {Array.<string> || null}
*/
this.AccessKeyIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.AccessKeyIds = 'AccessKeyIds' in params ? params.AccessKeyIds : null;
}
}
/**
* API environment binding policy
* @class
*/
class ApiEnvironmentStrategy extends AbstractModel {
constructor(){
super();
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Custom API name.
* @type {string || null}
*/
this.ApiName = null;
/**
* API path, such as `/path`.
* @type {string || null}
*/
this.Path = null;
/**
* API method, such as `GET`.
* @type {string || null}
*/
this.Method = null;
/**
* Environment throttling information.
* @type {Array.<EnvironmentStrategy> || null}
*/
this.EnvironmentStrategySet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
if (params.EnvironmentStrategySet) {
this.EnvironmentStrategySet = new Array();
for (let z in params.EnvironmentStrategySet) {
let obj = new EnvironmentStrategy();
obj.deserialize(params.EnvironmentStrategySet[z]);
this.EnvironmentStrategySet.push(obj);
}
}
}
}
/**
* CreateUpstream response structure.
* @class
*/
class CreateUpstreamResponse extends AbstractModel {
constructor(){
super();
/**
* The unique upstream ID returned
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.UpstreamId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ResetAPIDocPassword request structure.
* @class
*/
class ResetAPIDocPasswordRequest extends AbstractModel {
constructor(){
super();
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
}
}
/**
* Details of usage plans bound to API or service
* @class
*/
class ApiUsagePlan extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* API name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* API path.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* API method.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
/**
* Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Service environment bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Environment = null;
/**
* Used quota.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.InUseRequestNum = null;
/**
* Total number of requests allowed. `-1` indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Request QPS upper limit. `-1` indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
/**
* Usage plan creation time.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time of usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Service name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.InUseRequestNum = 'InUseRequestNum' in params ? params.InUseRequestNum : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
}
}
/**
* List of APIs bound to policy
* @class
*/
class IPStrategyApi extends AbstractModel {
constructor(){
super();
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Custom API name.
* @type {string || null}
*/
this.ApiName = null;
/**
* API type. Valid values: NORMAL (general API), TSF (microservice API).
* @type {string || null}
*/
this.ApiType = null;
/**
* API path, such as `/path`.
* @type {string || null}
*/
this.Path = null;
/**
* API request method, such as `GET`.
* @type {string || null}
*/
this.Method = null;
/**
* Unique ID of another policy bound to API.
* @type {string || null}
*/
this.OtherIPStrategyId = null;
/**
* Environment bound to API.
* @type {string || null}
*/
this.OtherEnvironmentName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
this.OtherIPStrategyId = 'OtherIPStrategyId' in params ? params.OtherIPStrategyId : null;
this.OtherEnvironmentName = 'OtherEnvironmentName' in params ? params.OtherEnvironmentName : null;
}
}
/**
* DescribeAPIDocs response structure.
* @class
*/
class DescribeAPIDocsResponse extends AbstractModel {
constructor(){
super();
/**
* API document list information
* @type {APIDocs || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new APIDocs();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceSubDomainMappings request structure.
* @class
*/
class DescribeServiceSubDomainMappingsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom domain name bound to service.
* @type {string || null}
*/
this.SubDomain = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SubDomain = 'SubDomain' in params ? params.SubDomain : null;
}
}
/**
* DeletePlugin response structure.
* @class
*/
class DeletePluginResponse extends AbstractModel {
constructor(){
super();
/**
* Result of the deletion action
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Queries APIs bound with an upstream
* @class
*/
class DescribeUpstreamBindApis extends AbstractModel {
constructor(){
super();
/**
* Total number
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information of bound APIs
* @type {Array.<BindApiInfo> || null}
*/
this.BindApiSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.BindApiSet) {
this.BindApiSet = new Array();
for (let z in params.BindApiSet) {
let obj = new BindApiInfo();
obj.deserialize(params.BindApiSet[z]);
this.BindApiSet.push(obj);
}
}
}
}
/**
* ModifyServiceEnvironmentStrategy request structure.
* @class
*/
class ModifyServiceEnvironmentStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Throttling value.
* @type {number || null}
*/
this.Strategy = null;
/**
* Environment list.
* @type {Array.<string> || null}
*/
this.EnvironmentNames = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Strategy = 'Strategy' in params ? params.Strategy : null;
this.EnvironmentNames = 'EnvironmentNames' in params ? params.EnvironmentNames : null;
}
}
/**
* CreateAPIDoc request structure.
* @class
*/
class CreateAPIDocRequest extends AbstractModel {
constructor(){
super();
/**
* API document name
* @type {string || null}
*/
this.ApiDocName = null;
/**
* Service name
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment name
* @type {string || null}
*/
this.Environment = null;
/**
* List of APIs for which to generate documents
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocName = 'ApiDocName' in params ? params.ApiDocName : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* DescribeApiAppBindApisStatus response structure.
* @class
*/
class DescribeApiAppBindApisStatusResponse extends AbstractModel {
constructor(){
super();
/**
* List of APIs bound to the application.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiAppApiInfos || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiAppApiInfos();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceSubDomains request structure.
* @class
*/
class DescribeServiceSubDomainsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* ModifyApiApp request structure.
* @class
*/
class ModifyApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique application ID.
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Modified application name
* @type {string || null}
*/
this.ApiAppName = null;
/**
* Modified application description
* @type {string || null}
*/
this.ApiAppDesc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.ApiAppName = 'ApiAppName' in params ? params.ApiAppName : null;
this.ApiAppDesc = 'ApiAppDesc' in params ? params.ApiAppDesc : null;
}
}
/**
* Returned result of service publishing
* @class
*/
class ReleaseService extends AbstractModel {
constructor(){
super();
/**
* Release remarks.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ReleaseDesc = null;
/**
* Published version ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ReleaseVersion = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ReleaseDesc = 'ReleaseDesc' in params ? params.ReleaseDesc : null;
this.ReleaseVersion = 'ReleaseVersion' in params ? params.ReleaseVersion : null;
}
}
/**
* DescribeUsagePlanEnvironments response structure.
* @class
*/
class DescribeUsagePlanEnvironmentsResponse extends AbstractModel {
constructor(){
super();
/**
* Usage plan binding details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlanEnvironmentStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlanEnvironmentStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceSubDomains response structure.
* @class
*/
class DescribeServiceSubDomainsResponse extends AbstractModel {
constructor(){
super();
/**
* Custom service domain name query.
* @type {DomainSets || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new DomainSets();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* AttachPlugin request structure.
* @class
*/
class AttachPluginRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the bound API gateway plugin.
* @type {string || null}
*/
this.PluginId = null;
/**
* ID of the service to be operated.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment for operating the API.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* List of APIs to be bound.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PluginId = 'PluginId' in params ? params.PluginId : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* API status details
* @class
*/
class DescribeApisStatusResultApiIdStatusSetInfo extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Custom API description.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* Creation time. u200dIt is the UTC time in ISO-8601 format. Format: YYYY-MM-DDThh:mm:ssZ.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modification time u200dIt is the UTC time in ISO-8601 format. Format: YYYY-MM-DDThh:mm:ssZ.
Note: u200dThis field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* API name.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* VPC ID
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.VpcId = null;
/**
* Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* API type API type. Valid values: `NORMAL` (general API), `TSF` (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiType = null;
/**
* API protocol.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Protocol = null;
/**
* Whether to enable debugging after purchase. (This field is reserved for Marketplace
Note: This field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthType = null;
/**
* OAuth API type. Valid values: u200d`NORMAL` (service API), `OAUTH` (authorization API). It is only applicable when `AuthType` is `OAUTH`.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Unique ID of associated authorization API. It is applicable when `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the service API.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* OAUTH configuration information. It is applicable when `AuthType` is `OAUTH`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* List of business APIs associated with authorization API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.RelationBuniessApiIds = null;
/**
* Information of tags associated with API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApigatewayTags> || null}
*/
this.Tags = null;
/**
* API path, such as `/path`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* API request method, such as `GET`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
this.RelationBuniessApiIds = 'RelationBuniessApiIds' in params ? params.RelationBuniessApiIds : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new ApigatewayTags();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
}
}
/**
* ModifyApiEnvironmentStrategy response structure.
* @class
*/
class ModifyApiEnvironmentStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether modification succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindSubDomain request structure.
* @class
*/
class BindSubDomainRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom domain name to be bound.
* @type {string || null}
*/
this.SubDomain = null;
/**
* Protocol supported by service. Valid values: http, https, http&https.
* @type {string || null}
*/
this.Protocol = null;
/**
* Network type. Valid values: OUTER, INNER.
* @type {string || null}
*/
this.NetType = null;
/**
* Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case.
* @type {boolean || null}
*/
this.IsDefaultMapping = null;
/**
* Default domain name.
* @type {string || null}
*/
this.NetSubDomain = null;
/**
* Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`.
* @type {string || null}
*/
this.CertificateId = null;
/**
* Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively.
* @type {Array.<PathMapping> || null}
*/
this.PathMappingSet = null;
/**
* Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.
* @type {boolean || null}
*/
this.IsForcedHttps = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SubDomain = 'SubDomain' in params ? params.SubDomain : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.NetType = 'NetType' in params ? params.NetType : null;
this.IsDefaultMapping = 'IsDefaultMapping' in params ? params.IsDefaultMapping : null;
this.NetSubDomain = 'NetSubDomain' in params ? params.NetSubDomain : null;
this.CertificateId = 'CertificateId' in params ? params.CertificateId : null;
if (params.PathMappingSet) {
this.PathMappingSet = new Array();
for (let z in params.PathMappingSet) {
let obj = new PathMapping();
obj.deserialize(params.PathMappingSet[z]);
this.PathMappingSet.push(obj);
}
}
this.IsForcedHttps = 'IsForcedHttps' in params ? params.IsForcedHttps : null;
}
}
/**
* Application information set
* @class
*/
class ApiAppInfos extends AbstractModel {
constructor(){
super();
/**
* Number of applications
* @type {number || null}
*/
this.TotalCount = null;
/**
* Application information array
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiAppInfo> || null}
*/
this.ApiAppSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiAppSet) {
this.ApiAppSet = new Array();
for (let z in params.ApiAppSet) {
let obj = new ApiAppInfo();
obj.deserialize(params.ApiAppSet[z]);
this.ApiAppSet.push(obj);
}
}
}
}
/**
* Service version details
* @class
*/
class DescribeServiceReleaseVersionResultVersionListInfo extends AbstractModel {
constructor(){
super();
/**
* Version ID.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VersionName = null;
/**
* Version description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VersionDesc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.VersionName = 'VersionName' in params ? params.VersionName : null;
this.VersionDesc = 'VersionDesc' in params ? params.VersionDesc : null;
}
}
/**
* CreateIPStrategy response structure.
* @class
*/
class CreateIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* New IP policy details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {IPStrategy || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new IPStrategy();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteApi response structure.
* @class
*/
class DeleteApiResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindIPStrategy request structure.
* @class
*/
class BindIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of the IP policy to be bound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the IP policy to be bound.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Environment to be bound to IP policy.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* List of APIs to be bound to IP policy.
* @type {Array.<string> || null}
*/
this.BindApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.BindApiIds = 'BindApiIds' in params ? params.BindApiIds : null;
}
}
/**
* UpdateService request structure.
* @class
*/
class UpdateServiceRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be switch.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Name of the environment to be switched to. Valid values: test (test environment), prepub (pre-release environment), release (release environment).
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of the version to be switched to.
* @type {string || null}
*/
this.VersionName = null;
/**
* Switch description.
* @type {string || null}
*/
this.UpdateDesc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.VersionName = 'VersionName' in params ? params.VersionName : null;
this.UpdateDesc = 'UpdateDesc' in params ? params.UpdateDesc : null;
}
}
/**
* BuildAPIDoc response structure.
* @class
*/
class BuildAPIDocResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the operation succeeded
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Custom error code
* @class
*/
class ErrorCodes extends AbstractModel {
constructor(){
super();
/**
* Custom response configuration error code.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.Code = null;
/**
* Custom response configuration error message.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Msg = null;
/**
* Custom response configuration error code remarks.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Desc = null;
/**
* Custom error code conversion.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.ConvertedCode = null;
/**
* Whether to enable error code conversion.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.NeedConvert = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Code = 'Code' in params ? params.Code : null;
this.Msg = 'Msg' in params ? params.Msg : null;
this.Desc = 'Desc' in params ? params.Desc : null;
this.ConvertedCode = 'ConvertedCode' in params ? params.ConvertedCode : null;
this.NeedConvert = 'NeedConvert' in params ? params.NeedConvert : null;
}
}
/**
* DescribeServiceEnvironmentList request structure.
* @class
*/
class DescribeServiceEnvironmentListRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* List of policies bound to environment
* @class
*/
class ServiceEnvironmentStrategyStatus extends AbstractModel {
constructor(){
super();
/**
* Number of throttling policies.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Throttling policy list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ServiceEnvironmentStrategy> || null}
*/
this.EnvironmentList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.EnvironmentList) {
this.EnvironmentList = new Array();
for (let z in params.EnvironmentList) {
let obj = new ServiceEnvironmentStrategy();
obj.deserialize(params.EnvironmentList[z]);
this.EnvironmentList.push(obj);
}
}
}
}
/**
* Information of microservice bound to API.
* @class
*/
class MicroService extends AbstractModel {
constructor(){
super();
/**
* Microservice cluster ID.
* @type {string || null}
*/
this.ClusterId = null;
/**
* Microservice namespace ID.
* @type {string || null}
*/
this.NamespaceId = null;
/**
* Microservice name.
* @type {string || null}
*/
this.MicroServiceName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ClusterId = 'ClusterId' in params ? params.ClusterId : null;
this.NamespaceId = 'NamespaceId' in params ? params.NamespaceId : null;
this.MicroServiceName = 'MicroServiceName' in params ? params.MicroServiceName : null;
}
}
/**
* DescribeApiEnvironmentStrategy response structure.
* @class
*/
class DescribeApiEnvironmentStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Details of policies bound to API
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiEnvironmentStrategyStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiEnvironmentStrategyStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApi request structure.
* @class
*/
class DescribeApiRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID of API.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
}
}
/**
* Application information
* @class
*/
class ApiAppInfo extends AbstractModel {
constructor(){
super();
/**
* Application name
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiAppName = null;
/**
* Application ID
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Application SECRET
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiAppSecret = null;
/**
* Application description
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiAppDesc = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Application KEY
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiAppKey = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppName = 'ApiAppName' in params ? params.ApiAppName : null;
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.ApiAppSecret = 'ApiAppSecret' in params ? params.ApiAppSecret : null;
this.ApiAppDesc = 'ApiAppDesc' in params ? params.ApiAppDesc : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ApiAppKey = 'ApiAppKey' in params ? params.ApiAppKey : null;
}
}
/**
* DeleteIPStrategy response structure.
* @class
*/
class DeleteIPStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Information of the APIs that can use this plugin
* @class
*/
class ApiInfoSummary extends AbstractModel {
constructor(){
super();
/**
* Total number of APIs that can use this plugin
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information of the APIs that can use this plugin
* @type {Array.<AvailableApiInfo> || null}
*/
this.ApiSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiSet) {
this.ApiSet = new Array();
for (let z in params.ApiSet) {
let obj = new AvailableApiInfo();
obj.deserialize(params.ApiSet[z]);
this.ApiSet.push(obj);
}
}
}
}
/**
* Key details
* @class
*/
class ApiKey extends AbstractModel {
constructor(){
super();
/**
* Created API key ID.
* @type {string || null}
*/
this.AccessKeyId = null;
/**
* Created API key.
* @type {string || null}
*/
this.AccessKeySecret = null;
/**
* Key type. Valid values: auto, manual.
* @type {string || null}
*/
this.AccessKeyType = null;
/**
* Custom key name.
* @type {string || null}
*/
this.SecretName = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Key status. 0: disabled. 1: enabled.
* @type {number || null}
*/
this.Status = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
* @type {string || null}
*/
this.CreatedTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
this.AccessKeySecret = 'AccessKeySecret' in params ? params.AccessKeySecret : null;
this.AccessKeyType = 'AccessKeyType' in params ? params.AccessKeyType : null;
this.SecretName = 'SecretName' in params ? params.SecretName : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.Status = 'Status' in params ? params.Status : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
}
}
/**
* Information of the API bound with the upstream
* @class
*/
class BindApiInfo extends AbstractModel {
constructor(){
super();
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Unique ID of the service
* @type {string || null}
*/
this.ServiceId = null;
/**
* API name
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.ApiName = null;
/**
* Service name
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Bound At
* @type {string || null}
*/
this.BindTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.BindTime = 'BindTime' in params ? params.BindTime : null;
}
}
/**
* Information of the API bound to the application
* @class
*/
class ApiAppApiInfo extends AbstractModel {
constructor(){
super();
/**
* Application name
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiAppName = null;
/**
* Application ID
* @type {string || null}
*/
this.ApiAppId = null;
/**
* API ID
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiId = null;
/**
* API name
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* Service ID
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Binding authorization time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthorizedTime = null;
/**
* API region
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiRegion = null;
/**
* Authorized binding environment
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.EnvironmentName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppName = 'ApiAppName' in params ? params.ApiAppName : null;
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.AuthorizedTime = 'AuthorizedTime' in params ? params.AuthorizedTime : null;
this.ApiRegion = 'ApiRegion' in params ? params.ApiRegion : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
}
}
/**
* DescribeUsagePlan response structure.
* @class
*/
class DescribeUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* Usage plan details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlanInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlanInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
*
* @class
*/
class ApiEnvironmentStrategyStatus extends AbstractModel {
constructor(){
super();
/**
*
* @type {number || null}
*/
this.TotalCount = null;
/**
*
* @type {Array.<ApiEnvironmentStrategy> || null}
*/
this.ApiEnvironmentStrategySet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiEnvironmentStrategySet) {
this.ApiEnvironmentStrategySet = new Array();
for (let z in params.ApiEnvironmentStrategySet) {
let obj = new ApiEnvironmentStrategy();
obj.deserialize(params.ApiEnvironmentStrategySet[z]);
this.ApiEnvironmentStrategySet.push(obj);
}
}
}
}
/**
* AttachPlugin response structure.
* @class
*/
class AttachPluginResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the binding operation is successful.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* BindEnvironment request structure.
* @class
*/
class BindEnvironmentRequest extends AbstractModel {
constructor(){
super();
/**
* List of unique IDs of the usage plans to be bound.
* @type {Array.<string> || null}
*/
this.UsagePlanIds = null;
/**
* Binding type. Valid values: API, SERVICE. Default value: SERVICE.
* @type {string || null}
*/
this.BindType = null;
/**
* Environment to be bound.
* @type {string || null}
*/
this.Environment = null;
/**
* Unique ID of the service to be bound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID array, which is required if `bindType` is `API`.
* @type {Array.<string> || null}
*/
this.ApiIds = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanIds = 'UsagePlanIds' in params ? params.UsagePlanIds : null;
this.BindType = 'BindType' in params ? params.BindType : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiIds = 'ApiIds' in params ? params.ApiIds : null;
}
}
/**
* ModifyUpstream response structure.
* @class
*/
class ModifyUpstreamResponse extends AbstractModel {
constructor(){
super();
/**
* Return modified upstream information
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {ModifyUpstreamResultInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ModifyUpstreamResultInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeIPStrategy request structure.
* @class
*/
class DescribeIPStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique IP policy ID.
* @type {string || null}
*/
this.StrategyId = null;
/**
* Environment associated with policy.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter, which is a reserved field. Filtering is not supported currently.
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.StrategyId = 'StrategyId' in params ? params.StrategyId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* DescribeApiForApiApp response structure.
* @class
*/
class DescribeApiForApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* API details.
* @type {ApiInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeInstancesNetworkConfig request structure.
* @class
*/
class DescribeInstancesNetworkConfigRequest extends AbstractModel {
constructor(){
super();
/**
* Number of returns, with a default value of 20 and a maximum value of 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset, which is 0 by default.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* DescribeUsagePlanEnvironments request structure.
* @class
*/
class DescribeUsagePlanEnvironmentsRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the usage plan to be queried.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Binding type. Valid values: API, SERVICE. Default value: SERVICE.
* @type {string || null}
*/
this.BindType = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.BindType = 'BindType' in params ? params.BindType : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* ImportOpenApi request structure.
* @class
*/
class ImportOpenApiRequest extends AbstractModel {
constructor(){
super();
/**
* The unique ID of the service associated with the API
* @type {string || null}
*/
this.ServiceId = null;
/**
* Content of the openAPI
* @type {string || null}
*/
this.Content = null;
/**
* Format of the content. Values: `YAML` (default), `JSON`
* @type {string || null}
*/
this.EncodeType = null;
/**
* Version of the content. It can only be `openAPI` for now.
* @type {string || null}
*/
this.ContentVersion = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Content = 'Content' in params ? params.Content : null;
this.EncodeType = 'EncodeType' in params ? params.EncodeType : null;
this.ContentVersion = 'ContentVersion' in params ? params.ContentVersion : null;
}
}
/**
* DescribeServiceReleaseVersion response structure.
* @class
*/
class DescribeServiceReleaseVersionResponse extends AbstractModel {
constructor(){
super();
/**
* Service release version list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceReleaseVersion || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceReleaseVersion();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Upstream node metadata
* @class
*/
class UpstreamNode extends AbstractModel {
constructor(){
super();
/**
* IP or domain name
* @type {string || null}
*/
this.Host = null;
/**
* The port number. Range: [0, 65535]
* @type {number || null}
*/
this.Port = null;
/**
* Value range: [0, 100]. `0` refers to disable it.
* @type {number || null}
*/
this.Weight = null;
/**
* CVM Instance ID
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.VmInstanceId = null;
/**
* Tag
Note: This field may return `null`, indicating that no valid value was found.
* @type {Array.<string> || null}
*/
this.Tags = null;
/**
* Health status of the node. Values: `OFF`, `HEALTHY`, `UNHEALTHY` and `NO_DATA`. It’s not required for creating and editing actions. It only supports VPC upstreams.
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.Healthy = null;
/**
* TKE container name
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.ServiceName = null;
/**
* TKE namespace
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.NameSpace = null;
/**
* ID of the TKE cluster
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.ClusterId = null;
/**
* Node source. Valid value: `K8S`
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.Source = null;
/**
* The unique service name in API Gateway
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.UniqueServiceName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Host = 'Host' in params ? params.Host : null;
this.Port = 'Port' in params ? params.Port : null;
this.Weight = 'Weight' in params ? params.Weight : null;
this.VmInstanceId = 'VmInstanceId' in params ? params.VmInstanceId : null;
this.Tags = 'Tags' in params ? params.Tags : null;
this.Healthy = 'Healthy' in params ? params.Healthy : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.NameSpace = 'NameSpace' in params ? params.NameSpace : null;
this.ClusterId = 'ClusterId' in params ? params.ClusterId : null;
this.Source = 'Source' in params ? params.Source : null;
this.UniqueServiceName = 'UniqueServiceName' in params ? params.UniqueServiceName : null;
}
}
/**
* Application information set
* @class
*/
class ApiAppApiInfos extends AbstractModel {
constructor(){
super();
/**
* Quantity
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information array of the API bound to the application
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiAppApiInfo> || null}
*/
this.ApiAppApiSet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiAppApiSet) {
this.ApiAppApiSet = new Array();
for (let z in params.ApiAppApiSet) {
let obj = new ApiAppApiInfo();
obj.deserialize(params.ApiAppApiSet[z]);
this.ApiAppApiSet.push(obj);
}
}
}
}
/**
* DeleteUpstream response structure.
* @class
*/
class DeleteUpstreamResponse extends AbstractModel {
constructor(){
super();
/**
* ID of the deleted upstream
Note: This field may return `NULL`, indicating that no valid value was found.
* @type {string || null}
*/
this.UpstreamId = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UpstreamId = 'UpstreamId' in params ? params.UpstreamId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpdateService response structure.
* @class
*/
class UpdateServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the version is successfully switched.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Usage plan details.
* @class
*/
class UsagePlanInfo extends AbstractModel {
constructor(){
super();
/**
* Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Number of initialization calls.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.InitQuota = null;
/**
* Limit of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
/**
* Maximum number of calls.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Whether to hide.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.IsHide = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* Number of bound keys.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.BindSecretIdTotalCount = null;
/**
* Details of bound keys.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.BindSecretIds = null;
/**
* Number of bound environments.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.BindEnvironmentTotalCount = null;
/**
* Details of bound environments.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<UsagePlanBindEnvironment> || null}
*/
this.BindEnvironments = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.InitQuota = 'InitQuota' in params ? params.InitQuota : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.IsHide = 'IsHide' in params ? params.IsHide : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.BindSecretIdTotalCount = 'BindSecretIdTotalCount' in params ? params.BindSecretIdTotalCount : null;
this.BindSecretIds = 'BindSecretIds' in params ? params.BindSecretIds : null;
this.BindEnvironmentTotalCount = 'BindEnvironmentTotalCount' in params ? params.BindEnvironmentTotalCount : null;
if (params.BindEnvironments) {
this.BindEnvironments = new Array();
for (let z in params.BindEnvironments) {
let obj = new UsagePlanBindEnvironment();
obj.deserialize(params.BindEnvironments[z]);
this.BindEnvironments.push(obj);
}
}
}
}
/**
* DescribeServiceEnvironmentReleaseHistory request structure.
* @class
*/
class DescribeServiceEnvironmentReleaseHistoryRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Environment name.
* @type {string || null}
*/
this.EnvironmentName = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.EnvironmentName = 'EnvironmentName' in params ? params.EnvironmentName : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* UnbindApiApp request structure.
* @class
*/
class UnbindApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the application to be bound.
* @type {string || null}
*/
this.ApiAppId = null;
/**
* Environment to be bound.
* @type {string || null}
*/
this.Environment = null;
/**
* Unique ID of the service to be bound.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique ID of the API to be bound.
* @type {string || null}
*/
this.ApiId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppId = 'ApiAppId' in params ? params.ApiAppId : null;
this.Environment = 'Environment' in params ? params.Environment : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
}
}
/**
* CreateService response structure.
* @class
*/
class CreateServiceResponse extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom service name.
* @type {string || null}
*/
this.ServiceName = null;
/**
* Custom service description.
* @type {string || null}
*/
this.ServiceDesc = null;
/**
* Default public domain name.
* @type {string || null}
*/
this.OuterSubDomain = null;
/**
* Default VPC domain name.
* @type {string || null}
*/
this.InnerSubDomain = null;
/**
* Service creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Network type list. INNER: private network access; OUTER: public network access.
* @type {Array.<string> || null}
*/
this.NetTypes = null;
/**
* IP version number.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IpVersion = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ServiceName = 'ServiceName' in params ? params.ServiceName : null;
this.ServiceDesc = 'ServiceDesc' in params ? params.ServiceDesc : null;
this.OuterSubDomain = 'OuterSubDomain' in params ? params.OuterSubDomain : null;
this.InnerSubDomain = 'InnerSubDomain' in params ? params.InnerSubDomain : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.NetTypes = 'NetTypes' in params ? params.NetTypes : null;
this.IpVersion = 'IpVersion' in params ? params.IpVersion : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteAPIDoc response structure.
* @class
*/
class DeleteAPIDocResponse extends AbstractModel {
constructor(){
super();
/**
* Whether the operation succeeded.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServiceEnvironmentStrategy response structure.
* @class
*/
class DescribeServiceEnvironmentStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Throttling policy list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceEnvironmentStrategyStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceEnvironmentStrategyStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* API status details
* @class
*/
class DesApisStatus extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Unique API ID.
* @type {string || null}
*/
this.ApiId = null;
/**
* Custom API description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiDesc = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
/**
* API name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiName = null;
/**
* VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.VpcId = null;
/**
* Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UniqVpcId = null;
/**
* API type. Valid values: NORMAL (general API), TSF (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiType = null;
/**
* API protocol.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Protocol = null;
/**
* Whether to enable debugging after purchase (reserved field for the marketplace)
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsDebugAfterCharge = null;
/**
* API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM`
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthType = null;
/**
* OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API).
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ApiBusinessType = null;
/**
* Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.AuthRelationApiId = null;
/**
* OAuth configuration information, which takes effect if `AuthType` is `OAUTH`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {OauthConfig || null}
*/
this.OauthConfig = null;
/**
* List of business APIs associated with authorization API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.RelationBuniessApiIds = null;
/**
* Information of tags associated with API.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.Tags = null;
/**
* API path, such as `/path`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Path = null;
/**
* API request method, such as `GET`.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Method = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.ApiId = 'ApiId' in params ? params.ApiId : null;
this.ApiDesc = 'ApiDesc' in params ? params.ApiDesc : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
this.ApiName = 'ApiName' in params ? params.ApiName : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.UniqVpcId = 'UniqVpcId' in params ? params.UniqVpcId : null;
this.ApiType = 'ApiType' in params ? params.ApiType : null;
this.Protocol = 'Protocol' in params ? params.Protocol : null;
this.IsDebugAfterCharge = 'IsDebugAfterCharge' in params ? params.IsDebugAfterCharge : null;
this.AuthType = 'AuthType' in params ? params.AuthType : null;
this.ApiBusinessType = 'ApiBusinessType' in params ? params.ApiBusinessType : null;
this.AuthRelationApiId = 'AuthRelationApiId' in params ? params.AuthRelationApiId : null;
if (params.OauthConfig) {
let obj = new OauthConfig();
obj.deserialize(params.OauthConfig)
this.OauthConfig = obj;
}
this.RelationBuniessApiIds = 'RelationBuniessApiIds' in params ? params.RelationBuniessApiIds : null;
this.Tags = 'Tags' in params ? params.Tags : null;
this.Path = 'Path' in params ? params.Path : null;
this.Method = 'Method' in params ? params.Method : null;
}
}
/**
* DescribeApiKeysStatus response structure.
* @class
*/
class DescribeApiKeysStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Key list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiKeysStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiKeysStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Usage plan list display.
* @class
*/
class UsagePlanStatusInfo extends AbstractModel {
constructor(){
super();
/**
* Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanId = null;
/**
* Custom usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanName = null;
/**
* Custom usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.UsagePlanDesc = null;
/**
* Maximum number of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNumPreSec = null;
/**
* Total number of requests allowed. `-1` indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MaxRequestNum = null;
/**
* Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CreatedTime = null;
/**
* Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ModifiedTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.UsagePlanId = 'UsagePlanId' in params ? params.UsagePlanId : null;
this.UsagePlanName = 'UsagePlanName' in params ? params.UsagePlanName : null;
this.UsagePlanDesc = 'UsagePlanDesc' in params ? params.UsagePlanDesc : null;
this.MaxRequestNumPreSec = 'MaxRequestNumPreSec' in params ? params.MaxRequestNumPreSec : null;
this.MaxRequestNum = 'MaxRequestNum' in params ? params.MaxRequestNum : null;
this.CreatedTime = 'CreatedTime' in params ? params.CreatedTime : null;
this.ModifiedTime = 'ModifiedTime' in params ? params.ModifiedTime : null;
}
}
/**
* DescribeLogSearch request structure.
* @class
*/
class DescribeLogSearchRequest extends AbstractModel {
constructor(){
super();
/**
* Log start time
* @type {string || null}
*/
this.StartTime = null;
/**
* Log end time
* @type {string || null}
*/
this.EndTime = null;
/**
* Service ID
* @type {string || null}
*/
this.ServiceId = null;
/**
* Reserved field
* @type {Array.<Filter> || null}
*/
this.Filters = null;
/**
* Number of logs to be returned at a time. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Subsequent content can be obtained based on the `ConText` returned last time. Up to 10,000 data entries can be obtained
* @type {string || null}
*/
this.ConText = null;
/**
* Sorting by time. Valid values: asc (ascending), desc (descending). Default value: desc
* @type {string || null}
*/
this.Sort = null;
/**
* Reserved field
* @type {string || null}
*/
this.Query = null;
/**
* Search criterion. Valid values:
req_id: "="
api_id: "="
cip: "="
uip: ":"
err_msg: ":"
rsp_st: "=", "!=", ":", ">", "<"
req_t: ">=", "<="
Note:
":" indicates included, and "!=" indicates not equal to. For the meanings of fields, please see the `LogSet` description of the output parameter
* @type {Array.<LogQuery> || null}
*/
this.LogQuerys = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.ConText = 'ConText' in params ? params.ConText : null;
this.Sort = 'Sort' in params ? params.Sort : null;
this.Query = 'Query' in params ? params.Query : null;
if (params.LogQuerys) {
this.LogQuerys = new Array();
for (let z in params.LogQuerys) {
let obj = new LogQuery();
obj.deserialize(params.LogQuerys[z]);
this.LogQuerys.push(obj);
}
}
}
}
/**
* BuildAPIDoc request structure.
* @class
*/
class BuildAPIDocRequest extends AbstractModel {
constructor(){
super();
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
}
}
/**
* DetachPlugin response structure.
* @class
*/
class DetachPluginResponse extends AbstractModel {
constructor(){
super();
/**
* Whether unbinding succeeded.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Key list
* @class
*/
class ApiKeysStatus extends AbstractModel {
constructor(){
super();
/**
* Number of eligible API keys.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* API key list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<ApiKey> || null}
*/
this.ApiKeySet = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.ApiKeySet) {
this.ApiKeySet = new Array();
for (let z in params.ApiKeySet) {
let obj = new ApiKey();
obj.deserialize(params.ApiKeySet[z]);
this.ApiKeySet.push(obj);
}
}
}
}
/**
* ModifyUsagePlan response structure.
* @class
*/
class ModifyUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* Usage plan details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {UsagePlanInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new UsagePlanInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Basic information of API document
* @class
*/
class APIDoc extends AbstractModel {
constructor(){
super();
/**
* API document ID
* @type {string || null}
*/
this.ApiDocId = null;
/**
* API document name
* @type {string || null}
*/
this.ApiDocName = null;
/**
* API document build status
* @type {string || null}
*/
this.ApiDocStatus = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiDocId = 'ApiDocId' in params ? params.ApiDocId : null;
this.ApiDocName = 'ApiDocName' in params ? params.ApiDocName : null;
this.ApiDocStatus = 'ApiDocStatus' in params ? params.ApiDocStatus : null;
}
}
/**
* DescribeServiceUsagePlan response structure.
* @class
*/
class DescribeServiceUsagePlanResponse extends AbstractModel {
constructor(){
super();
/**
* List of usage plans bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServiceUsagePlanSet || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServiceUsagePlanSet();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateApiApp response structure.
* @class
*/
class CreateApiAppResponse extends AbstractModel {
constructor(){
super();
/**
* New application details.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ApiAppInfo || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ApiAppInfo();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeApiUsagePlan request structure.
* @class
*/
class DescribeApiUsagePlanRequest extends AbstractModel {
constructor(){
super();
/**
* Unique ID of the service to be queried.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
}
}
/**
* UnBindSubDomain request structure.
* @class
*/
class UnBindSubDomainRequest extends AbstractModel {
constructor(){
super();
/**
* Unique service ID.
* @type {string || null}
*/
this.ServiceId = null;
/**
* Custom domain name to be unbound.
* @type {string || null}
*/
this.SubDomain = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ServiceId = 'ServiceId' in params ? params.ServiceId : null;
this.SubDomain = 'SubDomain' in params ? params.SubDomain : null;
}
}
/**
* Information of bound plug-ins
* @class
*/
class AttachedPluginSummary extends AbstractModel {
constructor(){
super();
/**
* Total number of bound plug-ins
* @type {number || null}
*/
this.TotalCount = null;
/**
* Information of bound plug-ins
* @type {Array.<AttachedPluginInfo> || null}
*/
this.PluginSummary = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.PluginSummary) {
this.PluginSummary = new Array();
for (let z in params.PluginSummary) {
let obj = new AttachedPluginInfo();
obj.deserialize(params.PluginSummary[z]);
this.PluginSummary.push(obj);
}
}
}
}
/**
* DescribeIPStrategysStatus response structure.
* @class
*/
class DescribeIPStrategysStatusResponse extends AbstractModel {
constructor(){
super();
/**
* List of eligible policies.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {IPStrategiesStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new IPStrategiesStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpdateApiAppKey response structure.
* @class
*/
class UpdateApiAppKeyResponse extends AbstractModel {
constructor(){
super();
/**
* Whether update succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UnBindSecretIds response structure.
* @class
*/
class UnBindSecretIdsResponse extends AbstractModel {
constructor(){
super();
/**
* Whether unbinding succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateApiApp request structure.
* @class
*/
class CreateApiAppRequest extends AbstractModel {
constructor(){
super();
/**
* Custom application name.
* @type {string || null}
*/
this.ApiAppName = null;
/**
* Application description
* @type {string || null}
*/
this.ApiAppDesc = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ApiAppName = 'ApiAppName' in params ? params.ApiAppName : null;
this.ApiAppDesc = 'ApiAppDesc' in params ? params.ApiAppDesc : null;
}
}
/**
* EnableApiKey request structure.
* @class
*/
class EnableApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* ID of the key to be enabled.
* @type {string || null}
*/
this.AccessKeyId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
}
}
/**
* ResetAPIDocPassword response structure.
* @class
*/
class ResetAPIDocPasswordResponse extends AbstractModel {
constructor(){
super();
/**
* Basic information of API document
* @type {APIDoc || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new APIDoc();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeServicesStatus request structure.
* @class
*/
class DescribeServicesStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Number of results to be returned. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
/**
* Offset. Default value: 0.
* @type {number || null}
*/
this.Offset = null;
/**
* Filter. Valid values: `ServiceId`, `ServiceName`, `NotUsagePlanId`, `Environment`, `IpVersion`, `InstanceId`, `NetType`, `EIAMAppId`.
* @type {Array.<Filter> || null}
*/
this.Filters = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Limit = 'Limit' in params ? params.Limit : null;
this.Offset = 'Offset' in params ? params.Offset : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
}
}
/**
* Request parameter
* @class
*/
class RequestParameter extends AbstractModel {
constructor(){
super();
/**
* Request parameter name
* @type {string || null}
*/
this.Name = null;
/**
* Description
* @type {string || null}
*/
this.Desc = null;
/**
* Parameter position
* @type {string || null}
*/
this.Position = null;
/**
* Parameter type
* @type {string || null}
*/
this.Type = null;
/**
* Default value
* @type {string || null}
*/
this.DefaultValue = null;
/**
* Whether it is required
* @type {boolean || null}
*/
this.Required = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
this.Desc = 'Desc' in params ? params.Desc : null;
this.Position = 'Position' in params ? params.Position : null;
this.Type = 'Type' in params ? params.Type : null;
this.DefaultValue = 'DefaultValue' in params ? params.DefaultValue : null;
this.Required = 'Required' in params ? params.Required : null;
}
}
/**
* Upstream health check parameter configuration
* @class
*/
class UpstreamHealthChecker extends AbstractModel {
constructor(){
super();
/**
* Specifies whether to enable active health check
* @type {boolean || null}
*/
this.EnableActiveCheck = null;
/**
* Specifies whether the enable passive health check
* @type {boolean || null}
*/
this.EnablePassiveCheck = null;
/**
* The HTTP status code that indicates that the upstream is healthy
* @type {string || null}
*/
this.HealthyHttpStatus = null;
/**
* The HTTP status code that indicates that the upstream is unhealthy
* @type {string || null}
*/
this.UnhealthyHttpStatus = null;
/**
* The threshold on consecutive TCP errors. Range: [0, 254]. `0` indicates not to check TCP.
* @type {number || null}
*/
this.TcpFailureThreshold = null;
/**
* The threshold on consecutive timeouts. Range: [0, 254]. `0` indicates not to check TCP.
* @type {number || null}
*/
this.TimeoutThreshold = null;
/**
* The threshold on consecutive HTTP errors. Range: [0, 254]. `0` indicates not to check HTTP.
* @type {number || null}
*/
this.HttpFailureThreshold = null;
/**
* The path for active health check. It defaults to `/`.
* @type {string || null}
*/
this.ActiveCheckHttpPath = null;
/**
* The timeout period for active health check in seconds. Default: `5`.
* @type {number || null}
*/
this.ActiveCheckTimeout = null;
/**
* The interval for active health check in seconds. Default: `5`.
* @type {number || null}
*/
this.ActiveCheckInterval = null;
/**
* Header of the active health check request
* @type {Array.<UpstreamHealthCheckerReqHeaders> || null}
*/
this.ActiveRequestHeader = null;
/**
* The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.
* @type {number || null}
*/
this.UnhealthyTimeout = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EnableActiveCheck = 'EnableActiveCheck' in params ? params.EnableActiveCheck : null;
this.EnablePassiveCheck = 'EnablePassiveCheck' in params ? params.EnablePassiveCheck : null;
this.HealthyHttpStatus = 'HealthyHttpStatus' in params ? params.HealthyHttpStatus : null;
this.UnhealthyHttpStatus = 'UnhealthyHttpStatus' in params ? params.UnhealthyHttpStatus : null;
this.TcpFailureThreshold = 'TcpFailureThreshold' in params ? params.TcpFailureThreshold : null;
this.TimeoutThreshold = 'TimeoutThreshold' in params ? params.TimeoutThreshold : null;
this.HttpFailureThreshold = 'HttpFailureThreshold' in params ? params.HttpFailureThreshold : null;
this.ActiveCheckHttpPath = 'ActiveCheckHttpPath' in params ? params.ActiveCheckHttpPath : null;
this.ActiveCheckTimeout = 'ActiveCheckTimeout' in params ? params.ActiveCheckTimeout : null;
this.ActiveCheckInterval = 'ActiveCheckInterval' in params ? params.ActiveCheckInterval : null;
if (params.ActiveRequestHeader) {
this.ActiveRequestHeader = new Array();
for (let z in params.ActiveRequestHeader) {
let obj = new UpstreamHealthCheckerReqHeaders();
obj.deserialize(params.ActiveRequestHeader[z]);
this.ActiveRequestHeader.push(obj);
}
}
this.UnhealthyTimeout = 'UnhealthyTimeout' in params ? params.UnhealthyTimeout : null;
}
}
/**
* Details of environments bound to service
* @class
*/
class ServiceEnvironmentSet extends AbstractModel {
constructor(){
super();
/**
* Total number of environments bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* List of environments bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<Environment> || null}
*/
this.EnvironmentList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.EnvironmentList) {
this.EnvironmentList = new Array();
for (let z in params.EnvironmentList) {
let obj = new Environment();
obj.deserialize(params.EnvironmentList[z]);
this.EnvironmentList.push(obj);
}
}
}
}
/**
* Service release version
* @class
*/
class ServiceReleaseVersion extends AbstractModel {
constructor(){
super();
/**
* Total number of published versions.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.TotalCount = null;
/**
* Release version list.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {Array.<DescribeServiceReleaseVersionResultVersionListInfo> || null}
*/
this.VersionList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TotalCount = 'TotalCount' in params ? params.TotalCount : null;
if (params.VersionList) {
this.VersionList = new Array();
for (let z in params.VersionList) {
let obj = new DescribeServiceReleaseVersionResultVersionListInfo();
obj.deserialize(params.VersionList[z]);
this.VersionList.push(obj);
}
}
}
}
/**
* DescribeServicesStatus response structure.
* @class
*/
class DescribeServicesStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Service list query result.
Note: this field may return null, indicating that no valid values can be obtained.
* @type {ServicesStatus || null}
*/
this.Result = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.Result) {
let obj = new ServicesStatus();
obj.deserialize(params.Result)
this.Result = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateApiKey request structure.
* @class
*/
class CreateApiKeyRequest extends AbstractModel {
constructor(){
super();
/**
* Custom key name.
* @type {string || null}
*/
this.SecretName = null;
/**
* Key type. Valid values: auto, manual (custom key). Default value: auto.
* @type {string || null}
*/
this.AccessKeyType = null;
/**
* Custom key ID, which is required if `AccessKeyType` is `manual`. It can contain 5-50 letters, digits, and underscores.
* @type {string || null}
*/
this.AccessKeyId = null;
/**
* Custom key, which is required if `AccessKeyType` is `manual`. It can contain 10-50 letters, digits, and underscores.
* @type {string || null}
*/
this.AccessKeySecret = null;
/**
*
* @type {Array.<Tag> || null}
*/
this.Tags = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.SecretName = 'SecretName' in params ? params.SecretName : null;
this.AccessKeyType = 'AccessKeyType' in params ? params.AccessKeyType : null;
this.AccessKeyId = 'AccessKeyId' in params ? params.AccessKeyId : null;
this.AccessKeySecret = 'AccessKeySecret' in params ? params.AccessKeySecret : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
}
}
module.exports = {
IPStrategyApiStatus: IPStrategyApiStatus,
UnBindSubDomainResponse: UnBindSubDomainResponse,
UpstreamInfo: UpstreamInfo,
UpdateApiKeyRequest: UpdateApiKeyRequest,
Service: Service,
DeleteAPIDocRequest: DeleteAPIDocRequest,
AttachedPluginInfo: AttachedPluginInfo,
ApiUsagePlanSet: ApiUsagePlanSet,
DescribeAPIDocDetailRequest: DescribeAPIDocDetailRequest,
CreateApiResultInfo: CreateApiResultInfo,
ModifyAPIDocResponse: ModifyAPIDocResponse,
AttachedApiSummary: AttachedApiSummary,
DescribeUsagePlanRequest: DescribeUsagePlanRequest,
DeleteUsagePlanResponse: DeleteUsagePlanResponse,
ImportOpenApiResponse: ImportOpenApiResponse,
DisableApiKeyResponse: DisableApiKeyResponse,
DescribeApiResponse: DescribeApiResponse,
DescribeServiceForApiAppRequest: DescribeServiceForApiAppRequest,
UnReleaseServiceRequest: UnReleaseServiceRequest,
DetachPluginRequest: DetachPluginRequest,
ModifySubDomainRequest: ModifySubDomainRequest,
DescribeApiAppsStatusRequest: DescribeApiAppsStatusRequest,
DescribeServiceUsagePlanRequest: DescribeServiceUsagePlanRequest,
DescribeServiceEnvironmentListResponse: DescribeServiceEnvironmentListResponse,
DescribeApiAppBindApisStatusRequest: DescribeApiAppBindApisStatusRequest,
ModifyApiResponse: ModifyApiResponse,
DescribeApiResultServiceParametersInfo: DescribeApiResultServiceParametersInfo,
CreateApiRspSet: CreateApiRspSet,
ApiInfo: ApiInfo,
TargetServicesReq: TargetServicesReq,
DescribeUsagePlansStatusRequest: DescribeUsagePlansStatusRequest,
TsfLoadBalanceConfResp: TsfLoadBalanceConfResp,
CreateIPStrategyRequest: CreateIPStrategyRequest,
IPStrategy: IPStrategy,
DescribeUsagePlansStatusResponse: DescribeUsagePlansStatusResponse,
HealthCheckConf: HealthCheckConf,
DeleteUpstreamRequest: DeleteUpstreamRequest,
Plugin: Plugin,
UnbindApiAppResponse: UnbindApiAppResponse,
ModifyUpstreamRequest: ModifyUpstreamRequest,
DescribeApiUsagePlanResponse: DescribeApiUsagePlanResponse,
DeleteIPStrategyRequest: DeleteIPStrategyRequest,
DescribeApiAppRequest: DescribeApiAppRequest,
DescribePluginResponse: DescribePluginResponse,
DescribeUpstreamBindApisRequest: DescribeUpstreamBindApisRequest,
DescribePluginsByApiResponse: DescribePluginsByApiResponse,
DomainSets: DomainSets,
K8sService: K8sService,
DeleteUsagePlanRequest: DeleteUsagePlanRequest,
DeleteServiceRequest: DeleteServiceRequest,
DescribeApiEnvironmentStrategyRequest: DescribeApiEnvironmentStrategyRequest,
UpstreamHealthCheckerReqHeaders: UpstreamHealthCheckerReqHeaders,
ServiceEnvironmentStrategy: ServiceEnvironmentStrategy,
DescribeServiceForApiAppResponse: DescribeServiceForApiAppResponse,
ServiceConfig: ServiceConfig,
DeleteApiAppResponse: DeleteApiAppResponse,
DescribeServiceResponse: DescribeServiceResponse,
UsagePlanEnvironmentStatus: UsagePlanEnvironmentStatus,
ModifyIPStrategyResponse: ModifyIPStrategyResponse,
BindSubDomainResponse: BindSubDomainResponse,
BindEnvironmentResponse: BindEnvironmentResponse,
Tag: Tag,
DescribeApiBindApiAppsStatusResponse: DescribeApiBindApiAppsStatusResponse,
ConstantParameter: ConstantParameter,
DescribeApiForApiAppRequest: DescribeApiForApiAppRequest,
APIDocs: APIDocs,
LogQuery: LogQuery,
ServiceParameter: ServiceParameter,
ModifyServiceResponse: ModifyServiceResponse,
DisableApiKeyRequest: DisableApiKeyRequest,
PathMapping: PathMapping,
UnBindIPStrategyResponse: UnBindIPStrategyResponse,
ModifyPluginRequest: ModifyPluginRequest,
BindIPStrategyResponse: BindIPStrategyResponse,
AvailableApiInfo: AvailableApiInfo,
DescribeApisStatusRequest: DescribeApisStatusRequest,
DeleteServiceSubDomainMappingRequest: DeleteServiceSubDomainMappingRequest,
BindApiAppRequest: BindApiAppRequest,
DescribeIPStrategyResponse: DescribeIPStrategyResponse,
DescribePluginRequest: DescribePluginRequest,
AttachedApiInfo: AttachedApiInfo,
CreateApiResponse: CreateApiResponse,
DescribeIPStrategyApisStatusRequest: DescribeIPStrategyApisStatusRequest,
UnBindEnvironmentRequest: UnBindEnvironmentRequest,
DescribeUpstreamInfo: DescribeUpstreamInfo,
ModifyApiEnvironmentStrategyRequest: ModifyApiEnvironmentStrategyRequest,
ServiceReleaseHistory: ServiceReleaseHistory,
DescribeUpstreamBindApisResponse: DescribeUpstreamBindApisResponse,
IPStrategiesStatus: IPStrategiesStatus,
CreateUsagePlanResponse: CreateUsagePlanResponse,
ReqParameter: ReqParameter,
DeletePluginRequest: DeletePluginRequest,
Base64EncodedTriggerRule: Base64EncodedTriggerRule,
RequestConfig: RequestConfig,
DeleteApiKeyResponse: DeleteApiKeyResponse,
EnvironmentStrategy: EnvironmentStrategy,
UsagePlan: UsagePlan,
DescribeServiceReleaseVersionRequest: DescribeServiceReleaseVersionRequest,
DescribeUsagePlanSecretIdsRequest: DescribeUsagePlanSecretIdsRequest,
DescribeLogSearchResponse: DescribeLogSearchResponse,
ModifyAPIDocRequest: ModifyAPIDocRequest,
UnBindIPStrategyRequest: UnBindIPStrategyRequest,
DescribeUpstreamsResponse: DescribeUpstreamsResponse,
DescribePluginApisRequest: DescribePluginApisRequest,
ResponseErrorCodeReq: ResponseErrorCodeReq,
CreateServiceRequest: CreateServiceRequest,
DescribeIPStrategysStatusRequest: DescribeIPStrategysStatusRequest,
DemoteServiceUsagePlanResponse: DemoteServiceUsagePlanResponse,
DescribePluginApisResponse: DescribePluginApisResponse,
EnableApiKeyResponse: EnableApiKeyResponse,
DeleteApiAppRequest: DeleteApiAppRequest,
UnReleaseServiceResponse: UnReleaseServiceResponse,
CreateAPIDocResponse: CreateAPIDocResponse,
DescribeServiceRequest: DescribeServiceRequest,
UsagePlansStatus: UsagePlansStatus,
CreateUsagePlanRequest: CreateUsagePlanRequest,
DescribeUsagePlanSecretIdsResponse: DescribeUsagePlanSecretIdsResponse,
CreatePluginRequest: CreatePluginRequest,
MicroServiceReq: MicroServiceReq,
ModifySubDomainResponse: ModifySubDomainResponse,
DescribeExclusiveInstanceRegionsResponse: DescribeExclusiveInstanceRegionsResponse,
BindSecretIdsRequest: BindSecretIdsRequest,
UnBindEnvironmentResponse: UnBindEnvironmentResponse,
ModifyUpstreamResultInfo: ModifyUpstreamResultInfo,
DeleteApiKeyRequest: DeleteApiKeyRequest,
DescribeApisStatusResultInfo: DescribeApisStatusResultInfo,
DescribeIPStrategyApisStatusResponse: DescribeIPStrategyApisStatusResponse,
ModifyApiAppResponse: ModifyApiAppResponse,
UpdateApiAppKeyRequest: UpdateApiAppKeyRequest,
ApigatewayTags: ApigatewayTags,
DomainSetList: DomainSetList,
ServicesStatus: ServicesStatus,
DescribeApiKeyResponse: DescribeApiKeyResponse,
ModifyApiIncrementResponse: ModifyApiIncrementResponse,
ModifyApiRequest: ModifyApiRequest,
DescribeAllPluginApisResponse: DescribeAllPluginApisResponse,
ModifyUsagePlanRequest: ModifyUsagePlanRequest,
ApiRequestConfig: ApiRequestConfig,
ModifyServiceRequest: ModifyServiceRequest,
DescribeAllPluginApisRequest: DescribeAllPluginApisRequest,
ApiIdStatus: ApiIdStatus,
CreateApiRequest: CreateApiRequest,
DescribeServiceEnvironmentStrategyRequest: DescribeServiceEnvironmentStrategyRequest,
DescribeInstancesNetworkConfigResponse: DescribeInstancesNetworkConfigResponse,
ReleaseServiceRequest: ReleaseServiceRequest,
DeleteServiceResponse: DeleteServiceResponse,
DescribeServiceEnvironmentReleaseHistoryResponse: DescribeServiceEnvironmentReleaseHistoryResponse,
Environment: Environment,
DescribeAPIDocsRequest: DescribeAPIDocsRequest,
DescribePluginsByApiRequest: DescribePluginsByApiRequest,
ServiceReleaseHistoryInfo: ServiceReleaseHistoryInfo,
CreatePluginResponse: CreatePluginResponse,
UsagePlanBindSecret: UsagePlanBindSecret,
K8sLabel: K8sLabel,
ReleaseServiceResponse: ReleaseServiceResponse,
APIDocInfo: APIDocInfo,
CosConfig: CosConfig,
ModifyApiIncrementRequest: ModifyApiIncrementRequest,
ServiceUsagePlanSet: ServiceUsagePlanSet,
CreateUpstreamRequest: CreateUpstreamRequest,
ModifyServiceEnvironmentStrategyResponse: ModifyServiceEnvironmentStrategyResponse,
UpdateApiKeyResponse: UpdateApiKeyResponse,
DescribeApiBindApiAppsStatusRequest: DescribeApiBindApiAppsStatusRequest,
DescribeApisStatusResponse: DescribeApisStatusResponse,
DescribeApiKeysStatusRequest: DescribeApiKeysStatusRequest,
DemoteServiceUsagePlanRequest: DemoteServiceUsagePlanRequest,
BindSecretIdsResponse: BindSecretIdsResponse,
CreateApiRsp: CreateApiRsp,
UsagePlanBindEnvironment: UsagePlanBindEnvironment,
DeleteApiRequest: DeleteApiRequest,
DescribeExclusiveInstanceRegionsRequest: DescribeExclusiveInstanceRegionsRequest,
DescribeApiAppResponse: DescribeApiAppResponse,
DescribeServiceSubDomainMappingsResponse: DescribeServiceSubDomainMappingsResponse,
OauthConfig: OauthConfig,
DescribeApiAppsStatusResponse: DescribeApiAppsStatusResponse,
ServiceSubDomainMappings: ServiceSubDomainMappings,
DescribeApiKeyRequest: DescribeApiKeyRequest,
DescribeAPIDocDetailResponse: DescribeAPIDocDetailResponse,
Filter: Filter,
BindApiAppResponse: BindApiAppResponse,
UsagePlanBindSecretStatus: UsagePlanBindSecretStatus,
DeleteServiceSubDomainMappingResponse: DeleteServiceSubDomainMappingResponse,
CreateApiKeyResponse: CreateApiKeyResponse,
DescribeUpstreamsRequest: DescribeUpstreamsRequest,
UsagePlanEnvironment: UsagePlanEnvironment,
ModifyIPStrategyRequest: ModifyIPStrategyRequest,
ModifyPluginResponse: ModifyPluginResponse,
UnBindSecretIdsRequest: UnBindSecretIdsRequest,
ApiEnvironmentStrategy: ApiEnvironmentStrategy,
CreateUpstreamResponse: CreateUpstreamResponse,
ResetAPIDocPasswordRequest: ResetAPIDocPasswordRequest,
ApiUsagePlan: ApiUsagePlan,
IPStrategyApi: IPStrategyApi,
DescribeAPIDocsResponse: DescribeAPIDocsResponse,
DescribeServiceSubDomainMappingsRequest: DescribeServiceSubDomainMappingsRequest,
DeletePluginResponse: DeletePluginResponse,
DescribeUpstreamBindApis: DescribeUpstreamBindApis,
ModifyServiceEnvironmentStrategyRequest: ModifyServiceEnvironmentStrategyRequest,
CreateAPIDocRequest: CreateAPIDocRequest,
DescribeApiAppBindApisStatusResponse: DescribeApiAppBindApisStatusResponse,
DescribeServiceSubDomainsRequest: DescribeServiceSubDomainsRequest,
ModifyApiAppRequest: ModifyApiAppRequest,
ReleaseService: ReleaseService,
DescribeUsagePlanEnvironmentsResponse: DescribeUsagePlanEnvironmentsResponse,
DescribeServiceSubDomainsResponse: DescribeServiceSubDomainsResponse,
AttachPluginRequest: AttachPluginRequest,
DescribeApisStatusResultApiIdStatusSetInfo: DescribeApisStatusResultApiIdStatusSetInfo,
ModifyApiEnvironmentStrategyResponse: ModifyApiEnvironmentStrategyResponse,
BindSubDomainRequest: BindSubDomainRequest,
ApiAppInfos: ApiAppInfos,
DescribeServiceReleaseVersionResultVersionListInfo: DescribeServiceReleaseVersionResultVersionListInfo,
CreateIPStrategyResponse: CreateIPStrategyResponse,
DeleteApiResponse: DeleteApiResponse,
BindIPStrategyRequest: BindIPStrategyRequest,
UpdateServiceRequest: UpdateServiceRequest,
BuildAPIDocResponse: BuildAPIDocResponse,
ErrorCodes: ErrorCodes,
DescribeServiceEnvironmentListRequest: DescribeServiceEnvironmentListRequest,
ServiceEnvironmentStrategyStatus: ServiceEnvironmentStrategyStatus,
MicroService: MicroService,
DescribeApiEnvironmentStrategyResponse: DescribeApiEnvironmentStrategyResponse,
DescribeApiRequest: DescribeApiRequest,
ApiAppInfo: ApiAppInfo,
DeleteIPStrategyResponse: DeleteIPStrategyResponse,
ApiInfoSummary: ApiInfoSummary,
ApiKey: ApiKey,
BindApiInfo: BindApiInfo,
ApiAppApiInfo: ApiAppApiInfo,
DescribeUsagePlanResponse: DescribeUsagePlanResponse,
ApiEnvironmentStrategyStatus: ApiEnvironmentStrategyStatus,
AttachPluginResponse: AttachPluginResponse,
BindEnvironmentRequest: BindEnvironmentRequest,
ModifyUpstreamResponse: ModifyUpstreamResponse,
DescribeIPStrategyRequest: DescribeIPStrategyRequest,
DescribeApiForApiAppResponse: DescribeApiForApiAppResponse,
DescribeInstancesNetworkConfigRequest: DescribeInstancesNetworkConfigRequest,
DescribeUsagePlanEnvironmentsRequest: DescribeUsagePlanEnvironmentsRequest,
ImportOpenApiRequest: ImportOpenApiRequest,
DescribeServiceReleaseVersionResponse: DescribeServiceReleaseVersionResponse,
UpstreamNode: UpstreamNode,
ApiAppApiInfos: ApiAppApiInfos,
DeleteUpstreamResponse: DeleteUpstreamResponse,
UpdateServiceResponse: UpdateServiceResponse,
UsagePlanInfo: UsagePlanInfo,
DescribeServiceEnvironmentReleaseHistoryRequest: DescribeServiceEnvironmentReleaseHistoryRequest,
UnbindApiAppRequest: UnbindApiAppRequest,
CreateServiceResponse: CreateServiceResponse,
DeleteAPIDocResponse: DeleteAPIDocResponse,
DescribeServiceEnvironmentStrategyResponse: DescribeServiceEnvironmentStrategyResponse,
DesApisStatus: DesApisStatus,
DescribeApiKeysStatusResponse: DescribeApiKeysStatusResponse,
UsagePlanStatusInfo: UsagePlanStatusInfo,
DescribeLogSearchRequest: DescribeLogSearchRequest,
BuildAPIDocRequest: BuildAPIDocRequest,
DetachPluginResponse: DetachPluginResponse,
ApiKeysStatus: ApiKeysStatus,
ModifyUsagePlanResponse: ModifyUsagePlanResponse,
APIDoc: APIDoc,
DescribeServiceUsagePlanResponse: DescribeServiceUsagePlanResponse,
CreateApiAppResponse: CreateApiAppResponse,
DescribeApiUsagePlanRequest: DescribeApiUsagePlanRequest,
UnBindSubDomainRequest: UnBindSubDomainRequest,
AttachedPluginSummary: AttachedPluginSummary,
DescribeIPStrategysStatusResponse: DescribeIPStrategysStatusResponse,
UpdateApiAppKeyResponse: UpdateApiAppKeyResponse,
UnBindSecretIdsResponse: UnBindSecretIdsResponse,
CreateApiAppRequest: CreateApiAppRequest,
EnableApiKeyRequest: EnableApiKeyRequest,
ResetAPIDocPasswordResponse: ResetAPIDocPasswordResponse,
DescribeServicesStatusRequest: DescribeServicesStatusRequest,
RequestParameter: RequestParameter,
UpstreamHealthChecker: UpstreamHealthChecker,
ServiceEnvironmentSet: ServiceEnvironmentSet,
ServiceReleaseVersion: ServiceReleaseVersion,
DescribeServicesStatusResponse: DescribeServicesStatusResponse,
CreateApiKeyRequest: CreateApiKeyRequest,
}