订阅导入网关的服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mse:ImportServices | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServiceList | array<object> | 否 | 服务列表。 | DNS |
object | 否 | 数据结构。 | ||
Name | string | 否 | 服务名。 | test |
Namespace | string | 否 | 命名空间。 | public |
GroupName | string | 否 | 分组。 | test |
Ips | array | 否 | IP 列表。 | |
string | 否 | IP。 | 127.0.XX.XX | |
ServicePort | long | 否 | 服务的端口。 | 8080 |
ServiceProtocol | string | 否 | 服务的协议版本。 | GRPC, HTTP |
SourceType | string | 是 | 服务来源:
枚举值:
| DNS |
GatewayUniqueId | string | 是 | 网关唯一标识 ID。 | gw-77e1153db6e14c0a8b1fae20bcb89ca5 |
TlsSetting | string | 否 | TLS 设定。
| { "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "ceshi" } |
FcServiceName | string | 否 | FC 服务名称,服务来源为“FC 函数计算”时使用。 | guide |
FcVersion | string | 否 | FC 服务版本号,服务来源为“FC 函数计算”时使用。 | LATEST |
FcAlias | string | 否 | FC 服务别名,服务来源为“FC 函数计算”时使用。 | test-alias |
AcceptLanguage | string | 否 | 返回信息的语言类型:
| zh |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9",
"HttpStatusCode": 200,
"Message": "请求处理成功",
"Code": 200,
"Success": true,
"Data": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalRequest | Invalid request:%s | 非法请求: %s |
400 | InvalidParameter | Parameter error:%s | 请求参数错误:%s |
403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s |
404 | NotFound | Not found:%s | 资源不存在:%s |
500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-09-20 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-07 | OpenAPI 入参发生变更 | 查看变更详情 |