华为云用户手册

HTTP(S)推送消息的格式 HTTP(S)订阅终端订阅确认后，终端将收到 SMN 推送的消息，下面将描述HTTP Content信息，它是JSON串，具体字段说明如表3所示。 表3 HTTP(S)推送消息的格式参数说明 参数 说明 type 消息类型，Notification。 signature 签名信息。 签名字段包括message，message_id，subject， timestamp，topic_urn和type,具体签名信息校验，如果subject不存在，则不参与校验，请参见校验消息签名。 subject 消息标题。 topic_urn 主题的唯一标识，表示消息归属的主题。 message_id 消息唯一标识。 signature_version 签名的版本信息，目前是V1。 message 订阅推送消息的描述。 unsubscribe_url 通过访问该链接可以取消终端订阅。 signing_cert_url 用于消息签名的证书URL。 timestamp 消息第一次发送的时间戳。 HTTP(S)推送消息样例如下： { "signature": "WmSQ2/0kp2v2u2T33lMqKYrrLxnJoW2NHqIy5QowDuHH3y+HvhCNlCgHDUiAGpb3suCXJm16hWF+EJAYR+tPaTY1q0N3p0p+oBbhlD30fOTxRNsEWRAg73k4qArmQajhdDZOtd57xelQiNhzl2r6iCs0en4kR2iY78zZM/9caZQGBTlNcjkd2lyXYP6aSc7MOgxTsYrRus0A6yipD3zsUA7TvTdfsauAe2hZLR5W0l+um+S3ytT7sA1CMlIJPBXHP5WlqS4iMAeivmufZv7T+G43DbwWfw/seKnK6uFKWd214oqsY2/oLY3C4dcyLdvsy0/7/W8zvxXbgHeSL4******", "subject": "SMN", "topic_urn": "urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******", "message_id": "d84bd6629ef04513ad2e37bffd6e17cb", "signature_version": "v1", "type": "Notification", "message": "{\"enterpriseProjectId\": \"0\", \"eventTime\": \"2019-08-12 22:40:55.040632\", \"chargingMode\": \"postPaid\", \"cloudserviceType\": \"xxx.service.type.bandwidth\", \"eventType\": 1, \"regionId\": \"region01\", \"tenantId\": \"057eefe55400d2742f8cc00178******\", \"resourceType\": \"xxx.resource.type.bandwidth\", \"resourceSpecCode\": \"19_bgp\", \"resourceSize\": 10, \"resourceId\": \"e091f1b1-08ef-4e2b-a27e-f85e4c******\", \"resouceSizeMeasureId\": 15, \"resourceName\": \"elbauto_2019_08_13_06_40_46\"}", "unsubscribe_url": "https://console.******.com/smn/subscription/unsubscribe?region=region01®ion_id=region01&subscription_urn=urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******:23cf104593284665a1f98691b1******", "signing_cert_url": "https://smn.region01.******.com/smn/SMN_region01_3190c26a56fb435f9882e3435b******.pem", "timestamp": "2024-07-10T09:45:00Z"}

HTTP(S)订阅确认消息的格式 添加HTTP(S)订阅终端以后，SMN会向订阅终端推送一条订阅确认的消息，下面将描述消息的HTTP Content，它是JSON格式的字符串，其中包括subscribe_url值，订阅确认需要GET请求subscribe_url地址进行确认，具体JSON字段说明如表2所示。 表2 HTTP(S)订阅确认消息的格式参数说明 参数 说明 type 消息类型，SubscriptionConfirmation。 signature 签名信息。 签名字段包括message，message_id，subscribe_url，timestamp，topic_urn和type，具体签名信息校验，请参见校验消息签名。 topic_urn 主题的唯一标识，表示消息归属的主题。 message_id 消息唯一标识。 signature_version 签名的版本信息，目前是V1。 message 订阅确认消息的描述。 subscribe_url 订阅确认需要访问的URL。 signing_cert_url 用于消息签名的证书URL，不需要鉴权，可直接访问。 timestamp 消息第一次发送的时间戳。 HTTP(S)订阅确认消息样例如下： { "subscribe_url": "https://console.******.com/smn/subscription/confirm?token=0a419ac94f80f2c62f14c01e34ae5dfcf6b0b92ef46241218eaae5b4cb90d5d423cf104593284665a1f98691b1576976785114fb4408450e8de153b9f1******&topic_urn=urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******®ion=region01®ion_id=region01", "signature": "W/DQSiqpRkY6En0jNaFtCYOpmUjMhzoJIdMPLhnRv37iPzNhH+SxlievFoUIyS29z7Ig4hL/ECWNfGrRhTqoasiAeOaXOjoRNoQ73YfyqWm7x7OdX+2c202zxaOS5GcsUHohxAS+wCYd6W6aVhx6eQpWzpzLwrGgE+iPmsd5I00HXIBeZEeBx/VuoqkPyBDnSvGNNDTJ2gw+fL7XuKqf/DUUjjI8dkPsp3gAcETe/XMgf3UTMFDvLLrq2fAZVhr/jMR/9m81PwuDs1k9i3iBxT67afzmQ1AhY/a/ayQX7Fmwf/FBpehG1o8e98lXAZFS2nzhvTpttawUFG8Z82******", "topic_urn": "urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******", "message_id": "54bb04eddfc842e9b44ca36393f77cd3", "signature_version": "v1", "type": "SubscriptionConfirmation", "message": "You are invited to subscribe to topic: urn:smn:regionid:0a419ac94f80f2c62f14c01e34******:test_******. To confirm this subscription, please visit the subscribe_url included in this message. The subscribe_url is valid only within 48 hours.", "signing_cert_url": "https://smn.region01.******.com/smn/SMN_region01_3190c26a56fb435f9882e3435b******.pem", "timestamp": "2024-07-10T09:43:44Z"}

操作场景 接收SMN服务发送的HTTP(S)消息时，终端证书的CN名称请参考业界规范，部分特殊字符可能导致https消息发送失败。 在互联网上传递未加密的http协议消息内容存在信息泄漏风险，推荐用户终端添加订阅时对接通道优先使用https类型。 描述SMN服务向HTTP(S)终端发送消息的格式，您可以通过消息头部信息中的消息类型来区分消息格式。消息格式包括：HTTP(S)订阅确认消息的格式、HTTP(S)推送消息的格式和HTTP(S)取消订阅消息的格式三种消息格式，HTTP/HTTPS协议均为POST方式。 当SMN服务向HTTP(S)终端发送消息时，头部包括请求X-SMN-MESSAGE-TYPE，X-SMN-MESSAGE-ID，X-SMN-TOPIC-URN，如表1所示。 表1 消息HTTP(S)头部参数说明 参数 说明 X-SMN-MESSAGE-TYPE 消息类型，消息类型分别有： SubscriptionConfirmation Notification UnsubscribeConfirmation X-SMN-MESSAGE-ID 消息唯一标识。 X-SMN-TOPIC-URN 主题的唯一标识，表示消息归属的主题。 关于HTTP(S)头部字段的说明： RFC 7230 章节3.2中规定，HTTP(S)头部的字段名称不区分大小写。 RFC 7540 章节8.1.2中规定，对于支持HTTP/2的服务端，头部字段信息需要统一改为全小写。 对于用户自定义的HTTP(S)头部字段，SMN也将采用上述的处理策略。 用户如果从HTTP(S)头部中获取相关字段，建议采用不区分大小写的方式。

操作场景 消息模板指消息的固定格式，发布消息时可以使用已创建的消息模板向订阅者发送消息。使用模板发送消息，发送时会自动替换模板变量为对应的参数值。 消息模板通过消息名称进行分组，消息名称下面可以根据不同的协议创建不同的模板。每个模板名称下面都必须要创建一个Default模板。当按照模板格式推送消息时，不同协议订阅者优先会选择模板名称下面对应的协议模板，如果对应的协议模板不存在，则采用默认Default的模板。如果没有预置的Default协议的模板，将不允许发送该模板。 当您需要发送模板格式的消息时，可参考本章节管理消息模板。

SMN自定义策略样例 示例1：授权用户创建主题 { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "smn:topic:create" ] } ]} 示例2：拒绝用户删除主题 拒绝策略需要同时配合其他策略使用，否则没有实际作用。用户被授予的策略中，一个授权项的作用如果同时存在Allow和Deny，则遵循Deny优先原则。 如果您给用户授予SMN FullAccess的系统策略，但不希望用户拥有SMN FullAccess中定义的删除主题权限，您可以创建一条拒绝删除主题的自定义策略，然后同时将SMN FullAccess和拒绝策略授予用户，根据Deny优先原则，则用户可以对SMN执行除了删除主题外的所有操作。拒绝策略示例如下： { "Version": "1.1", "Statement": [ { "Effect": "Deny", "Action": [ "smn:topic:delete" ] } ]} 示例3：多个授权项策略 一个自定义策略中可以包含多个授权项，且除了可以包含本服务的授权项外，还可以包含其他服务的授权项，可以包含的其他服务必须跟本服务同属性，即都是项目级服务或都是全局级服务。多个授权语句策略描述如下： { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "smn:topic:create", "smn:tag:create", "smn:application:create" ] }, { "Effect": "Allow", "Action": [ "elb:certificates:create", "elb:whitelists:create", "elb:pools:create", "elb:members:create", "elb:healthmonitors:create", "elb:l7policies:create", "elb:listeners:create", "elb:loadbalancers:create" ] } ]}

操作场景 SMN的终端节点订阅主题且确认订阅后，终端节点才能够接收到向该主题发布的所有消息。当用户在多个区域均需要创建同样的订阅时，终端节点会多次收到确认订阅信息，且需要在每一条订阅消息内确认订阅。为防止这种场景下对终端节点的消息干扰，建议使用订阅用户功能，一次创建用户后即可导入其他区域的订阅。 订阅用户是提供跨区域统一管理订阅者信息的功能。订阅者可以先创建多个订阅用户，当主题需要添加订阅时，再将订阅用户批量添加到该主题上。 当前订阅用户数据仅支持存储在国内，且仅支持国内站点查询订阅用户数据。 当订阅者需要创建订阅用户时，可参考本章节。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offer_name 否 String offer名称。 offer_status 否 String offer状态（默认返回已上架offer）： APPROVING： 审批中 APPROVE_REJECTED：审批拒绝 ON_BOARDING：上架中 ON_BOARD：已上架 ON_BOARD_FAILED：上架失败 OFF_BOARDING：下架中 OFF_BOARD：已下架 OFF_BOARD_FAILED：下架失败 枚举值： APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of Offer objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Offer 参数 参数类型 描述 offer_id String Offer ID。 offer_code String offer编码。 offer_name String offer名称。 offer_description String offer描述。 create_time String offer创建时间。 offer_status String offer状态： APPROVING： 审批中 APPROVE_REJECTED：审批拒绝 ON_BOARDING：上架中 ON_BOARD：已上架 ON_BOARD_FAILED：上架失败 OFF_BOARDING：下架中 OFF_BOARD：已下架 OFF_BOARD_FAILED：下架失败 枚举值： APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK Offer列表 { "data" : [ { "offer_id" : "e49cc59d-48a7-46b2-bfea-************", "offer_code" : "Fconnector-****88ad1de6fc124c519e56************", "offer_name" : "offer1", "offer_description" : "", "create_time" : "2023-12-01T15:06:48Z", "offer_status" : "ON_BOARD" }, { "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_code" : "Fconnector-****1fc857ef325a4a458042************", "offer_name" : "offer2", "offer_description" : "", "create_time" : "2023-11-29T10:19:53Z", "offer_status" : "ON_BOARD" } ], "total" : 2, "error_code" : null, "error_msg" : null}

请求示例 新增应用。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications{ "type" : "UNSTRUCTURED", "name" : "OBS-APP-TEST", "temp_id" : "335ac118-758e-4324-9d41-************", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "description" : "test", "connection" : { "datasource_type" : "OBS", "connection" : { "obs_connection" : { "endpoint" : "obs.************.huawei.com", "bucket_name" : "obs-***", "access_key" : "QA**************", "secret_key" : "8X**************", "path" : "obs-test/folder1" } } }}

响应示例 状态码： 200 OK 新增应用返回体。 { "data" : { "type" : "UNSTRUCTURED", "name" : "OBS-APP-TEST", "id" : "22c59dd8-12ef-4ead-94ff-************", "temp_id" : "335ac118-758e-4324-9d41-************", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-12-05T18:27:52Z" }, "total" : 1, "error_code" : null, "error_msg" : null}

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用 IAM 服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 应用模板类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name 是 String 应用名称。 temp_id 是 String 应用模板ID。 description 否 String 应用描述。 icon 否 String 应用图标。 connection 是 DataSourceConnect object 数据源连接信息。 表4 DataSourceConnect 参数 是否必选 参数类型 描述 datasource_type 否 String 数据源类型。 枚举值： OBS connection 否 DataSourceConnection object 数据源连接信息。 表5 DataSourceConnection 参数 是否必选 参数类型 描述 obs_connection 否 ObsConnection object OBS数据源连接信息。 表6 ObsConnection 参数 是否必选 参数类型 描述 endpoint 否 String OBS访问地址。 参数校验规则：最小长度1，最大长度1000，匹配 域名 正则表达式。 bucket_name 否 String OBS名称。 参数校验规则：最小长度1，最大长度100，匹配字母、数字、下划线、.及-。 access_key 否 String OBS永久访问密钥。 参数校验规则：最大长度1024。 secret_key 否 String OBS永久密钥。 参数校验规则：最大长度1024。 path 否 String OBS访问路径。 参数校验规则：最小长度1，最大长度100，只能包含英文字母、数字、下划线、中文、/、\及-。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 data AppInfo object 新增应用返回体。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表8 AppInfo 参数 参数类型 描述 type String 实例化的应用类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name String 应用名称。 id String 应用ID。 temp_id String 应用模板ID。 temp_name String 应用模板名称。 natives Boolean 是否内置应用 true：内置 false：自创 operation Array of strings 应用操作。 枚举值： VIEW PRO CES S DOWNLOAD description String 应用描述。 icon String 应用图标。 connection DataSourceConnect object 应用连接信息。 create_user_id String 创建人ID。 create_user_name String 创建人名称。 create_date String 创建时间。 表9 DataSourceConnect 参数 参数类型 描述 datasource_type String 数据源类型。 枚举值： OBS connection DataSourceConnection object 数据源连接信息。 表10 DataSourceConnection 参数 参数类型 描述 obs_connection ObsConnection object OBS数据源连接信息。 表11 ObsConnection 参数 参数类型 描述 endpoint String OBS访问地址。 参数校验规则：最小长度1，最大长度1000，匹配域名正则表达式。 bucket_name String OBS名称。 参数校验规则：最小长度1，最大长度100，匹配字母、数字、下划线、.及-。 access_key String OBS永久访问密钥。 参数校验规则：最大长度1024。 secret_key String OBS永久密钥。 参数校验规则：最大长度1024。 path String OBS访问路径。 参数校验规则：最小长度1，最大长度100，只能包含英文字母、数字、下划线、中文、/、\及-。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI PUT /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

请求示例 归档接收的合约数据。 PUT https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources{ "data_packet_ids" : [ "44d2f35e-0371-433f-b5b6-************" ], "new_folder_id" : "ROOT"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 x-eds-proxy-userid 否 String 如果X-Auth-Token是租户ID，那么x-eds-proxy-userid填写实际被代理的真实用户ID。 最小长度：0 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 data_packet_ids 是 Array of strings 数据包ID。 当前只允许同时归档一条数据。 new_folder_id 是 String 新的目录ID。

响应示例 状态码： 200 OK 归档返回结果。 { "data" : [ { "data_packet_id" : "44d2f35e-0371-433f-b5b6-************", "data_resource_ids" : [ "323daf49-15ee-4ad2-b6f0-************" ] } ], "total" : 1, "error_code" : null, "error_msg" : null}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of DataPackageResourceResponse objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 DataPackageResourceResponse 参数 参数类型 描述 data_packet_id String 数据包ID。 data_resource_ids Array of strings 资源ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/transfer 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 连接器列表。 { "data" : [ { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A", "create_user_name" : "pa*******135", "create_user_id" : "0574************", "connector_owner_name" : "pa*******135", "connector_owner_Id" : "0574************", "protocol_signed" : true }, { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "create_user_name" : "pa*******135", "create_user_id" : "0574************", "connector_owner_name" : "pa*******135", "connector_owner_Id" : "0574************", "protocol_signed" : true } ], "total" : 2, "error_code" : null, "error_msg" : null}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ConnectorInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ConnectorInfo 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 create_user_name String 连接器创建人名称。 create_user_id String 连接器创建人ID。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of TeamInfo objects 团队详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 TeamInfo 参数 参数类型 描述 team_id String 团队ID。 team_name String 团队名称。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/teams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 team_name 否 String 团队名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EDS.00011001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00011003 Get user information error 获取用户信息错误。 检查参数中的用户信息是否正确。 400 EDS.00011011 Convert time format error 转换时间格式错误。 检查日期格式是否正确。 400 EDS.00011012 Unknown server error 未知错误。 联系客服寻求帮助。 400 EDS.00011015 The user does not have the operation permission 用户无权执行此操作。 检查用户是否有操作API或者资源的权限。 400 EDS.00011016 Resource status error 资源状态异常。 检查要查询/操作的资源状态是否正常。 400 EDS.00011018 Failed to delete 删除失败。 检查资源是否存在；检查是否有权限删除资源。 400 EDS.00021006 This resource is frozen 此资源已冻结。 检查资源状态。 400 EDS.00021604 Domain already exists in the instance 客租户已加入当前空间。 检查操作租户是否已存在。 400 EDS.00021606 Domain not joined to this instance 域未加入此实例。 检查域ID和空间实例ID是否正确。 400 EDS.00021614 The EDS instance does not support transfer EDS实例不支持转让。 联系客服寻求帮助。 400 EDS.00021615 The EDS connector transfer failed EDS连接器转让失败。 联系客服寻求帮助。 400 EDS.00021619 Domain is in use 租户正在使用中。 租户正在使用中。 400 EDS.00021905 Connector does not exist 连接器不存在。 检查空间实例ID和连接器ID是否正确。 400 EDS.00021911 Connector does not belong to this user 连接器不属于此用户。 检查空间实例ID和连接器ID是否正确。 400 EDS.00021915 No permission to retrieve this connector 没有取回连接器的权限。 确认用户是否是连接器拥有者。 400 EDS.00021916 The EDS connector retrieve failed 取回连接器失败。 确认是否已签署协议；确认是否有权限做取回操作。 400 EDS.00031001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00031002 User does not have permission 用户无权限。 检查用户是否有操作API或者资源的权限。 400 EDS.00031601 The eds instance does not exist 实例不存在。 检查实例ID是否正确。 400 EDS.00031603 User does not join eds instance 用户未加入实例。 确认用户是否加入实例。 400 EDS.00032201 Get iam users failed 获取IAM用户失败。 联系客服寻求帮助。 400 EDS.00032202 User does not owner of the connector 用户不是连接器所有者。 检查用户是否有操作API或者资源的权限。 400 EDS.00032203 Query user failed 查询用户信息失败。 联系客服寻求帮助。 403 EDS.00012301 Domain does not allow to access OpenAPI 租户不允许访问OpenAPI。 联系客服申请访问OpenAPI。 403 EDS.00021602 Current user is not manager of instance 当前用户不是实例的管理员。 确认接口是否只有实例管理员可调用。 403 EDS.00021620 Deletion of the domain is forbidden 禁止删除该租户。 禁止删除实例主租户。 403 EDS.00031602 Instance does not belong domain 实例不属于租户。 检查用户所属租户是否是实例所属者。 404 EDS.00011017 This resource does not exist 此资源不存在。 检查资源是否存在。 406 EDS.00010001 Not Acceptable 服务异常，不可接受。 联系客服寻求帮助。 406 EDS.00011019 The operation occur exception 执行操作时发生异常。 联系客服寻求帮助。 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data UserInfo object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 UserInfo 参数 参数类型 描述 user_name String IAM用户名。 user_id String IAM用户ID。 result_code String 用户操作结果返回码。 枚举值： SUCCESS FAILED result_description String 用户操作结果描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 用户操作结果。 { "data" : { "user_name" : "test_user", "user_id" : "f528b3337a724e0b9d7************", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null}

URI DELETE /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 user_id 是 String 用户ID。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。