UpdateService - 更新服务--智能体身份和权限管理平台-火山引擎

文档中心

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

权限网关

UpdateService - 更新服务

更新服务

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateService	要执行的操作，取值：UpdateService。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
ServiceName	String	是	my-vikingdb-service	服务名称 @example:my-vikingdb-service
Description	String	否	"更新后的服务描述"	服务描述 @example:"更新后的服务描述"
Status	String	否	Active	服务状态：Active, Inactive @example:Active

返回参数

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

参数	类型	示例值	描述
Trn	String	trn:id:cn-beijing:1234567890:gatewayservice/svc-12345	TRN @example:trn:id:cn-beijing:1234567890:gatewayservice/svc-12345
Tags	Array of Object	[{Key: "app", Value: "test"}]	标签列表 @example:[{Key: "app", Value: "test"}]
Status	String	ACTIVE	服务状态 @example:ACTIVE
Backend	Object	example	后端服务配置
CreatedAt	Long	1701504000000	创建时间（Unix时间戳毫秒） @example:1701504000000
ServiceId	String	svc-1234567890	服务ID @example:svc-1234567890
UpdatedAt	Long	1701504000000	更新时间（Unix时间戳毫秒） @example:1701504000000
RouteCount	Integer	5	路由数量 @example:5
TemplateId	String	tpl_vikingdb_001	内置服务关联的模板ID @example:tpl_vikingdb_001
BackendType	String	viking	后端服务类型：custom, viking, agentkit-mcp @example:viking
Description	String	"用于VikingDB向量搜索的权限网关"	服务描述 @example:"用于VikingDB向量搜索的权限网关"
ProjectName	String	my-project	项目名称 @example:my-project
ServiceName	String	my-vikingdb-service	服务名称，在账号下唯一 @example:my-vikingdb-service
PermissionSpaceId	String	ps_123456	权限空间ID @example:ps_123456
HijackDomainPublic	String	api.example.com	公网域名 @example:api.example.com
HijackDomainPrivate	String	api.example.com	内网域名 @example:api.example.com
PermissionSpaceName	String	"我的权限空间"	权限空间名称 @example:"我的权限空间"

请求示例

POST
{
    "ServiceName": "my-vikingdb-service",
    "Description": "\"更新后的服务描述\"",
    "Status": "Active"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateService",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Status": null,
        "Backend": {
            "Protocol": "HTTPS",
            "EnableTls": true,
            "BackendPort": 443,
            "BackendDomain": "api.example.com",
            "TimeoutSeconds": 30
        },
        "CreatedAt": 1701504000000,
        "ServiceId": "svc-1234567890",
        "UpdatedAt": 1701504000000,
        "RouteCount": 5,
        "TemplateId": "tpl_vikingdb_001",
        "BackendType": null,
        "Description": "\"用于VikingDB向量搜索的权限网关\"",
        "ServiceName": "my-vikingdb-service",
        "PermissionSpaceId": "ps_123456",
        "HijackDomainPublic": "api.example.com",
        "HijackDomainPrivate": "api.example.com",
        "PermissionSpaceName": "\"我的权限空间\""
    }
}

错误码

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

状态码	错误码	错误信息	说明
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

这个页面对您有帮助吗？

有用

无用

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

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码