API概览

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

在使用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地址池的CIDR分配 释放IPAM地址池的CIDR分配,当前支持的类型包括专有网络、自定义分配。
UpdateIpamPoolAllocation 修改IPAM地址池的CIDR分配信息 修改IPAM地址池的CIDR分配信息。
GetIpamPoolAllocation 查询指定IPAM地址池CIDR分配的信息 查询指定IPAM地址池CIDR分配的信息。
ListIpamPoolAllocations 查询IPAM地址池的CIDR分配信息 查询IPAM地址池的CIDR分配信息。
GetIpamPoolNextAvailableCidr 获取IPAM地址池可用的CIDR地址段 获取IPAM地址池可用的CIDR地址段。

资源发现

API

标题

API概述

CreateIpamResourceDiscovery 创建自定义类型的资源发现实例 创建自定义类型的资源发现实例。
DeleteIpamResourceDiscovery 删除自定义类型的资源发现实例 删除自定义类型的资源发现实例。
UpdateIpamResourceDiscovery 修改资源发现实例 修改资源发现实例。
ListIpamResourceDiscoveries 查询资源发现实例 查询IPAM资源发现实例。
AssociateIpamResourceDiscovery 关联资源发现和IPAM实例 关联资源发现和IPAM实例。
DissociateIpamResourceDiscovery 解关联资源发现和IPAM实例 解关联资源发现和IPAM实例。
ListIpamResourceDiscoveryAssociations 查询资源发现和IPAM的关联关系 查询资源发现和IPAM的关联关系。
ListIpamDiscoveredResource 查询资源发现下的资源信息 查询资源发现下的资源信息。

资源组

API

标题

API概述

ChangeResourceGroup 修改IPAM资源所属的资源组 修改IPAM资源所属的资源组。

标签

API

标题

API概述

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