华为云用户手册

6.1：x-apigateway-backend.parameters 含义：ROMA Connect定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true - name: "userId" description: "user name" type: "string" in: "path" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" parameters: - name: "userId" value: "userId" in: "query" origin: "REQUEST" description: "user name" - name: "X-Invoke-User" value: "apigateway" in: "header" origin: "CONSTANT" description: "invoke user"

2：x-apigateway-request-type 含义：ROMA Connect定义的API类型，支持public和private。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-request-type: 'public' 表2 参数说明 参数 是否必选 类型 说明 x-apigateway-request-type 是 String API类型，支持“public”和“private”。 public：公开类型API，可以上架云市场。 private：私有类型API，不会被上架云市场。

1：x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义ROMA Connect支持的特有认证方式。 作用域：Security Scheme Object 示例： securityDefinitions: customize-name-iam: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: " IAM " customize-name-app: type: "apiKey" name: "Authorization" in: "header" x-apigateway-auth-type: "AppSigv1" customize-name-iam-none: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: "IAM_NONE"

维度 Key Value instance_id ROMA Connect实例 fdi 数据集成 apic 服务集成 kafka_instance_id 消息集成实例 kafka_broker 消息集成Broker节点 kafka_rest 消息集成Rest节点 kafka_topics 消息集成队列 kafka_partitions 消息集成分区 kafka_groups-partitions 消息集成分区的消费组 kafka_groups_topics 消息集成队列的消费组 kafka_groups 消息集成消费组 link 设备集成

LINK支持的监控指标 表4 LINK支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） online_connections 在线设备数 该指标用于统计用户在线设备的连接数。 ≥0 单位：个 实例 1分钟 msg_count 消息总数 该指标用于统计用户所有设备发送的消息总数。 ≥0 单位：个 实例 1分钟 msg_tps TPS 该指标用于统计时间区间内设备每秒发送消息数。 ≥0 单位：次/秒 实例 1分钟 msg_max_latency 发送消息最大时延 该指标用于统计时间区间内设备发送消息延迟毫秒数。 ≥0 单位：毫秒 实例 1分钟

MQS支持的监控指标 表3 MQS支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） current_partitions 分区数 统计实例中已经使用的分区数量。 ≥0 单位：个 实例 1分钟 current_topics 主题数 统计实例中已经创建的主题数量。 ≥0 单位：个 实例 1分钟 group_msgs 堆积消息数 统计实例中所有消费组中总堆积消息数。 ≥0 单位：个 实例 1分钟 broker_data_size 节点数据容量 统计节点当前的消息数据大小。 ≥0 单位：Byte/KB/MB/GB/TB/PB 节点 1分钟 broker_messages_in_rate 消息生产速率 统计每秒生产的消息数量。 ≥0 单位：个/秒 节点 1分钟 broker_bytes_out_rate 消费流量 统计每秒消费的字节数。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_bytes_in_rate 生产流量 统计每秒生产的字节数。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_public_bytes_in_rate 公网入流量 统计Broker节点每秒公网访问流入流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_public_bytes_out_rate 公网出流量 统计Broker节点每秒公网访问流出流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_fetch_mean 生产请求平均处理时长 统计Broker节点处理生产请求平均时长。 ≥0 单位：毫秒 节点 1分钟 broker_produce_mean 消费请求平均处理时长 统计Broker节点处理消费请求平均时长。 ≥0 单位：毫秒 节点 1分钟 broker_alive 节点存活状态 统计MQS节点是否存活。 ≥0 节点 1分钟 broker_connections 连接数 统计MQS节点当前所有TCP连接数量。 ≥0 单位：个 节点 1分钟 broker_cpu_usage CPU使用率 统计MQS节点虚拟机的CPU使用率。 ≥0 单位：百分比 节点 1分钟 broker_disk_read_await 磁盘平均读操作耗时 统计磁盘在测量周期内平均每个读IO的操作时长。 ≥0 单位：毫秒 节点 1分钟 broker_disk_write_await 磁盘平均写操作耗时 统计磁盘在测量周期内平均每个写IO的操作时长。 ≥0 单位：毫秒 节点 1分钟 broker_total_bytes_in_rate 网络入流量 统计MQS节点每秒网络访问流入流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_total_bytes_out_rate 网络出流量 统计MQS节点每秒网络访问流出流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 broker_cpu_core_load CPU核均负载 统计MQS节点虚拟机CPU每个核的平均负载。 ≥0 节点 1分钟 broker_disk_usage 磁盘容量使用率 统计MQS节点虚拟机的磁盘容量使用率。 ≥0 单位：百分比 节点 1分钟 broker_memory_usage 内存使用率 统计MQS节点虚拟机的内存使用率。 ≥0 单位：百分比 节点 1分钟 broker_heap_usage Kafka进程JVM堆内存使用率 统计MQS节点Kafka进程JVM中的堆内存使用率。 ≥0 单位：百分比 节点 1分钟 produced_messages 生产消息数 统计Rest节点每分钟生产消息数。 ≥0 单位：个 节点 1分钟 topic_bytes_in_rate 生产流量 统计Rest每秒钟生产流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 topic_bytes_out_rate 消费流量 统计Rest每秒钟消费流量。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 节点 1分钟 topic_messages_in_rate 消息生产速率 统计每秒生产的消息数量。 ≥0 单位：个/秒 队列 1分钟 topic_bytes_out_rate 消费流量 统计每秒消费的字节数。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 队列 1分钟 topic_bytes_in_rate 生产流量 统计每秒生产的字节数。 ≥0 单位：Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 队列 1分钟 topic_messages 队列消息总数 统计队列当前的消息总数。 ≥0 单位：个 队列 1分钟 produced_messages 生产消息数 统计目前生产的消息总数。 ≥0 单位：个 队列 1分钟 partition_messages 分区消息数 统计分区中当前的消息个数。 ≥0 单位：个 队列 1分钟 messages_consumed 分区已消费消息数 统计当前消费组已经消费的消息个数。 ≥0 单位：个 消费组 1分钟 messages_remained 分区可消费消息数 统计消费组可消费的消息个数。 ≥0 单位：个 消费组 1分钟 topic_messages_remained 队列可消费消息数 统计消费组指定队列可以消费的消息个数。 ≥0 单位：个 消费组 1分钟 topic_messages_consumed 队列已消费消息数 统计消费组指定队列当前已经消费的消息数。 ≥0 单位：个 消费组 1分钟 consumer_messages_remained 消费组可消费消息数 统计消费组剩余可以消费的消息个数。 ≥0 单位：个 消费组 1分钟 consumer_messages_consumed 消费组已消费消息数 统计消费组当前已经消费的消息数。 ≥0 单位：个 消费组 1分钟

APIC支持的监控指标 表2 APIC支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） data_api_request_count Data API调用次数 统计Data API调用次数。 ≥0 实例 1分钟 data_api_max_latency Data API最大延迟毫秒数 统计Data API最大响应延时时间。 ≥0 单位：毫秒 实例 1分钟 data_api_avg_latency Data API平均延迟毫秒数 统计Data API平均响应延时时间。 ≥0 单位：毫秒 实例 1分钟 data_api_errors Data API错误次数 统计Data API错误次数。 ≥0 实例 1分钟 func_api_request_count Function API调用次数 统计Function API调用次数。 ≥0 实例 1分钟 func_api_max_latency Function API最大延迟毫秒数 统计Function API最大响应延时时间。 ≥0 单位：毫秒 实例 1分钟 func_api_avg_latency Function API平均延迟毫秒数 统计Function API平均响应延时时间。 ≥0 单位：毫秒 实例 1分钟 func_api_errors Function API错误次数 统计Function API错误次数。 ≥0 实例 1分钟 requests 接口调用次数 统计测量api接口被调用的次数。 ≥0 实例 1分钟 error_4xx 4xx 异常次数 统计测量api接口返回4xx错误的次数。 ≥0 实例 1分钟 error_5xx 5xx 异常次数 统计测量api接口返回5xx错误的次数。 ≥0 实例 1分钟 throttled_calls 被流控的调用次数 统计测量api被流控的调用次数。 ≥0 实例 1分钟 avg_latency 平均延迟毫秒数 统计测量api接口平均响应延时时间。 ≥0 实例 1分钟 max_latency 最大延迟毫秒数 统计测量api接口最大响应延时时间。 ≥0 单位：毫秒 实例 1分钟 req_count 接口调用次数 统计测量api接口调用次数。 ≥0 单个API 1分钟 req_count_2xx 2xx调用次数 统计测量api接口调用2xx的次数。 ≥0 单个API 1分钟 req_count_4xx 4xx异常次数 统计测量api接口返回4xx错误的次数。 ≥0 单个API 1分钟 req_count_5xx 5xx异常次数 统计测量api接口返回5xx错误的次数。 ≥0 单个API 1分钟 req_count_error 异常次数 统计测量api接口总的错误次数。 ≥0 单个API 1分钟 avg_latency 平均延迟毫秒数 统计测量api接口平均响应延时时间。 ≥0 单位：毫秒 单个API 1分钟 max_latency 最大延迟毫秒数 统计测量api接口最大响应延时时间。 ≥0 单位：毫秒 单个API 1分钟 input_throughput 流入流量 统计测量api接口请求流量。 ≥0 单位：Byte/KB/MB/GB/TB/PB 单个API 1分钟 output_throughput 流出流量 统计测量api接口返回流量。 ≥0 单位：Byte/KB/MB/GB/TB/PB 单个API 1分钟

操作步骤 在实例控制台的“实例信息”页面选择“数据字典”页签。 单击“创建字典”。 在创建字典弹窗中配置数据字典相关信息，完成后单击“确认”。 表1 数据字典配置 参数 配置说明 字典编码 填写字典类唯一标识。 字典名称 填写字典类名称。 扩展字段1 作为字典类默认值，预留字段，可不填。 扩展字段2 描述 填写数据字典的描述信息。 数据字典创建完成后，单击字典名称前的“”展开字典项列表。 单击“创建字典项”。 在创建字典项弹窗中配置字典项相关信息，完成后单击“确认”。 表2 字典项配置 参数 配置说明 项编码 填写字典项唯一标识。 项名称 填写字典项名称。 扩展字段1 作为字典项默认值，预留字段，可不填。 扩展字段2 描述 填写字典项的描述信息。

11.1：x-apigateway-access-controls.policy 含义：访问控制策略定义。 作用域：x-apigateway-access-controls 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表19 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为，支持“PERMIT”和“DENY”。 entity-type 是 String 访问控制对象，仅支持“IP”。 value 是 String 访问控制策略值，多个值之间以英文逗号（,）隔开。

11：x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16

12：x-apigateway-roma-app 含义：API绑定的集成应用。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-roma-app: 'romaAppName' 表20 参数说明 参数 是否必选 类型 说明 x-apigateway-roma-app 是 String API所绑定的集成应用名称。

13 x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-plugins: ['Plugin_mock'] 表21 参数说明 参数 是否必选 类型 说明 x-apigateway-plugins 否 Array API所绑定的插件名列表。

14 x-apigateway-is-send-fg-body-base64 含义：是否对与FunctionGraph交互场景的请求体进行Base64编码，boolean类型。 作用域：Operation Object 示例： paths: '/path': get: "x-apigateway-is-send-fg-body-base64": true 表22 参数说明 参数 是否必选 类型 说明 x-apigateway-is-send-fg-body-base64 否 boolean 是否对与FunctionGraph交互场景的请求体进行Base64编码。 true：编码 false：不编码

9：x-apigateway-ratelimits 含义：流控策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: second/minute/hour shared: true special: - type: APP limit: 100 instance: xxxxxxxxx

9.2：x-apigateway-ratelimits.policy.special 含义：特殊流控策略定义。 作用域：x-apigateway-ratelimits.policy 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxxx 表16 参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型，支持“APP”和“USER”。 limit 是 Number 访问次数限制。 instance 是 String 特殊APP或USER的对象标识。

9.1：x-apigateway-ratelimits.policy 含义：流控策略定义。 作用域：x-apigateway-ratelimits 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxx

10：x-apigateway-access-control 含义：ROMA Connect引用的访问控制策略。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-access-control: 'customAccessControlName' 表17 参数说明 参数 是否必选 类型 说明 x-apigateway-access-control 否 String 引用的访问控制策略名称，设置为“customAccessControlName”。

8：x-apigateway-ratelimit 含义：ROMA Connect引用的流控策略。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-ratelimit: 'customRatelimitName' 表13 参数说明 参数 是否必选 类型 说明 x-apigateway-ratelimit 否 String 引用的流控策略名称，设置为“customRatelimitName”。

7.1：x-apigateway-backend-policies.conditions 含义：ROMA Connect定义的API后端策略条件。 作用域：x-apigateway-backend-policies 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表12 参数说明 参数 是否必选 类型 说明 type 是 String 策略条件类型，支持“equal”、“enum”和“pattern”。 value 是 String 策略条件值。 origin 是 String 策略条件输入来源，支持“source”和“request”。 parameter 否 String 策略条件输入来源为“request”时，请求入参的名称。

7：x-apigateway-backend-policies 含义：ROMA Connect定义的API后端策略。 作用域：Operation Object 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表11 参数说明 参数 是否必选 类型 说明 type 是 String 后端服务类型，支持“HTTP”、“HTTP-VPC”和“MOCK”。 name 是 String 后端策略名称。 parameters 否 x-apigateway-backend.parameters 后端参数定义。 httpEndpoints 否 x-apigateway-backend.httpEndpoints HTTP类型服务定义。 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义。 functionEndpoints 否 x-apigateway-backend.functionEndpoints FUNCTION类型服务定义。 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型服务定义。 conditions 是 x-apigateway-backend-policies.conditions 后端策略条件。

5：x-apigateway-any-method 含义：ROMA Connect定义的API请求方法，用以匹配未指定定义的HTTP方法。 作用域：Path Item Object 示例： paths: '/path': get: produces: - application/json responses: "200": description: "get response" x-apigateway-any-method: produces: - application/json responses: "200": description: "any response"

6.2：x-apigateway-backend.httpEndpoints 含义：ROMA Connect定义的HTTP类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" httpEndpoints: address: "www.example.com" scheme: "http" method: "GET" path: "/users" retryCount: "3" timeout: 30000

6.5：x-apigateway-backend.mockEndpoints 含义：ROMA Connect定义的MOCK类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "MOCK" mockEndpoints: result-content: "mocked"

6.1：x-apigateway-backend.parameters 含义：ROMA Connect定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true - name: "userId" description: "user name" type: "string" in: "path" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" parameters: - name: "userId" value: "userId" in: "query" origin: "REQUEST" description: "user name" - name: "X-Invoke-User" value: "apigateway" in: "header" origin: "CONSTANT" description: "invoke user"

6：x-apigateway-backend 含义：ROMA Connect定义的API后端服务定义。 作用域：Operation Object 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type"

6.4：x-apigateway-backend.functionEndpoints 含义：ROMA Connect定义的FUNCTION类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "FUNCTION" functionEndpoints: version: "v1" function-urn: "" invocation-type: "synchronous" timeout: 30000 表9 参数说明 参数 是否必选 类型 说明 function-urn 是 String 函数的URN地址。 version 是 String 函数的版本。 invocation-type 是 String 函数的调用类型，支持“async”和“sync”。 timeout 否 Number 函数超时时间，单位毫秒，缺省值为5000，取值范围为1-60000。

6.3：x-apigateway-backend.httpVpcEndpoints 含义：ROMA Connect定义的HTTP VPC类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP-VPC" httpVpcEndpoints: name: "vpc-test-1" scheme: "http" method: "GET" path: "/users" timeout: 30000

1：x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义ROMA Connect支持的特有认证方式。 作用域：Security Scheme Object 示例： securityDefinitions: customize-name-iam: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: "IAM" customize-name-app: type: "apiKey" name: "Authorization" in: "header" x-apigateway-auth-type: "AppSigv1" customize-name-iam-none: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: "IAM_NONE"

2：x-apigateway-request-type 含义：ROMA Connect定义的API类型，支持public和private。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-request-type: 'public' 表2 参数说明 参数 是否必选 类型 说明 x-apigateway-request-type 是 String API类型，支持“public”和“private”。 public：公开类型API，可以上架云市场。 private：私有类型API，不会被上架云市场。

3：x-apigateway-match-mode 含义：ROMA Connect定义的API请求路径的匹配模式，支持NORMAL和SWA。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-match-mode: 'SWA' 表3 参数说明 参数 是否必选 类型 说明 x-apigateway-match-mode 是 String API请求路径的匹配模式，支持“SWA”和“NORMAL”。 SWA：前缀匹配，例如API的请求路径为“/test/AA”，使用前缀匹配时，通过/test/AA/BB和/test/AA/CC都可以访问API，但是通过/test/AACC无法访问。 NORMAL：绝对匹配。