# 查询任务参数配置列表 - ListJobParameters #### 功能介绍 查询任务的参数配置列表信息。 #### 接口约束 - 仅支持MySQL-\>MySQL、MySQL-\>PostgreSQL、MySQL-\>GaussDB分布式、MySQL-\>GaussDB集中式、MySQL-\>TaurusDB、MySQL-\>Kafka、MySQL-\>Oracle的实时同步任务使用。 - 任务状态为配置中、全量中、增量中、全量失败、增量失败、暂停中的实时同步任务使用。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/jobs/{job_id}/configurations 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 | | job_id | 是 | String | 任务ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | String | 偏移量，表示从此偏移量开始查询，offset 大于等于 0。默认为0 | | limit | 否 | String | 每页显示的条目数量。默认为10，取值范围【1-1000】 | | name | 否 | String | 根据参数名查询。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：**application/json** | | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制：** 不涉及。 **取值范围：** - **en-us**：英语 - **zh-cn**：中文 **默认取** **值：** **en-us** | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 总数。 | | parameter_config_list | Array of objects | 任务参数列表。 详情请参见[表5]。 | 表5parameter_config_list字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名称。 | | value | String | 参数值。 | | default_value | String | 参数默认值。 | | value_range | String | 参数值范围，如Integer取值0-1、Boolean取值true\|false等。 | | is_need_restart | Boolean | 是否需要重启。默认为true, "false"表示否。"true"表示是。 | | description | String | 参数描述，目前只支持英文。 | | created_at | String | 创建时间，例如：2023-01-20T07:18:26Z。 | | updated_at | String | 更新时间，例如：2023-03-01T09:42:02Z。 | #### 请求示例 查询任务的参数配置列表信息 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configurations?offset={offset}&limit={limit} ``` #### 响应示例 **状态码：200** 任务参数配置列表信息。 ``` { "count" : 0, "parameter_config_list" : [ { "name" : "applier_thread_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads that write data to the target database during the full stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" }, { "name" : "read_task_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads reading data from the source database during the full volume stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。