华为云用户手册

响应示例 状态码： 200 Ok { "channels" : [ { "name" : "channel", "peers" : { "organization" : [ "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0", "peer-328000cb35d8971e0b0388f6182f95eaa4100784-1" ] }, "consensusNodes" : { "organization" : [ "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0" ] }, "consensus" : "etcdraft", "description" : "", "create_time" : "2020-10-15T10:24:51Z" } ] } 状态码： 400 Bad Request { "error_code" : " BCS .4006005", "error_msg" : "keyType error, keyType: blok not supported" } 状态码： 401 Unauthorized { "error_code" : "B CS .4010401", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" } 状态码： 500 InternalServerError { "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }

响应示例 状态码： 200 Ok { "enterprise_spec" : { "org_peer_max_num" : 5, "orderer_max_num" : 10, "member_max_num" : 50 } } 状态码： 400 Bad Request { "error_code" : "BCS.4006005", "error_msg" : "keyType error, keyType: blok not supported" } 状态码： 401 Unauthorized { "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" } 状态码： 500 InternalServerError { "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }

URI GET /v2/{project_id}/blockchains/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从 IAM 申请到的projectid，一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 取值范围(0,1000]，默认值为1000。用于限制本次返回的结果数据条数。 offset 否 Integer 分页查询起始位置，为非负整数。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 enterprise_spec InstanceSpc object 企业版联盟链规格 表5 InstanceSpc 参数 参数类型 描述 org_peer_max_num Long 单个组织支持的最大peer节点数量 orderer_max_num Long 单个联盟链支持的最大order节点数量 member_max_num Integer 单个联盟链支持的最大租户数量 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 Ok { "operation_id" : "B CSS VC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "BCS.4001245", "error_msg" : "The org name is invalid..." } 状态码： 401 Unauthorized { "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" } 状态码： 500 InternalServerError { "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 operation_id String 操作记录id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI PUT /v2/{project_id}/blockchains/{blockchain_id}/{channel_id}/peers/quit 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 blockchain_id 是 String 区块链 服务id。可调用“查询服务实例列表”接口获取ID channel_id 是 String 区块链通道名称。可调用“查询实例信息”接口获取，接口返回的“channels”中的name字段值

策略及授权项说明 如果您需要对您所拥有的华为云区块链引擎服务进行精细的权限管理，您可以使用 统一身份认证 服务（Identity and Access Management，简称IAM），如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用华为云区块链引擎服务的其它功能。 策略是以JSON格式描述权限集的语言。默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略，才能使用户组中的用户获得策略定义的权限，这一过程称为授权。授权后，用户就可以基于策略对云服务进行操作。 根据授权的精细程度，分为角色和策略。角色以服务为粒度，是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略以API接口为粒度进行权限拆分，授权更加精细，可以精确到某个操作、资源和条件，能够满足企业对权限最小化的安全管控要求。 华为云区块链引擎的策略说明请参考权限管理。 如果您需要允许或者禁止某个接口的操作权限，请使用策略。 支持的授权项 策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)： 自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 父主题： 权限策略说明

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，cn-north-4为项目名称，获取方法请参考终端节点。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参考获取用户Token。 非华为云账号 获取Token 请参考获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "cn-north-4" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

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

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如：HBS服务在“华北-北京四”区域的Endpoint为“bcs.cn-north-4.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应消息体 响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 1 2 3 4 5 6 7 8 9 10 11 12 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应示例 状态码： 200 Ok { "metrics" : [ { "metric" : { "namespace" : "abc", "metricName" : "def", "dimensions" : [ { "name" : "ghi", "value" : "lmn" } ] }, "dataPoints" : [ { "timestamp" : "1467892800000", "unit" : "Percent", "statistics" : [ { "statistic" : "maximum", "value" : "23" } ] } ] } ] } 状态码： 400 Bad Request { "error_code" : "BCS.4001108", "error_msg" : "metric names is wrong" } 状态码： 401 Unauthorized { "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" } 状态码： 500 InternalServerError { "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 metric_names 否 Array of strings 指标列表 取值范围 cpuUsage：CPU使用率 diskUsedRate：磁盘使用率 memUsedRate：物理内存使用率 sendBytesRate：上行Bps recvBytesRate：下行Bps cpuCoreLimit：CPU内核总量 cpuCoreUsed：CPU内核占用 totalMem：物理内存总量 freeMem：可用物理内存 diskCapacity：磁盘空间容量 diskAvailableCapacity：可用磁盘空间 默认值：前5项

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 metrics Array of MetricItemResultAPI objects 指标对象列表。 表5 MetricItemResultAPI 参数 参数类型 描述 metric MetricDemision object 指标描述信息 dataPoints Array of MetricDataPoints objects 监控数据信息 表6 MetricDemision 参数 参数类型 描述 namespace String 命名空间 metricName String 指标名称 dimensions Array of Dimension objects 维度列表 表7 Dimension 参数 参数类型 描述 name String 维度名称。 value String 维度取值。 表8 MetricDataPoints 参数 参数类型 描述 timestamp Long 时间戳。 unit String 指标单位。 statistics Array of StatisticValue objects 统计方式。 表9 StatisticValue 参数 参数类型 描述 statistic String 统计方式。 value Double 统计结果。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用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不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户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值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 notifications Array of NotificationList objects 通知列表 表4 NotificationList 参数 参数类型 描述 channel_name String 通道名称 status String 当前状态 updated_time String 更新时间 tc3_need Boolean 是否开启可信 invitor_info InvitorInfo object 邀请方信息 invitee_info InviteeInfo object 被邀请方信息 hide Long 是否删除 invitee_orgs Array of OrganizationV2 objects 被邀请的组织信息 read_status Long 阅读状态值 cross_version_upgrade String 跨版本进行升级 表5 InvitorInfo 参数 参数类型 描述 invitor_id String 邀请方用户id invitor_name String 邀请方用户名 invitor_bcs_id String 邀请方的服务实例id invitor_bcs_name String 邀请方的服务实例名 invitor_consensus String 邀请方的共识 invitor_project_id String 邀请方的projectID invitor_cluster_type String 邀请方的集群类型 invitor_database_type String 邀请方数据库类型 invitor_signature_algorithm String 邀请方的签名算法 invitor_fabric_version String 邀请方的fabric版本 order_fade_enabled Boolean 是否允许共识节点老化 order_fade_cache Long 共识节点的老化阈值 表6 InviteeInfo 参数 参数类型 描述 invitee_id String 被邀请用户id invitee_name Long 被邀请租户名称 invitee_bcs_name String 被邀请的服务实例名称 invitee_bcs_id String 被邀请的服务实例id invitee_project_id String 被邀请的项目id 表7 OrganizationV2 参数 参数类型 描述 name String 组织名称 name_hash String 组织hash node_count Integer 组织节点 status String 状态 status_detail String 状态描述 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 400 Bad Request { "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter quotasType : ecs" } 状态码： 401 Unauthorized { "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" } 状态码： 500 InternalServerError { "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.30010036 续费的资源非主资源，不允许续费。 400 CBC.30010069 不存在的续费周期。 400 CBC.30050006 订单自动支付失败。 400 CBC.99000092 订购周期校验失败。 400 CBC.99003100 当前操作的资源中，有资源包含在您的待支付的订单，不能进行当前操作。 400 CBC.99003016 资源已过期删除或不存在。 400 CBC.99003144 资源有处理中的订单，不能进行当前操作。 400 CBC.99003154 资源已购买时长加本次续费时长已超过最大值，请重新选择续费时长。 400 CBC.99003634 参与优惠套餐活动的资源需要整体续费，不能和其他资源一起续费。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

功能介绍 客户在伙伴销售平台完成包年/包月资源的续订。 客户的包年/包月资源即将到期时，可进行包年/包月资源的续订。 客户在费用中心执行续订操作请参见这里。 调用接口后，如果某个主资源有对应的从资源，系统会将主资源和从资源一起续订，主资源的从资源信息可以通过调用查询客户包年/包月资源列表接口获取。 注意：如ECS主机挂载新购的云硬盘，但此硬盘不是该ECS主资源的从资源，主从资源信息必须以调用查询客户包年/包月资源列表接口获取的信息为准。 本接口支持自动支付，支付时使用折扣或优惠券的说明，请参见支付使用折扣或优惠券说明。

包周期询价示例（通过价格计算器） 查询包年/包月产品价格接口的请求参数可通过价格计算器获取。 以“弹性云服务器”为例： 区域：华北-北京四 可用区：通用可用区 计费模式：包年包月 CPU架构：X86计算 规格 ：通用计算增强型 C6|2核|4GB 系统盘：通用型SSD 40G 购买时长：1个月 购买个数：1台 进入价格计算器页面，F12打开控制台。根据示例中的参数，在页面完成选择。 在控制台中进入Network选项，找到询价接口“resource”。点击“Payload”，查看接口请求参数。 根据步骤2获取到的请求参数拼接查询包年/包月产品价格接口请求参数。 如上图所示，查询包年/包月产品价格接口组合询价了一个弹性云服务器和一个云硬盘。所以产品信息列表product_infos需要两个结构体，最终结果如下所示： { "project_id": "84c5********fb2420", "product_infos": [ { "id": "1", "cloud_service_type": "hws.service.type.ec2", "resource_type": "hws.resource.type.vm", "resource_spec": "c6.large.2.linux", "region": "cn-north-4", "period_type": 2, "period_num": 1, "subscription_num": 1 }, { "id": "2", "cloud_service_type": "hws.service.type.ebs", "resource_type": "hws.resource.type.volume", "resource_spec": "GPSSD", "region": "cn-north-4", "resource_size": 40, "size_measure_id": 17, "period_type": 2, "period_num": 1, "subscription_num": 1 } ] } 【可选】登录APIExplorer，输入product_infos，询价得到的产品价格与价格计算器结果一致。 父主题： 询价接口指导

修订记录 表1 修订记录 文档版本 发布日期 修改说明 04 2024-04-11 第四次正式发布。 新增： 支持分子搜索。 支持自定义数据库。 修改： 分子优化。 靶点口袋发现。 靶点口袋分子设计。 自由能微扰。 分子属性预测。 合成路径规划。 03 2023-12-30 第三次正式发布。 新增： 支持小分子聚类。 支持卡片视图，同时查看多个小分子。 修改： 导入应用的数量限制。 分子属性上限。 分子对接计费规则。 02 2023-11-02 第二次正式发布。 新增 靶点口袋发现 靶点口袋分子设计 AI模型 修改 分子对接 分子优化 自由能微扰 分子属性预测 01 2023-08-10 第一次正式发布。 父主题： 用户指南（盘古辅助制药）

公共响应参数 公共响应参数如表 公共响应参数所示。 表1 公共响应参数 参数名 说明 Content-Length 响应消息体的字节长度，单位为Byte。 Date 系统响应的时间。 Content-type 发送的实体的MIME类型。 Upgrade 发送WebSocket握手请求时，响应消息包含该头域，内容为Websocket。 Connection 发送WebSocket握手请求时，响应消息包含该头域，内容为Upgrade。 Sec-WebSocket-Accept 结合Sec-WebSocket-Key提供基本的防护，比如恶意的连接，或者无意的连接。 父主题： 附录

示例 { "command": "START", "text": "欢迎使用语音云服务。", "config": { "audio_format": "pcm", "sample_rate": "8000", "property": "chinese_xiaoyan_common", "speed": 10, "pitch": 10, "volume": 60 } }

请求消息 表1 参数说明 名称 参数类型 是否必选 说明 command String 是 需设置为START，表示开始识别请求。 text String 是 待合成的文本，chinese_huaxiaomei_common,chinese_huaxiaofei_common,chinese_huaxiaolong_common,chinese_huaxiaorui_common发音人支持长度不大于10000字符的文本，其他发音人支持长度不大于500字符的文本。 config Object 否 配置信息。请参考表2。 表2 config数据结构 名称 参数类型 是否必选 说明 audio_format String 否 语音格式头：pcm、alaw、ulaw、mp3。 默认：pcm sample_rate String 否 采样率：16000、8000赫兹。 默认：8000 property String 否 可参考表3和表4。 默认：chinese_xiaoyan_common 实时 语音合成 和语音合成属于同一种资源，按次计费。实时语音合成普通发音人，每100字计一次。精品发音人每50字计一次。 speed Integer 否 语速。 取值范围：-500~500 默认值：0 pitch Integer 否 音高。 取值范围：-500~500 默认值：0 volume Integer 否 音量。 取值范围：0~100 默认值：50 subtitle String 否 是否生成时间戳信息，不使用则不填写。 取值范围： “word_level”：文本级别时间戳 “phoneme_level”：音素级别时间戳 注：chinese_huaxiaomei_common、chinese_huaxiaofei_common支持该功能，其他property暂不支持 表3 普通发音人property取值范围 名称 property取值 类型 使用场景 支持采样率（Hz） 支持audio_format 小琪 chinese_xiaoqi_common 标准女声 客服 8k/16k pcm、alaw、ulaw 小宇 chinese_xiaoyu_common 标准男声 电销 8k/16k pcm、alaw、ulaw 小燕 chinese_xiaoyan_common 温柔女声 文学 8k/16k pcm、alaw、ulaw 小王 chinese_xiaowang_common 童声 童声 8k/16k pcm、alaw、ulaw 表4 精品发音人property取值范围 名称 property取值 类型 使用场景 支持采样率（Hz） 支持audio_format 华小美 chinese_huaxiaomei_common 温柔女声 客服 8k/16k pcm、mp3 华小飞 chinese_huaxiaofei_common 朝气男声 客服 8k/16k pcm、mp3 华小汝 chinese_huaxiaoru_common 柔美女声 中英混合 8k/16k pcm 华小涵 chinese_huaxiaohan_common 知性女声 中英混合 8k/16k pcm 华小蕊 chinese_huaxiaorui_common 知性女声 中英混合 16k pcm、mp3 华小龙 chinese_huaxiaolong_common 朝气男声 中英混合 16k pcm、mp3 华小珍 chinese_huaxiaozhen_common 温柔女声 中英混合 8k/16k pcm alvin english_alvin_common 成熟男声 纯英文 8k/16k pcm amy english_amy_common 成熟女声 纯英文 8k/16k pcm

接口使用介绍 实时语音识别 接口使用Websocket协议承载，客户端与服务端交流流程如图1所示。 分为三个主要步骤： WebSocket握手。 基于WebSocket协议进行实时 语音识别 。 关闭WebSocket连接。 其中，基于WebSocket协议进行实时语音识别时，需要客户端首先发送转写开始消息，然后持续发送语音数据至服务端，最后发送结束消息，在此期间客户端会持续收到服务端发送的转写结果或事件，客户端根据所收到的响应消息做对应处理。实时语音识别接口的具体细节请参见接口说明章节。 图1 客户端与服务端交流流程

代码示例 import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; import okhttp3.WebSocket; import okhttp3.WebSocketListener; import okio.ByteString; /** * 此demo仅供测试使用，强烈建议使用SDK * 使用前需已配置okhttp、okio jar包。jar包可通过下载SDK获取。 */ public class SasrWebsocketDemo { public void sasrWebsocketDemo() { try { // endpoint和projectId需要替换成实际信息。 String url = "wss://{{endpoint}}/v1/{{project_id}}/asr/short-audio"; String token = "对应region的token"; byte[] data = null; // 存放将要发送音频的byte数组 OkHttpClient okHttpClient = new OkHttpClient(); Request request = new Request.Builder().url(url).header("X-Auth-Token", token).build(); WebSocket webSocket = okHttpClient.newWebSocket(request, new MyListener()); webSocket.send("{\"command\": \"START\", \"config\": {\"audio_format\": \"pcm8k16bit\", \"property\": \"chinese_8k_common\"}}"); webSocket.send(ByteString.of(data)); // audio太大注意要分片发送，否则会报错。建议分片大小3200 webSocket.send("{ \"command\": \"END\"}"); Thread.sleep(10000); webSocket.close(1000, null); } catch (Exception e) { e.printStackTrace(); } } class MyListener extends WebSocketListener { @Override public void onOpen(WebSocket webSocket, Response response) { System.out.println("conneected"); } @Override public void onClosed(WebSocket webSocket, int code, String reason) { System.out.println("closed"); } @Override public void onFailure(WebSocket webSocket, Throwable t, Response response) { t.printStackTrace(); } @Override public void onMessage(WebSocket webSocket, String text) { System.out.println(text); } } public static void main(String[] args) { SasrWebsocketDemo sasrWebsocketDemo = new SasrWebsocketDemo(); sasrWebsocketDemo.sasrWebsocketDemo(); } }

结束识别 功能介绍 对于识别中的对话，需要在Websocket上发送“结束识别”的请求来取消或结束识别。 "结束识别"请求使用文本类型的数据帧(text message)发送，命令和参数以json字符串的形式提供。 请求消息 表7 参数说明 参数名 是否必选 参数类型 说明 command 是 String 表示客户端结束识别请求，参数值设置为END。 示例 { "command": "END" } 状态码 状态码请参见状态码。 错误码 错误码请参见错误码。