使用DescribeSecurityIPGroup查询跨产品白名单模板详情-数据库自治服务-阿里云

展示用户跨产品白名单模板具体信息

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionName	string	是	地域 ID。	cn-shanghai

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	返回的状态码。	200
Data	object	ListResult
SecurityIpGroups	array<object>	用户在该 region 下的所有跨产品白名单模板列表。
	array<object>
DbInstances	array	该跨产品白名单模板所绑定的数据库实例列表。
	string	数据库实例 ID。	["r-2ze9g6mnhu1*", "pc-2zew5qn1m", "r-2ze9g6mn*", "pc-2zew5qh41***"]
SecurityIpType	string	ip 类型	ipv4
Uid	string	账号 ID，您可在阿里云账号管理的安全设置页面获取登录账号的 ID。	160-79abe3f4****
RegionId	string	地域 ID。	cn-hangzhou
GEcsSgIdList	string	ECS 安全组 ID，已无效，是冗余数据，待下线	null
GlobalIgName	string	IP 白名单模板名称。IP 白名单模板名称需满足如下要求：由小写字母、数字、下划线（_）组成。由字母开头、字母或数字结尾。长度为 2~120 个字符。	test_123
GlobalSecurityGroupId	string	IP 白名单模板 ID。	g-1no2rzybnqcv****
WhitelistNetType	string	白名单的网络类型。	mix
EngineInfoList	array<object>	该模板所绑定的各产品下的实例信息
	object
InstanceNum	integer	当前登录账号包含的实例数量。	10
EngineName	string	目标实例的数据库类型。	PolarDBMySQL
InstanceIds	array	数据库实例 ID 列表。
	string	数据库实例 ID。说明数据格式为 JSONArray，例如`['实例 ID1','实例 ID2']`，实例 ID 间用英文逗号（,）分隔。	rm-2ze8ygcc****
UserId	string	用户 id	641***
GIpList	string	白名单模板内的 IP 地址。说明多个 IP 地址需要用英文逗号（,）分隔。	192.168.1.28/32
Message	string	请求返回的消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	CAC553F1-C669-53F1-A295-2CF050E****
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "Success": "true"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

更多信息，参考变更详情。