tencentcloud-sdk-nodejs-intl-en
Version:
1,770 lines (1,497 loc) • 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 fronte