WSO2 APIM v4.2中APICTL导入应用密钥失败问题求助

问题概述 #

使用WSO2 APIM v4.2及对应版本的apictl-4.2.0-linux-amd64工具导入包含密钥和订阅的应用时，仅应用本身和订阅能成功导入，应用密钥导入失败。Carbon日志显示MySQL数据截断错误：apim_db.AM_APPLICATION_REGISTRATION.INPUTS列存在不正确的字符串值。

执行的导入命令：

apictl import app -f "/root/wso2-apps-to-import/Accounting API/Accounting API.zip" -k -o CARCWSO2/apiuser -e wso2-carc-env

导入文件内容：

{
"type": "application",
"version": "v4.2.0",
"data": {
    "applicationInfo": {
        "name": "Accounting API",
        "throttlingPolicy": "Unlimited",
        "description": "",
        "tokenType": "OAUTH",
        "status": "APPROVED",
        "keys": [
            {
                "keyManager": "Resident Key Manager",
                "consumerKey": "QQeoya0F5pWh6CvyDEao89owfioa",
                "consumerSecret": "1_acIM_i_d1zx4Q4s2YkftZ6ViEa",
                "supportedGrantTypes": [
                    "refresh_token",
                    "urn:ietf:params:oauth:grant-type:saml2-bearer",
                    "password",
                    "client_credentials",
                    "iwa:ntlm",
                    "urn:ietf:params:oauth:grant-type:jwt-bearer"
                ],
                "callbackUrl": "",
                "keyState": "COMPLETED",
                "keyType": "PRODUCTION",
                "mode": "CREATED",
                "token": {
                    "tokenScopes": [],
                    "validityTime": 0
                }
            }
        ]
    },
    "subscribedAPIs": [
        {
            "apiId": {
                "uuid": "1906e24e-f507-4dd1-ba07-d103248ee0c2",
                "apiName": "Account API",
                "providerName": "admin",
                "version": "v1"
            },
            "throttlingPolicy": "Unlimited"
        }
    ]
}
}

原因分析 #

WSO2 APIM v4.2对AM_APPLICATION_REGISTRATION表的INPUTS列存储逻辑进行了调整，而MySQL数据库的字符集/排序规则不兼容，导致密钥相关的JSON数据（如含特殊字符的consumerSecret）无法正确写入，触发数据截断错误。v4.1版本的存储逻辑或列定义不同，因此未出现该问题。

解决方案 #

1. 调整MySQL数据库字符集 #

• 确认apim_db数据库及AM_APPLICATION_REGISTRATION表的字符集为utf8mb4（支持全字符集，避免特殊字符截断），排序规则设为utf8mb4_unicode_ci
• 执行SQL修改表结构：

ALTER DATABASE apim_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
ALTER TABLE AM_APPLICATION_REGISTRATION CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

• 重启WSO2 APIM服务后重新执行导入命令

2. 修改APIM数据源配置 #

• 打开<APIM_HOME>/repository/conf/datasources/master-datasources.xml，找到WSO2AM_DB数据源配置
• 在JDBC URL中添加字符集参数：?useUnicode=true&characterEncoding=utf8mb4
• 示例配置片段：

<datasource>
    <name>WSO2AM_DB</name>
    <jndiConfig>
        <name>jdbc/WSO2AM_DB</name>
    </jndiConfig>
    <definition type="RDBMS">
        <configuration>
            <url>jdbc:mysql://localhost:3306/apim_db?useUnicode=true&characterEncoding=utf8mb4</url>
            <username>root</username>
            <password>root</password>
            <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
        </configuration>
    </definition>
</datasource>

• 重启APIM服务后重试导入

3. 验证并调整密钥特殊字符 #

• 检查consumerSecret中的特殊字符（如下划线、连字符），尝试替换为无特殊字符的测试值，验证是否能成功导入，确认是否为特殊字符导致的截断
• 若测试通过，可重新生成兼容的密钥或对特殊字符进行转义处理后再导入

4. 使用v4.2版本APICTL重新导出应用 #

• 如果原导入文件是从v4.1版本导出的，使用v4.2的apictl重新导出应用，确保导出的JSON格式符合v4.2的要求
• 导出命令示例：

apictl export app -n "Accounting API" -o CARCWSO2/apiuser -e wso2-carc-env -d "/root/wso2-apps-exported"

• 使用新导出的文件重新执行导入操作

内容的提问来源于stack exchange，提问作者Teodor Mysko