文档

DescribeParameters - 查看参数信息列表

更新时间:

查看参数信息列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DescribeParametersRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
Dimensionstring

参数类型。 当前支持集群(CLUSTER)和租户(TENANT)。

TENANT
DimensionValuestring

参数类型的资源标识。
如果为集群参数可以不填,若为租户的参数,则传入租户的 TenantId。

ob2mr3oae0****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parametersobject []

参数列表信息。

Descriptionstring

参数的描述信息。

弱读允许的最大时间延迟时间
ValueTypestring

参数取值的类型。其支持:

  • ENUM: 数值枚举。
  • RANGE: 数值范围。
  • TIME: 时间。
  • STRING:字符串。
  • ENUM_MULTIPLE:数值枚举多选。
  • CAPACITY:存储容量值(K,M,G)。
CAPACITY
CurrentValuestring

参数的当前取值。

600
NeedRebootboolean

修改此参数是否需要重启。

  • true:需要重启。
  • false:不需要重启。
false
Namestring

参数名称。

connect_timeout
DefaultValuestring

参数的默认取值。

600s
RejectedValuearray

参数的不允许取值范围。 其格式为具备两个字符串元素的数组类型,表示一个范围值,第一个元素为最小值,第二个元素为最大值。

string

参数的不允许取值范围。

1s
AcceptableValuearray

参数的可接受取值范围。

string

参数的可接受取值范围。

2s
Readonlyboolean

参数是否只读。

false
Unitstring

当前参数值单位。

s

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Parameters": [
    {
      "Description": "弱读允许的最大时间延迟时间",
      "ValueType": "CAPACITY",
      "CurrentValue": "600",
      "NeedReboot": false,
      "Name": "connect_timeout",
      "DefaultValue": "600s",
      "RejectedValue": [
        "1s"
      ],
      "AcceptableValue": [
        "2s"
      ],
      "Readonly": false,
      "Unit": "s"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

变更时间变更内容概要操作
2023-08-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-05-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)