使用DescribeGlobalSecurityIPGroupRelation查询集群与全局IP白名单模板的关联关系-云原生数据库 PolarDB-阿里云

查询集群与全局IP白名单模板的关联关系。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeGlobalSecurityIPGroupRelation	get	*DBCluster `acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DBClusterId	string	是	集群 ID。	pc-*****************
ResourceGroupId	string	否	资源组 ID。	rg-**********

返回参数

名称	类型	描述	示例值
	object
DBClusterId	string	集群 ID。	pc-*****************
RequestId	string	请求 ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
GlobalSecurityIPGroupRel	array<object>	全局 IP 白名单模板信息。
GlobalSecurityIPGroupRel	object
GlobalSecurityGroupId	string	IP 白名单模板 ID。	g-zsldxfiwjmti0kcm****
GIpList	string	白名单模板内的 IP 地址。说明多个 IP 地址需要用英文逗号隔开，所有 IP 白名单累积支持添加 1000 个 IP 地址或地址段。	192.168.0.1
RegionId	string	地域 ID。	cn-hangzhou
GlobalIgName	string	IP 白名单模板名称。IP 白名单模板名称需满足如下要求：由小写字母、数字、下划线（_）组成。由字母开头、字母或数字结尾。长度为 2~120 个字符。	test_123

示例

正常返回示例

JSON格式

{
  "DBClusterId": "pc-*****************",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "GlobalSecurityIPGroupRel": [
    {
      "GlobalSecurityGroupId": "g-zsldxfiwjmti0kcm****",
      "GIpList": "192.168.0.1",
      "RegionId": "cn-hangzhou",
      "GlobalIgName": "test_123"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	RequiredParam.NotFound	Required input param is not found.	所需的输入参数不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-05-11	OpenAPI 错误码发生变更	查看变更详情