ValidateBackend - 验证后端连通性--智能体身份和权限管理平台-火山引擎

文档中心

立即注册

智能体身份和权限管理平台

权限网关

ValidateBackend - 验证后端连通性

验证后端连通性

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ValidateBackend	要执行的操作，取值：ValidateBackend。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
Backend	Object	是	example	后端服务配置

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
LatencyMs	Integer	50	延迟毫秒数 @example:50
Reachable	Boolean	true	后端是否可达 @example:true
ErrorMessage	String	"Connection refused"	错误信息（不可达时） @example:"Connection refused"

请求示例

POST
{
    "Backend": {
        "Protocol": "HTTPS",
        "EnableTls": true,
        "BackendPort": 443,
        "BackendDomain": "api.example.com",
        "TimeoutSeconds": 30
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ValidateBackend",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "LatencyMs": 50,
        "Reachable": true,
        "ErrorMessage": "\"Connection refused\""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Invalid request parameters: %s.	参数 %s 无效
404	NotFound	Resource not found: %s.	资源 %s 不存在
409	Duplicated	Resource already exists: %s.	资源 %s 已存在
409	StatusConflict	Status conflict: %s.	状态冲突: %s
422	ParseFailed	Failed to parse document: %s.	文档解析失败: %s
429	QuotaExceeded	Quota exceeded: %s.	配额 %s 已达上限
500	InternalError	Internal server error: %s.	内部服务错误: %s
501	NotImplemented	Not implemented: %s.	功能未实现: %s
502	UpstreamUnreachable	Upstream unreachable: %s.	后端服务 %s 不可达

最近更新时间：2025.12.14 13:43:21

这个页面对您有帮助吗？

有用

无用