String 参数解释： 参数描述。 取值范围： 不涉及。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code

查看更多 →

String 参数解释： 参数描述。 取值范围： 不涉及。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code

查看更多 →

涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32 响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 extends_params Array of ExtendsParamV2 objects 附加参数列表 数组长度：0 - 65535 common_params

查看更多 →

查询实例配置参数 功能介绍 查询指定实例的配置参数信息。 URI GET /v1.0/{project_id}/instances/{instance_id}/configs 参数说明见表1。 表1 参数说明 参数 类型 必选 说明 project_id String 是 项目ID。

查看更多 →

参数组ID。获取方法，请参见查询集群参数组。 请求参数 无 响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 configurations Array of ConfigurationParameter objects 集群使用的参数配置信息。 表3 ConfigurationParameter

查看更多 →

查询参数组详情 功能介绍 查询参数组详情 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipeline/variable/group/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 参数组ID project_id

查看更多 →

Boolean 参数解释： 是否是用户自定义参数模板 取值范围： false：表示为系统默认参数模板。 true：表示为用户自定义参数模板。 description String 参数解释： 参数组描述。 取值范围： 不涉及。 状态码： 400 表6 响应Body参数 参数 参数类型 描述

查看更多 →

查询参数模板 功能介绍 获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。 该接口计划于2025-03-31下线，建议及时切换到新接口查询参数模板。 调试 您可以在 API Explorer 中调试该接口。 URI GET /mysql/v3/{project_id}/configurations

查看更多 →

查询参数修改历史 功能介绍 查询参数修改历史。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/configurations/{configuration_id}/modify-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id

查看更多 →

作业查询/详情参数 queryOption（作业列表查询参数） 参数 是否必选 类型 说明 order 否 String 返回结果的排序规则，格式为<属性名>：<[ASC|DESC]>。ASC表示升序，DESC表示降序，例如name:ASC，缺省时，按创建时间降序。 适用字段如下：

查看更多 →

查询Query参数 接口名称 WEB_GetLineStateRESTfulAPI(后续废弃) 功能描述 查询Query参数 应用场景 查询Query参数 URL https://ip/v1/om/device/lineInfo?ActionID=WEB_GetLineStateRESTfulAPI

查看更多 →

ID与下载AK/SK章节 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id

查看更多 →

表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述

查看更多 →

查询集群参数组 功能介绍 该接口用于查询集群所关联的参数组。 调用方法 请参见如何调用API。 URI 1 GET /v1.0/{project_id}/clusters/{cluster_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id

查看更多 →

查询参数模板 功能介绍 获取参数模板列表，包括所有数据库的默认参数模板和用户创建的参数模板。 该接口计划于2025-03-31下线，建议及时切换到新接口查询参数模板。 调试 您可以在API Explorer中调试该接口。 URI GET /mysql/v3/{project_id}/configurations

查看更多 →

查询实例配置参数 功能介绍 查询指定实例的配置参数信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是

查看更多 →

am 表1 路径参数 参数 是否必选 参数类型 描述 case_id 是 String 工单id 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 group_id 是 String 组id 最小长度：1 最大长度：64 请求参数 表3 请求Header参数

查看更多 →

数据，表示从第一条数据开始查询）。 取值必须为数字，不能为负数。 limit 否 Integer 查询个数上限值。 取值范围: 1~100。 不传该参数时，默认查询前100条信息。 请求消息 无。 响应消息 参数说明 表4 响应Body参数 参数 参数类型 说明 histories

查看更多 →

查询参数修改历史 功能介绍 查询参数修改历史。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/configurations/{configuration_id}/modify-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id

查看更多 →

Boolean 参数解释： 是否是用户自定义参数模板 取值范围： false：表示为系统默认参数模板。 true：表示为用户自定义参数模板。 description String 参数解释： 参数组描述。 取值范围： 不涉及。 状态码： 400 表6 响应Body参数 参数 参数类型 描述

查看更多 →

String 模板ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 模板类型，取值范围： sys：系统默认模板 user：用户自定义模板 请求参数 无 响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 template_id

查看更多 →