创建地址簿，包括IPv4地址簿、ECS标签地址簿、IPv6地址簿、域名地址簿、ACK地址簿。
接口说明
本接口一般用于创建地址簿，包括 IPv4 地址簿、ECS 标签地址簿、IPv6 地址簿、域名地址簿、ACK 地址簿。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
SourceIp
deprecated
|
string |
否 |
访问者源 IP 地址。 |
192.0.XX.XX |
| Lang |
string |
否 |
地址簿描述的语言类型。 枚举值：
|
zh |
| AddressList |
string |
否 |
地址簿的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。 说明
当 GroupType 为
|
192.0.XX.XX/32 开发网段,192.0.XX.XX/24 测试网段 |
| Description |
string |
是 |
地址簿的描述信息。 |
sz-001 |
| GroupName |
string |
是 |
地址簿的名称。 |
sz-001 |
| GroupType |
string |
是 |
地址簿的类型。 枚举值：
|
ip |
| AutoAddTagEcs |
string |
否 |
是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。 枚举值：
|
1 |
| TagRelation |
string |
否 |
待匹配的多个 ECS 标签间的关系。 枚举值：
|
and |
| TagList |
array<object> |
否 |
ECS 标签列表。 |
|
|
object |
否 |
ECS 标签。 |
||
| TagValue |
string |
否 |
ECS 标签值。 |
1 |
| TagKey |
string |
否 |
ECS 标签键。 |
TXY |
| AckClusterConnectorId |
string |
否 |
ACK 集群连接器 ID。取值来源：
|
ac-7c1bad6c3cc84c33baab1 |
| AckNamespaces |
array |
否 |
ACK 集群容器组命名空间列表。 说明
数量最多 10 个。 |
|
|
string |
否 |
ACK 集群容器组命名空间。取值来源：
说明
当 GroupType 为 ackNamespace 时，必填。 |
kube-system |
|
| AckLabels |
array<object> |
否 |
ACK 集群容器组标签列表。 说明
数量最多 10 个。 |
|
|
object |
否 |
ACK 集群容器组标签。取值来源：
说明
当 GroupType 为 ackLabel 时，必填。 |
||
| Key |
string |
否 |
ACK 集群容器组标签的键。 |
app |
| Value |
string |
否 |
ACK 集群容器组标签的值。 |
storage-operator |
调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。 调用 API 的请求格式，请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| GroupUuid |
string |
添加成功后返回的地址簿唯一标识 ID。 |
f04ac7ce-628b-4cb7-be61-310222b7**** |
| RequestId |
string |
请求 ID。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2**** |
示例
正常返回示例
JSON格式
{
"GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorParametersGroupType | The group type is invalid. | 无效的group类型 |
| 400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
| 400 | ErrorParametersGroupAddress | The IP address of the address group is invalid. | 地址簿IP地址错误 |
| 400 | ErrorDBSelect | An error occurred while querying database. | 内部错误：数据库查询错误 |
| 400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿内地址数量超出上限 |
| 400 | ErrorAddressGroupExist | The address group already exists. | 分组已存在 |
| 400 | ErrorParamDomain | The parameter Domain is invalid. | 地址簿域名地址错误 |
| 400 | ErrorUUIDNew | The UUID is invalid. | 内部错误：UUID错误 |
| 400 | ErrorAddressGroupCountExceed | The maximum number of address group is exceeded. | 地址簿数量超出上限 |
| 400 | ErrorDBInsert | An error occurred while performing an insert operation in the database. | 内部错误：数据库插入错误 |
| 400 | ErrorRecordLog | An error occurred while updating the operation log. | 写日志失败 |
| 400 | ErrorDBUpdate | internal error: sql updat. | 请求错误，数据库更新失败。 |
| 400 | ErrorParametersTagKey | The tag key is invalid. | 无效的tag key |
| 400 | ErrorParametersTagList | The tag list is invalid. | 无效的tag list |
| 400 | ErrorTagCountExceed | The maximum number of tag is exceeded. | tag数量超出上限 |
| 400 | ErrorParametersTagRelation | The tag relation is invalid. | 无效的tag relation |
| 400 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口错误 |
| 400 | ErrorPortCountExceed | The maixmum number of port in the group is exceeded. | 地址簿内端口数量超出上限 |
| 400 | InternalError | The request processing has failed due to some unknown error. | 由于某些未知错误，请求处理失败。 |
| 500 | ErrorAckClusterConnectorBusy | The ACK cluster connector is operating. | |
| 404 | ErrorAckClusterConnectorNotFound | The specified resource ACK cluster connector is not found. | 指定资源的ACK集群连接器不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。