tenyun/types/bmeip.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** EipAcl信息 */
declare interface EipAcl {
  /** ACL 实例 ID。 */
  AclId: string;
  /** ACL 实例名称 */
  AclName: string;
  /** ACL 状态。0：无状态，1：有状态 */
  Status: string;
  /** EIPACL 创建时间 */
  CreatedAt: string;
  /** EIPACL 已关联的 eip 数目 */
  EipNum: number;
  /** 出站规则 */
  OutRules: EipAclRule[];
  /** 入站规则 */
  InRules?: EipAclRule[];
}

/** eipid与aclid关联关系 */
declare interface EipAclMap {
  /** EIP 实例 ID */
  EipId: string;
  /** ACL 实例 ID */
  AclId: string;
}

/** eipacl规则 */
declare interface EipAclRule {
  /** 源 IP */
  Ip: string;
  /** 目标端口 */
  Port: string;
  /** 协议(TCP/UDP/ICMP/ANY) */
  Protocol: string;
  /** 策略（accept/drop） */
  Action: string;
  /** 备注 */
  Description: string;
}

/** Eip信息 */
declare interface EipInfo {
  /** EIP实例ID */
  EipId: string;
  /** EIP名称 */
  EipName: string;
  /** EIP地址 */
  Eip: string;
  /** 运营商ID 0：电信； 1：联通； 2：移动； 3：教育网； 4：盈科； 5：BGP； 6：中国香港 */
  IspId: number;
  /** 状态 0：创建中； 1：绑定中； 2：已绑定； 3：解绑中； 4：未绑定； 6：下线中； 9：创建失败 */
  Status: number;
  /** 是否欠费隔离 1： 欠费隔离； 0： 正常。处在欠费隔离情况下的EIP不能进行任何管理操作。 */
  Arrears: number;
  /** EIP所绑定的服务器实例ID，未绑定则为空 */
  InstanceId: string;
  /** 服务器别名 */
  InstanceAlias: string;
  /** EIP解绑时间 */
  FreeAt: string;
  /** EIP创建时间 */
  CreatedAt: string;
  /** EIP更新时间 */
  UpdatedAt: string;
  /** EIP未绑定服务器时长（单位：秒） */
  FreeSecond: number;
  /** EIP所绑定的资源类型，-1：未绑定资源；0：黑石物理机，字段对应unInstanceId；1：Nat网关，字段对应natUid；2：云服务器字段对应vpcIp; 3: 托管机器，字段对应HInstanceId, HInstanceAlias */
  Type: number;
  /** EIP计费模式，"flow"：流量计费； "bandwidth"：带宽计费 */
  PayMode: string;
  /** EIP带宽计费模式下的带宽上限（单位：MB） */
  Bandwidth: number;
  /** 最近一次操作变更的EIP计费模式，"flow"：流量计费； "bandwidth"：带宽计费 */
  LatestPayMode: string;
  /** 最近一次操作变更的EIP计费模式对应的带宽上限值，仅在带宽计费模式下有效（单位：MB） */
  LatestBandwidth: number;
  /** 私有网络名称 */
  VpcName: string;
  /** EIP所绑定的NAT网关的数字ID，形如：1001,，未绑定则为空 */
  NatId: number;
  /** EIP所绑定的NAT网关实例ID，形如："nat-n47xxxxx"，未绑定则为空 */
  NatUid: string;
  /** EIP所绑定的云服务器IP(托管或者云服务器的IP），形如："10.1.1.3"。 注意：IP资源需要通过bmvpc模块注册或者申请后才可以绑定eip，接口使用申请子网IP和注册子网IP：,未绑定则为空 */
  VpcIp: string;
  /** 私有网络实例ID */
  VpcId: string;
  /** 是否为独占类型EIP */
  Exclusive: number;
  /** 私有网络的cidr */
  VpcCidr: string;
  /** EIP ACL实例ID */
  AclId: string;
  /** EIP ACL名称 */
  AclName: string;
  /** 托管机器实例ID */
  HInstanceId: string;
  /** 托管机器别名 */
  HInstanceAlias: string;
}

/** EipId与InstanceId绑定关系 */
declare interface EipRsMap {
  /** EIP实例 ID */
  EipId: string;
  /** 黑石物理机实例ID */
  InstanceId: string;
}

declare interface BindEipAclsRequest {
  /** 待关联的 EIP 与 ACL关系列表 */
  EipIdAclIdList: EipAclMap[];
}

declare interface BindEipAclsResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface BindHostedRequest {
  /** Eip实例ID，可通过DescribeBmEip 接口返回字段中的 eipId获取。Eip和EipId参数必须要填写一个。 */
  EipId: string;
  /** 托管机器实例ID */
  InstanceId: string;
}

declare interface BindHostedResponse {
  /** 异步任务ID，可以通过EipBmQueryTask查询任务状态 */
  TaskId: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface BindRsRequest {
  /** Eip实例ID */
  EipId: string;
  /** 物理服务器实例ID */
  InstanceId: string;
}

declare interface BindRsResponse {
  /** 绑定黑石物理机异步任务ID，可以通过DescribeEipTask查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface BindVpcIpRequest {
  /** Eip实例ID */
  EipId: string;
  /** EIP归属VpcId，例如vpc-k7j1t2x1 */
  VpcId: string;
  /** 绑定的VPC内IP地址 */
  VpcIp: string;
}

declare interface BindVpcIpResponse {
  /** EIP绑定VPC网络IP异步任务ID，可以通过查询EIP任务状态查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateEipAclRequest {
  /** ACL 名称 */
  AclName: string;
  /** ACL 状态 0：无状态，1：有状态 */
  Status: number;
}

declare interface CreateEipAclResponse {
  /** ACL 实例 ID */
  AclId?: string;
  /** ACL 实例状态 */
  Status?: number;
  /** ACL 实例名称 */
  AclName?: string;
  /** ACL 实例创建时间 */
  CreatedAt?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateEipRequest {
  /** 申请数量，默认为1, 最大 20 */
  GoodsNum?: number;
  /** EIP计费方式，flow-流量计费；bandwidth-带宽计费 */
  PayMode?: string;
  /** 带宽设定值（只在带宽计费时生效） */
  Bandwidth?: number;
  /** EIP模式，目前支持tunnel和fullnat */
  SetType?: string;
  /** 是否使用独占集群，0：不使用，1：使用。默认为0 */
  Exclusive?: number;
  /** EIP归属私有网络ID，例如vpc-k7j1t2x1 */
  VpcId?: string;
  /** 指定申请的IP列表 */
  IpList?: string[];
}

declare interface CreateEipResponse {
  /** EIP列表 */
  EipIds: string[];
  /** 任务ID */
  TaskId: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteEipAclRequest {
  /** 待删除的 ACL 实例 ID */
  AclId: string;
}

declare interface DeleteEipAclResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteEipRequest {
  /** Eip实例ID列表 */
  EipIds: string[];
}

declare interface DeleteEipResponse {
  /** 任务Id */
  TaskId: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeEipAclsRequest {
  /** ACL 名称，支持模糊查找 */
  AclName?: string;
  /** ACL 实例 ID 列表，数组下标从 0 开始 */
  AclIds?: string[];
  /** 分页参数。偏移量，默认为 0 */
  Offset?: number;
  /** 分页参数。每一页的 EIPACL 列表数目 */
  Limit?: number;
  /** EIP实例ID列表 */
  EipIds?: string[];
  /** EIP IP地址列表 */
  EipIps?: string[];
  /** EIP名称列表 */
  EipNames?: string[];
  /** 排序字段 */
  OrderField?: string;
  /** 排序方式，取值：0:增序(默认)，1:降序 */
  Order?: number;
  /** ACL名称列表，支持模糊查找 */
  AclNames?: string[];
}

declare interface DescribeEipAclsResponse {
  /** 返回 EIPACL 列表总数 */
  TotalCount: number;
  /** EIPACL列表 */
  EipAclList: EipAcl[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeEipQuotaRequest {
}

declare interface DescribeEipQuotaResponse {
  /** 能拥有的EIP个数的总配额，默认是100个 */
  EipNumQuota?: number;
  /** 当前已使用的EIP个数，包括创建中、绑定中、已绑定、解绑中、未绑定几种状态的EIP个数总和 */
  CurrentEipNum?: number;
  /** 当天申请EIP次数 */
  DailyApplyCount?: number;
  /** 每日申请EIP的次数限制 */
  DailyApplyQuota?: number;
  /** BatchApplyMax */
  BatchApplyMax?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeEipTaskRequest {
  /** EIP查询任务ID */
  TaskId: number;
}

declare interface DescribeEipTaskResponse {
  /** 当前任务状态码：0-成功，1-失败，2-进行中 */
  Status: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeEipsRequest {
  /** EIP实例ID列表 */
  EipIds?: string[];
  /** EIP IP 列表 */
  Eips?: string[];
  /** 主机实例ID 列表 */
  InstanceIds?: string[];
  /** EIP名称,模糊匹配 */
  SearchKey?: string;
  /** 状态列表, 默认所有 */
  Status?: number[];
  /** 偏移量，默认为0 */
  Offset?: number;
  /** 返回EIP数量，默认 20, 最大值 100 */
  Limit?: number;
  /** 排序字段，支持： EipId,Eip,Status, InstanceId,CreatedAt */
  OrderField?: string;
  /** 排序方式 0:递增 1:递减(默认) */
  Order?: number;
  /** 计费模式,流量：flow，带宽：bandwidth */
  PayMode?: string;
  /** EIP归属VpcId，例如vpc-k7j1t2x1 */
  VpcId?: string;
  /** 绑定类型，-1：未绑定，0：物理机，1：nat网关，2：虚拟IP, 3:托管机器 */
  BindTypes?: number[];
  /** 独占标志，0：共享，1：独占 */
  ExclusiveTag?: number;
  /** EIP ACL实例ID */
  AclId?: string;
  /** 搜索条件，是否绑定了EIP ACL， 0：未绑定，1：绑定 */
  BindAcl?: number;
}

declare interface DescribeEipsResponse {
  /** 返回EIP信息数组 */
  EipSet?: EipInfo[];
  /** 返回EIP数量 */
  TotalCount?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ModifyEipAclRequest {
  /** ACL 实例 ID */
  AclId: string;
  /** ACL 名称 */
  AclName?: string;
  /** ACL 状态。0：无状态 1：有状态 */
  Status?: number;
  /** 规则类型（in/out）。in：入站规则 out：出站规则 */
  Type?: string;
  /** ACL规则列表 */
  Rules?: EipAclRule[];
}

declare interface ModifyEipAclResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ModifyEipChargeRequest {
  /** EIP计费方式，flow-流量计费；bandwidth-带宽计费 */
  PayMode: string;
  /** Eip实例ID列表 */
  EipIds?: string[];
  /** 带宽设定值（只在带宽计费时生效） */
  Bandwidth?: number;
}

declare interface ModifyEipChargeResponse {
  /** 修改计费模式的异步任务ID，可以通过查询EIP任务状态查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ModifyEipNameRequest {
  /** Eip实例ID，可通过/v2/DescribeEip 接口返回字段中的 eipId获取 */
  EipId: string;
  /** EIP 实例别名 */
  EipName: string;
}

declare interface ModifyEipNameResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UnbindEipAclsRequest {
  /** 待解关联的 EIP 与 ACL列表 */
  EipIdAclIdList: EipAclMap[];
}

declare interface UnbindEipAclsResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UnbindHostedRequest {
  /** 托管机器实例ID */
  InstanceId: string;
  /** Eip实例ID，可通过DescribeBmEip 接口返回字段中的 eipId获取。Eip和EipId参数必须要填写一个。 */
  EipId?: string;
  /** 弹性IP。Eip和EipId参数必须要填写一个。 */
  Eip?: string;
}

declare interface UnbindHostedResponse {
  /** 异步任务ID，可以通过EipBmQueryTask查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UnbindRsListRequest {
  /** 物理机绑定的EIP列表 */
  EipRsList: EipRsMap[];
}

declare interface UnbindRsListResponse {
  /** 解绑操作的异步任务ID，可以通过查询EIP任务状态查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UnbindRsRequest {
  /** Eip实例ID */
  EipId: string;
  /** 物理服务器实例ID */
  InstanceId: string;
}

declare interface UnbindRsResponse {
  /** 解绑操作的异步任务ID，可以通过查询EIP任务状态查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface UnbindVpcIpRequest {
  /** Eip实例ID */
  EipId: string;
  /** EIP归属VpcId，例如vpc-k7j1t2x1 */
  VpcId: string;
  /** 绑定的VPC内IP地址 */
  VpcIp: string;
}

declare interface UnbindVpcIpResponse {
  /** 绑定黑石物理机异步任务ID，可以通过查询EIP任务状态查询任务状态 */
  TaskId?: number;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Bmeip 黑石弹性公网IP} */
declare interface Bmeip {
  (): Versions;
  /** 绑定弹性公网IP ACL {@link BindEipAclsRequest} {@link BindEipAclsResponse} */
  BindEipAcls(data: BindEipAclsRequest, config?: AxiosRequestConfig): AxiosPromise<BindEipAclsResponse>;
  /** 黑石托管机器绑定EIP {@link BindHostedRequest} {@link BindHostedResponse} */
  BindHosted(data: BindHostedRequest, config?: AxiosRequestConfig): AxiosPromise<BindHostedResponse>;
  /** 绑定黑石EIP {@link BindRsRequest} {@link BindRsResponse} */
  BindRs(data: BindRsRequest, config?: AxiosRequestConfig): AxiosPromise<BindRsResponse>;
  /** 黑石EIP绑定VPC IP {@link BindVpcIpRequest} {@link BindVpcIpResponse} */
  BindVpcIp(data: BindVpcIpRequest, config?: AxiosRequestConfig): AxiosPromise<BindVpcIpResponse>;
  /** 创建黑石EIP {@link CreateEipRequest} {@link CreateEipResponse} */
  CreateEip(data?: CreateEipRequest, config?: AxiosRequestConfig): AxiosPromise<CreateEipResponse>;
  /** 创建黑石弹性公网 EIP ACL {@link CreateEipAclRequest} {@link CreateEipAclResponse} */
  CreateEipAcl(data: CreateEipAclRequest, config?: AxiosRequestConfig): AxiosPromise<CreateEipAclResponse>;
  /** 释放黑石弹性公网IP {@link DeleteEipRequest} {@link DeleteEipResponse} */
  DeleteEip(data: DeleteEipRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteEipResponse>;
  /** 删除弹性公网IP ACL {@link DeleteEipAclRequest} {@link DeleteEipAclResponse} */
  DeleteEipAcl(data: DeleteEipAclRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteEipAclResponse>;
  /** 查询弹性公网IP ACL {@link DescribeEipAclsRequest} {@link DescribeEipAclsResponse} */
  DescribeEipAcls(data?: DescribeEipAclsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeEipAclsResponse>;
  /** 查询黑石EIP 限额 {@link DescribeEipQuotaRequest} {@link DescribeEipQuotaResponse} */
  DescribeEipQuota(data?: DescribeEipQuotaRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeEipQuotaResponse>;
  /** 黑石EIP查询任务状态 {@link DescribeEipTaskRequest} {@link DescribeEipTaskResponse} */
  DescribeEipTask(data: DescribeEipTaskRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeEipTaskResponse>;
  /** 黑石EIP查询接口 {@link DescribeEipsRequest} {@link DescribeEipsResponse} */
  DescribeEips(data?: DescribeEipsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeEipsResponse>;
  /** 修改弹性公网IP ACL {@link ModifyEipAclRequest} {@link ModifyEipAclResponse} */
  ModifyEipAcl(data: ModifyEipAclRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyEipAclResponse>;
  /** 黑石EIP修改计费方式 {@link ModifyEipChargeRequest} {@link ModifyEipChargeResponse} */
  ModifyEipCharge(data: ModifyEipChargeRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyEipChargeResponse>;
  /** 更新黑石EIP名称 {@link ModifyEipNameRequest} {@link ModifyEipNameResponse} */
  ModifyEipName(data: ModifyEipNameRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyEipNameResponse>;
  /** 解绑弹性公网IP ACL {@link UnbindEipAclsRequest} {@link UnbindEipAclsResponse} */
  UnbindEipAcls(data: UnbindEipAclsRequest, config?: AxiosRequestConfig): AxiosPromise<UnbindEipAclsResponse>;
  /** 黑石托管机器解绑EIP {@link UnbindHostedRequest} {@link UnbindHostedResponse} */
  UnbindHosted(data: UnbindHostedRequest, config?: AxiosRequestConfig): AxiosPromise<UnbindHostedResponse>;
  /** 解绑黑石EIP {@link UnbindRsRequest} {@link UnbindRsResponse} */
  UnbindRs(data: UnbindRsRequest, config?: AxiosRequestConfig): AxiosPromise<UnbindRsResponse>;
  /** 批量解绑物理机弹性公网IP {@link UnbindRsListRequest} {@link UnbindRsListResponse} */
  UnbindRsList(data: UnbindRsListRequest, config?: AxiosRequestConfig): AxiosPromise<UnbindRsListResponse>;
  /** 黑石EIP解绑VPC IP {@link UnbindVpcIpRequest} {@link UnbindVpcIpResponse} */
  UnbindVpcIp(data: UnbindVpcIpRequest, config?: AxiosRequestConfig): AxiosPromise<UnbindVpcIpResponse>;
}

export declare type Versions = ["2018-06-25"];

export default Bmeip;