云服务器内容精选

  • 响应参数 返回状态码为200:正常响应返回体。 表3 NaasNetworkDeleteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 成功删除模板。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 失败删除模板。 - 表4 NaasNetworkDeleteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 naasNetworkId string 0~64个字符。 - 模板ID。 "00000000-0000-0000-0000-000000000000" naasNetworkName string 0~64个字符。 - 服务链名称。 "Template1" errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:正常响应返回体。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "errcode" : "0", "errmsg" : "" } ], "fail" : [ { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "errcode" : "0", "errmsg" : "" } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/sdwan/v1/naas/template/batch-delete HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "naasNetworkIds" : [ "00000000-0000-0000-0000-000000000000" ] }
  • 响应示例 返回状态码为201:创建成功返回。 HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "naasNetworkId" : "" } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/sdwan/v1/naas/template HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "naasNetworkPlatformType" : "", "networkInfrastructure" : { "subnet" : [ { "subnetName" : "subnet", "subnetId" : "00000000-0000-0000-0000-000000000000", "networkId" : "00000000-0000-0000-0000-000000000000", "portGroup" : "PortGroup-vmware", "segment" : "127.1.0.0/16", "reservedIps" : "127.1.1.1;127.1.1.2", "portGroupFc" : "PortGroup-fc" } ] }, "networkResources" : { "resources" : [ { "hostUnitType" : "director", "number" : 24 } ] }, "networkFunctions" : { "networkFunction" : [ { "interfaces" : [ { "nfiName" : "GE0/0/1", "subnetName" : "subnet" } ] } ] }, "initialLoadBalanceNumber" : "", "bandwidthRedundancy" : "", "nodeMaxDeviceNumber" : "" }
  • 响应参数 返回状态码为201:创建成功返回。 表10 NaasNetworkUpdateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" naasNetworkId string - - 创建的ID。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 naasNetwork 是 REFERENCE 详细请参见表2。 NaasNetwork信息。 - 表2 NaasNetworkInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 naasNetworkId 否 string 0~64个字符。 - 模板ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" naasNetworkName 是 string 1~32个字符。 - 服务链名称。 "Template1" naasNetworkPlatformType 否 int32 [1-3] 1 虚机平台类型,1:openstack, 2:vmware,3:FusionCompute。 - networkInfrastructure 否 REFERENCE 详细请参见表3。 服务功能。 - networkResources 否 REFERENCE 详细请参见表5。 资源。 - networkFunctions 否 REFERENCE 详细请参见表7。 服务功能。 - initialLoadBalanceNumber 否 int32 [1-8] 3 部署1个子设备的forwarder个数。 - bandwidthRedundancy 否 int32 [0-300] 50 带宽冗余度。 - nodeMaxDeviceNumber 否 int32 [1-1000] 512 每个forwarder部署的子设备最大数量。 - 表3 NetworkInfrastructure对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 subnet 否 ARRAY_REFERENCE 1-16个列表项,详细请参见表4。 地址池。 - 表4 NetworkInfrastructureSubnet对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 subnetName 是 string 1~127个字符。 - 子网名称。 "subnet" subnetId 否 string 1~127个字符。 - 子网UUID。 "00000000-0000-0000-0000-000000000000" networkId 否 string 1~127个字符。 - 网络UUID。 "00000000-0000-0000-0000-000000000000" portGroup 否 string 1~127个字符。 - 端口组名字,针对VMWare平台。 "PortGroup-vmware" segment 否 string 1~128个字符。 - 子网CIDR。 "127.1.0.0/16" reservedIps 否 string 0~1024个字符。 - 子网。 "127.1.1.1;127.1.1.2" portGroupFc 否 string 1~127个字符。 - 端口组名字,针对FusionCompute平台。 "PortGroup-fc" 表5 NetworkResources对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 resources 否 ARRAY_REFERENCE 2个列表项,详细请参见表6。 服务链资源组。 - 表6 NetworkResource对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 hostUnitType 是 string 1~32个字符。 - 取值为director或者forwarder,且director与forwarder必须同时填写。 "director" number 是 int32 [1-150] - 资源数量。 24 表7 NetworkFunctions对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 networkFunction 否 ARRAY_REFERENCE 1个列表项,详细请参见表8。 服务组。 - 表8 NetworkFunction对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaces 是 ARRAY_REFERENCE 1-16个列表项,详细请参见表9。 服务接口组。 - 表9 NetworkFunctionInterface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nfiName 是 string 1~64个字符。 - 服务名称。 "GE0/0/1" subnetName 是 string 1~127个字符。 - 子网名称 "subnet"
  • 响应示例 返回状态码为200:查询成功返回。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "naasNetworkPlatformType" : "", "networkInfrastructure" : { "subnet" : [ { "subnetName" : "subnet", "subnetId" : "00000000-0000-0000-0000-000000000000", "networkId" : "00000000-0000-0000-0000-000000000000", "portGroup" : "PortGroup-vmware", "segment" : "127.1.0.0/16", "reservedIps" : "127.1.1.1;127.1.1.2", "portGroupFc" : "PortGroup-fc" } ] }, "networkResources" : { "resources" : [ { "hostUnitType" : "director", "number" : 24 } ] }, "networkFunctions" : { "networkFunction" : [ { "interfaces" : [ { "nfiName" : "GE0/0/1", "subnetName" : "subnet" } ] } ] }, "initialLoadBalanceNumber" : "", "bandwidthRedundancy" : "", "nodeMaxDeviceNumber" : "" } } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:查询成功返回。 表2 NaasNetworkResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 NaasNetwork返回体。 - 表3 NaasNetworkInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 naasNetworkId string 0~64个字符。 - 模板ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" naasNetworkName string 1~32个字符。 - 服务链名称。 "Template1" naasNetworkPlatformType int32 [1-3] 1 虚机平台类型,1:openstack, 2:vmware,3:FusionCompute。 - networkInfrastructure REFERENCE 详细请参见表4。 服务功能。 - networkResources REFERENCE 详细请参见表6。 资源。 - networkFunctions REFERENCE 详细请参见表8。 服务功能。 - initialLoadBalanceNumber int32 [1-8] 3 部署1个子设备的forwarder个数。 - bandwidthRedundancy int32 [0-300] 50 带宽冗余度。 - nodeMaxDeviceNumber int32 [1-1000] 512 每个forwarder部署的子设备最大数量。 - 表4 NetworkInfrastructure对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 subnet ARRAY_REFERENCE 1-16个列表项,详细请参见表5。 地址池。 - 表5 NetworkInfrastructureSubnet对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 subnetName string 1~127个字符。 - 子网名称。 "subnet" subnetId string 1~127个字符。 - 子网UUID。 "00000000-0000-0000-0000-000000000000" networkId string 1~127个字符。 - 网络UUID。 "00000000-0000-0000-0000-000000000000" portGroup string 1~127个字符。 - 端口组名字,针对VMWare平台。 "PortGroup-vmware" segment string 1~128个字符。 - 子网CIDR。 "127.1.0.0/16" reservedIps string 0~1024个字符。 - 子网。 "127.1.1.1;127.1.1.2" portGroupFc string 1~127个字符。 - 端口组名字,针对FusionCompute平台。 "PortGroup-fc" 表6 NetworkResources对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 resources ARRAY_REFERENCE 2个列表项,详细请参见表7。 服务链资源组。 - 表7 NetworkResource对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 hostUnitType string 1~32个字符。 - 取值为director或者forwarder,且director与forwarder必须同时填写。 "director" number int32 [1-150] - 资源数量。 24 表8 NetworkFunctions对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 networkFunction ARRAY_REFERENCE 1个列表项,详细请参见表9。 服务组。 - 表9 NetworkFunction对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaces ARRAY_REFERENCE 1-16个列表项,详细请参见表10。 服务接口组。 - 表10 NetworkFunctionInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nfiName string 1~64个字符。 - 服务名称。 "GE0/0/1" subnetName string 1~127个字符。 - 子网名称 "subnet" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/sdwan/v1/naas/template?naasNetworkId=00000000-0000-0000-0000-000000000000 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应示例 返回状态码为200:查询成功返回。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "pageIndex" : "1", "pageSize" : "10", "totalRecords" : "2", "data" : [ { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "useStatus" : true, "networkResources" : { "resources" : [ { "hostUnitType" : "director", "number" : 24 } ] } } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 GET /controller/sdwan/v1/naas/template/all?naasNetworkName=Template1&pageIndex=1&pageSize=10 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询成功返回。 表2 NaasNetworkAllResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 [1-100] - 分页索引。 "1" pageSize int32 [1-100] - 分页大小。 "10" totalRecords int32 [0-32] - 总数。 "2" data ARRAY_REFERENCE 0-32个列表项,详细请参见表3。 NaasNetwork列表。 - 表3 NaasNetworkAllInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 naasNetworkId string 0~64个字符。 - 模板ID。 "00000000-0000-0000-0000-000000000000" naasNetworkName string 0~64个字符。 - 服务链名称。 "Template1" useStatus boolean true false - 模板是否正在被使用。 true networkResources REFERENCE 详细请参见表6。 资源。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • URI /controller/sdwan/v1/naas/template/all 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 naasNetworkName 否 string 0~32个字符。 - NaasNetwork名称。 "Template1" pageIndex 否 int32 [1-100] - 页面索引,不填时默认为1。 "1" pageSize 否 int32 [1-100] - 页面大小,不填时默认为10。 "10"
  • 响应示例 返回状态码为200:更新成功返回。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "naasNetworkId" : "" } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive