EditControlGroup

更新時間: 2024-11-27 20:17:18

This interface is used to modify the information of a specified ControlGroup, including the name, domain list, and account list of the ControlGroup. Users can choose to update by either overwriting or appending as needed. For custom-type ControlGroups, users can modify their name and domain list, while client-type and contract-type ControlGroups do not allow such modifications. Additionally, users can specify a list of accounts with access permissions for the ControlGroup. This interface facilitates flexible management of ControlGroup configuration, allowing users to control access permissions and applicability by adjusting these settings, thereby better serving business needs.

  • データ遅延: 5-15 minutes
  • 単一ユーザーの使用頻度: 30/5min
  • 使用できるプロダクト: IAM

リクエストパラメータ

Path パラメータ

パラメータ名説明
*ControlGroupCodeString
Control Group Code, Can be obtained through the API interface [QueryControlGroupList]

Body パラメータ

パラメータ名説明
controlGroupNameString
Control Group name, which only the User Customized type Control Group can be modified, customer type Control Group and product type Control Group can not be modified. User Customized type Control Group keeps the original Control Group name if no value is passed
accountListList
Account object array,Used to specify accounts with permission. all types of Control Group can be modified, if no value is passed, the original accountList will be emptied
loginNameString
Account
domainListList
Domain array, which only the User Customized type Control Group can be modified, customer type Control Group and product type Control Group can not be modified.User Customized type Control Group empties the original domainList if no value is passed
isAddBoolean
Whether to add: 1. Do not pass or pass false: rewrite method; 2. Pass true: append method.

レスポンスパラメータ

Body パラメータ

パラメータ名説明
codeInteger
Status Code
msgString
Message
dataObject
controlGroupCodeString
Control Group Code
controlGroupNameString
Control Group Name

エラーコード

エラーコード(code)説明(message)HTTPステータスコード意味
MissingBodyThis operation requires a body. Ensure that the body is present and the Content-Type header is set.400Missing request body
HeaderDirectionErrorHeader-direction can only select {0}.400Header-direction can only select {0}.
HttpHeaderXmlErrorMissing "action" or "direction" field in 403Lacking of foeld of action or direction.
InvalidHeaderNameHeader name {0} is no action.404Header name lack of action field
24192105The "controlGroupName"you specified is not exist200The "controlGroupName"you specified is not exist
24192107You do not have permission to operate this "controlGroup"200You do not have permission to operate this "controlGroup"
24192109The "controlGroup" you specified does not belong to you200The "controlGroup" you specified does not belong to you
24192103ccbc_control_group_add_account_illegal:xx200ccbc_control_group_add_account_illegal:xx

入力例

JSON
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"
    }
}