文档

AddServiceSource - 创建服务来源

更新时间:

创建Nacos服务来源。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Typestring

服务注册类型,按来源类型填写对应的值:

  • 容器服务:K8S
  • MSE Nacos:NACOS
  • MSE ZooKeeper:ZOOKEEPER
  • SAE 注册中心:NACOS
  • EDAS 注册中心:NACOS
NACOS
Sourcestring

服务来源类型:

  • 容器服务:K8S
  • MSE Nacos:MSE
  • MSE ZooKeeper:MSE_ZK
  • SAE 注册中心:SAE
  • EDAS 注册中心:EDAS
MSE
Addressstring

访问地址(必填):

  • 容器服务:对应容器服务集群 ID
  • MSE Nacos:实例内网访问地址
  • MSE ZooKeeper:实例内网访问地址
  • SAE 注册中心:命名空间 TID
  • EDAS 注册中心:微服务空间 Namespace
mse-********-nacos-ans.mse.aliyuncs.com:8848
Namestring

名称。

说明 不同来源类型描述。
  • 类型为 K8s 时入参为名称。
  • 类型为 NACOS 时入参为实例 ID。
nacos
GatewayUniqueIdstring

网关唯一 ID。

gw-c70622ff52fe49beb29bea9a6f52****
IngressOptionsRequestobject

Ingress 配置(服务来源类型为 K8S 时使用)。

EnableIngressboolean

是否开启 Ingress。

true
IngressClassstring

监听 Ingress Class。

com.test.xxx
WatchNamespacestring

监听目标命名空间。

default
EnableStatusboolean

是否更新 Ingress Status。

true
ToAuthorizeSecurityGroupsobject []

待授权安全组列表,用于在创建来源时打通后端服务的安全组限制

SecurityGroupIdstring

安全组 ID。

sg-bp1acepclex0vmi1****
PortRangestring

安全组的授权端口范围,可多选,使用,分隔。

8080/8080,9000/10000
Descriptionstring

授权记录描述。

rule for xxx
GroupListarray

服务分组列表。

string

服务分组。

NACOS
PathListarray

服务根路径数组。

string

服务根路径。

/test
AcceptLanguagestring

支持的语言。包括以下取值:

  • 中文:zh-CN(默认值)。
  • 英文:en-US。
  • 日文:ja。
zh-CN

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7
Codeinteger

返回值。

200
Successboolean

请求结果,取值如下:

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

返回数据。

63

示例

正常返回示例

JSON格式

{
  "RequestId": "D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7",
  "Code": 200,
  "Success": true,
  "Data": 63
}

错误码

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-12-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ToAuthorizeSecurityGroups
2022-08-09OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:GroupList
  • 本页导读 (1)
文档反馈