All Products
Search
Document Center

Security Center:GetCommonSwitchConfig

Last Updated:Feb 20, 2024

Queries the configuration of a common switch.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringNo

The type of the common switch.

Note You can call the ListClientUserDefineRules or ListSystemClientRules operation to obtain the switch type from the response parameter SwitchId.
USER-DEFINE-RULE-SWITCH-TYPE_180****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

24A20733-10A0-4AF6-BE6B-E3322413****
Dataobject

The data returned.

TargetSyncStatusstring

The status of the synchronization. Valid values:

  • sync: The modifications are being synchronized.
  • valid: The modifications has taken effect.
valid
TargetDefaultstring

Specifies whether to turn on the switch for newly added servers. Valid values:

  • add: By default, the switch is turned on for newly added servers.
  • del: By default, the switch is turned off for newly added servers.
add

Examples

Sample success responses

JSONformat

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413****",
  "Data": {
    "TargetSyncStatus": "valid",
    "TargetDefault": "add"
  }
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.