添加ip白名单分组
功能介绍
为指定实例添加IP白名单分组。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/instance/{instance_id}/whitelist-async
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
whitelist |
是 |
Array of Whitelist objects |
参数解释: 需要添加的IP白名单分组列表,支持IP或CIDR。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 添加IP白名单分组任务ID。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist-async { "whitelist" : [ { "group_name" : "test001", "ip_list" : [ "10.10.10.1", "10.10.10.2" ] } ] }
响应示例
状态码:200
添加IP白名单分组返回体。
{ "job_id" : "ff8080817fe01bb2017fe3cf68860481" }
状态码
状态码 |
描述 |
---|---|
200 |
添加IP白名单分组返回体。 |
400 |
参数解释: 非法请求。 |
401 |
参数解释: 认证失败。 |
403 |
参数解释: 请求被拒绝。 |
404 |
参数解释: 路径错误。 |
500 |
参数解释: 内部错误。 |
错误码
请参见错误码。