@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,424 lines • 396 kB
TypeScript
/**
* GenerateVpnConnectionDefaultHealthCheckIp请求参数结构体
*/
export interface GenerateVpnConnectionDefaultHealthCheckIpRequest {
/**
* VPN网关id, 例如:vpngw-1w9tue3d
*/
VpnGatewayId: string;
}
/**
* CreateNetworkAcl返回参数结构体
*/
export interface CreateNetworkAclResponse {
/**
* 网络ACL实例。
*/
NetworkAcl?: NetworkAcl;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网络ACL
*/
export interface NetworkAcl {
/**
* `VPC`实例`ID`。
*/
VpcId?: string;
/**
* 网络ACL实例`ID`。
*/
NetworkAclId?: string;
/**
* 网络ACL名称,最大长度为60。
*/
NetworkAclName?: string;
/**
* 创建时间。
*/
CreatedTime?: string;
/**
* 网络ACL关联的子网数组。
*/
SubnetSet?: Array<Subnet>;
/**
* 该参数仅对三元组ACL有效,网络ACl入站规则。
*/
IngressEntries?: Array<NetworkAclEntry>;
/**
* 该参数仅对三元组ACL有效,网络ACL出站规则。
*/
EgressEntries?: Array<NetworkAclEntry>;
/**
* 网络ACL类型。三元组:'TRIPLE' 五元组:'QUINTUPLE'
*/
NetworkAclType?: string;
/**
* 标签键值对
*/
TagSet?: Array<Tag>;
}
/**
* ModifyAddressTemplateAttribute返回参数结构体
*/
export interface ModifyAddressTemplateAttributeResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateDhcpIpWithAddressIp请求参数结构体
*/
export interface DisassociateDhcpIpWithAddressIpRequest {
/**
* `DhcpIp`唯一`ID`,形如:`dhcpip-9o233uri`。必须是已绑定`EIP`的`DhcpIp`。
*/
DhcpIpId: string;
}
/**
* 用户安全组配额限制。
*/
export interface SecurityGroupLimitSet {
/**
* 每个项目每个地域可创建安全组数
*/
SecurityGroupLimit: number;
/**
* 安全组下的最大规则数
*/
SecurityGroupPolicyLimit: number;
/**
* 安全组下嵌套安全组规则数
*/
ReferedSecurityGroupLimit: number;
/**
* 单安全组关联实例数
*/
SecurityGroupInstanceLimit: number;
/**
* 实例关联安全组数
*/
InstanceSecurityGroupLimit: number;
/**
* 安全组展开后的规则数限制
*/
SecurityGroupExtendedPolicyLimit?: number;
/**
* 被引用的安全组关联CVM、ENI的实例配额
*/
SecurityGroupReferedCvmAndEniLimit?: number;
/**
* 被引用的安全组关联数据库、LB等服务实例配额
*/
SecurityGroupReferedSvcLimit?: number;
}
/**
* LockCcns请求参数结构体
*/
export declare type LockCcnsRequest = null;
/**
* CreateRoutes请求参数结构体
*/
export interface CreateRoutesRequest {
/**
* 路由表实例ID。
*/
RouteTableId: string;
/**
* 路由策略对象。
*/
Routes: Array<Route>;
}
/**
* DescribeHaVips返回参数结构体
*/
export interface DescribeHaVipsResponse {
/**
* 符合条件的对象数。
*/
TotalCount?: number;
/**
* `HAVIP`对象数组。
*/
HaVipSet?: Array<HaVip>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 安全组关联的实例统计
*/
export interface SecurityGroupAssociationStatistics {
/**
* 安全组实例ID。
*/
SecurityGroupId: string;
/**
* 云服务器实例数。
*/
CVM: number;
/**
* MySQL数据库实例数。
*/
CDB: number;
/**
* 弹性网卡实例数。
*/
ENI: number;
/**
* 被安全组引用数。
*/
SG: number;
/**
* 负载均衡实例数。
*/
CLB: number;
/**
* 全量实例的绑定统计。
*/
InstanceStatistics: Array<InstanceStatistic>;
/**
* 所有资源的总计数(不包含被安全组引用数)。
*/
TotalCount: number;
}
/**
* DeleteServiceTemplate返回参数结构体
*/
export interface DeleteServiceTemplateResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateServiceTemplate请求参数结构体
*/
export interface CreateServiceTemplateRequest {
/**
* 协议端口模板名称。
*/
ServiceTemplateName: string;
/**
* 支持单个端口、多个端口、连续端口及所有端口,协议支持:TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。
*/
Services?: Array<string>;
/**
* 支持添加备注,单个端口、多个端口、连续端口及所有端口,协议支持:TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。
*/
ServicesExtra?: Array<ServicesInfo>;
}
/**
* CreateVpcPeeringConnection请求参数结构体
*/
export interface CreateVpcPeeringConnectionRequest {
/**
* 本端VPC唯一ID。
*/
SourceVpcId: string;
/**
* 对等连接名称。
*/
PeeringConnectionName: string;
/**
* 对端VPC唯一ID。
*/
DestinationVpcId: string;
/**
* 对端用户UIN。
*/
DestinationUin: string;
/**
* 对端地域。
*/
DestinationRegion: string;
/**
* 带宽上限,单位Mbps。
*/
Bandwidth?: number;
/**
* 互通类型,VPC_PEER:VPC间互通;VPC_BM_PEER:VPC与黑石网络互通。
*/
Type?: string;
/**
* 计费模式,日峰值POSTPAID_BY_DAY_MAX,月95POSTPAID_BY_MONTH_95。
*/
ChargeType?: string;
/**
* 服务分级:PT、AU、AG。
*/
QosLevel?: string;
}
/**
* DescribeBandwidthPackageResources请求参数结构体
*/
export interface DescribeBandwidthPackageResourcesRequest {
/**
* 标识 共享带宽包 的唯一 ID 列表。共享带宽包 唯一 ID 形如:`bwp-11112222`。
*/
BandwidthPackageId: string;
/**
* 每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AddressIds`和`Filters`。详细的过滤条件如下:
<li> resource-id - String - 是否必填:否 - (过滤条件)按照 共享带宽包内资源 的唯一 ID 过滤。共享带宽包内资源 唯一 ID 形如:eip-11112222。</li>
<li> resource-type - String - 是否必填:否 - (过滤条件)按照 共享带宽包内资源 类型过滤,目前仅支持 弹性IP 和 负载均衡 两种类型,可选值为 Address 和 LoadBalance。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。
*/
Limit?: number;
}
/**
* DescribeVpnConnections请求参数结构体
*/
export interface DescribeVpnConnectionsRequest {
/**
* VPN通道实例ID。形如:vpnx-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnConnectionIds和Filters。
*/
VpnConnectionIds?: Array<string>;
/**
* 过滤条件。每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定VpnConnectionIds和Filters。
<li>vpc-id - String - VPC实例ID,形如:`vpc-0a36uwkr`。</li>
<li>vpn-gateway-id - String - VPN网关实例ID,形如:`vpngw-p4lmqawn`。</li>
<li>customer-gateway-id - String - 对端网关实例ID,形如:`cgw-l4rblw63`。</li>
<li>vpn-connection-name - String - 通道名称,形如:`test-vpn`。</li>
<li>vpn-connection-id - String - 通道实例ID,形如:`vpnx-5p7vkch8"`。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* CreateAssistantCidr请求参数结构体
*/
export interface CreateAssistantCidrRequest {
/**
* `VPC`实例`ID`。形如:`vpc-6v2ht8q5`
*/
VpcId: string;
/**
* CIDR数组,格式如["10.0.0.0/16", "172.16.0.0/16"]
*/
CidrBlocks: Array<string>;
}
/**
* RejectVpcPeeringConnection请求参数结构体
*/
export interface RejectVpcPeeringConnectionRequest {
/**
* 对等连接唯一ID。
*/
PeeringConnectionId: string;
}
/**
* DescribeNetworkInterfaces请求参数结构体
*/
export interface DescribeNetworkInterfacesRequest {
/**
* 弹性网卡实例ID查询。形如:eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。
*/
NetworkInterfaceIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定NetworkInterfaceIds和Filters。
<li>vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。</li>
<li>subnet-id - String - (过滤条件)所属子网实例ID,形如:subnet-f49l6u0z。</li>
<li>network-interface-id - String - (过滤条件)弹性网卡实例ID,形如:eni-5k56k7k7。</li>
<li>attachment.instance-id - String - (过滤条件)绑定的云服务器实例ID,形如:ins-3nqpdn3i。</li>
<li>groups.security-group-id - String - (过滤条件)绑定的安全组实例ID,例如:sg-f9ekbxeq。</li>
<li>network-interface-name - String - (过滤条件)网卡实例名称。</li>
<li>network-interface-description - String - (过滤条件)网卡实例描述。</li>
<li>address-ip - String - (过滤条件)内网IPv4地址,单IP后缀模糊匹配,多IP精确匹配。可以与`ip-exact-match`配合做单IP的精确匹配查询。</li>
<li>ip-exact-match - Boolean - (过滤条件)内网IPv4精确匹配查询,存在多值情况,只取第一个。</li>
<li>tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。使用请参考示例2</li>
<li>tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2。</li>
<li>is-primary - Boolean - 是否必填:否 - (过滤条件)按照是否主网卡进行过滤。值为true时,仅过滤主网卡;值为false时,仅过滤辅助网卡;此过滤参数未提供时,同时过滤主网卡和辅助网卡。</li>
<li>eni-type - String -是否必填:否- (过滤条件)按照网卡类型进行过滤。“0”-辅助网卡,“1”-主网卡,“2”:中继网卡。</li>
<li>eni-qos - String -是否必填:否- (过滤条件)按照网卡服务质量进行过滤。“AG”-服务质量为云铜,“AU”-服务质量为云银。</li>
<li>address-ipv6 - String - 是否必填:否 -(过滤条件)内网IPv6地址过滤,支持多ipv6地址查询,如果和address-ip一起使用取交集。</li>
<li>public-address-ip - String - (过滤条件)公网IPv4地址,精确匹配。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* DescribeVpcLimits请求参数结构体
*/
export interface DescribeVpcLimitsRequest {
/**
* 配额名称。每次最大查询100个配额类型。
*/
LimitTypes: Array<string>;
}
/**
* ReleaseIp6AddressesBandwidth返回参数结构体
*/
export interface ReleaseIp6AddressesBandwidthResponse {
/**
* 异步任务TaskId。可以使用[DescribeTaskResult](https://cloud.tencent.com/document/api/215/36271)接口查询任务状态。
*/
TaskId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVpcIpv6Addresses请求参数结构体
*/
export interface DescribeVpcIpv6AddressesRequest {
/**
* `VPC`实例`ID`,形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* `IP`地址列表,批量查询单次请求最多支持`10`个。
*/
Ipv6Addresses?: Array<string>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* VPC下的子网ID。
*/
SubnetId?: string;
}
/**
* SSL-VPN-CLIENT 出参
*/
export interface SslVpnClient {
/**
* VPC实例ID。
*/
VpcId?: string;
/**
* SSL-VPN-SERVER 实例ID。
*/
SslVpnServerId?: string;
/**
* 证书状态。
0:创建中
1:正常
2:已停用
3.已过期
4.创建出错
*/
CertStatus?: number;
/**
* SSL-VPN-CLIENT 实例ID。
*/
SslVpnClientId?: string;
/**
* 证书开始时间。
*/
CertBeginTime?: string;
/**
* 证书到期时间。
*/
CertEndTime?: string;
/**
* CLIENT NAME。
*/
Name?: string;
/**
* 创建CLIENT 状态。
0 创建中
1 创建出错
2 更新中
3 更新出错
4 销毁中
5 销毁出错
6 已连通
7 未知
*/
State?: string;
}
/**
* NAT的SNAT规则
*/
export interface SourceIpTranslationNatRule {
/**
* 资源ID,如果ResourceType为USERDEFINED,可以为空
*/
ResourceId: string;
/**
* 资源类型,目前包含SUBNET、NETWORKINTERFACE、USERDEFINED
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceType: string;
/**
* 源IP/网段
*/
PrivateIpAddress: string;
/**
* 弹性IP地址池
*/
PublicIpAddresses: Array<string>;
/**
* 描述
*/
Description: string;
/**
* Snat规则ID
*/
NatGatewaySnatId?: string;
/**
* NAT网关的ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
NatGatewayId?: string;
/**
* 私有网络VPC的ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* NAT网关SNAT规则创建时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedTime?: string;
}
/**
* DisableCcnRoutes请求参数结构体
*/
export interface DisableCcnRoutesRequest {
/**
* CCN实例ID。形如:ccn-f49l6u0z。
*/
CcnId: string;
/**
* CCN路由策略唯一ID。形如:ccnr-f49l6u0z。
*/
RouteIds: Array<string>;
}
/**
* ModifyNatGatewayDestinationIpPortTranslationNatRule返回参数结构体
*/
export interface ModifyNatGatewayDestinationIpPortTranslationNatRuleResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyIp6Rule返回参数结构体
*/
export interface ModifyIp6RuleResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetVpnGatewaysRenewFlag请求参数结构体
*/
export interface SetVpnGatewaysRenewFlagRequest {
/**
* VPNGW字符型ID列表。可通过[DescribeVpnGateways](https://cloud.tencent.com/document/api/215/17514)接口返回值VpnGatewaySet中的VpnGatewayId获取。
*/
VpnGatewayIds: Array<string>;
/**
* 自动续费标记 [0, 1, 2]
0表示默认状态(初始状态), 1表示自动续费,2表示明确不自动续费。
*/
AutoRenewFlag: number;
/**
* VPNGW类型['IPSEC', 'SSL'], 默认为IPSEC。
*/
Type?: string;
}
/**
* ModifyCcnRegionBandwidthLimitsType返回参数结构体
*/
export interface ModifyCcnRegionBandwidthLimitsTypeResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVpnGateways返回参数结构体
*/
export interface DescribeVpnGatewaysResponse {
/**
* 符合条件的实例数量。
*/
TotalCount?: number;
/**
* VPN网关实例详细信息列表。
*/
VpnGatewaySet?: Array<VpnGateway>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNetworkAclQuintupleEntries请求参数结构体
*/
export interface ModifyNetworkAclQuintupleEntriesRequest {
/**
* 网络ACL实例ID。例如:acl-12345678。
*/
NetworkAclId: string;
/**
* 网络五元组ACL规则集。
*/
NetworkAclQuintupleSet: NetworkAclQuintupleEntries;
}
/**
* 协议端口模板集合
*/
export interface ServiceTemplateGroup {
/**
* 协议端口模板集合实例ID,例如:ppmg-2klmrefu。
*/
ServiceTemplateGroupId: string;
/**
* 协议端口模板集合名称。
*/
ServiceTemplateGroupName: string;
/**
* 协议端口模板实例ID。
*/
ServiceTemplateIdSet: Array<string>;
/**
* 创建时间。
*/
CreatedTime?: string;
/**
* 协议端口模板实例信息。
*/
ServiceTemplateSet: Array<ServiceTemplate>;
}
/**
* CreateDhcpIp返回参数结构体
*/
export interface CreateDhcpIpResponse {
/**
* 新创建的`DhcpIp`信息。
*/
DhcpIpSet?: Array<DhcpIp>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVpnGatewaySslServer返回参数结构体
*/
export interface DeleteVpnGatewaySslServerResponse {
/**
* 异步任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIpGeolocationInfos请求参数结构体
*/
export interface DescribeIpGeolocationInfosRequest {
/**
* 需查询的IP地址列表,目前仅支持IPv4地址。查询的IP地址数量上限为100个。
*/
AddressIps: Array<string>;
/**
* 需查询的IP地址的字段信息。
*/
Fields?: IpField;
}
/**
* AddTemplateMember返回参数结构体
*/
export interface AddTemplateMemberResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDefaultSecurityGroup请求参数结构体
*/
export interface CreateDefaultSecurityGroupRequest {
/**
* 项目ID,默认0。可在qcloud控制台项目管理页面查询到。
*/
ProjectId?: string;
}
/**
* CreateSnapshotPolicies返回参数结构体
*/
export interface CreateSnapshotPoliciesResponse {
/**
* 快照策略。
*/
SnapshotPolicies: Array<SnapshotPolicy>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServiceTemplateGroups返回参数结构体
*/
export interface DescribeServiceTemplateGroupsResponse {
/**
* 符合条件的实例数量。
*/
TotalCount?: number;
/**
* 协议端口模板集合。
*/
ServiceTemplateGroupSet?: Array<ServiceTemplateGroup>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVpcEndPoint请求参数结构体
*/
export interface DescribeVpcEndPointRequest {
/**
* 过滤条件。
<li> end-point-service-id- String - (过滤条件)终端节点服务ID。</li>
<li>end-point-name - String - (过滤条件)终端节点实例名称。</li>
<li> end-point-id- String - (过滤条件)终端节点实例ID。</li>
<li> vpc-id- String - (过滤条件)VPC实例ID。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 单页返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 终端节点ID列表。
*/
EndPointId?: Array<string>;
}
/**
* 资源统计项。
*/
export interface ResourceStatisticsItem {
/**
* 资源类型。比如,CVM,ENI等。
*/
ResourceType: string;
/**
* 资源名称。
*/
ResourceName: string;
/**
* 资源个数。
*/
ResourceCount: number;
}
/**
* ModifyVpcPeeringConnection请求参数结构体
*/
export interface ModifyVpcPeeringConnectionRequest {
/**
* 对等连接ID。
*/
PeeringConnectionId: string;
/**
* 对等连接名称。
*/
PeeringConnectionName?: string;
/**
* 带宽上限,单位Mbps。
*/
Bandwidth?: number;
/**
* 计费模式,日峰值POSTPAID_BY_DAY_MAX,月95 POSTPAID_BY_MONTH_95。
*/
ChargeType?: string;
}
/**
* DetachClassicLinkVpc请求参数结构体
*/
export interface DetachClassicLinkVpcRequest {
/**
* VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
*/
VpcId: string;
/**
* CVM实例ID查询。形如:ins-r8hr2upy。
*/
InstanceIds: Array<string>;
}
/**
* DescribeBandwidthPackageBillUsage返回参数结构体
*/
export interface DescribeBandwidthPackageBillUsageResponse {
/**
* 当前计费用量
*/
BandwidthPackageBillBandwidthSet: Array<BandwidthPackageBillBandwidth>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteBandwidthPackage返回参数结构体
*/
export interface DeleteBandwidthPackageResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNatGatewayAttribute请求参数结构体
*/
export interface ModifyNatGatewayAttributeRequest {
/**
* NAT网关的ID,形如:`nat-df45454`。
*/
NatGatewayId: string;
/**
* NAT网关的名称,形如:`test_nat`。
*/
NatGatewayName?: string;
/**
* NAT网关最大外网出带宽(单位:Mbps)。
*/
InternetMaxBandwidthOut?: number;
/**
* 是否修改NAT网关绑定的安全组。
*/
ModifySecurityGroup?: boolean;
/**
* NAT网关绑定的安全组列表,最终状态,空列表表示删除所有安全组,形如: `['sg-1n232323', 'sg-o4242424']`
*/
SecurityGroupIds?: Array<string>;
}
/**
* DescribeLocalGateway请求参数结构体
*/
export interface DescribeLocalGatewayRequest {
/**
* 查询条件:
vpc-id:按照VPCID过滤,local-gateway-name:按照本地网关名称过滤,名称支持模糊搜索,local-gateway-id:按照本地网关实例ID过滤,cdc-id:按照cdc实例ID过滤查询。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。
*/
Limit?: number;
}
/**
* 流日志
*/
export interface FlowLog {
/**
* 私用网络ID或者统一ID,建议使用统一ID。
*/
VpcId?: string;
/**
* 流日志唯一ID。
*/
FlowLogId?: string;
/**
* 流日志实例名字。
*/
FlowLogName?: string;
/**
* 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE|CCN|NAT|DCG。
*/
ResourceType?: string;
/**
* 资源唯一ID。
*/
ResourceId?: string;
/**
* 流日志采集类型,ACCEPT|REJECT|ALL。
*/
TrafficType?: string;
/**
* 流日志存储ID。
*/
CloudLogId?: string;
/**
* 流日志存储ID状态。
*/
CloudLogState?: string;
/**
* 流日志描述信息。
*/
FlowLogDescription?: string;
/**
* 流日志创建时间。
*/
CreatedTime?: string;
/**
* 标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
*/
TagSet: Array<Tag>;
/**
* 是否启用,true-启用,false-停用。
*/
Enable: boolean;
/**
* 消费端类型:cls、ckafka。
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageType: string;
/**
* 消费端信息,当消费端类型为ckafka时返回。
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowLogStorage: FlowLogStorage;
/**
* 流日志存储ID对应的地域信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
CloudLogRegion: string;
}
/**
* DescribeVpcLimits返回参数结构体
*/
export interface DescribeVpcLimitsResponse {
/**
* 私有网络配额
*/
VpcLimitSet?: Array<VpcLimit>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IP在线查询的字段信息
*/
export interface IpField {
/**
* 国家字段信息
*/
Country?: boolean;
/**
* 省、州、郡一级行政区域字段信息
*/
Province?: boolean;
/**
* 市一级行政区域字段信息
*/
City?: boolean;
/**
* 市内区域字段信息
*/
Region?: boolean;
/**
* 接入运营商字段信息
*/
Isp?: boolean;
/**
* 骨干运营商字段信息
*/
AsName?: boolean;
/**
* 骨干As号
*/
AsId?: boolean;
/**
* 注释字段
*/
Comment?: boolean;
}
/**
* AddBandwidthPackageResources请求参数结构体
*/
export interface AddBandwidthPackageResourcesRequest {
/**
* 资源唯一ID,当前支持EIP资源和LB资源,形如'eip-xxxx', 'lb-xxxx'
*/
ResourceIds: Array<string>;
/**
* 带宽包唯一标识ID,形如'bwp-xxxx'
*/
BandwidthPackageId?: string;
/**
* 带宽包类型,当前支持'BGP'类型,表示内部资源是BGP IP。
*/
NetworkType?: string;
/**
* 资源类型,包括'Address', 'LoadBalance'
*/
ResourceType?: string;
/**
* 带宽包协议类型。当前支持'ipv4'和'ipv6'协议类型。
*/
Protocol?: string;
}
/**
* AssignIpv6SubnetCidrBlock请求参数结构体
*/
export interface AssignIpv6SubnetCidrBlockRequest {
/**
* 子网所在私有网络`ID`。形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* 分配 `IPv6` 子网段列表。
*/
Ipv6SubnetCidrBlocks: Array<Ipv6SubnetCidrBlock>;
}
/**
* DeleteVpnGatewaySslClient返回参数结构体
*/
export interface DeleteVpnGatewaySslClientResponse {
/**
* 异步任务ID。
*/
TaskId?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVpc返回参数结构体
*/
export interface CreateVpcResponse {
/**
* Vpc对象。
*/
Vpc?: Vpc;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VPC辅助CIDR信息。
*/
export interface AssistantCidr {
/**
* `VPC`实例`ID`。形如:`vpc-6v2ht8q5`
*/
VpcId: string;
/**
* 辅助CIDR。形如:`172.16.0.0/16`
*/
CidrBlock: string;
/**
* 辅助CIDR类型(0:普通辅助CIDR,1:容器辅助CIDR),默认都是0。
*/
AssistantType: number;
/**
* 辅助CIDR拆分的子网。
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetSet: Array<Subnet>;
}
/**
* ModifyNetworkAclEntries请求参数结构体
*/
export interface ModifyNetworkAclEntriesRequest {
/**
* 网络ACL实例ID。例如:acl-12345678。
*/
NetworkAclId: string;
/**
* 网络ACL规则集。NetworkAclEntrySet和NetworkAclQuintupleSet只能输入一个。
*/
NetworkAclEntrySet?: NetworkAclEntrySet;
/**
* 网络ACL五元组规则集。NetworkAclEntrySet和NetworkAclQuintupleSet只能输入一个。
*/
NetworkAclQuintupleSet?: NetworkAclQuintupleEntries;
/**
* 三元组的增量更新。该接口的默认语义为全量覆盖。当需要实现增量更新语义时,设置该参数为True。
*/
EnableUpdateAclEntries?: boolean;
}
/**
* DescribeVpcPrivateIpAddresses请求参数结构体
*/
export interface DescribeVpcPrivateIpAddressesRequest {
/**
* `VPC`实例`ID`,形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* 内网`IP`地址列表,批量查询单次请求最多支持`10`个。
*/
PrivateIpAddresses: Array<string>;
}
/**
* IP地址模板
*/
export interface AddressTemplate {
/**
* IP地址模板名称。
*/
AddressTemplateName: string;
/**
* IP地址模板实例唯一ID。
*/
AddressTemplateId: string;
/**
* IP地址信息。
*/
AddressSet: Array<string>;
/**
* 创建时间。
*/
CreatedTime?: string;
/**
* 带备注的IP地址信息。
*/
AddressExtraSet: Array<AddressInfo>;
}
/**
* DescribeIp6TranslatorQuota返回参数结构体
*/
export interface DescribeIp6TranslatorQuotaResponse {
/**
* 账户在指定地域的IPV6转换实例及规则配额信息
QUOTAID属性是TOTAL_TRANSLATOR_QUOTA,表示账户在指定地域的IPV6转换实例配额信息;QUOTAID属性是IPV6转换实例唯一ID(形如ip6-xxxxxxxx),表示账户在该转换实例允许创建的转换规则配额
*/
QuotaSet?: Array<Quota>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VPN网关配额对象
*/
export interface VpnGatewayQuota {
/**
* 带宽配额
*/
Bandwidth: number;
/**
* 配额中文名称
*/
Cname: string;
/**
* 配额英文名称
*/
Name: string;
}
/**
* DescribeBandwidthPackageBillUsage请求参数结构体
*/
export interface DescribeBandwidthPackageBillUsageRequest {
/**
* 后付费共享带宽包的唯一ID
*/
BandwidthPackageId: string;
}
/**
* UnassignIpv6Addresses返回参数结构体
*/
export interface UnassignIpv6AddressesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIp6Translators返回参数结构体
*/
export interface CreateIp6TranslatorsResponse {
/**
* 转换实例的唯一ID数组,形如"ip6-xxxxxxxx"
*/
Ip6TranslatorSet?: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowLogs请求参数结构体
*/
export interface DescribeFlowLogsRequest {
/**
* 私用网络ID或者统一ID,建议使用统一ID。
*/
VpcId?: string;
/**
* 流日志唯一ID。
*/
FlowLogId?: string;
/**
* 流日志实例名字。
*/
FlowLogName?: string;
/**
* 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE。
*/
ResourceType?: string;
/**
* 资源唯一ID。
*/
ResourceId?: string;
/**
* 流日志采集类型,ACCEPT|REJECT|ALL。
*/
TrafficType?: string;
/**
* 流日志存储ID。
*/
CloudLogId?: string;
/**
* 流日志存储ID状态。
*/
CloudLogState?: string;
/**
* 按某个字段排序,支持字段:flowLogName,createTime,默认按createTime。
*/
OrderField?: string;
/**
* 升序(asc)还是降序(desc),默认:desc。
*/
OrderDirection?: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 每页行数,默认为10。
*/
Limit?: number;
/**
* 过滤条件,参数不支持同时指定FlowLogId和Filters。
<li>tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。</li>
<li>tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。</li>
*/
Filters?: Filter;
/**
* 流日志存储ID对应的地域信息。
*/
CloudLogRegion?: string;
}
/**
* 云联网(CCN)地域出带宽上限。
*/
export interface CcnRegionBandwidthLimitInfo {
/**
* 源地域,例如:ap-shanghai
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceRegion: string;
/**
* 目的地域, 例如:ap-shanghai
注意:此字段可能返回 null,表示取不到有效值。
*/
DestinationRegion: string;
/**
* 出带宽上限,单位:Mbps。
注意:此字段可能返回 null,表示取不到有效值。
*/
BandwidthLimit: number;
}
/**
* CloneSecurityGroup请求参数结构体
*/
export interface CloneSecurityGroupRequest {
/**
* 安全组实例ID,例如sg-33ocnj9n,可通过<a href="https://cloud.tencent.com/document/product/215/15808">DescribeSecurityGroups</a>获取。
*/
SecurityGroupId: string;
/**
* 安全组名称,可任意命名,但不得超过60个字符。未提供参数时,克隆后的安全组名称和SecurityGroupId对应的安全组名称相同。
*/
GroupName?: string;
/**
* 安全组备注,最多100个字符。未提供参数时,克隆后的安全组备注和SecurityGroupId对应的安全组备注相同。
*/
GroupDescription?: string;
/**
* 项目ID,默认0。可在<a href="https://console.cloud.tencent.com/project">qcloud控制台项目管理页面</a>查询到。
*/
ProjectId?: string;
/**
* 源Region,跨地域克隆安全组时,需要传入源安全组所属地域信息,例如:克隆广州的安全组到上海,则这里需要传入广州安全的地域信息:ap-guangzhou。
*/
RemoteRegion?: string;
}
/**
* AssociateNatGatewayAddress请求参数结构体
*/
export interface AssociateNatGatewayAddressRequest {
/**
* NAT网关的ID,形如:`nat-df45454`。
*/
NatGatewayId: string;
/**
* 需要申请的弹性IP个数,系统会按您的要求生产N个弹性IP, 其中AddressCount和PublicAddresses至少传递一个。
*/
AddressCount?: number;
/**
* 绑定NAT网关的弹性IP数组,其中AddressCount和PublicAddresses至少传递一个。
*/
PublicIpAddresses?: Array<string>;
/**
* 弹性IP可用区,自动分配弹性IP时传递。
*/
Zone?: string;
/**
* 绑定NAT网关的弹性IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。
*/
StockPublicIpAddressesBandwidthOut?: number;
/**
* 需要申请公网IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。
*/
PublicIpAddressesBandwidthOut?: number;
/**
* 公网IP是否强制与NAT网关来自同可用区,true表示需要与NAT网关同可用区;false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。
*/
PublicIpFromSameZone?: boolean;
}
/**
* CreateDirectConnectGateway请求参数结构体
*/
export interface CreateDirectConnectGatewayRequest {
/**
* 专线网关名称
*/
DirectConnectGatewayName: string;
/**
* 关联网络类型,可选值:
<li>VPC - 私有网络</li>
<li>CCN - 云联网</li>
*/
NetworkType: string;
/**
* <li>NetworkType 为 VPC 时,这里传值为私有网络实例ID</li>
<li>NetworkType 为 CCN 时,这里传值为云联网实例ID</li>
*/
NetworkInstanceId: string;
/**
* 网关类型,可选值:
<li>NORMAL - (默认)标准型,注:云联网只支持标准型</li>
<li>NAT - NAT型</li>NAT类型支持网络地址转换配置,类型确定后不能修改;一个私有网络可以创建一个NAT类型的专线网关和一个非NAT类型的专线网关
*/
GatewayType?: string;
/**
* 云联网路由发布模式,可选值:`standard`(标准模式)、`exquisite`(精细模式)。只有云联网类型专线网关才支持`ModeType`。
*/
ModeType?: string;
/**
* 专线网关可用区
*/
Zone?: string;
/**
* 专线网关高可用区容灾组ID
*/
HaZoneGroupId?: string;
}
/**
* CreateVpnGatewaySslServer请求参数结构体
*/
export interface CreateVpnGatewaySslServerRequest {
/**
* VPN网关实例ID。
*/
VpnGatewayId: string;
/**
* SSL-VPN-SERVER 实例名称,长度不超过60个字节。
*/
SslVpnServerName: string;
/**
* 云端地址(CIDR)列表。
*/
LocalAddress: Array<string>;
/**
* 客户端地址网段。
*/
RemoteAddress: string;
/**
* SSL VPN服务端监听协议。当前仅支持 UDP,默认UDP。
*/
SslVpnProtocol?: string;
/**
* SSL VPN服务端监听协议端口,默认1194。
*/
SslVpnPort?: number;
/**
* 认证算法。可选 'SHA1', 'MD5', 'NONE',默认NONE。
*/
IntegrityAlgorithm?: string;
/**
* 加密算法。可选 'AES-128-CBC','AES-192-CBC', 'AES-256-CBC', 'NONE',默认NONE。
*/
EncryptAlgorithm?: string;
/**
* 是否支持压缩。当前仅支持不支持压缩,默认False。
*/
Compress?: boolean;
/**
* 是否开启SSO认证。默认为False
*/
SsoEnabled?: boolean;
/**
* 是否开启策略访问控制。默认为False
*/
AccessPolicyEnabled?: boolean;
/**
* SAML-DATA,开启SSO时传。
*/
SamlData?: string;
}
/**
* CreateVpcEndPoint请求参数结构体
*/
export interface CreateVpcEndPointRequest {
/**
* VPC实例ID。
*/
VpcId: string;
/**
* 子网实例ID。
*/
SubnetId: string;
/**
* 终端节点名称。
*/
EndPointName: string;
/**
* 终端节点服务ID。
*/
EndPointServiceId: string;
/**
* 终端节点VIP,可以指定IP申请。
*/
EndPointVip?: string;
/**
* 安全组ID。
*/
SecurityGroupId?: string;
}
/**
* ModifyBandwidthPackageAttribute请求参数结构体
*/
export interface ModifyBandwidthPackageAttributeRequest {
/**
* 带宽包唯一标识ID
*/
BandwidthPackageId: string;
/**
* 带宽包名称
*/
BandwidthPackageName: string;
/**
* 带宽包计费模式,示例 :
'TOP5_POSTPAID_BY_MONTH'(后付费-TOP5计费)
*/
ChargeType?: string;
}
/**
* TransformAddress返回参数结构体
*/
export interface TransformAddressResponse {
/**
* 异步任务TaskId。可以使用[DescribeTaskResult](https://cloud.tencent.com/document/api/215/36271)接口查询任务状态。
*/
TaskId?: number;
/**
* 转为弹性公网IP后的唯一ID
*/
AddressId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateNetworkInterfaceSecurityGroups请求参数结构体
*/
export interface DisassociateNetworkInterfaceSecurityGroupsRequest {
/**
* 弹性网卡实例ID。形如:eni-pxir56ns。每次请求的实例的上限为100。
*/
NetworkInterfaceIds: Array<string>;
/**
* 安全组实例ID,例如:sg-33ocnj9n,可通过DescribeSecurityGroups获取。每次请求的实例的上限为100。
*/
SecurityGroupIds: Array<string>;
}
/**
* DeleteNetworkAclEntries请求参数结构体
*/
export interface DeleteNetworkAclEntriesRequest {
/**
* 三元组网络ACL实例ID。例如:acl-12345678。
*/
NetworkAclId: string;
/**
* 三元组网络ACL规则集。
*/
NetworkAclEntrySet?: NetworkAclEntrySet;
}
/**
* 安全组规则集合
*/
export interface SecurityGroupPolicySet {
/**
* 安全组规则当前版本。用户每次更新安全规则版本会自动加1,防止更新的路由规则已过期,不填不考虑冲突。
注意:此字段可能返回 null,表示取不到有效值。
*/
Version?: string;
/**
* 出站规则。
注意:此字段可能返回 null,表示取不到有效值。
*/
Egress?: Array<SecurityGroupPolicy>;
/**
* 入站规则。
注意:此字段可能返回 null,表示取不到有效值。
*/
Ingress?: Array<SecurityGroupPolicy>;
}
/**
* ModifyFlowLogAttribute请求参数结构体
*/
export interface ModifyFlowLogAttributeRequest {
/**
* 流日志唯一ID。
*/
FlowLogId: string;
/**
* 私用网络ID或者统一ID,建议使用统一ID,修改云联网流日志属性时可不填,其他流日志类型必填。
*/
VpcId?: string;
/**
* 流日志实例名字。
*/
FlowLogName?: string;
/**
* 流日志实例描述。
*/
FlowLogDescription?: string;
}
/**
* UnassignIpv6SubnetCidrBlock返回参数结构体
*/
export interface UnassignIpv6SubnetCidrBlockResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyVpcEndPointServiceAttribute请求参数结构体
*/
export interface ModifyVpcEndPointServiceAttributeRequest {
/**
* 终端节点服务ID。
*/
EndPointServiceId: string;
/**
* VPCID。
*/
VpcId: string;
/**
* 终端节点服务名称。
*/
EndPointServiceName?: string;
/**
* 是否自动接受终端节点的连接请求。<ui><li>true:自动接受<li>false:不自动接受</ul>
*/
AutoAcceptFlag?: boolean;
/**
* 后端服务的ID,比如lb-xxx。
*/
ServiceInstanceId?: string;
}
/**
* 过滤器键值对
*/
export interface FilterObject {
/**
* 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
*/
Name: string;
/**
* 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
*/
Values: Array<string>;
}
/**
* DescribeIpGeolocationInfos返回参数结构体
*/
export interface DescribeIpGeolocationInfosResponse {
/**
* IP地址信息列表。
*/
AddressInfo?: Array<IpGeolocationInfo>;
/**
* IP地址信息个数。
*/
Total?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVpcTaskResult请求参数结构体
*/
export interface DescribeVpcTaskResultRequest {
/**
* 异步任务请求返回的RequestId。
*/
TaskId: string;
}
/**
* AssociateNetworkAclSubnets返回参数结构体
*/
export interface AssociateNetworkAclSubnetsResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteNatGatewayDestinationIpPortTranslationNatRule请求参数结构体
*/
export interface DeleteNatGatewayDestinationIpPortTranslationNatRuleRequest {
/**
* NAT网关的ID,形如:`nat-df45454`。
*/
NatGatewayId: string;
/**
* NAT网关的端口转换规则。
*/
DestinationIpPortTranslationNatRules: Array<DestinationIpPortTranslationNatRule>;
}
/**
* ResetRoutes请求参数结构体
*/
export interface ResetRoutesRequest {
/**
* 路由表实例ID,例如:rtb-azd4dt1c。
*/
RouteTableId: string;
/**
* 路由表名称,最大长度不能超过60个字节。
*/
RouteTableName: string;
/**
* 路由策略。
*/
Routes: Array<Route>;
}
/**
* CheckDefaultSubnet请求参数结构体
*/
export interface CheckDefaultSubnetRequest {
/**
* 子网所在的可用区ID,不同子网选择不同可用区可以做跨可用区灾备。
*/
Zone?: string;
}
/**
* 对等连接实例信息。
*/
export interface PeerConnection {
/**
* 本端VPC唯一ID。
*/
SourceVpcId?: string;
/**
* 对端VPC唯一ID。
*/
PeerVpcId?: string;
/**
* 对等连接唯一ID。
*/
PeeringConnectionId?: string;
/**
* 对等连接名称。
*/
PeeringConnectionName?: string;
/**
* 对等连接状态,PENDING,投放中;ACTIVE,使用中;REJECTED,已拒绝‘DELETED,已删除;FAILED,失败;EXPIRED,已过期;ISOLATED,隔离中。
*/
State?: string;
/**
* 是否是新控制器,true: 是NewAfc;false:不是。
*/
IsNgw?: boolean;
/**
* 对等连接带宽值。
*/
Bandwidth?: number;
/**
* 本端地域。
*/
SourceRegion?: string;
/**
* 对端地域。
*/
DestinationRegion?: string;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 本端APPID。
*/
AppId?: number;
/**
* 对端APPID。
*/
PeerAppId?: number;
/**
* 计费类型,POSTPAID_BY_DAY_MAX:日峰值计费;POSTPAID_BY_MONTH_95:月95计费。
*/
ChargeType?: string;
/**
* 本端UIN。
*/
SourceUin?: number;
/**
* 对端UIN。
*/
DestinationUin?: number;
/**
* 资源标签数据。
*/
TagSet?: Array<Tag>;
/**
* 服务分级:PT、AU、AG。
注意:此字段可能返回 null,表示取不到有效值。
*/
QosLevel?: string;
/**
* 互通类型,VPC_PEER:VPC间互通;VPC_BM_PEER:VPC与黑石网络互通。
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
}
/**
* CheckNetDetectState请求参数结构体
*/
export interface CheckNetDetectStateRequest {
/**
* 探测目的IPv4地址数组,最多两个。
*/
DetectDestinationIp: Array<string>;
/**
* 网络探测实例ID。形如:netd-12345678。该参数与(VpcId,SubnetId,NetDetectName),至少要有一个。当NetDetectId存在时,使用NetDetectId。
*/
NetDetectId?: string;
/**
* `VPC`实例`ID`。形如:`vpc-12345678`。该参数与(SubnetId,NetDetectName)配合使用,与NetDetectId至少要有一个。当NetDetectId存在时,使用NetDetectId。
*/
VpcId?: string;
/**
* 子网实例ID。形如:subnet-12345678。该参数与(VpcId,NetDetectName)配合使用,与NetDetectId至少要有一个。当NetDetectId存在时,使用NetDetectId。
*/
SubnetId?: string;
/**
* 网络探测名称,最大长度不能超过60个字节。该参数与(VpcId,SubnetId)配合使用,与NetDetectId至少要有一个。当NetDetectId存在时,使用NetDetectId。
*/
NetDetectName?: string;
/**
* 下一跳类型,目前我们支持的类型有:
VPN:VPN网关;
DIRECTCONNECT:专线网关;
PEERCONNECTION:对等连接;
NAT:NAT网关;
NORMAL_CVM:普通云服务器;
CCN:云联网网关;
NONEXTHOP:无下一跳;
*/
NextHopType?: string;
/**
* 下一跳目的网关,取值与“下一跳类型”相关:
下一跳类型为VPN,取值VPN网关ID,形如:vpngw-12345678;
下一跳类型为DIRECTCONNECT,取值专线网关ID,形如:dcg-12345678;
下一跳类型为PEERCONNECTION,取值对等连接ID,形如:pcx-12345678;
下一跳类型为NAT,取值Nat网关,形如:nat-12345678;
下一跳类型为NORMAL_CVM,取值云服务器IPv4地址,形如:10.0.0.12;
下一跳类型为CCN,取值云联网ID,形如:ccn-12345678;
下一跳类型为NONEXTHOP,指定网络探测为无下一跳的网络探测;
*/
NextHopDestination?: string;
}
/**
* 路由表关联关系
*/
export interface RouteTableAssociation {
/**
* 子网实例ID。
*/
SubnetId: string;
/**
* 路由表实例ID。
*/
RouteTableId: string;
}
/**
* ModifyCustomerGatewayAttribute请求参数结构体
*/
export interface ModifyCustomerGatewayAttributeRequest {
/**
* 对端网关ID,例如:cgw-2wqq41m9,可通过[DescribeCustomerGateways](https://cloud.tencent.com/document/api/215/17516)接口查询对端网关。
*/
CustomerGatewayId: string;
/**
* 对端网关名称,可任意命名,但不得超过60个字符。
*/
CustomerGatewayName: string;
/**
* BGP ASN。只有开启BGP白名单才可以修改此参数。
*/
BgpAsn?: number;
}
/**
* DescribeRouteTables返回参数结构体
*/
export interface DescribeRouteTablesResponse {
/**
* 符合条件的实例数量。
*/
TotalCount?: number;
/**
* 路由表对象。
*/
RouteTableSet?: Array<RouteTable>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVpcEndPointServiceWhiteList请求参数结构体
*/
export interface DeleteVpcEndPointServiceWhiteListRequest {
/**
* 用户UIN数组。
*/
UserUin: Array<string>;
/**
* 终端节点服务ID。
*/
EndPointServiceId: string;
}
/**
* DetachSnapshotInstances返回参数结构体
*/
export interface DetachSnapshotInstancesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DetachNetworkInterface返回参数结构体
*/
export interface DetachNetworkInterfaceResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVpcEndPointService请求参数结构体
*/
export interface DeleteVpcEndPointServiceRequest {
/**
* 终端节点ID。
*/
EndPointServiceId: string;
}
/**
* DeleteCcn返回参数结构体
*/
export interface DeleteCcnResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 协议端口模板
*/
export interface ServiceTemplate {
/**
* 协议端口实例ID,例如:ppm-f5n1f8da。
*/
ServiceTemplateId: string;
/**
* 模板名称。
*/
ServiceTemplateName: string;
/**
* 协议端口信息。
*/
ServiceSet: Array<string>;
/**
* 创建时间。
*/
CreatedTime?: string;
/**
* 带备注的协议端口信息。
*/
ServiceExtraSet: Array<ServicesInfo>;
}
/**
* DescribeCcnAttachedInstances请求参数结构体
*/
export interface DescribeCcnAttachedInstancesRequest {
/**
* 偏移量
*/
Offset?: number;
/**
* 返回数量
*/
Limit?: number;
/**
* 过滤条件:
<li>ccn-id - String -(过滤条件)CCN实例ID。</li>
<li>instance-type - String -(过滤条件)关联实例类型。</li>
<li>instance-region - String -(过滤条件)关联实例所属地域。</li>
<li>instance-id - String -(过滤条件)关联实例ID。</li>
*/
Filters?: Array<Filter>;
/**
* 云联网实例ID
*/
CcnId?: string;
/**
* 排序字段。支持:`CcnId` `InstanceType` `InstanceId` `InstanceName` `InstanceRegion` `AttachedTime` `State`。默认值:`AttachedTime`
*/
OrderField?: string;
/**
* 排序方法。升序:`ASC`,倒序:`DESC`。默认值:`ASC`
*/
OrderDirection?: string;
}
/**
* AttachSnapshotInstances返回参数结构体
*/
export interface AttachSnapshotInstancesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatGatewaySourceIpTranslationNatRules请求参数结构体
*/
export interface DescribeNatGatewaySourceIpTranslationNatRulesRequest {
/**
* NAT网关统一 ID,形如:`nat-123xx454`。
*/
NatGatewayId: string;
/**
* 过滤条件:
<li> resource-id,Subnet的ID或者Cvm ID,如`subnet-0yi4hekt`</li>
<li> public-ip-address,弹性IP,如`139.199.232.238`</li>
<li>description,规则描述。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* DescribeNatGateways请求参数结构体
*/
export interface DescribeNatGatewaysRequest {
/**
* NAT网关统一 ID,形如:`nat-123xx454`。每次请求的实例上限为100。参数不支持同时指定NatGatewayIds和Filters。
*/
NatGatewayIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定NatGatewayIds和Filters。每次请求的Filters的上限为10,Filter.Values的上限为5。
<li>nat-gateway-id - String - (过滤条件)协议端口模板实例ID,形如:`nat-123xx454`。</li>
<li>vpc-id - String - (过滤条件)私有网络 唯一ID,形如:`vpc-123xx454`。</li>
<li>nat-gateway-name - String - (过滤条件)协议端口模板实例ID,形如:`test_nat`。</li>
<li>tag-key - String - (过滤条件)标签键,形如:`test-key`。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* ModifyFlowLogAttribute返回参数结构体
*/
export interface ModifyFlowLogAttributeResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBandwidthPackages返回参数结构体
*/
export interface DescribeBandwidthPackagesResponse {
/**
* 符合条件的带宽包数量
*/
TotalCount?: number;
/**
* 描述带宽包详细信息
*/
BandwidthPackageSet?: Array<BandwidthPackage>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplaceSecurityGroupPolicies返回参数结构体
*/
export interface ReplaceSecurityGroupPoliciesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDirectConnectGateways请求参数结构体
*/
export interface DescribeDirectConnectGatewaysRequest {
/**
* 专线网关唯一`ID`,形如:`dcg-9o233uri`。
*/
DirectConnectGatewayIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定`DirectConnectGatewayIds`和`Filters`。
<li>direct-connect-gateway-id - String - 专线网关唯一`ID`,形如:`dcg-9o233uri`。</li>
<li>direct-connect-gateway-name - String - 专线网关名称,默认模糊查询。</li>
<li>direct-connect-gateway-ip - String - 专线网关`IP`。</li>
<li>gateway-type - String - 网关类型,可选值:`NORMAL`(普通型)、`NAT`(NAT型)。</li>
<li>network-type- String - 网络类型,可选值:`VPC`(私有网络类型)、`CCN`(云联网类型)。</li>
<li>ccn-id - String - 专线网关所在云联网`ID`。</li>
<li>vpc-id - String - 专线网关所在私有网络`ID`。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量。
*/
Offset?: number;
/**
* 返回数量。
*/
Limit?: number;
}
/**
* DescribeSpecificTrafficPackageUsedDetails返回参数结构体
*/
export interface DescribeSpecificTrafficPackageUsedDetailsResponse {
/**
* 符合查询条件的共享流量包用量明细的总数
*/
TotalCount?: number;
/**
* 共享流量包用量明细列表
*/
UsedDetailSet?: Array<UsedDetail>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachSnapshotInstances请求参数结构体
*/
export interface AttachSnapshotInstancesRequest {
/**
* 快照策略Id。
*/
SnapshotPolicyId: string;
/**
* 关联实例信息。
*/
Instances: Array<SnapshotInstance>;
}
/**
* ModifyIp6Translator返回参数结构体
*/
export interface ModifyIp6TranslatorResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVpcEndPointServiceWhiteList返回参数结构体
*/
export interface CreateVpcEndPointServiceWhiteListResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIpGeolocationDatabaseUrl返回参数结构体
*/
export interface DescribeIpGeolocationDatabaseUrlResponse {
/**
* IP地理位置库下载链接地址。
*/
DownLoadUrl?: string;
/**
* 链接到期时间。按照`ISO8601`标准表示,并且使用`UTC`时间。
*/
ExpiredAt?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UnlockCcnBandwidths请求参数结构体
*/
export interface UnlockCcnBandwidthsRequest {
/**
* 带宽实例对象数组。
*/
Instances: Array<CcnFlowLock>;
}
/**
* DeleteIp6Translators返回参数结构体
*/
export interface DeleteIp6TranslatorsResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNatGatewaySourceIpTranslationNatRules返回参数结构体
*/
export interface DescribeNatGatewaySourceIpTranslationNatRulesResponse {
/**
* NAT网关SNAT规则对象数组。
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceIpTranslationNatRuleSet: Array<SourceIpTranslationNatRule>;
/**
* 符合条件的NAT网关端口转发规则对象数目。
*/
TotalCount: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeVpcs请求参数结构体
*/
export interface DescribeVpcsRequest {
/**
* VPC实例ID。形如:vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。
*/
VpcIds?: Array<string>;
/**
* 过滤条件,不支持同时指定VpcIds和Filters参数。
支持的过滤条件如下:
<li>vpc-name:VPC实例名称,支持模糊查询。</li>
<li>is-default :是否默认VPC。</li>
<li>vpc-id :VPC实例ID,例如:vpc-f49l6u0z。</li>
<li>cidr-block:VPC的CIDR。</li>
<li>tag-key :按照标签键进行过滤,非必填参数。</li>
<li>tag:tag-key:按照标签键值对进行过滤,非必填参数。 其中 tag-key 请使用具体的标签键进行替换,可参考示例2。</li>
**说明:**若同一个过滤条件(Filter)存在多个Values,则同一Filter下Values间的关系为逻辑或(OR)关系;若存在多个过滤条件(Filter),Filter之间的关系为逻辑与(AND)关系。
<li>ipv6-cidr-block - String - (过滤条件)IPv6子网网段,形如: 2402:4e00:1717:8700::/64 。</li>
<li>isp-type - String - (过滤条件)运营商类型,形如: BGP 取值范围:'BGP'-默认, 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调。</li>
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: string;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: string;
}
/**
* DescribeRouteConflicts返回参数结构体
*/
export interface DescribeRouteConflictsResponse {
/**
* 路由策略冲突列表。
*/
RouteConflictSet?: Array<RouteConflict>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AcceptAttachCcnInstances请求参数结构体
*/
export interface AcceptAttachCcnInstancesRequest {
/**
* CCN实例ID。形如:ccn-f49l6u0z。
*/
CcnId: string;
/**
* 接受关联实例列表。
*/
Instances: Array<CcnInstance>;
}
/**
* CreateNetworkAclQuintupleEntries返回参数结构体
*/
export interface CreateNetworkAclQuintupleEntriesResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeGatewayFlowMonitorDetail返回参数结构体
*/
export interface DescribeGatewayFlowMonitorDetailResponse {
/**
* 符合条件的对象数。
*/
TotalCount?: number;
/**
* 网关流量监控明细。
*/
GatewayFlowMonitorDetailSet?: Array<GatewayFlowMonitorDetail>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* IP地理位置信息
*/
export interface IpGeolocationInfo {
/**
* 国家信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Country?: string;
/**
* 省、州、郡一级行政区域信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Province?: string;
/**
* 市一级行政区域信息
注意:此字段可能返回 null,表示取不到有效值。
*/
City?: string;
/**
* 市内区域信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* 接入运营商信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Isp?: string;
/**
* 骨干运营商名称
注意:此字段可能返回 null,表示取不到有效值。
*/
AsName?: string;
/**
* 骨干运营商AS号
注意:此字段可能返回 null,表示取不到有效值。
*/
AsId?: string;
/**
* 注释信息。目前的填充值为移动接入用户的APN值,如无APN属性则为空
注意:此字段可能返回 null,表示取不到有效值。
*/
Comment?: string;
/**
* IP地址
注意:此字段可能返回 null,表示取不到有效值。
*/
AddressIp: string;
}
/**
* DeleteFlowLog请求参数结构体
*/
export interface DeleteFlowLogRequest {
/**
* 流日志唯一ID。
*/
FlowLogId: string;
/**
* 私用网络ID或者统一ID,建议使用统一ID,删除云联网流日志时,可不填,其他流日志类型必填。
*/
VpcId?: string;
}
/**
* 网络探测验证结果。
*/
export interface NetDetectState {
/**
* 网络探测实例ID。形如:netd-12345678。
*/
NetDetectId: string;
/**
* 网络探测目的IP验证结果对象数组。
*/
NetDetectIpStateSet: Array<NetDetectIpState>;
}
/**
* DescribeSnapshotFiles请求参数结构体
*/
export interface DescribeSnapshotFilesRequest {
/**
* 业务类型,目前支持安全组:securitygroup。
*/
BusinessType: string;
/**
* 业务实例Id,和BusinessType对应。
*/
InstanceId: string;
/**
* 开始日期,格式%Y-%m-%d %H:%M:%S。
*/
StartDate: string;
/**
* 结束日期,格式%Y-%m-%d %H:%M:%S。
*/
EndDate: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大为100。
*/
Limit?: number;
}
/**
* HaVipDisassociateAddressIp返回参数结构体
*/
export interface HaVipDisassociateAddressIpResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateVpcEndPointSecurityGroups请求参数结构体
*/
export interface DisassociateVpcEndPointSecurityGroupsRequest {
/**
* 安全组ID数组。
*/
SecurityGroupIds: Array<string>;
/**
* 终端节点ID。
*/
EndPointId: string;
}
/**
* IKE配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自我保护机制,用户配置网络安全协议
*/
export interface IKEOptionsSpecification {
/**
* 加密算法,可选值:'3DES-CBC', 'AES-CBC-128', 'AES-CBS-192', 'AES-CBC-256', 'DES-CBC','SM4', 默认为3DES-CBC
注意:此字段可能返回 null,表示取不到有效值。
*/
PropoEncryAlgorithm?: string;
/**
* 认证算法:可选值:'MD5', 'SHA1','SHA-256' 默认为MD5
注意:此字段可能返回 null,表示取不到有效值。
*/
PropoAuthenAlgorithm?: string;
/**
* 协商模式:可选值:'AGGRESSIVE', 'MAIN',默认为MAIN
注意:此字段可能返回 null,表示取不到有效值。
*/
ExchangeMode?: string;
/**
* 本端标识类型:可选值:'ADDRESS', 'FQDN',默认为ADDRESS
注意:此字段可能返回 null,表示取不到有效值。
*/
LocalIdentity?: string;
/**
* 对端标识类型:可选值:'ADDRESS', 'FQDN',默认为ADDRESS
注意:此字段可能返回 null,表示取不到有效值。
*/
RemoteIdentity?: string;
/**
* 本端标识,当LocalIdentity选为ADDRESS时,LocalAddress必填。localAddress默认为vpn网关公网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
LocalAddress?: string;
/**
* 对端标识,当RemoteIdentity选为ADDRESS时,RemoteAddress必填
注意:此字段可能返回 null,表示取不到有效值。
*/
RemoteAddress?: string;
/**
* 本端标识,当LocalIdentity选为FQDN时,LocalFqdnName必填
注意:此字段可能返回 null,表示取不到有效值。
*/
LocalFqdnName?: string;
/**
* 对端标识,当remoteIdentity选为FQDN时,RemoteFqdnName必填
注意:此字段可能返回 null,表示取不到有效值。
*/
RemoteFqdnName?: string;
/**
* DH group,指定IKE交换密钥时使用的DH组,可选值:'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24',
注意:此字段可能返回 null,表示取不到有效值。
*/
DhGroupName?: string;
/**
* IKE SA Lif