全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeComponentPropeties - 查询组件属性

更新时间:Sep 10, 2026

该接口用于获取指定组件的属性信息,包括属性名称、类型等。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeComponentPropeties

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所在地域。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情,包括地域 id。

cn-hangzhou

CommodityCode

string

商品类型。

learn_EasDedicatedPrepay_public_cn

ComponentName

string

资源组 ID

rg-xxxxx

StorageType

string

存储类型

cloud_auto

返回参数

名称

类型

描述

示例值

object

RequestId

string

Id of the request

A501A191-BD70-5E50-98A9-C2A486A82****

Properties

array<object>

异常事件的导出参数。

object

异常事件的导出参数。

PropertyCode

string

商品模块。

dn_node_spec

Name

string

名称。

4核32G

OrderIndex

string

商品模块属性显示顺序。

不同商品模块返回内容不同。

1

Value

string

标签值

172.27.35.

示例

正常返回示例

JSON格式

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Properties": [
    {
      "PropertyCode": "dn_node_spec",
      "Name": "4核32G",
      "OrderIndex": "1",
      "Value": "172.27.35."
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情