全部产品
Search
文档中心

云安全中心:GetCommonSwitchConfig - 获取开关配置

更新时间:Nov 25, 2024

获取通用开关配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetCommonSwitchConfigget
*全部资源
*

请求参数

名称类型必填描述示例值
Typestring

通用开关类型。

说明 通过 ListClientUserDefineRulesListSystemClientRules 接口的响应参数 SwitchId 可以获取该参数。
USER-DEFINE-RULE-SWITCH-TYPE_180****

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

返回数据。

TargetSyncStatusstring

同步状态。取值:

  • sync:修改正在同步。
  • valid:修改已生效。
valid
TargetDefaultstring

默认是否生效。取值:

  • add:新增主机默认生效。
  • del:新增主机默认不生效。
add

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。