全部产品
Search
文档中心

云原生数据库 PolarDB:DescribePxfsSecurityIps - 查询Agent文件服务白名单

更新时间:Sep 10, 2026

查询Agent文件服务白名单

接口说明

查询 Agent 文件服务白名单。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID

cn-hangzhou

DBInstanceName

string

PolarDB-X 实例 ID

pxc-xxxxxxxx

返回参数

名称

类型

描述

示例值

object

返回参数

RequestId

string

请求 ID

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Data

object

返回数据

Groups

array<object>

白名单分组列表

object

白名单分组

GroupName

string

白名单分组名称

default

IpLists

string

IP 地址列表

192.168.1.0/24,10.0.0.1

GroupTag

string

白名单分组标签

default

CustinsName

string

管控实例名称

pxfs-xxxxxxxx

AccessDeniedDetail

object

无权限访问详情

AuthAction

string

鉴权动作

xxx

AuthPrincipalType

string

说明如上。

222

AuthPrincipalOwnerId

string

鉴权主体 OwnerId

111

AuthPrincipalDisplayName

string

请求中用于鉴权的身份标识。

xxx

PolicyType

string

策略类型

PRIORITY

NoPermissionType

string

无权限类型

ImplicitDeny

EncodedDiagnosticMessage

string

诊断信息

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "Groups": [
      {
        "GroupName": "default",
        "IpLists": "192.168.1.0/24,10.0.0.1",
        "GroupTag": "default"
      }
    ],
    "CustinsName": "pxfs-xxxxxxxx"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

错误码

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

变更历史

更多信息,参考变更详情