文档首页/ 应用服务网格 ASM/ API参考/ API/ 服务接口/ 一键修复网格服务 - FormatServices
更新时间:2026-02-02 GMT+08:00
分享

一键修复网格服务 - FormatServices

功能介绍

该API用于一键修复网格服务。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    asm:mesh:updateService

    Write

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

POST /v2/meshes/{mesh_id}/namespaces/{namespace}/services/format

表1 路径参数

参数

是否必选

参数类型

描述

mesh_id

String

网格ID。

namespace

String

命名空间。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。

Content-Type

String

消息体的类型(格式)。

取值范围:

  • application/json;charset=utf-8:指定内容为JSON格式,并以UTF8字符编码进行编码

  • application/json:指定内容为JSON格式

表3 请求Body参数

参数

是否必选

参数类型

描述

validations

Array of ServiceValidation objects

网格服务校验结果列表

表4 ServiceValidation

参数

是否必选

参数类型

描述

serviceName

String

服务名称

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

formattings

Array of ServiceFormatting objects

网格服务修复结果列表

表6 ServiceFormatting

参数

参数类型

描述

serviceName

String

网格服务名

servicePorts

Array of ServicePort objects

网格服务端口

result

String

网格服务修复结果

errMsg

String

网格服务修复失败信息

items

Array of FormattingItem objects

网格服务修复结果

表7 ServicePort

参数

参数类型

描述

port

String

服务端口

protocol

String

服务协议

sniHosts

Array of strings

服务sni hosts

表8 FormattingItem

参数

参数类型

描述

name

String

修复项名称

result

String

修复项结果

errMsg

String

修复错误原因

状态码:500

表9 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMsg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

网格服务修复成功,返回修复成结果

500

内部错误

错误码

请参见错误码

相关文档