API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(Vpc/2016-04-28)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

弹性公网IP

API

标题

API概述

EIP实例 EIP实例
AllocateEipAddress 申请弹性公网IP(EIP) 申请弹性公网IP(Elastic IP Address,简称EIP)。
AllocateEipAddressPro 申请指定的EIP 调用AllocateEipAddressPro申请指定的EIP,可用于特定的网络配置需求。
ReleaseEipAddress 释放指定EIP 调用ReleaseEipAddress接口释放指定的弹性公网IP(EIP)。
ModifyEipAddressAttribute 修改EIP属性 调用ModifyEipAddressAttribute接口修改指定EIP的名称、描述信息和带宽峰值。
DescribeEipAddresses 查询指定地域已创建的EIP 查询指定地域已创建的EIP。
DescribeEipGatewayInfo 查询EIP的网关和掩码信息 调用DescribeEipGatewayInfo接口查询EIP的网关和掩码信息。
AllocateEipSegmentAddress 申请连续EIP 连续EIP是一组按序排列的弹性公网IP地址,您可以在进行网络设计时,为需要连续公网IP地址的云资源批量申请和使用这些IP地址。您可以通过调用AllocateEipSegmentAddress接口申请连续EIP。
DescribeEipSegment 查询连续EIP 调用DescribeEipSegment查询连续EIP组的信息。
ReleaseEipSegmentAddress 释放连续EIP 调用ReleaseEipSegmentAddress释放连续EIP。
ModifyEipForwardMode 修改EIP转发模式 修改EIP转发模式。
绑定与解绑 绑定与解绑
AssociateEipAddress EIP绑定到云产品实例 调用AssociateEipAddress将弹性公网IP(EIP)绑定到同地域的云产品实例上。
AssociateEipAddressBatch 批量绑定EIP到云产品实例 调用AssociateEipAddressBatch接口批量将弹性公网IP(Elastic IP Address,简称EIP)绑定到同地域的云产品实例上。
UnassociateEipAddress EIP从云产品解绑 调用UnassociateEipAddress将弹性公网IP(EIP)从绑定的云产品上解绑。
IP地址池 IP地址池
CreatePublicIpAddressPool 创建IP地址池 调用CreatePublicIpAddressPool接口创建IP地址池。
OpenPublicIpAddressPoolService 开通IP地址池功能 调用OpenPublicIpAddressPoolService接口开通IP地址池功能。
AddPublicIpAddressPoolCidrBlock IP地址池添加IP地址段 调用AddPublicIpAddressPoolCidrBlock接口将IP地址网段添加至IP地址池。
TransformEipSegmentToPublicIpAddressPool 连续EIP组迁移至IP地址池 将连续EIP组迁移至IP地址池。
DeletePublicIpAddressPool 删除IP地址池 调用DeletePublicIpAddressPool接口删除IP地址池。
DeletePublicIpAddressPoolCidrBlock IP地址段从IP地址池中删除 调用DeletePublicIpAddressPoolCidrBlock接口将IP地址网段从IP地址池中删除。
UpdatePublicIpAddressPoolAttribute 修改地址池属性 调用UpdatePublicIpAddressPoolAttribute接口修改地址池属性。
ListPublicIpAddressPools 查询IP地址池信息 调用ListPublicIpAddressPools接口查询可使用的IP地址池信息。
ListPublicIpAddressPoolCidrBlocks 查询IP地址池的地址段信息 调用ListPublicIpAddressPoolCidrBlocks接口查询IP地址池中的IP地址网段信息。
GetPublicIpAddressPoolServiceStatus 查询IP地址池功能的开通状态 调用GetPublicIpAddressPoolServiceStatus接口查询IP地址池功能的开通状态。
监控 监控
DescribeEipMonitorData 查看EIP的监控信息 调用DescribeEipMonitorData接口查看弹性公网IP(Elastic IP Address,简称EIP)的监控信息,最多查询31天内的数据,单次最多查询400个流量点的数据。
SetHighDefinitionMonitorLogStatus EIP配置高精度秒级监控 调用SetHighDefinitionMonitorLogStatus接口为EIP配置高精度秒级监控。
DescribeHighDefinitionMonitorLogAttribute 查询EIP秒级监控的SLS log信息 调用DescribeHighDefinitionMonitorLogAttribute接口查询EIP高精度秒级监控的配置信息。
其他 其他
DescribePublicIpAddress 查询专有网络中公网IP地址的范围 调用DescribePublicIpAddress接口查询指定地域中位于专有网络的公网IP地址的范围。