创建一个IPAM实例。
接口说明
-
每个阿里云账号（主账号）在每个地域只支持创建 1 个 IPAM。
-
目前，IPAM 仅支持分配 IPv4 类型的 IP 地址。
-
创建 IPAM 实例时：
- 若用户在当前地域不存在自定义类型的资源发现实例，系统会直接创建与 IPAM 实例关联的默认资源发现实例。
- 若用户在当前地域已经存在自定义类型的资源发现实例，系统会将该资源发现转化为默认资源发现，并创建与 IPAM 实例的关联关系。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:CreateIpam | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| IpamName | string | 否 | IPAM 的名称。 长度为 1～128 个字符，不能以 | abc |
| OperatingRegionList | array | 是 | IPAM 生效地域列表。 | |
| OperatingRegionList | string | 是 | IPAM 的生效地域。 说明
支持选择一个或多个地域。
| cn-hangzhou |
| IpamDescription | string | 否 | IPAM 的描述信息。 长度为 1～256 个字符，必须以大小写字母或中文开头，但不能以 | This is my first Ipam |
| ResourceGroupId | string | 否 | IPAM 的资源组 ID。 | rg-acfmxazb4ph6aiy**** |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| Tag | array<object> | 否 | 标签列表信息。 | |
| Tag | object | 否 | 标签列表信息。 | |
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。 最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。 最多支持 128 个字符，不能包含 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
"IpamId": "ipam-ccxbnsbhew0d6t****",
"PrivateDefaultScopeId": "ipam-scope-8wiontzmiy6cg0****",
"PublicDefaultScopeId": "ipam-scope-r5c5c7bmym1brc****",
"DefaultResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
"DefaultResourceDiscoveryAssociationId": "ipam-res-disco-assoc-jt5fac8twugdbbgip****",
"ResourceDiscoveryAssociationCount": 1
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | UnsupportedRegion.Ipam | Ipam is not supported in this region. | 该地域不支持IPAM。 |
| 400 | QuotaExceeded.IpamQuotaPerRegion | The quota of ipamQuotaPerRegion count is exceeded. | IPAM允许的最大数量超过限制。 |
| 400 | IllegalParam.OperatingRegion | The operating region is invalid. | 生效地域非法。 |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun校验通过。 |
| 400 | OperationFailed.OperatingRegionsNeedIncludeIpamRegion | The operating regions do not contain IPAM region. | 操作地域未包含IPAM托管地域。 |
| 400 | UnsupportedFeature.Ipam | IPAM is not supported in this region. | 该地域不支持IPAM功能。 |
| 400 | OptInRequired.Ipam | You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use. | 您无权使用请求的 IPAM 服务。 确保您已经订阅了您尝试使用的服务。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-08-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |