DescribeGlobalSecurityIPGroup - 查询全局IP白名单模板 - 云数据库 MongoDB

查询全局IP白名单模板。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeGlobalSecurityIPGroup

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属的地域 ID，您可以通过调用 DescribeDBInstanceAttribute 进行查询。	cn-hangzhou
GlobalSecurityGroupId	string	否	IP 白名单模板 ID。	g-hedmu8kg9nsabw6u42rv

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一 ID，如果遇到问题请提供这个请求 ID，由工作人员为您排查。	72651AF9-7897-41A7-8B67-6C15C7F26A0A
GlobalSecurityIPGroup	array<object>	全局 IP 白名单模板列表。
	object	全局 IP 白名单模板。
GlobalSecurityGroupId	string	IP 白名单模板 ID。	g-sdgwqyp4f5j1x3qk7yvm
GlobalIgName	string	IP 白名单模板名称。	dev_baoxian_k8s_bj
GIpList	string	白名单模板内的 IP 地址。说明多个 IP 地址需要用英文逗号隔开，所有 IP 白名单累积支持添加 1000 个 IP 地址或地址段。	117.12.202.19
RegionId	string	地域 ID。	cn-hangzhou
DBInstances	array	全局 IP 白名单模板绑定的实例列表。
	string	MongoDB 实例 Id。	[dds-asdxxxx,dds-afrexxxxxx]

示例

正常返回示例

JSON格式

{
  "RequestId": "72651AF9-7897-41A7-8B67-6C15C7F26A0A",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-sdgwqyp4f5j1x3qk7yvm",
      "GlobalIgName": "dev_baoxian_k8s_bj",
      "GIpList": "117.12.202.19",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "[dds-asdxxxx,dds-afrexxxxxx]"
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	RequiredParam.NotFound	Required input param is not found.
400	InvalidAction	Specified action is not valid.	服务异常。
404	InvalidUser.NotFound	Specified user does not exist.

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

变更历史

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