文档首页/ 应用服务网格 ASM/ API参考/ API/ 网格接口/ 创建网格

更新时间：2025-08-29 GMT+08:00

查看PDF

创建网格

功能介绍

该API用于创建一个网格。

URI

POST /v1/{project_id}/meshes

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式）。取值范围： application/json;charset=utf-8：指定内容为JSON格式，并以UTF8字符编码进行编码 application/json：指定内容为JSON格式
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

表3 请求Body参数
参数	是否必选	参数类型	描述
apiVersion	是	String	API版本，固定值“v1”，该值不可修改
kind	是	String	API类型，固定值“Mesh”或“mesh”，该值不可修改
metadata	是	表4 object	网格的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性
spec	是	表5 object	集合类的元素类型，您对需要管理的网格进行详细描述的主体部分都在spec中给出。ASM通过spec的描述来创建或更新网格对象

表4 MeshMetadata
参数	是否必选	参数类型	描述
name	是	String	网格名称。命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-64位，且不能以中划线(-)结尾

表5 MeshSpec
参数	是否必选	参数类型	描述
type	是	String	网格类型。取值范围： InCluster: 集群内控制平面形态，基础版网格取值为InCluster。目前仅支持该类型。
version	是	String	网格版本
extendParams	是	表6 object	服务网格扩展信息
ipv6Enable	否	Boolean	网格是否支持IPV6
config	否	表12 object	网格配置。

表6 MeshExtendParams
参数	是否必选	参数类型	描述
clusters	是	Array of 表7 objects	网格内集群信息

表7 MeshCluster
参数	是否必选	参数类型	描述
clusterID	是	String	集群ID，资源唯一标识，通过该ID查询需要添加的集群
injection	否	表8 object	sidecar注入配置
installation	是	表9 object	网格组件安装配置

表8 InjectionConfig
参数	是否必选	参数类型	描述
namespaces	否	表10 object	需要注入的命名空间

表9 InstallationConfig
参数	是否必选	参数类型	描述
nodes	是	表10 object	安装网格组件的节点

**表10** Selector
参数	是否必选	参数类型	描述
fieldSelector	是	表11 object	字段选择器

**表11** FieldSelector
参数	是否必选	参数类型	描述
key	是	String	Key值
operator	是	String	操作符，仅支持取值"In"
values	是	Array of strings	Value值

**表12** MeshConfig
参数	是否必选	参数类型	描述
proxyConfig	否	表13 object	网格数据面配置
telemetryConfig	否	表14 object	网格的可观测性配置

**表13** ProxyConfig
参数	是否必选	参数类型	描述
includeIPRanges	否	String	拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段
excludeIPRanges	否	String	排除拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段
excludeOutboundPorts	否	String	排除拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表
excludeInboundPorts	否	String	排除拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表
includeOutboundPorts	否	String	拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表
includeInboundPorts	否	String	拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表

**表14** TelemetryConfig
参数	是否必选	参数类型	描述
metrics	否	表15 object	应用指标配置，用于上报ASM网格指标数据。如果要启用该配置，集群需安装云原生监控插件。
accessLogging	否	表17 object	AccessLog配置，用于上报ASM网格内Istio代理的访问日志。如果要启用该配置，集群需安装云原生日志采集插件。
tracing	否	表19 object	Tracing配置，用于上报ASM网格内的调用链数据。

**表15** Metric
参数	是否必选	参数类型	描述
aom	否	Array of 表16 objects	AOM实例配置。

**表16** Aom
参数	是否必选	参数类型	描述
instanceID	是	String	AOM实例ID。

**表17** AccessLogging
参数	是否必选	参数类型	描述
lts	否	Array of 表18 objects	LTS配置

**表18** LtsConfig
参数	是否必选	参数类型	描述
logGroupID	否	String	AccessLog日志组ID
logStreamID	否	String	AccessLog输出日志流ID

**表19** Tracing
参数	是否必选	参数类型	描述
randomSamplingPercentage	否	Float	tracing采样率
defaultProviders	否	Array of strings	tracing默认上报的provider名称，必须与extensionProviders中的name字段匹配，或使用ASM预设的provider "apm-otel"。如果使用"apm-otel"，需确认当前region已支持APM2.0且网格版本大于1.18。
extensionProviders	否	Array of 表20 objects	用户自配置provider，目前支持zipkin。如果用户配置zipkin的provider，请保证网格版本大于等于1.15。

**表20** TracingExtensionProvider
参数	是否必选	参数类型	描述
name	否	String	provider实例name
zipkin	否	表21 object	zipkin provider自有配置

**表21** ZipkinTracingProvider
参数	是否必选	参数类型	描述
service	否	String	zipkin服务地址
port	否	Integer	zipkin服务端口

响应参数

状态码： 201

**表22** 响应Body参数
参数	参数类型	描述
apiVersion	String	API版本，固定值“v1”，该值不可修改
kind	String	API类型，固定值“Mesh”或“mesh”，该值不可修改
metadata	表23 object	网格的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性
spec	表24 object	集合类的元素类型，您对需要管理的网格进行详细描述的主体部分都在spec中给出。ASM通过spec的描述来创建或更新网格对象
status	表37 object	集合类的元素类型，用于记录网格在系统中的当前状态信息。该参数为系统自动生成，不需要用户填写

**表23** MeshMetadata
参数	参数类型	描述
name	String	网格名称。命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-64位，且不能以中划线(-)结尾
uid	String	网格ID，资源唯一标识，创建成功后自动生成，填写无效
creationTimestamp	String	网格创建时间

**表24** MeshSpec
参数	参数类型	描述
type	String	网格类型。取值范围： InCluster: 集群内控制平面形态，基础版网格取值为InCluster。目前仅支持该类型。
version	String	网格版本
extendParams	表25 object	服务网格扩展信息
ipv6Enable	Boolean	网格是否支持IPV6
config	表27 object	网格配置。

**表25** MeshExtendParams
参数	参数类型	描述
clusters	Array of 表26 objects	网格内集群信息，仅基础版使用

**表26** MeshCluster
参数	参数类型	描述
clusterID	String	集群ID，资源唯一标识，通过该ID查询需要添加的集群

**表27** MeshConfig
参数	参数类型	描述
proxyConfig	表28 object	网格数据面配置
telemetryConfig	表29 object	网格的可观测性配置

**表28** ProxyConfig
参数	参数类型	描述
includeIPRanges	String	拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段
excludeIPRanges	String	排除拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段
excludeOutboundPorts	String	排除拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表
excludeInboundPorts	String	排除拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表
includeOutboundPorts	String	拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表
includeInboundPorts	String	拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表

**表29** TelemetryConfig
参数	参数类型	描述
metrics	表30 object	应用指标配置，用于上报ASM网格指标数据。如果要启用该配置，集群需安装云原生监控插件。
accessLogging	表32 object	AccessLog配置，用于上报ASM网格内Istio代理的访问日志。如果要启用该配置，集群需安装云原生日志采集插件。
tracing	表34 object	Tracing配置，用于上报ASM网格内的调用链数据。

**表30** Metric
参数	参数类型	描述
aom	Array of 表31 objects	AOM实例配置。

**表31** Aom
参数	参数类型	描述
instanceID	String	AOM实例ID。

**表32** AccessLogging
参数	参数类型	描述
lts	Array of 表33 objects	LTS配置

**表33** LtsConfig
参数	参数类型	描述
logGroupID	String	AccessLog日志组ID
logStreamID	String	AccessLog输出日志流ID

**表34** Tracing
参数	参数类型	描述
randomSamplingPercentage	Float	tracing采样率
defaultProviders	Array of strings	tracing默认上报的provider名称，必须与extensionProviders中的name字段匹配，或使用ASM预设的provider "apm-otel"。如果使用"apm-otel"，需确认当前region已支持APM2.0且网格版本大于1.18。
extensionProviders	Array of 表35 objects	用户自配置provider，目前支持zipkin。如果用户配置zipkin的provider，请保证网格版本大于等于1.15。

**表35** TracingExtensionProvider
参数	参数类型	描述
name	String	provider实例name
zipkin	表36 object	zipkin provider自有配置

**表36** ZipkinTracingProvider
参数	参数类型	描述
service	String	zipkin服务地址
port	Integer	zipkin服务端口

**表37** MeshStatus
参数	参数类型	描述
phase	String	网格状态，取值如下 Running：运行中，表示网格处于正常运行状态 Creating：创建中，表示网格正处于创建过程中 CreateFailed：创建失败 Deleting：删除中，表示网格正处于删除过程中 DeleteFailed：删除失败 Upgrading：升级中，表示网格正处于升级过程中 UpgradeFailed：升级失败 RollingBack：回滚中，表示网格正处于回滚过程中 RollbackFailed：回滚失败
updateTimestamp	String	网格更新时间

状态码： 400

**表38** 响应Body参数
参数	参数类型	描述
errorCode	String	错误码最小长度：8 最大长度：36
errorMsg	String	错误描述最小长度：2 最大长度：512

状态码： 409

**表39** 响应Body参数
参数	参数类型	描述
errorCode	String	错误码最小长度：8 最大长度：36
errorMsg	String	错误描述最小长度：2 最大长度：512

状态码： 500

**表40** 响应Body参数
参数	参数类型	描述
errorCode	String	错误码最小长度：8 最大长度：36
errorMsg	String	错误描述最小长度：2 最大长度：512

请求示例

创建网格

POST /v1/719217bc273743xxxxxxxxae8bc34480/meshes 
 
{ 
  "apiVersion" : "v1", 
  "kind" : "Mesh", 
  "metadata" : { 
    "name" : "mesh-test-api" 
  }, 
  "spec" : { 
    "type" : "InCluster", 
    "version" : "1.18.7-r5", 
    "extendParams" : { 
      "clusters" : [ { 
        "clusterID" : "cb0ef541-xxxx-xxxx-xxxx-0255ac1001b7", 
        "installation" : { 
          "nodes" : { 
            "fieldSelector" : { 
              "key" : "UID", 
              "operator" : "In", 
              "values" : [ "1c531b0c-xxxx-xxxx-xxxx-0255ac100b08" ] 
            } 
          } 
        }, 
        "injection" : { 
          "namespaces" : { 
            "fieldSelector" : { 
              "key" : "Name", 
              "operator" : "In", 
              "values" : [ "default" ] 
            } 
          } 
        } 
      } ] 
    }, 
    "config" : { 
      "proxyConfig" : { 
        "includeIPRanges" : "10.247.0.0/16" 
      }, 
      "telemetryConfig" : { 
        "metrics" : { 
          "aom" : [ { 
            "instanceID" : "602a5b7e-xxxx-xxxx-xxxx-4268c35b0424" 
          } ] 
        }, 
        "accessLogging" : { 
          "lts" : [ { 
            "logGroupID" : "b884eaeb-xxxx-xxxx-xxxx-f442de73c392", 
            "logStreamID" : "362e11e8-xxxx-xxxx-xxxx-0afdc68da7d2" 
          } ] 
        }, 
        "tracing" : { 
          "randomSamplingPercentage" : 1, 
          "defaultProviders" : [ "zipkin" ], 
          "extensionProviders" : [ { 
            "name" : "zipkin", 
            "zipkin" : { 
              "service" : "zipkin.monitoring.svc.cluster.local", 
              "port" : 9411 
            } 
          } ] 
        } 
      } 
    } 
  } 
}

响应示例

状态码： 201

表示创建网格任务下发成功，开始创建网格

{ 
  "kind" : "Mesh", 
  "apiVersion" : "v1", 
  "metadata" : { 
    "name" : "mesh-test-api", 
    "uid" : "a1efdc3e-xxxx-xxxx-xxxx-94bef433347e", 
    "creationTimestamp" : "2025-04-10T07:48:37Z" 
  }, 
  "spec" : { 
    "type" : "InCluster", 
    "version" : "1.18.7-r5", 
    "config" : { 
      "telemetryConfig" : { 
        "metrics" : { 
          "aom" : [ { 
            "instanceID" : "602a5b7e-xxxx-xxxx-xxxx-4268c35b0424" 
          } ] 
        }, 
        "accessLogging" : { 
          "lts" : [ { 
            "logGroupID" : "b884eaeb-xxxx-xxxx-xxxx-f442de73c392", 
            "logStreamID" : "362e11e8-xxxx-xxxx-xxxx-0afdc68da7d2" 
          } ] 
        }, 
        "tracing" : { 
          "randomSamplingPercentage" : 1, 
          "defaultProviders" : [ "zipkin" ], 
          "extensionProviders" : [ { 
            "name" : "zipkin", 
            "zipkin" : { 
              "service" : "zipkin.monitoring.svc.cluster.local", 
              "port" : 9411 
            } 
          } ] 
        } 
      }, 
      "proxyConfig" : { 
        "includeIPRanges" : "10.247.0.0/16" 
      } 
    }, 
    "extendParams" : { 
      "clusters" : [ { 
        "clusterID" : "cb0ef541-xxxx-xxxx-xxxx-0255ac1001b7" 
      } ] 
    } 
  }, 
  "status" : { 
    "phase" : "Creating" 
  } 
}

状态码

状态码	描述
201	表示创建网格任务下发成功，开始创建网格
400	用户提供的网格创建参数有问题，未通过校验
409	需要创建的网格与现有网格冲突
500	创建过程中出现问题

错误码

请参见错误码。

父主题： 网格接口

上一篇：网格接口

下一篇：删除网格

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

创建网格

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？