文档

ImportServices - 创建网关服务

更新时间:

订阅导入网关的服务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ImportServices
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ServiceListarray<object>

服务列表。

DNS
object

数据结构。

Namestring

服务名。

test
Namespacestring

命名空间。

public
GroupNamestring

分组。

test
Ipsarray

IP 列表。

string

IP。

127.0.XX.XX
ServicePortlong

服务的端口。

8080
ServiceProtocolstring

服务的协议版本。

GRPC, HTTP
SourceTypestring

服务来源:

  • MSE(MSE-NACOS)
  • K8s(ACK 容器服务)
  • VIP(固定地址)
  • DNS(DNS 域名)
枚举值:
  • EDASEDAS
  • MSE_ZKMSE_ZK
  • SAESAE
  • K8SK8S
  • DNSDNS
  • VIPVIP
  • MSEMSE
DNS
GatewayUniqueIdstring

网关唯一标识 ID。

gw-77e1153db6e14c0a8b1fae20bcb89ca5
TlsSettingstring

TLS 设定。

  • TLS 模式:mode

  • 证书 ID:certId

  • CA 证书 ID:caCertId

  • CA 证书公钥:caCertContent

  • 服务名称标识:sni

{ "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "ceshi" }
FcServiceNamestring

FC 服务名称,服务来源为“FC 函数计算”时使用。

guide
FcVersionstring

FC 服务版本号,服务来源为“FC 函数计算”时使用。

LATEST
FcAliasstring

FC 服务别名,服务来源为“FC 函数计算”时使用。

test-alias
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

请求处理成功
Codeinteger

返回值。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Databoolean

返回结果。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": true
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-20OpenAPI 入参发生变更查看变更详情
2023-03-07OpenAPI 入参发生变更查看变更详情