查询规则详情 - ShowRuleDetail
功能介绍
该API用于获取一条规则的详情。
URI
GET /v2/{project_id}/routemgr/rules/{rule_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID |
rule_id | 是 | String | 规则ID |
请求参数
参数 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 消息体的类型(格式) 推荐您使用默认值application/json。 |
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
ief-instance-id | 否 | String | 企业版实例ID,专业版实例为空值 |
响应参数
状态码为 200 时:
参数 | 参数类型 | 描述 |
|---|---|---|
rule | RuleResponse object | 规则详情 |
参数 | 参数类型 | 描述 |
|---|---|---|
created_at | String | 创建时间 |
description | String | 规则描述,最大长度255,不允许^~#$%&*<>()[]{}'"\ |
fail_messages | Integer | 转发失败的消息数 |
id | String | 规则ID |
ief_instance_id | String | 企业版实例ID,如果为空则表示是专业版实例。 |
in_using | Boolean | 是否启用规则,默认为true(启用) |
name | String | 规则名称,只允许中文字符、英文字符、数字、下划线、中划线,最大长度64 同一个账号中创建的规则名唯一 |
project_id | String | 项目ID |
source | EndpointResponse object | 源端点信息 |
source_resource | Map<String,Object> | 源端点资源,示例:
|
success_messages | Integer | 转发成功的消息数 |
target | EndpointResponse object | 目标端点信息 |
target_resource | Map<String,Object> | 目的端点资源,示例:
|
updated_at | String | 更新时间 |
参数 | 参数类型 | 描述 |
|---|---|---|
created_at | String | 创建时间 |
description | String | 端点描述,最大长度255,不允许^~#$%&*<>()[]{}'"\ |
id | String | 端点ID |
ief_instance_id | String | 企业版实例ID,如果为空则表示是专业版实例。 |
is_shared | Boolean | 是否共享 |
name | String | 端点名称,只允许中文字符、英文字符、数字、下划线、中划线,最大长度64 同一个账号中创建的端点名唯一 |
project_id | String | 项目ID |
properties | Map<String,Object> | 端点的属性,端点需要对外展示的属性,示例:
|
type | String | 端点类型 枚举值:
|
updated_at | String | 更新时间 |
状态码为 401 时:
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_message | String | 错误信息 |
状态码为 404 时:
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_message | String | 错误信息 |
状态码为 500 时:
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_message | String | 错误信息 |
请求示例
无
响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | 查询成功 |
401 | 错误响应 |
404 | 错误响应 |
500 | 错误响应 |
错误码
请参见错误码。

