在云效中调用云效api日志返回500,日志在哪能查?
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
在云效中调用API时,如果返回了500错误,通常表示服务器端发生了内部错误。为了排查问题,您可以通过以下方式查找相关日志信息:
云效提供了操作日志功能,您可以查看用户在组织中的行为记录,包括API调用的相关信息: - 路径:进入企业管理 > 操作日志。 - 筛选条件: - 日期范围:选择调用API的时间段。 - 操作分类:选择“API”相关的操作分类。 - 操作者:输入调用API的用户账号。 - 操作类型:搜索与API调用相关的具体操作。 - 导出日志:如果需要进一步分析,可以单击页面右上角的导出日志按钮,根据筛选条件导出日志文件。
注意:
- 导出后需等待5分钟才能进行下一次导出。 - 单次导出时间范围不得超过一年。
审计日志记录了更详细的API调用信息,包括操作时间、IP地址、操作内容等: - 请求语法:使用GET
请求查询组织审计日志。
GET /organization/{organizationId}/audit/logs
organizationId
:企业标识。actionTimeRange
:指定操作时间范围。userIdList
:指定操作者的用户ID列表。appIdList
:指定应用ID列表。action
:操作名称(如login
或api_call
)。actionTime
:操作时间。detail
:操作内容详情。ip
:调用API的IP地址。user
:操作者信息。示例返回:
[
{
"action": "api_call",
"actionTime": "2023-08-31T03:59:16.201Z",
"detail": "调用失败,返回500错误",
"ip": "192.*.*.1",
"user": {
"id": "99d1****6124",
"name": "示例名"
}
}
]
如果API调用涉及流水线任务或机器部署,可以通过以下接口获取更具体的日志信息: - 任务运行日志: - 请求语法: GET /organization/{organizationId}/pipeline/{pipelineId}/pipelineRun/{pipelineRunId}/job/{jobId}/logs
- 返回参数: - content
:日志内容。 - more
:是否还有更多日志。 - 机器部署日志: - 请求语法: GET /organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/log
- 返回参数: - deployLog
:部署日志内容。 - deployBeginTime
和 deployEndTime
:部署开始和结束时间。
如果API调用失败可能与权限相关,请确保您的个人访问令牌(x-yunxiao-token
)符合以下要求: - 最小授权原则:仅授予完成特定任务所需的最低权限。 - 有效时间设定:合理设置令牌的有效时间。 - 避免明文传输:切勿通过未加密的渠道分享令牌。
如果通过上述方法仍无法定位问题,建议联系阿里云技术支持团队,提供以下信息以便快速排查: - 请求ID:每次API调用返回的requestId
。 - 调用时间:精确到秒的时间戳。 - 调用参数:包括organizationId
、pipelineId
等关键参数。
重要提醒:
- 导出日志限制:每个组织的操作日志每自然周最多导出3次,请合理规划导出频率。
- 日志更新延迟:管理后台的操作日志更新时间为1小时,请耐心等待最新记录同步。
通过以上步骤,您可以逐步定位并解决API调用返回500错误的问题。
云效,企业级一站式研发协同平台,数十万企业都在用。支持公共云、专有云和混合云多种部署形态,通过云原生新技术和研发新模式,助力创新创业和数字化转型企业快速实现研发敏捷和组织敏捷,打造“双敏”组织,实现多倍效能提升。