RESTful API-华为云

客户运营能力-构造请求:请求消息头

请求消息头可选的附加请求头字段，如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表3。表3 公共请求消息头名称描述是否必选示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。否使用AK/SK认证时该字段必选。 bss.myhuaweicloud.com or bss.myhuaweicloud.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。是 application/json Content-Length 请求body长度，单位为Byte。否 3495 X-Auth-Token 用户Token。获取Token，请参考Token认证。否使用Token认证时该字段必选。注：以下仅为Token示例片段MIIPAgYJKoZIhvcNAQcCoIIO8zCCDu8CAQExDTALBglghkgBZQMEAgEwgg1QBgkqhkiG9w0BBwGggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。对于创建客户接口，添加消息头后的请求如下所示。 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

客户运营能力 RESTful API

客户运营能力-构造请求:请求消息体（可选）

请求消息体（可选）该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于创建客户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，请求参数的取值需要根据实际情况填写。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "domain_name": "test", "mobile_phone": "189xxxxxxxx", "verification_code": "253xxx", "xaccount_id": "35reyxxxx", "xaccount_type": "xxx_IDP", "password": "xxxxxxx", "is_close_market_ms": "true", "cooperation_type": "1", "indirect_partner_id": "a0d736359ada40aab6502d1a828c1809" } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

客户运营能力 RESTful API

客户运营能力-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。表2 HTTP方法方法说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在创建客户的URI部分，您可以看到其请求方法为“POST”，则其请求URI为： 1 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers

客户运营能力 RESTful API

客户运营能力-构造请求:请求URI

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以我们在此单独拿出来强调。表1 URI中的参数说明参数描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP。客户运营能力API的Endpoint为“bss.myhuaweicloud.com”。说明：该Endpoint为全局Endpoint，中国站所有区域均可使用。支持TLS 1.2。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“创建客户”API的resource-path为“/v2/partners/sub-customers”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。例如您需要获取创建客户的请求URI，则需找到创建客户的resource-path（/v2/partners/sub-customers），拼接起来如下所示。 https://bss.myhuaweicloud.com/v2/partners/sub-customers 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

客户运营能力 RESTful API

合作伙伴中心-构造请求:请求消息头

请求消息头可选的附加请求头字段，如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表3。表3 公共请求消息头名称描述是否必选示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。否使用AK/SK认证时该字段必选。 bss.myhuaweicloud.com or bss.myhuaweicloud.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。是 application/json Content-Length 请求body长度，单位为Byte。否 3495 X-Auth-Token 用户Token。获取Token，请参考Token认证。否使用Token认证时该字段必选。注：以下仅为Token示例片段MIIPAgYJKoZIhvcNAQcCoIIO8zCCDu8CAQExDTALBglghkgBZQMEAgEwgg1QBgkqhkiG9w0BBwGggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。对于创建客户接口，添加消息头后的请求如下所示。 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

合作伙伴中心 RESTful API

合作伙伴中心-构造请求:请求消息体（可选）

请求消息体（可选）该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于创建客户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，请求参数的取值需要根据实际情况填写。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "domain_name": "test", "mobile_phone": "189xxxxxxxx", "verification_code": "253xxx", "xaccount_id": "35reyxxxx", "xaccount_type": "xxx_IDP", "password": "xxxxxxx", "is_close_market_ms": "true", "cooperation_type": "1", "indirect_partner_id": "a0d736359ada40aab6502d1a828c1809" } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

合作伙伴中心 RESTful API

合作伙伴中心-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。表2 HTTP方法方法说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在创建客户的URI部分，您可以看到其请求方法为“POST”，则其请求URI为： 1 POST https://bss.myhuaweicloud.com/v2/partners/sub-customers

合作伙伴中心 RESTful API

合作伙伴中心-构造请求:请求URI

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以我们在此单独拿出来强调。表1 URI中的参数说明参数描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP。合作伙伴运营能力API的Endpoint为“bss.myhuaweicloud.com”。说明：该Endpoint为全局Endpoint，中国站所有区域均可使用。支持TLS 1.2。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“创建客户”API的resource-path为“/v2/partners/sub-customers”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。例如您需要获取创建客户的请求URI，则需找到创建客户的resource-path（/v2/partners/sub-customers），拼接起来如下所示。 https://bss.myhuaweicloud.com/v2/partners/sub-customers 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

合作伙伴中心 RESTful API

合作伙伴中心-认证鉴权:AK/SK认证

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

合作伙伴中心 RESTful API

合作伙伴中心-认证鉴权:Token认证

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。具体Token有效期说明请参见获取用户Token。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。在构造请求中以调用获取用户Token接口为例说明了如何调用API。获取伙伴或客户Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 Content-Type: application/jsonX-Auth-Token: ABCDEFJ.... 获取伙伴Token请参见获取用户Token。获取客户Token请参见通过assume_role方式获取用户token。

合作伙伴中心 RESTful API

应用与数据集成平台 ROMA Connect-生产消息接口说明:响应消息

响应消息响应参数参数类型说明 state String 结果状态。成功为success，失败为fail。 id String 消息序号。响应示例 [ { "state": "success", "id": "1" }, { "state": "success", "id": "2" }, { "state": "success", "id": "3" }]

应用与数据集成平台 ROMA Connect MQS连接开发（RESTful API）

应用与数据集成平台 ROMA Connect-生产消息接口说明:请求消息

请求消息请求参数参数类型必选说明 messages Array 是消息列表，数组大小不能超过10，且不能为空数组。表2 messages参数参数类型必选说明 content Object 是消息内容。 id String 是消息序号，序列号不能重复。请求示例 { "messages": [ { "content": "hello roma-1", "id": "1" }, { "content": "hello roma-2", "id": "2" }, { "content": "hello roma-3", "id": "3" } ]}

应用与数据集成平台 ROMA Connect MQS连接开发（RESTful API）

智能制造-操作流程

操作流程获取MQS连接信息，具体请参考开发准备。若ROMA Connect实例的消息集成在开启SASL_SSL的同时，也开启了VPC内网明文访问，则VPC内无法使用SASL方式连接消息集成的Topic。使用SASL方式连接消息集成的Topic时，建议在客户端所在主机的“/etc/hosts”文件中配置host和IP的映射关系，否则会引入时延。其中，IP地址必须为消息集成的连接地址，host为每个实例主机的名称，可以自定义，但不能重复。例如： 10.10.10.11 host01 10.10.10.12 host02 10.10.10.13 host03 参考示例代码，组装API请求，包括对API请求的签名。对API请求签名，指使用SASL的用户名与密码作为密钥对，将请求URL、消息头时间戳等内容进行签名，供后端服务进行校验。点此了解签名流程。使用Demo向指定Topic生产消息、消费消息和确认消息时，返回的响应消息结构请参考生产消息接口说明、消费消息接口说明和消费确认接口说明。父主题： Restful API连接

智能制造 Restful API连接

云服务器内容精选

RESTful API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线