用途:对阿里云网关实例执行健康巡检,获取监控指标数据并生成巡检报告。架构涉及云监控(CMS)、API网关(cloudapi)与云原生API网关/AI网关(apig)。
支持产品:云原生API网关(实例ID形如gw-xxxxxxx,命令aliyun apig list-gateways)、AI网关(同前)、API网关专享实例(apigateway-xx-xxxxxxx,命令aliyun cloudapi describe-instances)。API网关共享实例(VPC_SHARED)不支持巡检,仅支持专享实例(VPC_DEDICATED)。
安装与前置:需阿里云CLI >= 3.3.3,用aliyun version校验。安装/升级示例:macOS用brew install aliyun-cli或brew upgrade aliyun-cli;Linux/macOS二进制用curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash;Windows用PowerShell下载zip并解压。随后执行aliyun configure set --auto-plugin-install true与aliyun plugin update。
可观测性要求:每个调用云API的aliyun命令必须带--user-agent AlibabaCloud-Agent-Skills/alibabacloud-apigw-inspection/{session-id},本地工具命令(configure、plugin、version)除外。
认证:凭证通过aliyun configure配置,禁止读取、回显或打印AK/SK,禁止在对话或命令行输入凭证,仅用aliyun configure list检查状态。需最小RAM只读权限,涉及apigateway:DescribeInstances、DescribeInstanceDropPacket、DescribeInstanceDropConnections、DescribeInstanceSlbConnect、DescribeInstanceTraffic、DescribeInstanceQps,apig:ListGateways,cms:QueryMetricData。权限失败时读取references/ram-policies.md并用ram-permission-diagnose引导申请。
参数确认:执行前必须与用户确认产品类型、RegionId、实例ID,时间范围可选(默认当前时间),禁止擅自使用默认值。
核心流程:先收集信息;再查询实例列表(必须用CLI插件模式,插件缺失时运行aliyun plugin install --names apig);然后取监控数据。云原生API网关/AI网关用aliyun cms describe-metric-data,命名空间acs_cnapigateway,维度含instanceId,时间用Unix毫秒时间戳,须覆盖CPU、内存、连接、网络IO、限流等指标;禁止使用DescribeMetricList与DescribeMetricMetaList。API网关专享实例改用cloudapi的5个API(丢包、丢连接、SLB连接、流量、QPS),其中流量与QPS须分别查询RELEASE、PRE、TEST三个环境,共7次调用,时间格式为ISO8601 UTC。
限制:仅只读操作;共享实例不支持;具体报告格式与更多平台安装细节见references目录,资料未提供完整报告模板。