华为云用户手册

  • 请求参数 表3 请求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。 最小长度:1 最大长度:100000
  • URI GET /v1/{project_id}/eds/instances/user-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 实例名称。 参数校验规则:只能包含英文字母、数字、下划线、中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 resource_spec_code 否 String EDS实例类型。 INSTANCE_FREE:免费版EDS实例 INSTANCE_BASIC:基础版EDS实例 INSTANCE_PROFESSIONAL:EDS实例专业版 枚举值: INSTANCE_FREE INSTANCE_BASIC INSTANCE_PROFESSIONAL belong_type 否 Array 归属类型。 OWNER:实例的所有者 GUEST:实例的参与者 枚举值: OWNER GUEST status 否 String EDS实例状态。 枚举值: CREATING CREATE_FAILED NORMAL FREEZE offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应示例 状态码: 200 successful operation 查询用户实例列表。 { "data" : [ { "id" : "b40b0d94-3201-4687-93aa-************", "name" : "连接器A", "description" : "连接器A", "resource_spec_code" : "instance.basic", "type" : "OPEN", "status" : "NORMAL", "initialization" : true, "charging_mode" : "PERIOD", "belong_type" : "OWNER", "enterprise_name" : "XXX公司", "administrator_user_id" : "6c4027c7536040619226f2**********" }, { "id" : "c1bf9bd7-52fc-435b-ae55-************", "name" : "连接器B", "description" : "连接器B", "resource_spec_code" : "instance.basic", "type" : "OPEN", "status" : "NORMAL", "initialization" : true, "charging_mode" : "PERIOD", "belong_type" : "OWNER", "enterprise_name" : "XXX公司", "administrator_user_id" : "6c4027c7536040619226f2**********" } ], "total" : 2, "error_code" : null, "error_msg" : null}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of InstanceApiInfo objects 实例信息。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 InstanceApiInfo 参数 参数类型 描述 id String EDS实例ID。 name String EDS实例名称。 description String EDS实例描述信息。 resource_spec_code String EDS资源规格编码。 枚举值: INSTANCE_FREE INSTANCE_BASIC INSTANCE_PROFESSIONAL CONNECTOR_FREE CONNECTOR_PRESENTATION CONNECTOR_BASIC STRUCTURED_STORAGE_BASIC UNSTRUCTURED_STORAGE_BASIC type String EDS实例类型。 枚举值: INTERNAL STAR_SHAPE OPEN status String EDS实例状态。 枚举值: CREATING CREATE_FAILED NORMAL FREEZE initialization Boolean EDS实例是否已初始化。 charging_mode String 计费模式。 枚举值: PERIOD ON_DEMAND FREE_MODE H CS belong_type String EDS实例所属类型:OWNER/GUEST。 枚举值: OWNER GUEST enterprise_name String 企业名称。 administrator_user_id String 管理员用户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 OK offer详情 { "data" : { "offer_id" : "321fd67b-ceba-4638-b54a-************", "offer_name" : "Offer20231121AD_EXCEL", "offer_type" : 2, "need_approval" : false, "can_terminate" : true, "ownered_company_name" : null, "ownered_company_id" : null, "ownered_connector_name" : "连接器A", "ownered_connector_id" : "b40b0d94-3201-4687-93aa-************", "offer_creator_name" : null, "offer_creator_id" : null, "offer_description" : "a", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 1, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : null }, "total" : 0, "error_code" : null, "error_msg" : null}
  • 请求参数 表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。 最小长度:1 最大长度:100000
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data OfferSummary object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 OfferSummary 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 offer_type Integer Offer公开范围:公开-1、受控-2。 need_approval Boolean 是否需要审批。 注:开启【需要审批】后,下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 ownered_company_name String Offer所属的企业,即所属租户名。 ownered_company_id String Offer所属的企业ID,即所属租户ID。 ownered_connector_name String Offer所属的连接器,即所属连接器名。 ownered_connector_id String Offer所属的连接器ID,即所属连接器id。 offer_creator_name String Offer创建者名称。 offer_creator_id String Offer创建者ID。 offer_description String Offer描述。 subscription_type String 订阅类型: OPEN_DATA:公开数据 CONTROLLED_DATA:受控数据 offer_followed_info OfferFollowed object Offer引用信息。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。 表5 OfferFollowed 参数 参数类型 描述 offer_subscription Boolean Offer订阅状态。 offer_favorite Boolean Offer收藏状态。 offer_subscription_num Integer Offer订阅次数。 offer_favorite_num Integer Offer收藏次数。 offer_view_num Integer Offer查看次数。 表6 MaskSensitive 参数 参数类型 描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 最大值:5000 reserve_tail_len Integer 尾端保留长度。 最大值:5000 表7 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤: VIEW:查看 MODIFY:加工 DOWNLOAD:下载 枚举值: VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 参数校验规则:最小值1,最大值10000。 where Where object 限制地点列表。 who Array of strings 限制用户/团队列表。(目前不支持多个用户或者团队) user_type String 限制用户类型。(团队订阅时who和user_type必填) USER :指定用户 TEAM :指定团队 枚举值: USER TEAM application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 表8 TimeInterval 参数 参数类型 描述 start_time String 起始时间,UTC时间格式。 end_time String 截止时间,UTC时间格式。 表9 Where 参数 参数类型 描述 device_ip Array of strings 限定访问IP。 device_mac Array of strings 限定访问设备MAC。 表10 DatabaseAttributes 参数 参数类型 描述 column String 可见列。 rows Array of RowDTO objects 可见行。 表11 RowDTO 参数 参数类型 描述 column_name String 参数名称,需要与condition、value配合生效。 condition String 参数条件,需要与column_name、value配合生效。 value String 参数条件值,需要与column_name、condition配合生效。 状态码: 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 GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers/{offer_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 offer_id 是 String Offer ID。 参数校验规则:最小长度1,最大长度100。
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于管理员创建IAM用户接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM和企业管理的区别。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of SubscriptionResponse objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 SubscriptionResponse 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 subscription_id String 订阅返回ID。 subscription_reason String 订阅理由。 status String 订阅状态: WAIT_TO_APPROVE:待审批 REJECTED:已驳回 PASSED:已通过 REVOKED:已撤销 枚举值: WAIT_TO_APPROVE REJECTED PASSED REVOKED create_time String 创建时间。 creator 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 错误描述。
  • 响应示例 状态码: 200 OK 订阅列表。 { "data" : [ { "offer_id" : "6168c382-5184-4ec8-8a04-************", "offer_name" : "offer-mysql-20231129AA", "subscription_id" : "90bedec2-2efc-41d4-8223-************", "subscription_reason" : "Subscribe by OpenApi.", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-01T17:53:03Z", "creator" : "************" }, { "offer_id" : "b74b4c6b-0c00-4a9d-86c3-************", "offer_name" : "offer-mysql-20231129AA", "subscription_id" : "7343b305-75f9-4979-ade0-************", "subscription_reason" : "Subscribe by OpenApi.", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-01T17:47:23Z", "creator" : "************" } ], "total" : 2, "error_code" : null, "error_msg" : null}
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 status 否 String 审批状态。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of Contract objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Contract 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 contract_description String 合约描述。 owner_connector_id String 提供者连接器ID。 owner_connector_name String 提供者连接器名称。 subscribe_connector_id String 订阅连接器ID。 subscribe_connector_name String 订阅连接器名称。 transactional_mode String 交换模式: PEER_TO_PEER: 点对点 SUBSCRIBE:订阅 枚举值: PEER_TO_PEER SUBSCRIBE status String 合约状态: APPROVING: 审批中 RUNNING:数据传输中 SUC CES S:成功 FAILED:失败 CLOSED:到期关闭 TERMINATED:已终止 REJECTED:审批驳回 枚举值: APPROVING RUNNING SUCCESS FAILED CLOSED TERMINATED REJECTED create_time 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}/contracts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 sub_flag 是 Integer 提供/收到的合约标志: 0:我提供的合约 1:我收到的合约 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 最小值:1 最大值:999 缺省值:10 transactional_mode 是 String 交换模式: PEER_TO_PEER: 点对点 SUBSCRIBE:订阅 枚举值: PEER_TO_PEER SUBSCRIBE name 否 String 合约名称。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 x-eds-proxy-userid 否 String 如果X-Auth-Token是租户ID,那么x-eds-proxy-userid填写实际被代理的真实用户ID。 最小长度:0 最大长度:100000
  • 响应示例 状态码: 200 OK 合约列表。 { "data" : [ { "contract_id" : "AGRTconnector-****94b22a8544ab486c8f45************", "contract_name" : "测试合约1", "contract_description" : "测试合约", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-10-12T18:11:07Z" }, { "contract_id" : "AGRTconnector-****e1c57b62b46b411380a0************", "contract_name" : "测试合约2", "contract_description" : "测试合约", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-10-12T16:20:20Z" } ], "total" : 2, "error_code" : null, "error_msg" : null}
  • 响应示例 状态码: 200 OK 操作结果。 { "data" : { "operation_id" : "90bedec2-2efc-41d4-8223-************", "result_code" : "SUCCESS", "result_description" : "Revoke subscription success." }, "total" : 0, "error_code" : null, "error_msg" : null}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data OperationResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 OperationResult 参数 参数类型 描述 operation_id String 操作资源ID。 result_code String 操作结果返回码: SUCCESS:操作成功 FAILED:操作失败 枚举值: 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 错误描述。
  • URI DELETE /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/{subscription_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 subscription_id 是 String 订阅ID。
  • 请求参数 表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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 审批操作结果返回码。 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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 是 String 订阅请求id。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 approval_reason 否 String 审批理由。 参数校验规则:最小长度1,最大长度200,以字母数字中文开头,只含有字母数字汉字下划线和符号-。 approval_result 是 Boolean 审批是否通过。 contract_name 是 String 生成合约名称。 can_terminate 否 Boolean 是否允许提供方提前终止合约。
  • URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。
  • 请求示例 审批请求体。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals{ "approval_result" : "true", "approval_reason" : "审批通过", "request_id" : "7343b305-75f9-4979-ade0-********", "contract_name" : "测试合约4"}
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,用户需要用到账号、用户和密码信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中的资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间的资源进行分组和管理,具有逻辑隔离能力。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为获取到的Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data ConnectorDetail object 连接器详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ConnectorDetail 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 connector_description String 连接器描述。 create_time String 连接器创建时间。 connector_status String 连接器当前状态。 枚举值: ACTIVE INACTIVE create_user_name String 连接器创建人名称。 create_user_id String 连接器创建人ID。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识。 状态码: 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 GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。
  • 响应示例 状态码: 200 OK 连接器详情。 { "data" : { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "connector_description" : "测试连接器", "create_time" : "2023-10-09T11:15:48Z", "connector_status" : "ACTIVE", "create_user_name" : "pa*******135", "create_user_id" : "0574************", "connector_owner_name" : "pa*******135", "connector_owner_Id" : "0574************", "protocol_signed" : true }, "total" : 0, "error_code" : null, "error_msg" : null}
共100000条