全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeContextDBConfig - 查看上下文服务配置

更新时间:Sep 10, 2026

查询ContextDB-X管理凭证

接口说明

说明
  • PolarDB-X 2.0 SQL 审计与分析功能本身免费使用,但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费,更多关于 SQL 审计功能的详情,请参见开启 SQL 审计与分析

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

DBInstanceName

string

实例 ID。

pxc-********

返回参数

名称

类型

描述

示例值

object

RequestId

string

Id of the request

9B2F3840-5C98-475C-B269-2D5C3A31797C

Data

object

数据结构体。

ContextDBInstanceName

string

上下文服务实例名

pxt-*********

ContextDBAdminKey

string

上下文服务实例的 Admin Key

ctx-admin-***

ContextDBOwnerKey

string

上下文服务实例的 Owner Key

ctx-***

DBInstanceName

string

实例名称

pxc-*********

OpenSearchInstanceName

string

PolarDBX Search 实例名

pxs-*********

AccessDeniedDetail

object

无权限访问详情

AuthAction

string

鉴权动作

xxx

AuthPrincipalType

string

鉴权主体类型

222

AuthPrincipalOwnerId

string

鉴权主体 OwnerId

111

AuthPrincipalDisplayName

string

鉴权主体名称

xxx

PolicyType

string

策略类型

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

诊断信息

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

示例

正常返回示例

JSON格式

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "ContextDBInstanceName": "pxt-*********",
    "ContextDBAdminKey": "ctx-admin-***",
    "ContextDBOwnerKey": "ctx-***",
    "DBInstanceName": "pxc-*********",
    "OpenSearchInstanceName": "pxs-*********"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

错误码

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

变更历史

更多信息,参考变更详情