Alibaba Cloud API Gateway

Collect Alibaba Cloud API Gateway monitoring data

Configuration¶

Install Func¶

It is recommended to activate the Guance Integration - Extensions - DataFlux Func (Automata)

If deploying Func by yourself, refer to Deploy Func by Yourself

Activate Script¶

Note: Please prepare the Alibaba Cloud AK that meets the requirements in advance (for simplicity, you can directly grant the global read-only permission ReadOnlyAccess)

Automata Activation Script¶

1. Log in to the Guance console
2. Click the 【Integration】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【Alibaba Cloud】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
4. Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
5. Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
6. Click the 【Integration】 button on the cloud account details page, find Alibaba Cloud API Gateway under the Not Installed list, and click the 【Install】 button to pop up the installation interface for installation.

Manual Activation Script¶

1. Log in to the Func console, click 【Script Market】, and enter the Guance script market. Search for: integration_alibabacloud_apigateway

2. Click 【Install】, then enter the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

3. Click 【Deploy Startup Script】, the system will automatically create a Startup script set and configure the corresponding startup script.

4. After enabling, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. After a while, you can view the execution task records and corresponding logs.

Verification¶

1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task records and logs for any exceptions.
2. In Guance, check if asset information exists in 「Infrastructure / Custom」.
3. In Guance, check if there is corresponding monitoring data in 「Metrics」.

Metrics¶

After configuring Alibaba Cloud Cloud Monitor, the default Measurement is as follows. More metrics can be collected through configuration. Alibaba Cloud Cloud Monitor Metrics Details

API Gateway¶

API Group¶

API Instance¶

Object¶

The collected Alibaba Cloud API Gateway object data structure can be seen in 「Infrastructure - Custom」.

{
  "measurement": "aliyun_apigateway",
  "tags": {
    "instance_spec"             : "api.s1.small",
    "instance_name"             : "xxxx-test",
    "instance_id"               : "i-xxxxx",
    "region_id"                 : "cn-hangzhou"
  },
  "fields": {
    "zone_local_name"                   : "xxxxx",
    "internet_egress_address"           : "114.55.1xx.xxx",
    "created_time"                     : "2025/09/01 16:10:09",
    "vpc_egress_address"                : "100.xxx.xxx.0/xx",
    "instance_spec_attributes"          : "xxxxx",
    "instance_charge_type"              : "PayAsYouGo",
    "vpc_slb_intranet_enable"            : "False",
    "instance_type"                    : "VPC_SHARED",
    "status"                          : "RUNNING",
    "zone_id"                          : "cn-hangzhou",
    "instance_cidr_block"               : "172.16.xx.xx/xx",
    "ipv_6_acl_status"                   : "off",
    "egress_ipv_6_enable"                : "False",
    "maintain_start_time"               : "18:00Z",
    "maintain_end_time"                 : "22:00Z"
  }
}

Note: The fields in tags and fields may change with subsequent updates.