修改ControlGroup接口
更新时间：2025-04-02 19:10:37
该接口用于修改指定的ControlGroup信息，包括ControlGroup的名称、域名列表及账号列表。用户可根据需求选择覆盖或者追加的方式进行更新。针对自定义类型的ControlGroup，用户可以修改其名称和域名列表，而客户类型和合同类型的ControlGroup则不允许此类修改。此外，还可以为ControlGroup指定有权限访问的账号列表。此接口便于用户灵活管理ControlGroup的配置信息，通过调整这些设置可以控制访问权限和适用性，从而更好地服务于业务需求。
- 数据延迟：5-15 minutes
- 单用户调用频率：30/5min
- 适用产品：访问控制
请求参数
Path 参数
| 参数名称 | 描述 |
|---|---|
*ControlGroupCodeString | Control Group 编号，可通过API接口 【查询ControlGroupList接口】 获取 |
Body 参数
| 参数名称 | 描述 |
|---|---|
controlGroupNameString | Control Group名称，只有自定义类型的Control Group可做修改，若是客户类型与合同类型Control Group则不做修改。自定义类型Control Group若不传值则保持原来的Control Group名称 |
accountListList | 账号对象数组, 用来指定有权限访问的账号。客户类型，合同类型与自定义类型的Control Group都可以做修改，若不传值则将原accountList清空 |
loginNameString | 账号 |
domainListList | 域名字符串数组，只有自定义类型的Control Group可做修改，若是客户类型与合同类型Control Group则不做修改。自定义类型Control Group若不传值则将原domainList清空 |
isAddBoolean | 是否追加:
1.不传或false：覆盖方式;
2.传true：追加方式. |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
codeInteger | 错误具体状态码 |
msgString | 消息提示 |
requestIdString | 请求ID |
dataObject | |
controlGroupCodeString | Control Group Code |
controlGroupNameString | Control Group名称 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| MissingBody | This operation requires a body. Ensure that the body is present and the Content-Type header is set. | 400 | 缺少请求体 |
| HeaderDirectionError | Header-direction can only select {0}. | 400 | Header-direction只能是{} |
| HttpHeaderXmlError | Missing "action" or "direction" field in | 403 | 缺少action或者direction字段 |
| InvalidHeaderName | Header name {0} is no action. | 404 | Header name缺少action字段 |
| 24192105 | The "controlGroupName"you specified is not exist | 200 | 控制组不存在 |
| 24192107 | You do not have permission to operate this "controlGroup" | 200 | 请求账号没权限操作controlGroup |
| 24192109 | The "controlGroup" you specified does not belong to you | 200 | 控制在属于其他客户 |
| 24192103 | ccbc_control_group_add_account_illegal:xx | 200 | 存在不属于当前客户的账号：xx |
示例
JSON
- 请求示例
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/user/control-groups/<ControlGroupCode>" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -d '{ "accountList":[{"loginName":"test"}], "controlGroupName":"xxx", "domainList":["www.aaa.com","www.bbb.com"], "isAdd":"false" }'- 返回示例
{ "msg":"Success", "code":"0", "data":{ "controlGroupCode":"CG201906241004", "controlGroupName":"xxx" } }
本篇文档内容对您是否有帮助？
有帮助
我要反馈