查询StarRocks参数 - ShowStarrocksParams
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/configurations
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 | 
| instance_id | 是 | String | 参数解释: StarRocks实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认取值: 不涉及。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 | 
响应参数
状态码:200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| configurations | ParameterConfigurationInfo object | 参数解释: 参数信息。 取值范围: 不涉及。 | 
| total_count | Long | 参数解释: 参数信息的总数。 取值范围: 不涉及。 | 
| parameter_values | Array of ParameterValuesInfo objects | 参数解释: 参数对象。 取值范围: 不涉及。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| datastore_version_name | String | 参数解释: 数据库版本名称。 取值范围: 2.0 | 
| datastore_name | String | 参数解释: 参数组引擎名称。 取值范围: taurus | 
| created | String | 参数解释: 参数组创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 | 
| updated | String | 参数解释: 参数组更新时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| name | String | 参数解释: 参数名称。 取值范围: 不涉及。 | 
| value | String | 参数解释: 参数值。 取值范围: 不涉及。 | 
| restart_required | Boolean | 参数解释: 是否需要重启。 取值范围: 
 | 
| readonly | Boolean | 参数解释: 是否只读。 取值范围: 
 | 
| value_range | String | 参数解释: 参数值范围。 取值范围: 不涉及。 | 
| type | String | 参数解释: 参数类型。 取值范围: 
 | 
| description | String | 参数解释: 参数描述。 取值范围: 不涉及。 | 
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码。 | 
| error_msg | String | 错误描述。 | 
状态码:500
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码。 | 
| error_msg | String | 错误描述。 | 
请求示例
查询实例be节点的参数。
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3edf6218dfb442329730765ee02fdd31in17/starrocks/configurations?node_type=be
  响应示例
状态码:200
参数查询接口返回。
{
    "configurations": {
        "datastore_name": "taurus",
        "datastore_version_name": "2.0",
        "created": "2024-05-17T02:58:32+0000",
        "updated": "2024-05-17T08:51:45+0000"
    },
    "parameter_values": [
        {
            "name": "auto_increment_increment",
            "value": "1",
            "restart_required": false,
            "readonly": false,
            "value_range": "1-65535",
            "type": "integer",
            "description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制,并可以用来控制AUTO_INCREMENT列的操作。"
        },
    ],
    "total_count": 140
}
  状态码
请参见状态码。
错误码
请参见错误码。
 
    