API概览

本产品(IP地址管理/2023-02-28)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

IPAM

API标题API概述
OpenVpcIpamService开通IPAM功能开通IPAM功能。
GetVpcIpamServiceStatus查询IPAM功能的开通状态查询IPAM功能的开通状态。
CreateIpam创建一个IPAM实例创建一个IPAM实例。
DeleteIpam删除一个IPAM实例删除IPAM实例。
UpdateIpam修改创建的IPAM实例更新ipam。
ListIpams查询IPAM实例查询ipam。

IPAM作用范围

API标题API概述
CreateIpamScope创建IPAM作用范围创建私网和公网IPAM作用范围,分别用于管理私网和公网地址。
DeleteIpamScope删除IPAM作用范围删除IPAM作用范围。
UpdateIpamScope修改IPAM作用范围的信息修改IPAM作用范围的基本信息。
ListIpamScopes查询IPAM作用范围的实例信息查询IPAM作用范围的实例信息。
ListIpamResourceCidrs查询IPAM作用范围内的资源查询IPAM作用范围内的资源。

IPAM地址池

API标题API概述
CreateIpamPool创建IPAM地址池创建IPAM地址池。
DeleteIpamPool删除IPAM地址池实例删除IPAM地址池实例。
UpdateIpamPool修改IPAM地址池信息修改IPAM地址池基本信息。
ListIpamPools查询IPAM地址池信息查询IPAM地址池信息。
AddIpamPoolCidr为IPAM地址池预置CIDR地址段为IPAM地址池预置CIDR地址段。
DeleteIpamPoolCidr删除IPAM地址池预置的CIDR地址段删除IPAM地址池预置的CIDR地址段。
ListIpamPoolCidrs查询IPAM地址池预置的CIDR地址段查询IPAM地址池预置的CIDR地址段。
CreateIpamPoolAllocation从IPAM地址池创建自定义预留网段从IPAM地址池创建自定义预留网段。
DeleteIpamPoolAllocation删除IPAM地址池中的自定义预留网段删除IPAM地址池中的自定义预留网段。
UpdateIpamPoolAllocation修改IPAM地址池的CIDR分配信息修改IPAM地址池的CIDR分配信息。
GetIpamPoolAllocation查询指定IPAM地址池CIDR分配的信息查询指定IPAM地址池CIDR分配的信息。
ListIpamPoolAllocations查询IPAM地址池的CIDR分配信息查询IPAM地址池的CIDR分配信息。

资源发现

API标题API概述
ListIpamResourceDiscoveries查询资源发现实例查询IPAM资源发现实例。
ListIpamDiscoveredResource查询资源发现下的资源信息查询资源发现下的资源信息。

资源组

API标题API概述
ChangeResourceGroup修改IPAM所属的资源组修改IPAM所属的资源组。

标签

API标题API概述
TagResources为IPAM资源创建并绑定标签为资源实例绑定资源标签。
UntagResources为IPAM资源解绑标签为资源解绑资源标签。
ListTagResources查询IPAM已绑定的标签列表查询资源标签列表。