{
  "name": "bmeip",
  "display_name": "黑石弹性公网IP",
  "description": "",
  "domain": "network",
  "api_version": "2018-06-25",
  "endpoint": "bmeip.tencentcloudapi.com",
  "actions": [
    {
      "name": "BindEipAcls",
      "description": "此接口用于为某个 EIP 关联 ACL。",
      "status": "online",
      "parameters": [
        {
          "name": "EipIdAclIdList",
          "type": "array",
          "required": true,
          "description": "待关联的 EIP 与 ACL关系列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "EipId",
              "type": "string",
              "required": true,
              "description": "EIP 实例 ID"
            },
            {
              "name": "AclId",
              "type": "string",
              "required": true,
              "description": "ACL 实例 ID"
            }
          ]
        }
      ],
      "required": [
        "EipIdAclIdList"
      ]
    },
    {
      "name": "BindHosted",
      "description": "BindHosted接口用于绑定黑石弹性公网IP到黑石托管机器上",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID，可通过DescribeBmEip 接口返回字段中的 eipId获取。Eip和EipId参数必须要填写一个。",
          "example": "eip-kwn5q7mt"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "托管机器实例ID",
          "example": "chm-343fqw4"
        }
      ],
      "required": [
        "EipId",
        "InstanceId"
      ]
    },
    {
      "name": "BindRs",
      "description": "绑定黑石EIP",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "物理服务器实例ID"
        }
      ],
      "required": [
        "EipId",
        "InstanceId"
      ]
    },
    {
      "name": "BindVpcIp",
      "description": "黑石EIP绑定VPC IP",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID",
          "example": "eip-t6j1t2x1"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "EIP归属VpcId，例如vpc-k7j1t2x1",
          "example": "vpc-k7j1t2x1"
        },
        {
          "name": "VpcIp",
          "type": "string",
          "required": true,
          "description": "绑定的VPC内IP地址",
          "example": "10.0.0.1"
        }
      ],
      "required": [
        "EipId",
        "VpcId",
        "VpcIp"
      ]
    },
    {
      "name": "CreateEip",
      "description": "创建黑石弹性公网IP",
      "status": "online",
      "parameters": [
        {
          "name": "GoodsNum",
          "type": "integer",
          "required": false,
          "description": "申请数量，默认为1, 最大 20",
          "example": "1"
        },
        {
          "name": "PayMode",
          "type": "string",
          "required": false,
          "description": "EIP计费方式，flow-流量计费；bandwidth-带宽计费",
          "example": "flow"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": false,
          "description": "带宽设定值（只在带宽计费时生效）",
          "example": "10"
        },
        {
          "name": "SetType",
          "type": "string",
          "required": false,
          "description": "EIP模式，目前支持tunnel和fullnat",
          "example": "fullnat"
        },
        {
          "name": "Exclusive",
          "type": "integer",
          "required": false,
          "description": "是否使用独占集群，0：不使用，1：使用。默认为0",
          "example": "0"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "EIP归属私有网络ID，例如vpc-k7j1t2x1",
          "example": "vpc-bjh0qd20"
        },
        {
          "name": "IpList",
          "type": "array",
          "required": false,
          "description": "指定申请的IP列表",
          "example": "[\"1.1.1.1\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "CreateEipAcl",
      "description": "创建黑石弹性公网 EIP ACL",
      "status": "online",
      "parameters": [
        {
          "name": "AclName",
          "type": "string",
          "required": true,
          "description": "ACL 名称",
          "example": "acltest"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "ACL 状态 0：无状态，1：有状态",
          "example": "0"
        }
      ],
      "required": [
        "AclName",
        "Status"
      ]
    },
    {
      "name": "DeleteEip",
      "description": "释放黑石弹性公网IP",
      "status": "online",
      "parameters": [
        {
          "name": "EipIds",
          "type": "array",
          "required": true,
          "description": "Eip实例ID列表",
          "example": "[\"eip-k5zjz4yy\\r\\n\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "EipIds"
      ]
    },
    {
      "name": "DeleteEipAcl",
      "description": "删除弹性公网IP ACL",
      "status": "online",
      "parameters": [
        {
          "name": "AclId",
          "type": "string",
          "required": true,
          "description": "待删除的 ACL 实例 ID",
          "example": "bmeipacl-s1hf4voq"
        }
      ],
      "required": [
        "AclId"
      ]
    },
    {
      "name": "DescribeEipAcls",
      "description": "查询弹性公网IP ACL",
      "status": "online",
      "parameters": [
        {
          "name": "AclName",
          "type": "string",
          "required": false,
          "description": "ACL 名称，支持模糊查找",
          "example": "abc"
        },
        {
          "name": "AclIds",
          "type": "array",
          "required": false,
          "description": "ACL 实例 ID 列表，数组下标从 0 开始",
          "example": "[\"bmeipacl-s1hf4voq\\r\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数。偏移量，默认为 0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数。每一页的 EIPACL 列表数目",
          "example": "20"
        },
        {
          "name": "EipIds",
          "type": "array",
          "required": false,
          "description": "EIP实例ID列表",
          "example": "[\"eip-1234abcd\", \"eip-abcd1234\"]",
          "item_type": "string"
        },
        {
          "name": "EipIps",
          "type": "array",
          "required": false,
          "description": "EIP IP地址列表",
          "example": "[\"1,1,1,1\"]",
          "item_type": "string"
        },
        {
          "name": "EipNames",
          "type": "array",
          "required": false,
          "description": "EIP名称列表",
          "example": "name",
          "item_type": "string"
        },
        {
          "name": "OrderField",
          "type": "string",
          "required": false,
          "description": "排序字段",
          "example": "CreateTime"
        },
        {
          "name": "Order",
          "type": "integer",
          "required": false,
          "description": "排序方式，取值：0:增序(默认)，1:降序",
          "example": "1"
        },
        {
          "name": "AclNames",
          "type": "array",
          "required": false,
          "description": "ACL名称列表，支持模糊查找",
          "example": "[\"abc\", \"def\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeEipQuota",
      "description": "查询黑石EIP 限额",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeEipTask",
      "description": "黑石EIP查询任务状态",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "EIP查询任务ID",
          "example": "2488126"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeEips",
      "description": "黑石EIP查询接口",
      "status": "online",
      "parameters": [
        {
          "name": "EipIds",
          "type": "array",
          "required": false,
          "description": "EIP实例ID列表",
          "item_type": "string"
        },
        {
          "name": "Eips",
          "type": "array",
          "required": false,
          "description": "EIP IP 列表",
          "item_type": "string"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "主机实例ID 列表",
          "item_type": "string"
        },
        {
          "name": "SearchKey",
          "type": "string",
          "required": false,
          "description": "EIP名称,模糊匹配"
        },
        {
          "name": "Status",
          "type": "array",
          "required": false,
          "description": "状态列表, 默认所有",
          "item_type": "integer"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回EIP数量，默认 20, 最大值 100"
        },
        {
          "name": "OrderField",
          "type": "string",
          "required": false,
          "description": "排序字段，支持： EipId,Eip,Status, InstanceId,CreatedAt"
        },
        {
          "name": "Order",
          "type": "integer",
          "required": false,
          "description": "排序方式 0:递增 1:递减(默认)"
        },
        {
          "name": "PayMode",
          "type": "string",
          "required": false,
          "description": "计费模式,流量：flow，带宽：bandwidth"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "EIP归属VpcId，例如vpc-k7j1t2x1"
        },
        {
          "name": "BindTypes",
          "type": "array",
          "required": false,
          "description": "绑定类型，-1：未绑定，0：物理机，1：nat网关，2：虚拟IP, 3:托管机器",
          "item_type": "integer"
        },
        {
          "name": "ExclusiveTag",
          "type": "integer",
          "required": false,
          "description": "独占标志，0：共享，1：独占"
        },
        {
          "name": "AclId",
          "type": "string",
          "required": false,
          "description": "EIP ACL实例ID"
        },
        {
          "name": "BindAcl",
          "type": "integer",
          "required": false,
          "description": "搜索条件，是否绑定了EIP ACL， 0：未绑定，1：绑定"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyEipAcl",
      "description": "修改弹性公网IP ACL",
      "status": "online",
      "parameters": [
        {
          "name": "AclId",
          "type": "string",
          "required": true,
          "description": "ACL 实例 ID",
          "example": "bmeipacl-s1hf4voq"
        },
        {
          "name": "AclName",
          "type": "string",
          "required": false,
          "description": "ACL 名称",
          "example": "abc"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "ACL 状态。0：无状态 1：有状态",
          "example": "1"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "规则类型（in/out）。in：入站规则 out：出站规则",
          "example": "in"
        },
        {
          "name": "Rules",
          "type": "array",
          "required": false,
          "description": "ACL规则列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Ip",
              "type": "string",
              "required": true,
              "description": "源 IP"
            },
            {
              "name": "Port",
              "type": "string",
              "required": true,
              "description": "目标端口"
            },
            {
              "name": "Protocol",
              "type": "string",
              "required": true,
              "description": "协议(TCP/UDP/ICMP/ANY)"
            },
            {
              "name": "Action",
              "type": "string",
              "required": true,
              "description": "策略（accept/drop）"
            },
            {
              "name": "Description",
              "type": "string",
              "required": true,
              "description": "备注"
            }
          ]
        }
      ],
      "required": [
        "AclId"
      ]
    },
    {
      "name": "ModifyEipCharge",
      "description": "黑石EIP修改计费方式",
      "status": "online",
      "parameters": [
        {
          "name": "PayMode",
          "type": "string",
          "required": true,
          "description": "EIP计费方式，flow-流量计费；bandwidth-带宽计费"
        },
        {
          "name": "EipIds",
          "type": "array",
          "required": false,
          "description": "Eip实例ID列表",
          "item_type": "string"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": false,
          "description": "带宽设定值（只在带宽计费时生效）"
        }
      ],
      "required": [
        "PayMode"
      ]
    },
    {
      "name": "ModifyEipName",
      "description": "更新黑石EIP名称",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID，可通过/v2/DescribeEip 接口返回字段中的 eipId获取"
        },
        {
          "name": "EipName",
          "type": "string",
          "required": true,
          "description": "EIP 实例别名"
        }
      ],
      "required": [
        "EipId",
        "EipName"
      ]
    },
    {
      "name": "UnbindEipAcls",
      "description": "解绑弹性公网IP ACL",
      "status": "online",
      "parameters": [
        {
          "name": "EipIdAclIdList",
          "type": "array",
          "required": true,
          "description": "待解关联的 EIP 与 ACL列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "EipId",
              "type": "string",
              "required": true,
              "description": "EIP 实例 ID"
            },
            {
              "name": "AclId",
              "type": "string",
              "required": true,
              "description": "ACL 实例 ID"
            }
          ]
        }
      ],
      "required": [
        "EipIdAclIdList"
      ]
    },
    {
      "name": "UnbindHosted",
      "description": "UnbindHosted接口用于解绑托管机器上的EIP",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "托管机器实例ID"
        },
        {
          "name": "EipId",
          "type": "string",
          "required": false,
          "description": "Eip实例ID，可通过DescribeBmEip 接口返回字段中的 eipId获取。Eip和EipId参数必须要填写一个。"
        },
        {
          "name": "Eip",
          "type": "string",
          "required": false,
          "description": "弹性IP。Eip和EipId参数必须要填写一个。"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "UnbindRs",
      "description": "解绑黑石EIP",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "物理服务器实例ID"
        }
      ],
      "required": [
        "EipId",
        "InstanceId"
      ]
    },
    {
      "name": "UnbindRsList",
      "description": "批量解绑物理机弹性公网IP接口",
      "status": "online",
      "parameters": [
        {
          "name": "EipRsList",
          "type": "array",
          "required": true,
          "description": "物理机绑定的EIP列表",
          "item_type": "object",
          "children": [
            {
              "name": "EipId",
              "type": "string",
              "required": true,
              "description": "EIP实例 ID"
            },
            {
              "name": "InstanceId",
              "type": "string",
              "required": true,
              "description": "黑石物理机实例ID"
            }
          ]
        }
      ],
      "required": [
        "EipRsList"
      ]
    },
    {
      "name": "UnbindVpcIp",
      "description": "黑石EIP解绑VPCIP",
      "status": "online",
      "parameters": [
        {
          "name": "EipId",
          "type": "string",
          "required": true,
          "description": "Eip实例ID",
          "example": "eip-fz3yvdzi"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "EIP归属VpcId，例如vpc-k7j1t2x1",
          "example": "vpc-bjh0qd20"
        },
        {
          "name": "VpcIp",
          "type": "string",
          "required": true,
          "description": "绑定的VPC内IP地址",
          "example": "10.1.0.11"
        }
      ],
      "required": [
        "EipId",
        "VpcId",
        "VpcIp"
      ]
    }
  ]
}