最近更新时间:2024.04.19 11:53:53
首次发布时间:2023.06.30 15:23:33
获取 RecordingRule 规则文件列表。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListRuleFiles | 公共参数,本接口值:ListRuleFiles。 |
Version | String | 是 | 2021-03-03 | 公共参数,本接口值:2021-03-03。 |
PageNumber | Integer | 否 | 1 | 当前页数,最小值或默认值均为 1。 |
PageSize | Integer | 否 | 10 | 单页数量:
|
Filter | Object RuleFileFilter | 是 | - | 规则文件过滤条件。 |
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
WorkspaceId | String | 是 | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 按工作区 ID 过滤,精确查询。 |
Ids | Array of String | 否 | ["1c3f6e48-b5e1-4832-8564-10eaac12a22c"] | 按规则文件 ID 过滤,精确查询。 |
Name | String | 否 | test | 按规则文件名称过滤,模糊搜索。 |
Status | Array of String | 否 | ["Running"] | 按规则文件状态过滤,精确查询。取值:
|
POST /?Action=ListRuleFiles&Version=2021-03-03 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c", "Ids": ["1c3f6e48-b5e1-4832-8564-10eaac12a22c"], "Name": "test", "Status": ["Running"] } }
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Total | Integer | 100 | 规则文件总数。 |
Items | Array of RuleFile | - | 规则文件列表。 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 1c3f6e48-b5e1-4832-8564-10eaac12a22c | 规则文件 ID。 |
CreateTime | String | 2022-01-01T00:00:00Z | 规则文件创建时间,RFC3339 格式。 |
LastUpdateTime | String | 2022-01-01T00:00:00Z | 规则文件最近更新时间,RFC3339 格式。 |
Name | String | test | 规则文件名称。 |
Description | String | 这是一段描述 | 规则文件描述信息。 |
Status | String | Running | 规则文件状态:
|
RuleCount | Integer | 2 | 规则文件中的规则数。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202211302208xxxx", "Action": "ListRuleFiles", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Total": 100, "Items": [ { "Id": " 1c3f6e48-b5e1-4832-8564-10eaac12a22c", "CreateTime": "2022-01-01T00:00:00Z", "LastUpdateTime": "2022-01-01T00:00:00Z", "Name": "test", "Description": "这是一段描述", "Status": "Running", "RuleCount": 2 } ] } }
本接口错误码如下表所示,公共错误码请参见 公共错误码。
HTTP 状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotFound.Id | The specified Workspace {{id}} is not found. | 未找到指定的工作区。 |