summaryrefslogtreecommitdiff
path: root/data/zh_cn/ltl
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/ltl
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/ltl')
-rw-r--r--data/zh_cn/ltl/2019-05-10/api-docs.php8019
1 files changed, 2150 insertions, 5869 deletions
diff --git a/data/zh_cn/ltl/2019-05-10/api-docs.php b/data/zh_cn/ltl/2019-05-10/api-docs.php
index 22312d5..8af387b 100644
--- a/data/zh_cn/ltl/2019-05-10/api-docs.php
+++ b/data/zh_cn/ltl/2019-05-10/api-docs.php
@@ -1,204 +1,79 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'ltl',
- 'version' => '2019-05-10',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'ltl', 'version' => '2019-05-10'],
'directories' => [
[
- 'id' => 65761,
- 'title' => '使用方',
+ 'children' => ['CreateMember', 'LockMember', 'ModifyMember', 'UnLockMember', 'ListMember'],
'type' => 'directory',
- 'children' => [
- 'CreateMember',
- 'LockMember',
- 'ModifyMember',
- 'UnLockMember',
- 'ListMember',
- ],
+ 'title' => '使用方',
+ 'id' => 307442,
],
[
- 'id' => 65767,
- 'title' => '设备',
+ 'children' => ['RegisterDeviceGroup', 'AuthorizeDevice', 'AuthorizeDeviceGroup', 'UnAuthorizeDevice', 'UnAuthorizeDeviceGroup', 'ListDevice', 'ListDeviceGroup'],
'type' => 'directory',
- 'children' => [
- 'RegisterDeviceGroup',
- 'AuthorizeDevice',
- 'AuthorizeDeviceGroup',
- 'UnAuthorizeDevice',
- 'UnAuthorizeDeviceGroup',
- 'ListDevice',
- 'ListDeviceGroup',
- ],
+ 'title' => '设备',
+ 'id' => 307448,
],
[
- 'id' => 65775,
- 'title' => 'MPCos',
+ 'children' => ['CreateMPCoSPhase', 'CreateMPCoSPhaseGroup', 'ModifyMPCoSPhase', 'ModifyMPCoSPhaseGroup', 'UpdateMPCoSAuthorizedInfo', 'DescribeMPCoSAuthorizedInfo', 'DescribeMPCoSPhaseInfo', 'DescribeMPCoSResourceInfo', 'ListMPCoSPhase', 'ListMPCoSPhaseGroup', 'ListMPCoSPhaseHistory'],
'type' => 'directory',
- 'children' => [
- 'CreateMPCoSPhase',
- 'CreateMPCoSPhaseGroup',
- 'ModifyMPCoSPhase',
- 'ModifyMPCoSPhaseGroup',
- 'UpdateMPCoSAuthorizedInfo',
- 'DescribeMPCoSAuthorizedInfo',
- 'DescribeMPCoSPhaseInfo',
- 'DescribeMPCoSResourceInfo',
- 'ListMPCoSPhase',
- 'ListMPCoSPhaseGroup',
- 'ListMPCoSPhaseHistory',
- ],
+ 'title' => 'MPCos',
+ 'id' => 307456,
],
[
- 'id' => 65787,
- 'title' => '配置',
+ 'children' => ['ApplyDataModelConfigInfo'],
'type' => 'directory',
- 'children' => [
- 'ApplyDataModelConfigInfo',
- ],
+ 'title' => '配置',
+ 'id' => 307468,
],
[
- 'id' => 65789,
- 'title' => '上传',
+ 'children' => ['AttachData', 'AttachDataWithSignature', 'SetData', 'SetDataWithSignature', 'BatchUploadMPCoSPhaseDigestInfo', 'BatchUploadMPCoSPhaseDigestInfoByDevice', 'BatchUploadMPCoSPhaseTextInfo', 'BatchUploadMPCoSPhaseTextInfoByDevice', 'UploadMPCoSPhaseDigestInfo', 'UploadMPCoSPhaseDigestInfoByDevice', 'UploadMPCoSPhaseTextInfo', 'UploadMPCoSPhaseTextInfoByDevice'],
'type' => 'directory',
- 'children' => [
- 'AttachData',
- 'AttachDataWithSignature',
- 'SetData',
- 'SetDataWithSignature',
- 'BatchUploadMPCoSPhaseDigestInfo',
- 'BatchUploadMPCoSPhaseDigestInfoByDevice',
- 'BatchUploadMPCoSPhaseTextInfo',
- 'BatchUploadMPCoSPhaseTextInfoByDevice',
- 'UploadMPCoSPhaseDigestInfo',
- 'UploadMPCoSPhaseDigestInfoByDevice',
- 'UploadMPCoSPhaseTextInfo',
- 'UploadMPCoSPhaseTextInfoByDevice',
- ],
+ 'title' => '上传',
+ 'id' => 307470,
],
[
- 'id' => 65802,
- 'title' => '查询',
+ 'children' => ['DescribeCapacityInfo', 'DescribeMemberCapacityInfo', 'DescribeResourceInfo', 'GetBlockChainInfo', 'GetData', 'GetDataModelConfigInfo', 'GetHistoryDataCount', 'GetHistoryDataList', 'ListDependentDataModels', 'ListMultiPartyCollaborationChain', 'ListProofChain', 'ListPSMemberDataTypeCode'],
'type' => 'directory',
- 'children' => [
- 'DescribeCapacityInfo',
- 'DescribeMemberCapacityInfo',
- 'DescribeResourceInfo',
- 'GetBlockChainInfo',
- 'GetData',
- 'GetDataModelConfigInfo',
- 'GetHistoryDataCount',
- 'GetHistoryDataList',
- 'ListDependentDataModels',
- 'ListMultiPartyCollaborationChain',
- 'ListProofChain',
- 'ListPSMemberDataTypeCode',
- ],
+ 'title' => '查询',
+ 'id' => 307483,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ApplyDataModelConfigInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'MemberUid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '阿里云RAM用户UID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '19720316234381****',
- ],
- ],
- [
- 'name' => 'MemberName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '账户名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司',
- ],
- ],
- [
- 'name' => 'MemberContact',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '账户联系人。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '张三',
- ],
+ 'schema' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWz******g'],
],
[
- 'name' => 'MemberPhone',
+ 'name' => 'DataModelCode',
'in' => 'query',
- 'schema' => [
- 'description' => '账户电话。可包含数字和横线(-)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1381111****',
- ],
+ 'schema' => ['description' => '数据模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DF3K'],
],
[
- 'name' => 'Remark',
+ 'name' => 'Configuration',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。'."\n"
- .'长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某应用某业务',
- ],
+ 'schema' => ['description' => '模型配置信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"productKey\\":\\"a1lPbm9Yq0v\\"}'],
],
],
'responses' => [
@@ -206,110 +81,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'example' => '717534457003****',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '响应内容。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '180E5D71-FF24-5E87-9746-3DA837E686FE'],
+ 'Success' => ['description' => '是否成功。-**true**:是。-**false**:否。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"180E5D71-FF24-5E87-9746-3DA837E686FE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '应用数据模型配置',
+ 'summary' => '应用自定义数据模型配置信息。',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"717534457003****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>717534457003****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMemberResponse>","errorExample":""}]',
- 'title' => '创建使用方',
- 'summary' => '管理方创建使用方账户。',
- 'description' => '**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
],
- 'LockMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AttachData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****'],
],
[
- 'name' => 'MemberId',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => '数据Value。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。'],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'query',
+ 'schema' => ['description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
+ .'2. 如果不包含该参数,则返回当前Key最新数据。', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****'],
],
],
'responses' => [
@@ -317,280 +141,110 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<LockMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</LockMemberResponse>","errorExample":""}]',
- 'title' => '锁定使用方账户',
- 'summary' => '锁定使用方账户,锁定账户后则账户不能访问当前区块链。',
- 'description' => '**可访问账号:**'."\n"
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AttachDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AttachDataResponse>","errorExample":""}]',
+ 'title' => '数据多次上传',
+ 'summary' => '用于向IoT区块链可信应用系统多次上传数据。',
+ 'description' => '- 同一个数据Key,可以多次使用AttachData上传数据。'."\n"
+ .'- 调用成功后,系统会进行异步处理,稍后需使用GetData查询数据,进行确认。'."\n"
+ .'- 同一个数据Key多次上传,后续上传数据需等待前序数据确认上链完成。'."\n"
+ ."\n"
+ .'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
+ .'| √ | √ |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ModifyMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AttachDataWithSignature' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****'],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '阿里云RAM用户UID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => '数据value。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。'],
],
[
- 'name' => 'MemberName',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '账户名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司',
- ],
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
],
[
- 'name' => 'MemberContact',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '账户联系人。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '张三',
- ],
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
],
[
- 'name' => 'MemberPhone',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '账户联系电话。'."\n"
- .'长度限制为20字符,可以包含数字和横线(-)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1381111****',
- ],
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****'],
],
[
- 'name' => 'Remark',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '备注。'."\n"
- .'长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '某应用某业务',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****'],
],
[
- 'name' => 'MemberId',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['description' => 'IoT数据Value摘要。'."\n"
+ .'1. Value数据UTF-8编码。'."\n"
+ .'2. SHA256运算,结果为32字节数据。'."\n"
+ .'3. 转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******'],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMemberResponse>","errorExample":""}]',
- 'title' => '修改使用方',
- 'summary' => '修改账户信息。',
- 'description' => '**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
- ],
- 'UnLockMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
- [
- 'name' => 'ApiVersion',
+ 'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'IoT设备数据签名。'."\n"
+ .'使用 IoT 设备安全 SDK 进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
],
[
- 'name' => 'MemberId',
+ 'name' => 'BusinessId',
'in' => 'query',
- 'schema' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
+ .'2. 如果不包含该参数,则返回当前Key最新数据。', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****'],
],
],
'responses' => [
@@ -598,134 +252,67 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnLockMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnLockMemberResponse>","errorExample":""}]',
- 'title' => '解锁使用方',
- 'summary' => '解锁使用方账户,解锁后账户可访问区块链。',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AttachDataWithSignatureResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AttachDataWithSignatureResponse>","errorExample":""}]',
+ 'title' => '设备数据多次上传',
+ 'summary' => '用于向 IoT区块链可信应用系统多次上传数据,并且上传的数据必须由 IoT设备端进行签名。',
+ 'description' => '- 同一个数据Key,可以多次使用AttachDataWithSignature上传数据。'."\n"
+ .'- 调用成功后,系统会进行异步处理,稍后需使用GetData查询数据,进行确认。'."\n"
+ .'- 同一个数据Key多次上传,后续上传数据需等待前序数据确认上链完成。'."\n"
+ ."\n"
+ .'**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AuthorizeDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'DeviceId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '设备标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '654887879557****'],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询阿里云RAM用户的UID。'."\n"
- .'> 不传则查询业务链下所有的阿里云RAM用户。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****'],
],
],
'responses' => [
@@ -733,114 +320,26 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '账号锁定状态:'."\n"
- .'- **UNLOCK**:未锁定。'."\n"
- .'- **LOCK**:已锁定。',
- 'type' => 'string',
- 'example' => 'UNLOCK',
- ],
- 'MemberName' => [
- 'description' => '账户名称。',
- 'type' => 'string',
- 'example' => '某公司',
- ],
- 'Remark' => [
- 'description' => '备注。',
- 'type' => 'string',
- 'example' => '某应用某业务',
- ],
- 'MemberUid' => [
- 'description' => '阿里云RAM用户UID。',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- 'MemberPhone' => [
- 'description' => '账户电话。',
- 'type' => 'string',
- 'example' => '1381111****',
- ],
- 'MemberId' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'example' => '717534457003****',
- ],
- 'MemberContact' => [
- 'description' => '账户联系人。',
- 'type' => 'string',
- 'example' => '张三',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"UNLOCK\\",\\n \\"MemberName\\": \\"某公司\\",\\n \\"Remark\\": \\"某应用某业务\\",\\n \\"MemberUid\\": \\"19720316234381****\\",\\n \\"MemberPhone\\": \\"1381111****\\",\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"MemberContact\\": \\"张三\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>UNLOCK</Status>\\n <MemberId>717534457003****</MemberId>\\n <MemberContact>张三</MemberContact>\\n <MemberUid>19720316234381****</MemberUid>\\n <MemberPhone>1381111****</MemberPhone>\\n <MemberName>某公司</MemberName>\\n <Remark>某应用某业务</Remark>\\n </PageData>\\n <PageData>\\n <Status>UNLOCK</Status>\\n <MemberId>717534457003****</MemberId>\\n <MemberContact>张三</MemberContact>\\n <MemberUid>19720316234381****</MemberUid>\\n <MemberPhone>1381111****</MemberPhone>\\n <MemberName>某公司</MemberName>\\n <Remark>某应用某业务</Remark>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMemberResponse>","errorExample":""}]',
- 'title' => '查询使用方列表',
- 'summary' => '查询使用方账户列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AuthorizeDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AuthorizeDeviceResponse>","errorExample":""}]',
+ 'title' => '授权设备',
+ 'summary' => '授权指定设备接入区块链权限。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -849,93 +348,34 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'RegisterDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AuthorizeDeviceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '981184817831****',
- ],
- ],
- [
- 'name' => 'DeviceGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某数据源组',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'ProductKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hKpHMh2****',
- ],
- ],
- [
- 'name' => 'AuthorizeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '授权类型。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
- ],
- [
- 'name' => 'Remark',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某数据源组的备注信息。',
- ],
+ 'schema' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****'],
],
],
'responses' => [
@@ -943,67 +383,39 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'example' => '256399502929****',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"256399502929****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RegisterDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>256399502929****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RegisterDeviceGroupResponse>","errorExample":""}]',
- 'title' => '注册数据源组',
- 'summary' => '注册IoT数据源组。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AuthorizeDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AuthorizeDeviceGroupResponse>","errorExample":""}]',
+ 'title' => '授权设备分组',
+ 'summary' => '授权IoT数据源组下的设备接入区块链的权限。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
+ .'| √ | × |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'AuthorizeDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchUploadMPCoSPhaseDigestInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1011,53 +423,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DeviceId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '设备标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '654887879557****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
+ ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '阶段数据列表。详情请参见下表PhaseData。', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]'],
],
],
'responses' => [
@@ -1065,67 +457,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AuthorizeDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AuthorizeDeviceResponse>","errorExample":""}]',
- 'title' => '授权设备',
- 'summary' => '授权指定设备接入区块链权限。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseDigestInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseDigestInfoResponse>","errorExample":""}]',
+ 'title' => '批量上传摘要数据',
+ 'summary' => '批量上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
+ .'| √ | √ |',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
+ .'|phaseData|String|是|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|阶段数据。长度要求64字节。|'."\n"
+ .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
+ .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'AuthorizeDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchUploadMPCoSPhaseDigestInfoByDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1133,164 +511,69 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '阶段数据列表。详情请参见下表PhaseData。', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]'],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AuthorizeDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AuthorizeDeviceGroupResponse>","errorExample":""}]',
- 'title' => '授权设备分组',
- 'summary' => '授权IoT数据源组下的设备接入区块链的权限。',
- 'description' => '**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
- ],
- 'UnAuthorizeDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'IotAuthType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
],
[
- 'name' => 'DeviceId',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '设备标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '654887879557****',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****'],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => 'IoT可信数据Value摘要:'."\n"
+ .'1. Value数据UTF-8编码。'."\n"
+ .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED'],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备数据签名。'."\n"
+ .'使用IoT设备安全SDK进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******'],
],
],
'responses' => [
@@ -1298,67 +581,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnAuthorizeDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnAuthorizeDeviceResponse>","errorExample":""}]',
- 'title' => '设备取消授权',
- 'summary' => '取消指定设备接入区块链权限。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseDigestInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseDigestInfoByDeviceResponse>","errorExample":""}]',
+ 'title' => '设备批量上传摘要数据',
+ 'summary' => '通过IoT设备签名后,批量上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
+ .'| √ | √ |',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
+ .'|phaseData|String|是|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|阶段数据。长度要求64字节。|'."\n"
+ .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
+ .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见错误码[错误码](~~184711~~)。',
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UnAuthorizeDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchUploadMPCoSPhaseTextInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1366,42 +635,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
+ ],
+ [
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****'],
+ ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '阶段数据列表。详情请参见下表PhaseData。', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]'],
],
],
'responses' => [
@@ -1409,341 +669,123 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnAuthorizeDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnAuthorizeDeviceGroupResponse>","errorExample":""}]',
- 'title' => '数据源组取消授权',
- 'summary' => '取消指定IoT数据源组下的设备接入区块链的权限。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseTextInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseTextInfoResponse>","errorExample":""}]',
+ 'title' => '批量上传文本数据',
+ 'summary' => '批量上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
+ .'| √ | √ |',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
+ .'|phaseData|String|是|某公司某业务数据|阶段数据。长度要求1~4096字节,一个中文字符占两位字符。|'."\n"
+ .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
+ .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchUploadMPCoSPhaseTextInfoByDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Num',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseDataList',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '阶段数据列表。详情请参见下表PhaseData。', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","dataSeq":"某公司某业务数据。","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]'],
],
[
- 'name' => 'IotId',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询IoT设备的ID。'."\n"
- ."\n"
- .'> 不传则查询该IoT数据源组下的所有IoT设备。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '183329761572****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '授权状态。'."\n"
- .'- **AUTHORIZED**:已授权。'."\n"
- .'- **UNAUTHORIZED**:未授权。',
- 'type' => 'string',
- 'example' => 'AUTHORIZED',
- ],
- 'LastSaveTime' => [
- 'description' => '最后存证时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1606379090866',
- ],
- 'DeviceId' => [
- 'description' => '设备标识。',
- 'type' => 'string',
- 'example' => '876055554040****',
- ],
- 'IotId' => [
- 'description' => 'IoT设备ID。',
- 'type' => 'string',
- 'example' => '183329761572****',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"AUTHORIZED\\",\\n \\"LastSaveTime\\": 1606379090866,\\n \\"DeviceId\\": \\"876055554040****\\",\\n \\"IotId\\": \\"183329761572****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <IotId>183329761572****</IotId>\\n <LastSaveTime>1606379090866</LastSaveTime>\\n <DeviceId>876055554040****</DeviceId>\\n </PageData>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <IotId>183329761573****</IotId>\\n <LastSaveTime>1606379090888</LastSaveTime>\\n <DeviceId>876055554041****</DeviceId>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListDeviceResponse>","errorExample":""}]',
- 'title' => '查询设备列表',
- 'summary' => '查询IoT数据源组下的所有设备。',
- 'description' => '**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
- ],
- 'ListDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****'],
],
[
- 'name' => 'Num',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
],
[
- 'name' => 'Size',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'IoT可信数据Value摘要:'."\n"
+ .'1. Value数据UTF-8编码。'."\n"
+ .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组ProductKey。'."\n"
- ."\n"
- .'> 不传则查询业务链下所有的IoT数据源组。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKpHMh2****',
- ],
+ 'schema' => ['description' => 'IoT设备数据签名。'."\n"
+ .'使用IoT设备安全SDK进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******'],
],
],
'responses' => [
@@ -1751,138 +793,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误消息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => 'IoT数据源组授权状态。'."\n"
- .'- **AUTHORIZED**:已授权。'."\n"
- .'- **UNAUTHORIZED**:未授权。',
- 'type' => 'string',
- 'example' => 'AUTHORIZED',
- ],
- 'DeviceGroupId' => [
- 'description' => 'IoT数据源组标识。',
- 'type' => 'string',
- 'example' => '577187700697****',
- ],
- 'ProductKey' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'example' => 'hKpHMh2****',
- ],
- 'Remark' => [
- 'description' => '备注信息。',
- 'type' => 'string',
- 'example' => '某业务某设备',
- ],
- 'AuthorizeType' => [
- 'description' => 'IoT数据源组授权类型。'."\n"
- .'**ID2**:阿里云ID²认证。',
- 'type' => 'string',
- 'example' => 'ID2',
- ],
- 'OwnerName' => [
- 'description' => 'IoT数据源组所属成员名称。',
- 'type' => 'string',
- 'example' => '某公司',
- ],
- 'OwnerUid' => [
- 'description' => 'IoT数据源组所属成员账号UID。',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => '无'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"AUTHORIZED\\",\\n \\"DeviceGroupId\\": \\"577187700697****\\",\\n \\"ProductKey\\": \\"hKpHMh2****\\",\\n \\"Remark\\": \\"某业务某设备\\",\\n \\"AuthorizeType\\": \\"ID2\\",\\n \\"OwnerName\\": \\"某公司\\",\\n \\"OwnerUid\\": \\"19720316234381****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <AuthorizeType>ID2</AuthorizeType>\\n <OwnerName>某公司</OwnerName>\\n <DeviceGroupId>577187700697****</DeviceGroupId>\\n <OwnerUid>19720316234381****</OwnerUid>\\n <ProductKey>hKpHMh2****</ProductKey>\\n <Remark>某业务某设备</Remark>\\n </PageData>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <AuthorizeType>ID2</AuthorizeType>\\n <OwnerName>某公司</OwnerName>\\n <DeviceGroupId>577187700698****</DeviceGroupId>\\n <OwnerUid>19720316234386****</OwnerUid>\\n <ProductKey>hKpHMh2****</ProductKey>\\n <Remark>某业务某设备</Remark>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListDeviceGroupResponse>","errorExample":""}]',
- 'title' => '查询数据源组列表',
- 'summary' => '查询IoT数据源组列表'."\n"
- .'使用方可查看自己注册的IoT数据源组'."\n"
- .'管理方可查看项目下所有的IoT数据源组。',
- 'description' => '1. 使用方仅可查看自行注册的IoT数据源组列表。'."\n"
- .'2. 管理方可查看所创建所有使用方的IoT数据源组列表。'."\n"
- ."\n"
- .'**可访问账号:**'."\n"
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseTextInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseTextInfoByDeviceResponse>","errorExample":""}]',
+ 'title' => '设备批量上传文本数据',
+ 'summary' => '通过IoT设备签名后,批量上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => ' ',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
+ .'|phaseData|String|是|某公司某业务数据|阶段数据。|阶段数据。长度要求1~4096字节,一个中文字符占两位字符。|'."\n"
+ .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
+ .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
'CreateMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1890,64 +847,33 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某阶段',
- ],
+ 'schema' => ['description' => '阶段名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某阶段'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某阶段的备注信息。',
- ],
+ 'schema' => ['description' => '备注信息。长度限制为100字符。', 'type' => 'string', 'required' => false, 'example' => '某阶段的备注信息。'],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
],
],
'responses' => [
@@ -1955,44 +881,21 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'example' => '196487512811****',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '阶段标识。', 'type' => 'string', 'example' => '196487512811****'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"196487512811****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMPCoSPhaseResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>196487512811****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMPCoSPhaseResponse>","errorExample":""}]',
@@ -2006,69 +909,39 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
'CreateMPCoSPhaseGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某协同模型',
- ],
+ 'schema' => ['description' => '协同模型名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某协同模型'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型备注。长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某协同模型的备注信息。',
- ],
+ 'schema' => ['description' => '协同模型备注。长度限制为100字符。', 'type' => 'string', 'required' => false, 'example' => '某协同模型的备注信息。'],
],
],
'responses' => [
@@ -2076,44 +949,21 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '协同模型标识。', 'type' => 'string', 'example' => '987823074334****'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"987823074334****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMPCoSPhaseGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>987823074334****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMPCoSPhaseGroupResponse>","errorExample":""}]',
@@ -2127,214 +977,57 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ModifyMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '阶段名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某阶段',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'Remark',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某阶段的备注信息。',
- ],
+ 'schema' => ['description' => '阿里云RAM用户UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '19720316234381****'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'MemberName',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '196487512811****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMPCoSPhaseResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMPCoSPhaseResponse>","errorExample":""}]',
- 'title' => '修改阶段',
- 'summary' => '在协同模型中修改阶段信息。',
- 'description' => '**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
- ],
- 'ModifyMPCoSPhaseGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['description' => '账户名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'MemberContact',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => '账户联系人。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三'],
],
[
- 'name' => 'Name',
+ 'name' => 'MemberPhone',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型名称。'."\n"
- .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某协同模型',
- ],
+ 'schema' => ['description' => '账户电话。可包含数字和横线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1381111****'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。长度限制为100字符。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '某协同模型备注。',
- ],
- ],
- [
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
- ],
- [
- 'name' => 'BizChainId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '备注信息。'."\n"
+ .'长度限制为100字符。', 'type' => 'string', 'required' => false, 'example' => '某应用某业务'],
],
],
'responses' => [
@@ -2342,49 +1035,26 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '账户标识。', 'type' => 'string', 'example' => '717534457003****'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMPCoSPhaseGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMPCoSPhaseGroupResponse>","errorExample":""}]',
- 'title' => '修改数据模型',
- 'summary' => '修改协同模型信息。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"717534457003****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>717534457003****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMemberResponse>","errorExample":""}]',
+ 'title' => '创建使用方',
+ 'summary' => '管理方创建使用方账户。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -2393,16 +1063,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UpdateMPCoSAuthorizedInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeCapacityInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2410,65 +1075,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'MemberId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
- ],
- [
- 'name' => 'AuthorizedPhaseList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '授权阶段标识列表。',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '["196487512811****","196487512812****"]',
- ],
- ],
- [
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '要查询的业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
],
'responses' => [
@@ -2476,67 +1093,50 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CountQuota' => ['description' => '该业务链的条数配额。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000'],
+ 'CapacityQuota' => ['description' => '该业务链的容量配额(单位:字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '800000000000'],
+ 'UsedCount' => ['description' => '该业务链已使用条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'],
+ 'UsedCapacity' => ['description' => '该业务链已使用容量(单位:字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '870000000'],
+ 'MemberUsedCapacity' => ['description' => '当前用户在该业务链已使用的容量(单位:字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '70000000'],
+ 'MemberUsedCount' => ['description' => '当前用户该业务链已使用的条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '26666'],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateMPCoSAuthorizedInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateMPCoSAuthorizedInfoResponse>","errorExample":""}]',
- 'title' => '更新使用方权限',
- 'summary' => '更新账户在协同模型中的权限信息。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CountQuota\\": 10000000,\\n \\"CapacityQuota\\": 800000000000,\\n \\"UsedCount\\": 30000,\\n \\"UsedCapacity\\": 870000000,\\n \\"MemberUsedCapacity\\": 70000000,\\n \\"MemberUsedCount\\": 26666\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCapacityInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <CountQuota>10000000</CountQuota>\\n <MemberUsedCapacity>70000000</MemberUsedCapacity>\\n <CapacityQuota>800000000000</CapacityQuota>\\n <UsedCapacity>870000000</UsedCapacity>\\n <UsedCount>30000</UsedCount>\\n <MemberUsedCount>26666</MemberUsedCount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeCapacityInfoResponse>","errorExample":""}]',
+ 'title' => '查询容量统计信息',
+ 'summary' => '查询资源容量统计信息。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
+ .'| √ | √ |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
'DescribeMPCoSAuthorizedInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2544,53 +1144,27 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => '账户标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****'],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
],
'responses' => [
@@ -2598,29 +1172,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应内容。',
'type' => 'object',
@@ -2631,17 +1188,10 @@
'items' => [
'type' => 'object',
'properties' => [
- 'PhaseName' => [
- 'description' => '阶段名称。',
- 'type' => 'string',
- 'example' => '某阶段',
- ],
- 'PhaseId' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'PhaseName' => ['description' => '阶段名称。', 'type' => 'string', 'example' => '某阶段'],
+ 'PhaseId' => ['description' => '阶段标识。', 'type' => 'string', 'example' => '987823074334****'],
],
+ 'description' => '',
],
],
'UnAuthorizedPhaseList' => [
@@ -2650,31 +1200,22 @@
'items' => [
'type' => 'object',
'properties' => [
- 'PhaseName' => [
- 'description' => '阶段名称。',
- 'type' => 'string',
- 'example' => '某某阶段',
- ],
- 'PhaseId' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'PhaseName' => ['description' => '阶段名称。', 'type' => 'string', 'example' => '某某阶段'],
+ 'PhaseId' => ['description' => '阶段标识。', 'type' => 'string', 'example' => '987823074334****'],
],
+ 'description' => '',
],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AuthorizedPhaseList\\": [\\n {\\n \\"PhaseName\\": \\"某阶段\\",\\n \\"PhaseId\\": \\"987823074334****\\"\\n }\\n ],\\n \\"UnAuthorizedPhaseList\\": [\\n {\\n \\"PhaseName\\": \\"某某阶段\\",\\n \\"PhaseId\\": \\"987823074334****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMPCoSAuthorizedInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <AuthorizedPhaseList>\\n <PhaseName>某阶段</PhaseName>\\n <PhaseId>987823074334****</PhaseId>\\n </AuthorizedPhaseList>\\n <UnAuthorizedPhaseList>\\n <PhaseName>某某阶段</PhaseName>\\n <PhaseId>987823074334****</PhaseId>\\n </UnAuthorizedPhaseList>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMPCoSAuthorizedInfoResponse>","errorExample":""}]',
@@ -2688,16 +1229,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
'DescribeMPCoSPhaseInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2705,74 +1241,37 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
[
'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
],
[
'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => '数据序列号。', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
],
],
'responses' => [
@@ -2780,126 +1279,50 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应内容。',
'type' => 'object',
'properties' => [
- 'PreviousHash' => [
- 'description' => '前一区块摘要。',
- 'type' => 'string',
- 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****',
- ],
- 'ProductKey' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'example' => 'hfoi7GQ****',
- ],
- 'DataHash' => [
- 'description' => '数据摘要。',
- 'type' => 'string',
- 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****',
- ],
- 'DataValue' => [
- 'description' => '上链值。',
- 'type' => 'string',
- 'example' => '某公司某业务数据。',
- ],
- 'Timestamp' => [
- 'description' => '上链时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1605885676000',
- ],
- 'TransactionHash' => [
- 'description' => '交易摘要。',
- 'type' => 'string',
- 'example' => 'c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****',
- ],
- 'BlockHash' => [
- 'description' => '区块摘要。',
- 'type' => 'string',
- 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****',
- ],
- 'BlockNumber' => [
- 'description' => '区块高度。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1942',
- ],
- 'IotId' => [
- 'description' => '设备标识。',
- 'type' => 'string',
- 'example' => 'DFA7B98AD494FB98A491****',
- ],
+ 'PreviousHash' => ['description' => '前一区块摘要。', 'type' => 'string', 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****'],
+ 'ProductKey' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'example' => 'hfoi7GQ****'],
+ 'DataHash' => ['description' => '数据摘要。', 'type' => 'string', 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****'],
+ 'DataValue' => ['description' => '上链值。', 'type' => 'string', 'example' => '某公司某业务数据。'],
+ 'Timestamp' => ['description' => '上链时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1605885676000'],
+ 'TransactionHash' => ['description' => '交易摘要。', 'type' => 'string', 'example' => 'c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****'],
+ 'BlockHash' => ['description' => '区块摘要。', 'type' => 'string', 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****'],
+ 'BlockNumber' => ['description' => '区块高度。', 'type' => 'integer', 'format' => 'int64', 'example' => '1942'],
+ 'IotId' => ['description' => '设备标识。', 'type' => 'string', 'example' => 'DFA7B98AD494FB98A491****'],
'RelatedDataList' => [
'description' => '关联数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RelatedDataKey' => [
- 'description' => '关联的数据Key值。',
- 'type' => 'string',
- 'example' => '256399502929****',
- ],
- 'RelatedPhaseDataHash' => [
- 'description' => '关联的阶段数据摘要。',
- 'type' => 'string',
- 'example' => '73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****',
- ],
- 'RelatedDataSeq' => [
- 'description' => '关联的数据序列号。',
- 'type' => 'string',
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
- 'RelatedPhaseName' => [
- 'description' => '关联的数据阶段名称。',
- 'type' => 'string',
- 'example' => '某业务阶段',
- ],
- 'RelatedPhaseId' => [
- 'description' => '关联的数据阶段ID。',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'RelatedDataKey' => ['description' => '关联的数据Key值。', 'type' => 'string', 'example' => '256399502929****'],
+ 'RelatedPhaseDataHash' => ['description' => '关联的阶段数据摘要。', 'type' => 'string', 'example' => '73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****'],
+ 'RelatedDataSeq' => ['description' => '关联的数据序列号。', 'type' => 'string', 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
+ 'RelatedPhaseName' => ['description' => '关联的数据阶段名称。', 'type' => 'string', 'example' => '某业务阶段'],
+ 'RelatedPhaseId' => ['description' => '关联的数据阶段ID。', 'type' => 'string', 'example' => '987823074334****'],
],
+ 'description' => '',
],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PreviousHash\\": \\"bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****\\",\\n \\"ProductKey\\": \\"hfoi7GQ****\\",\\n \\"DataHash\\": \\"9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****\\",\\n \\"DataValue\\": \\"某公司某业务数据。\\",\\n \\"Timestamp\\": 1605885676000,\\n \\"TransactionHash\\": \\"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****\\",\\n \\"BlockHash\\": \\"5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****\\",\\n \\"BlockNumber\\": 1942,\\n \\"IotId\\": \\"DFA7B98AD494FB98A491****\\",\\n \\"RelatedDataList\\": [\\n {\\n \\"RelatedDataKey\\": \\"256399502929****\\",\\n \\"RelatedPhaseDataHash\\": \\"73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****\\",\\n \\"RelatedDataSeq\\": \\"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****\\",\\n \\"RelatedPhaseName\\": \\"某业务阶段\\",\\n \\"RelatedPhaseId\\": \\"987823074334****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMPCoSPhaseInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <IotId>DFA7B98AD494FB98A491****</IotId>\\n <DataValue>某公司某业务数据。</DataValue>\\n <BlockHash>5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****</BlockHash>\\n <TransactionHash>c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****</TransactionHash>\\n <PreviousHash>bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****</PreviousHash>\\n <BlockNumber>1942</BlockNumber>\\n <Timestamp>1605885676000</Timestamp>\\n <RelatedDataList>\\n <RelatedPhaseId>256399502929****</RelatedPhaseId>\\n <RelatedDataSeq>be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****</RelatedDataSeq>\\n <RelatedDataKey>987823074334****</RelatedDataKey>\\n <RelatedPhaseDataHash>73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****</RelatedPhaseDataHash>\\n <RelatedPhaseName>某业务阶段</RelatedPhaseName>\\n </RelatedDataList>\\n <ProductKey>hfoi7GQ****</ProductKey>\\n <DataHash>9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****</DataHash>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMPCoSPhaseInfoResponse>","errorExample":""}]',
@@ -2913,16 +1336,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
'DescribeMPCoSResourceInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2930,31 +1348,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
],
'responses' => [
@@ -2962,100 +1366,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求标识。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求标识。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应内容。',
'type' => 'object',
'properties' => [
- 'PhaseGroupQuota' => [
- 'description' => '协同模型配额。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'MemberQuota' => [
- 'description' => '成员配额。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'UsedMember' => [
- 'description' => '已添加成员个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'UsedPhaseGroup' => [
- 'description' => '已添加协同模型个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'PhaseGroupQuota' => ['description' => '协同模型配额。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'MemberQuota' => ['description' => '成员配额。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'UsedMember' => ['description' => '已添加成员个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'UsedPhaseGroup' => ['description' => '已添加协同模型个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PhaseQuotaInfoList' => [
'description' => '阶段配额列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'PhaseGroupId' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'example' => '383860792287****',
- ],
- 'PhaseGroupName' => [
- 'description' => '协同模型名称。',
- 'type' => 'string',
- 'example' => '某协同模型',
- ],
- 'PhaseQuota' => [
- 'description' => '阶段配额。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'UsedPhase' => [
- 'description' => '已添加阶段个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
+ 'PhaseGroupId' => ['description' => '协同模型标识。', 'type' => 'string', 'example' => '383860792287****'],
+ 'PhaseGroupName' => ['description' => '协同模型名称。', 'type' => 'string', 'example' => '某协同模型'],
+ 'PhaseQuota' => ['description' => '阶段配额。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'UsedPhase' => ['description' => '已添加阶段个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
],
+ 'description' => '',
],
],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PhaseGroupQuota\\": 200,\\n \\"MemberQuota\\": 100,\\n \\"UsedMember\\": 5,\\n \\"UsedPhaseGroup\\": 10,\\n \\"PhaseQuotaInfoList\\": [\\n {\\n \\"PhaseGroupId\\": \\"383860792287****\\",\\n \\"PhaseGroupName\\": \\"某协同模型\\",\\n \\"PhaseQuota\\": 5,\\n \\"UsedPhase\\": 3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMPCoSResourceInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PhaseGroupQuota>200</PhaseGroupQuota>\\n <UsedPhaseGroup>10</UsedPhaseGroup>\\n <UsedMember>5</UsedMember>\\n <PhaseQuotaInfoList>\\n <PhaseQuota>5</PhaseQuota>\\n <UsedPhase>3</UsedPhase>\\n <PhaseGroupId>383860792287****</PhaseGroupId>\\n <PhaseGroupName>某协同模型</PhaseGroupName>\\n </PhaseQuotaInfoList>\\n <MemberQuota>100</MemberQuota>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMPCoSResourceInfoResponse>","errorExample":""}]',
@@ -3069,16 +1417,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeMemberCapacityInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3086,81 +1429,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要查询的阶段名称。'."\n"
- .'> 不传则查询该协同模型下所有阶段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某阶段',
- ],
+ 'schema' => ['description' => '要查询的业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
],
'responses' => [
@@ -3168,119 +1447,53 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '阶段名称。',
- 'type' => 'string',
- 'example' => '某阶段',
- ],
- 'Remark' => [
- 'description' => '阶段备注。',
- 'type' => 'string',
- 'example' => '某阶段的备注信息。',
- ],
- 'AccessPermission' => [
- 'description' => '访问权限。'."\n"
- .'- **1**:读权限。'."\n"
- .'- **2**:写权限。'."\n"
- .'- **3**:读写权限。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PhaseId' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'example' => '196487512811****',
- ],
- ],
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UsedCapacity' => ['description' => '用户已使用该业务链容量(单位:字节)。', 'type' => 'string', 'example' => '70000000'],
+ 'MemberId' => ['description' => '账户标识。', 'type' => 'string', 'example' => '717534457003****'],
+ 'MemberName' => ['description' => '账户名称。', 'type' => 'string', 'example' => '张三'],
+ 'UsedCount' => ['description' => '用户已使用该业务链条数。', 'type' => 'string', 'example' => '26666'],
+ 'MemberUid' => ['description' => '阿里云RAM用户UID。', 'type' => 'string', 'example' => '19720316234381****'],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"Name\\": \\"某阶段\\",\\n \\"Remark\\": \\"某阶段的备注信息。\\",\\n \\"AccessPermission\\": 1,\\n \\"PhaseId\\": \\"196487512811****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <AccessPermission>1</AccessPermission>\\n <PhaseId>196487512811****</PhaseId>\\n <Remark>某阶段的备注信息。</Remark>\\n <Name>某阶段</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseResponse>","errorExample":""}]',
- 'title' => '查询阶段列表',
- 'summary' => '查询协同模型所属的阶段列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"UsedCapacity\\": \\"70000000\\",\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"MemberName\\": \\"张三\\",\\n \\"UsedCount\\": \\"26666\\",\\n \\"MemberUid\\": \\"19720316234381****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMemberCapacityInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <MemberId>717534457003****</MemberId>\\n <UsedCapacity>70000000</UsedCapacity>\\n <MemberName>张三</MemberName>\\n <MemberUid>19720316234381****</MemberUid>\\n <UsedCount>26666</UsedCount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMemberCapacityInfoResponse>","errorExample":""}]',
+ 'title' => '查询使用方容量信息',
+ 'summary' => '查询使用方容量统计信息。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
+ .'| √ | × |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListMPCoSPhaseGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeResourceInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3288,71 +1501,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '要查询的协同模型名称。'."\n"
- ."\n"
- .'> 若不传则查询所有协同模型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '某业务链',
- ],
+ 'schema' => ['description' => '要查询的业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
],
'responses' => [
@@ -3360,92 +1519,40 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '响应状态码。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应内容。',
'type' => 'object',
'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PhaseGroupId' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
- 'Name' => [
- 'description' => '协同模型名称。',
- 'type' => 'string',
- 'example' => '某协同模型',
- ],
- 'Remark' => [
- 'description' => '协同模型备注。',
- 'type' => 'string',
- 'example' => '某协同模型的备注信息。',
- ],
- ],
- ],
- ],
+ 'Status' => ['description' => '业务链状态。'."\n"
+ .'- **NORMAL**:正常。'."\n"
+ .'- **EXPIRED**:已过期。', 'type' => 'string', 'example' => 'NORMAL'],
+ 'EffectiveTime' => ['description' => '开通时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1586125838680'],
+ 'AuthorizeType' => ['description' => '授权类型。'."\n"
+ .'- **企业版**:企业版套餐。'."\n"
+ .'- **标准版**:标准版套餐。', 'type' => 'string', 'example' => '标准版'],
+ 'ExpiredTime' => ['description' => '到期时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1666125838680'],
+ 'Region' => ['description' => '地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"PhaseGroupId\\": \\"987823074334****\\",\\n \\"Name\\": \\"某协同模型\\",\\n \\"Remark\\": \\"某协同模型的备注信息。\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <PhaseGroupId>987823074334****</PhaseGroupId>\\n <Remark>某协同模型的备注信息。</Remark>\\n <Name>某协同模型</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseGroupResponse>","errorExample":""}]',
- 'title' => '查询协同模型列表',
- 'summary' => '查询业务链所属的协同模型列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"EffectiveTime\\": 1586125838680,\\n \\"AuthorizeType\\": \\"标准版\\",\\n \\"ExpiredTime\\": 1666125838680,\\n \\"Region\\": \\"cn-shanghai\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourceInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <Status>NORMAL</Status>\\n <AuthorizeType>标准版</AuthorizeType>\\n <EffectiveTime>1586125838680</EffectiveTime>\\n <ExpiredTime>1666125838680</ExpiredTime>\\n <Region>cn-shanghai</Region>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeResourceInfoResponse>","errorExample":""}]',
+ 'title' => '查询资源信息',
+ 'summary' => '查询资源开通信息。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -3454,16 +1561,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListMPCoSPhaseHistory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetBlockChainInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3471,120 +1573,104 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Num',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****'],
],
[
- 'name' => 'Size',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'BusinessId',
'in' => 'query',
+ 'schema' => ['description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
+ .'2. 如果不包含该参数,则返回当前Key最新数据。', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '返回唯一标识key对应的区块链元数据信息(JSON格式)。详情请参见下表blockChainInfo。', 'type' => 'string', 'example' => '{"blockChainInfo":{"chainName":"某公司业务链","blockHeight":48971,"transactionHash":"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****","iotId":"1BE0F46275B17147E7D2****","endorsementNames":"某公司,某某公司","timestamp":"1591676312000","blockHash":"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****","previousHash":"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****","dataHash":"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****"}}'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"{\\\\\\"blockChainInfo\\\\\\":{\\\\\\"chainName\\\\\\":\\\\\\"某公司业务链\\\\\\",\\\\\\"blockHeight\\\\\\":48971,\\\\\\"transactionHash\\\\\\":\\\\\\"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****\\\\\\",\\\\\\"iotId\\\\\\":\\\\\\"1BE0F46275B17147E7D2****\\\\\\",\\\\\\"endorsementNames\\\\\\":\\\\\\"某公司,某某公司\\\\\\",\\\\\\"timestamp\\\\\\":\\\\\\"1591676312000\\\\\\",\\\\\\"blockHash\\\\\\":\\\\\\"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****\\\\\\",\\\\\\"previousHash\\\\\\":\\\\\\"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****\\\\\\",\\\\\\"dataHash\\\\\\":\\\\\\"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****\\\\\\"}}\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetBlockChainInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>{\\"blockChainInfo\\":{\\"chainName\\":\\"某公司业务链\\",\\"blockHeight\\":48971,\\"transactionHash\\":\\"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****\\",\\"iotId\\":\\"1BE0F46275B17147E7D2****\\",\\"endorsementNames\\":\\"某公司,某某公司\\",\\"timestamp\\":\\"1591676312000\\",\\"blockHash\\":\\"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****\\",\\"previousHash\\":\\"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****\\",\\"dataHash\\":\\"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****\\"}}</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetBlockChainInfoResponse>","errorExample":""}]',
+ 'title' => '查询数据区块链元信息',
+ 'summary' => '用于查询上传数据的区块链元信息。',
+ 'description' => '**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => '**blockChainInfo**'."\n"
+ .'|参数|类型|示例值|描述|'."\n"
+ .'|-|-|-|-|'."\n"
+ .'|chainName|String|某公司业务链|存储区块链名称。|'."\n"
+ .'|blockHeight|Long|48971|区块链存证区块号。|'."\n"
+ .'|transactionHash|String|ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20f********|交易哈希。|'."\n"
+ .'|iotId|String|1BE0F46275B17147E7D2****|IoT设备ID。|'."\n"
+ .'|endorsementNames|String|某公司,某某公司|区块链背书节点名称。|'."\n"
+ .'|timestamp|String|1591676312000|存证时间。毫秒级时间戳。|'."\n"
+ .'|blockHash|String|d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e********|区块哈希。|'."\n"
+ .'|previousHash|String|c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4********|上一区块哈希。|'."\n"
+ .'|dataHash|String|21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e********|数据哈希。|',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'GetData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'PhaseId',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'DataKey',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzw******'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '开始时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '1606379090866',
- ],
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'BusinessId',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '1606389090866',
- ],
+ 'schema' => ['description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
+ .'2. 如果不包含该参数,则返回当前Key最新数据。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '000000000000000000000000000000000000000000000000000000000001****'],
],
],
'responses' => [
@@ -3592,129 +1678,22 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ProductKey' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'example' => 'hfoi7GQ****',
- ],
- 'PreviousHash' => [
- 'description' => '前一区块摘要。',
- 'type' => 'string',
- 'example' => '2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****',
- ],
- 'DataHash' => [
- 'description' => '数据摘要。',
- 'type' => 'string',
- 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****',
- ],
- 'DataSeq' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
- 'DataValue' => [
- 'description' => '上链值。',
- 'type' => 'string',
- 'example' => '某公司业务数据。',
- ],
- 'Timestamp' => [
- 'description' => '上链时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1606389620000',
- ],
- 'TransactionHash' => [
- 'description' => '交易摘要。',
- 'type' => 'string',
- 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****',
- ],
- 'BlockHash' => [
- 'description' => '区块摘要。',
- 'type' => 'string',
- 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****',
- ],
- 'BlockNumber' => [
- 'description' => '区块高度。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9852',
- ],
- 'IotId' => [
- 'description' => 'IoT设备ID。',
- 'type' => 'string',
- 'example' => 'DFA7B98AD494FB98A491****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '返回数据Key对应的Value数据。', 'type' => 'string', 'example' => '某业务数据。'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"ProductKey\\": \\"hfoi7GQ****\\",\\n \\"PreviousHash\\": \\"2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****\\",\\n \\"DataHash\\": \\"9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****\\",\\n \\"DataSeq\\": \\"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****\\",\\n \\"DataValue\\": \\"某公司业务数据。\\",\\n \\"Timestamp\\": 1606389620000,\\n \\"TransactionHash\\": \\"bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****\\",\\n \\"BlockHash\\": \\"5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****\\",\\n \\"BlockNumber\\": 9852,\\n \\"IotId\\": \\"DFA7B98AD494FB98A491****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseHistoryResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <IotId>DFA7B98AD494FB98A492****</IotId>\\n <DataValue>某公司业务数据。</DataValue>\\n <BlockHash>5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c5****</BlockHash>\\n <DataSeq>be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a6****</DataSeq>\\n <TransactionHash>bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb2764****</TransactionHash>\\n <PreviousHash>2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f77****</PreviousHash>\\n <BlockNumber>9852</BlockNumber>\\n <Timestamp>1606389620000</Timestamp>\\n <ProductKey>hfoi7G7****</ProductKey>\\n <DataHash>9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e978****</DataHash>\\n </PageData>\\n <PageData>\\n <IotId>DFA7B98AD494FB98A491****</IotId>\\n <DataValue>某公司业务数据。</DataValue>\\n <BlockHash>5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****</BlockHash>\\n <DataSeq>be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****</DataSeq>\\n <TransactionHash>bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****</TransactionHash>\\n <PreviousHash>2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****</PreviousHash>\\n <BlockNumber>9852</BlockNumber>\\n <Timestamp>1606389630000</Timestamp>\\n <ProductKey>hfoi7GQ****</ProductKey>\\n <DataHash>9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****</DataHash>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseHistoryResponse>","errorExample":""}]',
- 'title' => '查询历史数据列表',
- 'summary' => '通过阶段标识,数据唯一标识,起始时间,结束时间,查询数据列表。',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"某业务数据。\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>某业务数据。</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetDataResponse>","errorExample":""}]',
+ 'title' => '查询数据',
+ 'summary' => '用于确认之前上传的数据已处理成功。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -3723,16 +1702,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ApplyDataModelConfigInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDataModelConfigInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3740,51 +1714,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'api版本号,"1.0.0"。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'],
],
[
'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWz******g',
- ],
+ 'schema' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWzwcM****'],
],
[
'name' => 'DataModelCode',
'in' => 'query',
- 'schema' => [
- 'description' => '数据模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DF3K',
- ],
- ],
- [
- 'name' => 'Configuration',
- 'in' => 'query',
- 'schema' => [
- 'description' => '模型配置信息。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{\\"productKey\\":\\"a1lPbm9Yq0v\\"}',
- ],
+ 'schema' => ['description' => '数据模型编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DF3K'],
],
],
'responses' => [
@@ -3792,113 +1737,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '180E5D71-FF24-5E87-9746-3DA837E686FE',
- ],
- 'Success' => [
- 'description' => '是否成功。-**true**:是。-**false**:否。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '响应内容。', 'type' => 'string', 'example' => '{}'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'RequestID-1638240165139'],
+ 'Success' => ['description' => '是否调用成功。-**true**:调用成功,但不代表调用的服务器端口和协议不存在。-**false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"180E5D71-FF24-5E87-9746-3DA837E686FE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '应用数据模型配置',
- 'summary' => '应用自定义数据模型配置信息。',
- ],
- 'AttachData' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"{}\\",\\n \\"RequestId\\": \\"RequestID-1638240165139\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '查询模型配置',
+ 'summary' => '用户查询自定义数据模型配置信息。',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => '错误码发生变更'],
],
+ ],
+ 'GetHistoryDataCount' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****'],
],
[
- 'name' => 'Value',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Value。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司某业务数据。',
- ],
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '起始时间戳。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608010000000'],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
- .'2. 如果不包含该参数,则返回当前Key最新数据。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => '结束时间戳。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608019800000'],
],
],
'responses' => [
@@ -3906,45 +1797,23 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '返回Key对应的记录条数。', 'type' => 'string', 'example' => '10'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AttachDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AttachDataResponse>","errorExample":""}]',
- 'title' => '数据多次上传',
- 'summary' => '用于向IoT区块链可信应用系统多次上传数据。',
- 'description' => '- 同一个数据Key,可以多次使用AttachData上传数据。'."\n"
- .'- 调用成功后,系统会进行异步处理,稍后需使用GetData查询数据,进行确认。'."\n"
- .'- 同一个数据Key多次上传,后续上传数据需等待前序数据确认上链完成。'."\n"
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"10\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHistoryDataCountResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>10</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetHistoryDataCountResponse>","errorExample":""}]',
+ 'title' => '查询历史数据条数',
+ 'summary' => '历史数据数量查询,该API用于从 IoT区块链可信应用系统查询历史数据条数 。',
+ 'description' => '> 若不传时间戳,则返回所有历史数据的数量。'."\n"
."\n"
.'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
@@ -3954,16 +1823,11 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'AttachDataWithSignature' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetHistoryDataList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3971,137 +1835,42 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
- ],
- [
- 'name' => 'Value',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据value。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司某业务数据。',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****'],
],
[
'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
- ],
- [
- 'name' => 'IotAuthType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
- ],
- [
- 'name' => 'IotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
- ],
- [
- 'name' => 'IotIdServiceProvider',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据Value摘要。'."\n"
- .'1. Value数据UTF-8编码。'."\n"
- .'2. SHA256运算,结果为32字节数据。'."\n"
- .'3. 转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '0', 'example' => '1'],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。'."\n"
- .'使用 IoT 设备安全 SDK 进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '起始时间戳。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608010000000'],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
- .'2. 如果不包含该参数,则返回当前Key最新数据。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => '结束时间戳。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608019800000'],
],
],
'responses' => [
@@ -4109,46 +1878,36 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => ['description' => '返回Key对应的所有Value数据列表(JSON格式)。', 'type' => 'object', 'example' => '[{"chainName":"PS-**","code":"9***","blockHeight":"605350","businessId":"129297272256****","totalCount":"2","value":"某公司业务数据。","transactionHash":"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****","seq":"1","timestamp":"1608005018000"},{"chainName":"PS-**","code":"9***","blockHeight":"605349","businessId":"129297272258****","totalCount":"2","value":"某公司业务数据。","transactionHash":"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****","seq":"2","timestamp":"1608003040000"}]'],
+ 'description' => '',
+ ],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AttachDataWithSignatureResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AttachDataWithSignatureResponse>","errorExample":""}]',
- 'title' => '设备数据多次上传',
- 'summary' => '用于向 IoT区块链可信应用系统多次上传数据,并且上传的数据必须由 IoT设备端进行签名。',
- 'description' => '- 同一个数据Key,可以多次使用AttachDataWithSignature上传数据。'."\n"
- .'- 调用成功后,系统会进行异步处理,稍后需使用GetData查询数据,进行确认。'."\n"
- .'- 同一个数据Key多次上传,后续上传数据需等待前序数据确认上链完成。'."\n"
- ."\n"
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Data\\": [\\n [\\n {\\n \\"chainName\\": \\"PS-**\\",\\n \\"code\\": \\"9***\\",\\n \\"blockHeight\\": \\"605350\\",\\n \\"businessId\\": \\"129297272256****\\",\\n \\"totalCount\\": \\"2\\",\\n \\"value\\": \\"某公司业务数据。\\",\\n \\"transactionHash\\": \\"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****\\",\\n \\"seq\\": \\"1\\",\\n \\"timestamp\\": \\"1608005018000\\"\\n },\\n {\\n \\"chainName\\": \\"PS-**\\",\\n \\"code\\": \\"9***\\",\\n \\"blockHeight\\": \\"605349\\",\\n \\"businessId\\": \\"129297272258****\\",\\n \\"totalCount\\": \\"2\\",\\n \\"value\\": \\"某公司业务数据。\\",\\n \\"transactionHash\\": \\"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****\\",\\n \\"seq\\": \\"2\\",\\n \\"timestamp\\": \\"1608003040000\\"\\n }\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHistoryDataListResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <Data>[{\\"chainName\\":\\"PS-**\\",\\"code\\":\\"9***\\",\\"blockHeight\\":\\"605350\\",\\"businessId\\":\\"129297272256****\\",\\"totalCount\\":\\"2\\",\\"value\\":\\"某公司业务数据。\\",\\"transactionHash\\":\\"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****\\",\\"seq\\":\\"1\\",\\"timestamp\\":\\"1608005018000\\"},{\\"chainName\\":\\"PS-**\\",\\"code\\":\\"9***\\",\\"blockHeight\\":\\"605349\\",\\"businessId\\":\\"129297272258****\\",\\"totalCount\\":\\"2\\",\\"value\\":\\"某公司业务数据。\\",\\"transactionHash\\":\\"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****\\",\\"seq\\":\\"2\\",\\"timestamp\\":\\"1608003040000\\"}]</Data>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetHistoryDataListResponse>","errorExample":""}]',
+ 'title' => '查询历史数据列表',
+ 'summary' => '历史数据查询,该API用于从 IoT区块链可信应用系统查询历史数据 。',
+ 'description' => '1. 当传递时间参数时开始时间和结束时间,最大查询区间为 30天 。'."\n"
+ .'2. 当未传递时间参数时,限制数据量最大为500条,如超过该条数限制需添加时间戳参数方式查询。'."\n"
+ ."\n\n"
.'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -4157,70 +1916,29 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'SetData' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDependentDataModels' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Key',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b',
- ],
- ],
- [
- 'name' => 'Value',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据Value。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司某业务数据。',
- ],
+ 'schema' => ['description' => 'api版本号,"1.0.0"。', 'type' => 'string', 'required' => false, 'example' => '1.0.0'],
],
[
'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWz******g',
- ],
+ 'schema' => ['description' => '产品的ProductKey。', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWzwcM****'],
],
],
'responses' => [
@@ -4228,188 +1946,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '响应状态描述。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'RequestID-1638239980855'],
+ 'Success' => ['description' => '是否成功。-**true**:表示是。-**false**:表示否。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DataModelInfo' => [
+ 'description' => '响应内容。',
+ 'example' => '{}',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataModelName' => ['description' => '数据模型名称', 'type' => 'string', 'example' => '测算模型'],
+ 'DataModelCode' => ['description' => '数据模型编码', 'type' => 'string', 'example' => 'KI8D'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetDataResponse>","errorExample":""}]',
- 'title' => '数据上传',
- 'summary' => '数据上传,该API用于向LTL上传数据。',
- 'description' => '调用成功后,系统会进行异步处理,稍后需使用[GetData](~~195376~~)查询数据,进行确认。'."\n"
- ."\n"
- .'**可访问账号:**'."\n"
- .'| 业务管理方 | 业务使用方 |'."\n"
- .'| :--------: | :-----: |'."\n"
- .'| √ | √ |'."\n",
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
- ],
- 'SetDataWithSignature' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"RequestID-1638239980855\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DataModelInfo\\": [\\n {\\n \\"DataModelName\\": \\"测算模型\\",\\n \\"DataModelCode\\": \\"KI8D\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '查询自定义模型列表',
+ 'summary' => '用于查询自定义模型列表。',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => '错误码发生变更'],
],
+ ],
+ 'ListDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Key',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'Value',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Value。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司某业务数据。',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****'],
],
[
'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '00CCCC098D98F2BDD8BB****',
- ],
- ],
- [
- 'name' => 'IotIdServiceProvider',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'kKpACh5****',
- ],
- ],
- [
- 'name' => 'IotDataDigest',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT可信数据Value摘要:'."\n"
- .'1. Value数据UTF-8编码。'."\n"
- .'2. SHA256运算,结果为32字节数据。'."\n"
- .'3. 转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '31A200471049AEA3B8459455B4447D05DD1290A875A17792F71D5550F048****',
- ],
- ],
- [
- 'name' => 'IotSignature',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。使用IoT设备安全SDK进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3~2~010253040257****~1599722505821~50sZwIXt9jtTTIoGAkEs4THSyCMghVVaYO1w2AcvQf0vm51MQYt0nfHUT7jQ****',
- ],
- ],
- [
- 'name' => 'IotIdSource',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '要查询IoT设备的ID。'."\n"
+ ."\n"
+ .'> 不传则查询该IoT数据源组下的所有IoT设备。', 'type' => 'string', 'required' => false, 'example' => '183329761572****'],
],
],
'responses' => [
@@ -4417,45 +2032,51 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '授权状态。'."\n"
+ .'- **AUTHORIZED**:已授权。'."\n"
+ .'- **UNAUTHORIZED**:未授权。', 'type' => 'string', 'example' => 'AUTHORIZED'],
+ 'LastSaveTime' => ['description' => '最后存证时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1606379090866'],
+ 'DeviceId' => ['description' => '设备标识。', 'type' => 'string', 'example' => '876055554040****'],
+ 'IotId' => ['description' => 'IoT设备ID。', 'type' => 'string', 'example' => '183329761572****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDataWithSignatureResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetDataWithSignatureResponse>","errorExample":""}]',
- 'title' => '设备数据上传',
- 'summary' => '用于上传数据,并且上传的数据必须由IoT设备端进行签名。',
- 'description' => '调用成功后,系统会进行异步处理,稍后需使用[GetData](~~195376~~)查询数据,进行确认。'."\n"
- ."\n"
- .'**可访问账号:**'."\n"
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"AUTHORIZED\\",\\n \\"LastSaveTime\\": 1606379090866,\\n \\"DeviceId\\": \\"876055554040****\\",\\n \\"IotId\\": \\"183329761572****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <IotId>183329761572****</IotId>\\n <LastSaveTime>1606379090866</LastSaveTime>\\n <DeviceId>876055554040****</DeviceId>\\n </PageData>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <IotId>183329761573****</IotId>\\n <LastSaveTime>1606379090888</LastSaveTime>\\n <DeviceId>876055554041****</DeviceId>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListDeviceResponse>","errorExample":""}]',
+ 'title' => '查询设备列表',
+ 'summary' => '查询IoT数据源组下的所有设备。',
+ 'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
@@ -4463,80 +2084,46 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'BatchUploadMPCoSPhaseDigestInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDeviceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '阶段数据列表。详情请参见下表PhaseData。',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]',
- ],
+ 'schema' => ['description' => 'IoT数据源组ProductKey。'."\n"
+ ."\n"
+ .'> 不传则查询业务链下所有的IoT数据源组。', 'type' => 'string', 'required' => false, 'example' => 'hKpHMh2****'],
],
],
'responses' => [
@@ -4544,217 +2131,111 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'IoT数据源组授权状态。'."\n"
+ .'- **AUTHORIZED**:已授权。'."\n"
+ .'- **UNAUTHORIZED**:未授权。', 'type' => 'string', 'example' => 'AUTHORIZED'],
+ 'DeviceGroupId' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'example' => '577187700697****'],
+ 'ProductKey' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'example' => 'hKpHMh2****'],
+ 'Remark' => ['description' => '备注信息。', 'type' => 'string', 'example' => '某业务某设备'],
+ 'AuthorizeType' => ['description' => 'IoT数据源组授权类型。'."\n"
+ .'**ID2**:阿里云ID²认证。', 'type' => 'string', 'example' => 'ID2'],
+ 'OwnerName' => ['description' => 'IoT数据源组所属成员名称。', 'type' => 'string', 'example' => '某公司'],
+ 'OwnerUid' => ['description' => 'IoT数据源组所属成员账号UID。', 'type' => 'string', 'example' => '19720316234381****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseDigestInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseDigestInfoResponse>","errorExample":""}]',
- 'title' => '批量上传摘要数据',
- 'summary' => '批量上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
- 'description' => '**可访问账号:**'."\n"
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"AUTHORIZED\\",\\n \\"DeviceGroupId\\": \\"577187700697****\\",\\n \\"ProductKey\\": \\"hKpHMh2****\\",\\n \\"Remark\\": \\"某业务某设备\\",\\n \\"AuthorizeType\\": \\"ID2\\",\\n \\"OwnerName\\": \\"某公司\\",\\n \\"OwnerUid\\": \\"19720316234381****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <AuthorizeType>ID2</AuthorizeType>\\n <OwnerName>某公司</OwnerName>\\n <DeviceGroupId>577187700697****</DeviceGroupId>\\n <OwnerUid>19720316234381****</OwnerUid>\\n <ProductKey>hKpHMh2****</ProductKey>\\n <Remark>某业务某设备</Remark>\\n </PageData>\\n <PageData>\\n <Status>AUTHORIZED</Status>\\n <AuthorizeType>ID2</AuthorizeType>\\n <OwnerName>某公司</OwnerName>\\n <DeviceGroupId>577187700698****</DeviceGroupId>\\n <OwnerUid>19720316234386****</OwnerUid>\\n <ProductKey>hKpHMh2****</ProductKey>\\n <Remark>某业务某设备</Remark>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListDeviceGroupResponse>","errorExample":""}]',
+ 'title' => '查询数据源组列表',
+ 'summary' => '查询IoT数据源组列表'."\n"
+ .'使用方可查看自己注册的IoT数据源组'."\n"
+ .'管理方可查看项目下所有的IoT数据源组。',
+ 'description' => '1. 使用方仅可查看自行注册的IoT数据源组列表。'."\n"
+ .'2. 管理方可查看所创建所有使用方的IoT数据源组列表。'."\n"
+ ."\n"
+ .'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => '**PhaseData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
- .'|phaseData|String|是|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|阶段数据。长度要求64字节。|'."\n"
- .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
- .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
- ."\n"
- .'**relatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'BatchUploadMPCoSPhaseDigestInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListMPCoSPhase' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
- ],
- [
- 'name' => 'PhaseId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
- ],
- [
- 'name' => 'PhaseDataList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '阶段数据列表。详情请参见下表PhaseData。',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]',
- ],
- ],
- [
- 'name' => 'IotAuthType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
- ],
- [
- 'name' => 'IotId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT可信数据Value摘要:'."\n"
- .'1. Value数据UTF-8编码。'."\n"
- .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。'."\n"
- .'使用IoT设备安全SDK进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => '要查询的阶段名称。'."\n"
+ .'> 不传则查询该协同模型下所有阶段。', 'type' => 'string', 'required' => false, 'example' => '某阶段'],
],
],
'responses' => [
@@ -4762,145 +2243,99 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '阶段名称。', 'type' => 'string', 'example' => '某阶段'],
+ 'Remark' => ['description' => '阶段备注。', 'type' => 'string', 'example' => '某阶段的备注信息。'],
+ 'AccessPermission' => ['description' => '访问权限。'."\n"
+ .'- **1**:读权限。'."\n"
+ .'- **2**:写权限。'."\n"
+ .'- **3**:读写权限。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PhaseId' => ['description' => '阶段标识。', 'type' => 'string', 'example' => '196487512811****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseDigestInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseDigestInfoByDeviceResponse>","errorExample":""}]',
- 'title' => '设备批量上传摘要数据',
- 'summary' => '通过IoT设备签名后,批量上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"Name\\": \\"某阶段\\",\\n \\"Remark\\": \\"某阶段的备注信息。\\",\\n \\"AccessPermission\\": 1,\\n \\"PhaseId\\": \\"196487512811****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <AccessPermission>1</AccessPermission>\\n <PhaseId>196487512811****</PhaseId>\\n <Remark>某阶段的备注信息。</Remark>\\n <Name>某阶段</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseResponse>","errorExample":""}]',
+ 'title' => '查询阶段列表',
+ 'summary' => '查询协同模型所属的阶段列表。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => '**PhaseData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
- .'|phaseData|String|是|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|阶段数据。长度要求64字节。|'."\n"
- .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
- .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
- ."\n"
- .'**relatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'BatchUploadMPCoSPhaseTextInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListMPCoSPhaseGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '196487512811****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'Name',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '阶段数据列表。详情请参见下表PhaseData。',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]',
- ],
+ 'schema' => ['description' => '要查询的协同模型名称。'."\n"
+ ."\n"
+ .'> 若不传则查询所有协同模型。', 'type' => 'string', 'required' => false, 'example' => '某业务链'],
],
],
'responses' => [
@@ -4908,217 +2343,113 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '响应状态码。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PhaseGroupId' => ['description' => '协同模型标识。', 'type' => 'string', 'example' => '987823074334****'],
+ 'Name' => ['description' => '协同模型名称。', 'type' => 'string', 'example' => '某协同模型'],
+ 'Remark' => ['description' => '协同模型备注。', 'type' => 'string', 'example' => '某协同模型的备注信息。'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseTextInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseTextInfoResponse>","errorExample":""}]',
- 'title' => '批量上传文本数据',
- 'summary' => '批量上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"PhaseGroupId\\": \\"987823074334****\\",\\n \\"Name\\": \\"某协同模型\\",\\n \\"Remark\\": \\"某协同模型的备注信息。\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <PhaseGroupId>987823074334****</PhaseGroupId>\\n <Remark>某协同模型的备注信息。</Remark>\\n <Name>某协同模型</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseGroupResponse>","errorExample":""}]',
+ 'title' => '查询协同模型列表',
+ 'summary' => '查询业务链所属的协同模型列表。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => '**PhaseData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
- .'|phaseData|String|是|某公司某业务数据|阶段数据。长度要求1~4096字节,一个中文字符占两位字符。|'."\n"
- .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
- .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
- ."\n"
- .'**relatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'BatchUploadMPCoSPhaseTextInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListMPCoSPhaseHistory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'BizChainId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'PhaseGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'Size',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '阶段数据列表。详情请参见下表PhaseData。',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"dataKey":"987823074334****","phaseData":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","dataSeq":"某公司某业务数据。","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'IotId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT可信数据Value摘要:'."\n"
- .'1. Value数据UTF-8编码。'."\n"
- .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => '开始时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1606379090866'],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。'."\n"
- .'使用IoT设备安全SDK进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => '结束时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1606389090866'],
],
],
'responses' => [
@@ -5126,176 +2457,198 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductKey' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'example' => 'hfoi7GQ****'],
+ 'PreviousHash' => ['description' => '前一区块摘要。', 'type' => 'string', 'example' => '2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****'],
+ 'DataHash' => ['description' => '数据摘要。', 'type' => 'string', 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****'],
+ 'DataSeq' => ['description' => '数据序列号。', 'type' => 'string', 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
+ 'DataValue' => ['description' => '上链值。', 'type' => 'string', 'example' => '某公司业务数据。'],
+ 'Timestamp' => ['description' => '上链时间。毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1606389620000'],
+ 'TransactionHash' => ['description' => '交易摘要。', 'type' => 'string', 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****'],
+ 'BlockHash' => ['description' => '区块摘要。', 'type' => 'string', 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****'],
+ 'BlockNumber' => ['description' => '区块高度。', 'type' => 'integer', 'format' => 'int64', 'example' => '9852'],
+ 'IotId' => ['description' => 'IoT设备ID。', 'type' => 'string', 'example' => 'DFA7B98AD494FB98A491****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchUploadMPCoSPhaseTextInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchUploadMPCoSPhaseTextInfoByDeviceResponse>","errorExample":""}]',
- 'title' => '设备批量上传文本数据',
- 'summary' => '通过IoT设备签名后,批量上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"ProductKey\\": \\"hfoi7GQ****\\",\\n \\"PreviousHash\\": \\"2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****\\",\\n \\"DataHash\\": \\"9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****\\",\\n \\"DataSeq\\": \\"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****\\",\\n \\"DataValue\\": \\"某公司业务数据。\\",\\n \\"Timestamp\\": 1606389620000,\\n \\"TransactionHash\\": \\"bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****\\",\\n \\"BlockHash\\": \\"5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****\\",\\n \\"BlockNumber\\": 9852,\\n \\"IotId\\": \\"DFA7B98AD494FB98A491****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMPCoSPhaseHistoryResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <IotId>DFA7B98AD494FB98A492****</IotId>\\n <DataValue>某公司业务数据。</DataValue>\\n <BlockHash>5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c5****</BlockHash>\\n <DataSeq>be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a6****</DataSeq>\\n <TransactionHash>bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb2764****</TransactionHash>\\n <PreviousHash>2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f77****</PreviousHash>\\n <BlockNumber>9852</BlockNumber>\\n <Timestamp>1606389620000</Timestamp>\\n <ProductKey>hfoi7G7****</ProductKey>\\n <DataHash>9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e978****</DataHash>\\n </PageData>\\n <PageData>\\n <IotId>DFA7B98AD494FB98A491****</IotId>\\n <DataValue>某公司业务数据。</DataValue>\\n <BlockHash>5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****</BlockHash>\\n <DataSeq>be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****</DataSeq>\\n <TransactionHash>bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****</TransactionHash>\\n <PreviousHash>2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****</PreviousHash>\\n <BlockNumber>9852</BlockNumber>\\n <Timestamp>1606389630000</Timestamp>\\n <ProductKey>hfoi7GQ****</ProductKey>\\n <DataHash>9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****</DataHash>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMPCoSPhaseHistoryResponse>","errorExample":""}]',
+ 'title' => '查询历史数据列表',
+ 'summary' => '通过阶段标识,数据唯一标识,起始时间,结束时间,查询数据列表。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => '**PhaseData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|dataKey|String|是|987823074334****|数据唯一标识。|'."\n"
- .'|phaseData|String|是|某公司某业务数据|阶段数据。|阶段数据。长度要求1~4096字节,一个中文字符占两位字符。|'."\n"
- .'|dataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|数据序列号。|'."\n"
- .'|relatedDataList|List|否|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|关联数据列表。详情请参见下表relatedData。|'."\n"
- ."\n"
- .'**relatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UploadMPCoSPhaseDigestInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511***',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DataKey',
+ 'name' => 'MemberUid',
'in' => 'query',
+ 'schema' => ['description' => '要查询阿里云RAM用户的UID。'."\n"
+ .'> 不传则查询业务链下所有的阿里云RAM用户。', 'type' => 'string', 'required' => false, 'example' => '19720316234381****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '账号锁定状态:'."\n"
+ .'- **UNLOCK**:未锁定。'."\n"
+ .'- **LOCK**:已锁定。', 'type' => 'string', 'example' => 'UNLOCK'],
+ 'MemberName' => ['description' => '账户名称。', 'type' => 'string', 'example' => '某公司'],
+ 'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => '某应用某业务'],
+ 'MemberUid' => ['description' => '阿里云RAM用户UID。', 'type' => 'string', 'example' => '19720316234381****'],
+ 'MemberPhone' => ['description' => '账户电话。', 'type' => 'string', 'example' => '1381111****'],
+ 'MemberId' => ['description' => '账户标识。', 'type' => 'string', 'example' => '717534457003****'],
+ 'MemberContact' => ['description' => '账户联系人。', 'type' => 'string', 'example' => '张三'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 30,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Status\\": \\"UNLOCK\\",\\n \\"MemberName\\": \\"某公司\\",\\n \\"Remark\\": \\"某应用某业务\\",\\n \\"MemberUid\\": \\"19720316234381****\\",\\n \\"MemberPhone\\": \\"1381111****\\",\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"MemberContact\\": \\"张三\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <Status>UNLOCK</Status>\\n <MemberId>717534457003****</MemberId>\\n <MemberContact>张三</MemberContact>\\n <MemberUid>19720316234381****</MemberUid>\\n <MemberPhone>1381111****</MemberPhone>\\n <MemberName>某公司</MemberName>\\n <Remark>某应用某业务</Remark>\\n </PageData>\\n <PageData>\\n <Status>UNLOCK</Status>\\n <MemberId>717534457003****</MemberId>\\n <MemberContact>张三</MemberContact>\\n <MemberUid>19720316234381****</MemberUid>\\n <MemberPhone>1381111****</MemberPhone>\\n <MemberName>某公司</MemberName>\\n <Remark>某应用某业务</Remark>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>30</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMemberResponse>","errorExample":""}]',
+ 'title' => '查询使用方列表',
+ 'summary' => '查询使用方账户列表。',
+ 'description' => '**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'ListMultiPartyCollaborationChain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DataSeq',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段数据的SHA256摘要值,要求长度为64字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dee68c73bdead5f717fc25803236924c165d0a3c1728aa58cbf05b1473c2****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'Size',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '关联数据列表。详情请参见下表RelatedData。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '要查询的业务链名称。'."\n"
+ ."\n"
+ .'> 不传则查询所有业务链。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某业务链'],
],
],
'responses' => [
@@ -5303,240 +2656,189 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '业务链名称。', 'type' => 'string', 'example' => '某业务链'],
+ 'Remark' => ['description' => '业务链备注。', 'type' => 'string', 'example' => '某业务某服务'],
+ 'RoleType' => ['description' => '账号角色。'."\n"
+ .'- **ADMIN**:业务管理方。'."\n"
+ .'- **MEMBER**:业务使用方。', 'type' => 'string', 'example' => 'ADMIN'],
+ 'BizChainId' => ['description' => '业务链标识。', 'type' => 'string', 'example' => '489973087549****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseDigestInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseDigestInfoResponse>","errorExample":""}]',
- 'title' => '摘要数据上传',
- 'summary' => '上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"Name\\": \\"某业务链\\",\\n \\"Remark\\": \\"某业务某服务\\",\\n \\"RoleType\\": \\"ADMIN\\",\\n \\"BizChainId\\": \\"489973087549****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMultiPartyCollaborationChainResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <BizChainId>489973087549****</BizChainId>\\n <RoleType>ADMIN</RoleType>\\n <Remark>某业务某服务</Remark>\\n <Name>某业务链</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMultiPartyCollaborationChainResponse>","errorExample":""}]',
+ 'title' => '查询多方任务协同业务链列表',
+ 'summary' => '用于查询多方任务协同业务链列表。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => '**RelatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UploadMPCoSPhaseDigestInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPSMemberDataTypeCode' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'BizChainId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'DataKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
- ],
- [
- 'name' => 'DataSeq',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段数据的SHA256摘要值,要求长度为64字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ebf44d78ae75288d7d0057a5ebf44d78a6b86d04502dcbda643c4d24ff2a****',
- ],
+ 'schema' => ['description' => '要查询的阿里云RAM用户UID。'."\n"
+ .'> 不传则查询所有阿里云RAM用户UID。', 'type' => 'string', 'required' => false, 'example' => '19720316234381****'],
],
- [
- 'name' => 'RelatedDataList',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '关联数据列表。详情请参见下表RelatedData。',
'type' => 'object',
- 'required' => false,
- 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]',
+ 'properties' => [
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MemberId' => ['description' => '账户标识。', 'type' => 'string', 'example' => '717534457003****'],
+ 'DataTypeCode' => ['description' => '存证类型编码。', 'type' => 'string', 'example' => 'E***'],
+ 'MemberName' => ['description' => '账户名称。', 'type' => 'string', 'example' => '某某公司账户'],
+ 'MemberUid' => ['description' => '阿里云RAM用户UID。', 'type' => 'string', 'example' => '19720316234381****'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
- [
- 'name' => 'IotAuthType',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"DataTypeCode\\": \\"E***\\",\\n \\"MemberName\\": \\"某某公司账户\\",\\n \\"MemberUid\\": \\"19720316234381****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListPSMemberDataTypeCodeResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <MemberId>717534457003****</MemberId>\\n <MemberName>某某公司账户</MemberName>\\n <MemberUid>19720316234381****</MemberUid>\\n <DataTypeCode>E***</DataTypeCode>\\n </PageData>\\n <PageData>\\n <MemberId>717534457005****</MemberId>\\n <MemberName>某公司账户</MemberName>\\n <MemberUid>19720316234382****</MemberUid>\\n <DataTypeCode>D***</DataTypeCode>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListPSMemberDataTypeCodeResponse>","errorExample":""}]',
+ 'title' => '查询接入方类型编码',
+ 'summary' => '查询接入方账号下存证类型编码。',
+ 'description' => '**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'ListProofChain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'IotIdSource',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => '指定显示返回结果中的第几页,最小取值是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT可信数据Value摘要。'."\n"
- .'1. Value数据UTF-8编码。'."\n"
- .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => '指定返回结果中每页显示的记录数量,最大值是100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2'],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。'."\n"
- .'使用IoT设备安全SDK进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => '要查询的业务链名称。'."\n"
+ ."\n"
+ .'> 不传则查询所有存证服务业务链。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某业务链'],
],
],
'responses' => [
@@ -5544,73 +2846,65 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '响应内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Size' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'PageData' => [
+ 'description' => '数据项。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Remark' => ['description' => '业务链备注。', 'type' => 'string', 'example' => '某业务链的备注信息。'],
+ 'BizChainId' => ['description' => '业务链标识。', 'type' => 'string', 'example' => '489973087549****'],
+ 'RoleType' => ['description' => '账号角色。'."\n"
+ .'- **ADMIN**:业务管理方。'."\n"
+ .'- **MEMBER**:业务使用方。', 'type' => 'string', 'example' => 'ADMIN'],
+ 'BizChainCode' => ['description' => '业务链编码。', 'type' => 'string', 'example' => 'SA7z9XkBMVPg****'],
+ 'Name' => ['description' => '业务链名称。', 'type' => 'string', 'example' => '某业务链'],
+ 'DataTypeCode' => ['description' => '类型编码。', 'type' => 'string', 'example' => 'B***'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseDigestInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseDigestInfoByDeviceResponse>","errorExample":""}]',
- 'title' => '设备摘要数据上传',
- 'summary' => '通过IoT设备签名后,上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Remark\\": \\"某业务链的备注信息。\\",\\n \\"BizChainId\\": \\"489973087549****\\",\\n \\"RoleType\\": \\"ADMIN\\",\\n \\"BizChainCode\\": \\"SA7z9XkBMVPg****\\",\\n \\"Name\\": \\"某业务链\\",\\n \\"DataTypeCode\\": \\"B***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListProofChainResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <RoleType>ADMIN</RoleType>\\n <BizChainId>489973087549****</BizChainId>\\n <DataTypeCode>B***</DataTypeCode>\\n <BizChainCode>SA7z9XkBMVPg****</BizChainCode>\\n <Remark>某业务链的备注信息。</Remark>\\n <Name>某业务链</Name>\\n </PageData>\\n <PageData>\\n <RoleType>ADMIN</RoleType>\\n <BizChainId>489973087550****</BizChainId>\\n <DataTypeCode>C***</DataTypeCode>\\n <BizChainCode>SA7z9XkBMVPj****</BizChainCode>\\n <Remark>某某业务链的备注信息。</Remark>\\n <Name>某某业务链</Name>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListProofChainResponse>","errorExample":""}]',
+ 'title' => '查询存证与溯源业务链列表',
+ 'summary' => '用于查询存证与溯源业务链列表。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => ' **RelatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UploadMPCoSPhaseTextInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'LockMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5618,94 +2912,95 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'MemberId',
'in' => 'query',
+ 'schema' => ['description' => '账户标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<LockMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</LockMemberResponse>","errorExample":""}]',
+ 'title' => '锁定使用方账户',
+ 'summary' => '锁定使用方账户,锁定账户后则账户不能访问当前区块链。',
+ 'description' => '**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'ModifyMPCoSPhase' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'PhaseId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '196487512811****',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'DataKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DataSeq',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => '阶段名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某阶段'],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段数据。长度要求1~4096字节,一个中文字符占两位字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => '备注信息。长度限制为100字符。', 'type' => 'string', 'required' => false, 'example' => '某阶段的备注信息。'],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '关联数据列表。详情请参见下表RelatedData。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq ":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****'],
],
],
'responses' => [
@@ -5713,73 +3008,39 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseTextInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseTextInfoResponse>","errorExample":""}]',
- 'title' => '文本数据上传',
- 'summary' => '上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMPCoSPhaseResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMPCoSPhaseResponse>","errorExample":""}]',
+ 'title' => '修改阶段',
+ 'summary' => '在协同模型中修改阶段信息。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |'."\n",
- 'requestParamsDescription' => '**RelatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'UploadMPCoSPhaseTextInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ModifyMPCoSPhaseGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5787,166 +3048,125 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '协同模型名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某协同模型'],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '协同模型标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => '备注信息。长度限制为100字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某协同模型备注。'],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
],
[
- 'name' => 'DataKey',
+ 'name' => 'BizChainId',
'in' => 'query',
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '数据唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMPCoSPhaseGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMPCoSPhaseGroupResponse>","errorExample":""}]',
+ 'title' => '修改数据模型',
+ 'summary' => '修改协同模型信息。',
+ 'description' => '**可访问账号:**'."\n"
+ .'| 业务管理方 | 业务使用方 |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'ModifyMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DataSeq',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据序列号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'PhaseData',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '阶段数据。长度要求1~4096字节,一个中文字符占两位字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '某公司某业务数据。',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '关联数据列表。详情请参见下表RelatedData。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT认证方式。'."\n"
- .'**ID2**:阿里云Link ID²。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => '阿里云RAM用户UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '19720316234381****'],
],
[
- 'name' => 'IotId',
+ 'name' => 'MemberName',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => '账户名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司'],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'MemberContact',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方。'."\n"
- .'- **1**:开放平台。'."\n"
- .'- **2**:物联网平台。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '账户联系人。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三'],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'MemberPhone',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备服务提供方标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => '账户联系电话。'."\n"
+ .'长度限制为20字符,可以包含数字和横线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1381111****'],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT可信数据Value摘要:'."\n"
- .'1:Value数据UTF-8编码。'."\n"
- .'2:SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => '备注。'."\n"
+ .'长度限制为100字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某应用某业务'],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT设备数据签名。'."\n"
- .'使用IoT设备安全SDK进行签名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => '账户标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****'],
],
],
'responses' => [
@@ -5954,105 +3174,79 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '多余参数,请忽略。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseTextInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseTextInfoByDeviceResponse>","errorExample":""}]',
- 'title' => '设备文本数据上传',
- 'summary' => '通过IoT设备签名后,上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyMemberResponse>","errorExample":""}]',
+ 'title' => '修改使用方',
+ 'summary' => '修改账户信息。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
- 'requestParamsDescription' => ' **RelatedData**'."\n"
- .'|参数|类型|是否必选|示例值|描述|'."\n"
- .'|-|-|-|-|-|'."\n"
- .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。|'."\n"
- .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
- .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
- .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
+ .'| √ | × |',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'DescribeCapacityInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RegisterDeviceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '981184817831****'],
+ ],
+ [
+ 'name' => 'DeviceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT数据源组名称。'."\n"
+ .'长度为2~30字符,可以包含中文、英文字母、数字、下划线(_)、横线(-)、英文句号(.)和圆括号(())。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某数据源组'],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT数据源组ProductKey。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hKpHMh2****'],
+ ],
+ [
+ 'name' => 'AuthorizeType',
+ 'in' => 'query',
+ 'schema' => ['description' => '授权类型。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '备注信息。长度限制为100字符。', 'type' => 'string', 'required' => false, 'example' => '某数据源组的备注信息。'],
],
],
'responses' => [
@@ -6060,86 +3254,26 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'CountQuota' => [
- 'description' => '该业务链的条数配额。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000000',
- ],
- 'CapacityQuota' => [
- 'description' => '该业务链的容量配额(单位:字节)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '800000000000',
- ],
- 'UsedCount' => [
- 'description' => '该业务链已使用条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30000',
- ],
- 'UsedCapacity' => [
- 'description' => '该业务链已使用容量(单位:字节)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '870000000',
- ],
- 'MemberUsedCapacity' => [
- 'description' => '当前用户在该业务链已使用的容量(单位:字节)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '70000000',
- ],
- 'MemberUsedCount' => [
- 'description' => '当前用户该业务链已使用的条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '26666',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'example' => '256399502929****'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CountQuota\\": 10000000,\\n \\"CapacityQuota\\": 800000000000,\\n \\"UsedCount\\": 30000,\\n \\"UsedCapacity\\": 870000000,\\n \\"MemberUsedCapacity\\": 70000000,\\n \\"MemberUsedCount\\": 26666\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCapacityInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <CountQuota>10000000</CountQuota>\\n <MemberUsedCapacity>70000000</MemberUsedCapacity>\\n <CapacityQuota>800000000000</CapacityQuota>\\n <UsedCapacity>870000000</UsedCapacity>\\n <UsedCount>30000</UsedCount>\\n <MemberUsedCount>26666</MemberUsedCount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeCapacityInfoResponse>","errorExample":""}]',
- 'title' => '查询容量统计信息',
- 'summary' => '查询资源容量统计信息。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"256399502929****\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RegisterDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>256399502929****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RegisterDeviceGroupResponse>","errorExample":""}]',
+ 'title' => '注册数据源组',
+ 'summary' => '注册IoT数据源组。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
@@ -6148,48 +3282,39 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'DescribeMemberCapacityInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SetData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b'],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据Value。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。'],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWz******g'],
],
],
'responses' => [
@@ -6197,128 +3322,101 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UsedCapacity' => [
- 'description' => '用户已使用该业务链容量(单位:字节)。',
- 'type' => 'string',
- 'example' => '70000000',
- ],
- 'MemberId' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'example' => '717534457003****',
- ],
- 'MemberName' => [
- 'description' => '账户名称。',
- 'type' => 'string',
- 'example' => '张三',
- ],
- 'UsedCount' => [
- 'description' => '用户已使用该业务链条数。',
- 'type' => 'string',
- 'example' => '26666',
- ],
- 'MemberUid' => [
- 'description' => '阿里云RAM用户UID。',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"UsedCapacity\\": \\"70000000\\",\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"MemberName\\": \\"张三\\",\\n \\"UsedCount\\": \\"26666\\",\\n \\"MemberUid\\": \\"19720316234381****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMemberCapacityInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <MemberId>717534457003****</MemberId>\\n <UsedCapacity>70000000</UsedCapacity>\\n <MemberName>张三</MemberName>\\n <MemberUid>19720316234381****</MemberUid>\\n <UsedCount>26666</UsedCount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMemberCapacityInfoResponse>","errorExample":""}]',
- 'title' => '查询使用方容量信息',
- 'summary' => '查询使用方容量统计信息。',
- 'description' => '**可访问账号:**'."\n"
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetDataResponse>","errorExample":""}]',
+ 'title' => '数据上传',
+ 'summary' => '数据上传,该API用于向LTL上传数据。',
+ 'description' => '调用成功后,系统会进行异步处理,稍后需使用[GetData](~~195376~~)查询数据,进行确认。'."\n"
+ ."\n"
+ .'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
+ .'| √ | √ |'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'DescribeResourceInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SetDataWithSignature' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '数据Key唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97bd45c71a509d****'],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据Value。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。'],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务链编码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****'],
+ ],
+ [
+ 'name' => 'IotAuthType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
+ ],
+ [
+ 'name' => 'IotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '00CCCC098D98F2BDD8BB****'],
+ ],
+ [
+ 'name' => 'IotIdServiceProvider',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'kKpACh5****'],
+ ],
+ [
+ 'name' => 'IotDataDigest',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT可信数据Value摘要:'."\n"
+ .'1. Value数据UTF-8编码。'."\n"
+ .'2. SHA256运算,结果为32字节数据。'."\n"
+ .'3. 转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '31A200471049AEA3B8459455B4447D05DD1290A875A17792F71D5550F048****'],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备数据签名。使用IoT设备安全SDK进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3~2~010253040257****~1599722505821~50sZwIXt9jtTTIoGAkEs4THSyCMghVVaYO1w2AcvQf0vm51MQYt0nfHUT7jQ****'],
+ ],
+ [
+ 'name' => 'IotIdSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
],
],
'responses' => [
@@ -6326,82 +3424,25 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '业务链状态。'."\n"
- .'- **NORMAL**:正常。'."\n"
- .'- **EXPIRED**:已过期。',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'EffectiveTime' => [
- 'description' => '开通时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1586125838680',
- ],
- 'AuthorizeType' => [
- 'description' => '授权类型。'."\n"
- .'- **企业版**:企业版套餐。'."\n"
- .'- **标准版**:标准版套餐。',
- 'type' => 'string',
- 'example' => '标准版',
- ],
- 'ExpiredTime' => [
- 'description' => '到期时间。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666125838680',
- ],
- 'Region' => [
- 'description' => '地域。',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"EffectiveTime\\": 1586125838680,\\n \\"AuthorizeType\\": \\"标准版\\",\\n \\"ExpiredTime\\": 1666125838680,\\n \\"Region\\": \\"cn-shanghai\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourceInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <Status>NORMAL</Status>\\n <AuthorizeType>标准版</AuthorizeType>\\n <EffectiveTime>1586125838680</EffectiveTime>\\n <ExpiredTime>1666125838680</ExpiredTime>\\n <Region>cn-shanghai</Region>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeResourceInfoResponse>","errorExample":""}]',
- 'title' => '查询资源信息',
- 'summary' => '查询资源开通信息。',
- 'description' => '**可访问账号:**'."\n"
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDataWithSignatureResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetDataWithSignatureResponse>","errorExample":""}]',
+ 'title' => '设备数据上传',
+ 'summary' => '用于上传数据,并且上传的数据必须由IoT设备端进行签名。',
+ 'description' => '调用成功后,系统会进行异步处理,稍后需使用[GetData](~~195376~~)查询数据,进行确认。'."\n"
+ ."\n"
+ .'**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
@@ -6409,70 +3450,39 @@
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'GetBlockChainInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UnAuthorizeDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'DeviceId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '设备标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '654887879557****'],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
- .'2. 如果不包含该参数,则返回当前Key最新数据。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****'],
],
],
'responses' => [
@@ -6480,126 +3490,62 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误消息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '返回唯一标识key对应的区块链元数据信息(JSON格式)。详情请参见下表blockChainInfo。',
- 'type' => 'string',
- 'example' => '{"blockChainInfo":{"chainName":"某公司业务链","blockHeight":48971,"transactionHash":"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****","iotId":"1BE0F46275B17147E7D2****","endorsementNames":"某公司,某某公司","timestamp":"1591676312000","blockHash":"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****","previousHash":"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****","dataHash":"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****"}}',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"{\\\\\\"blockChainInfo\\\\\\":{\\\\\\"chainName\\\\\\":\\\\\\"某公司业务链\\\\\\",\\\\\\"blockHeight\\\\\\":48971,\\\\\\"transactionHash\\\\\\":\\\\\\"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****\\\\\\",\\\\\\"iotId\\\\\\":\\\\\\"1BE0F46275B17147E7D2****\\\\\\",\\\\\\"endorsementNames\\\\\\":\\\\\\"某公司,某某公司\\\\\\",\\\\\\"timestamp\\\\\\":\\\\\\"1591676312000\\\\\\",\\\\\\"blockHash\\\\\\":\\\\\\"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****\\\\\\",\\\\\\"previousHash\\\\\\":\\\\\\"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****\\\\\\",\\\\\\"dataHash\\\\\\":\\\\\\"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****\\\\\\"}}\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetBlockChainInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>{\\"blockChainInfo\\":{\\"chainName\\":\\"某公司业务链\\",\\"blockHeight\\":48971,\\"transactionHash\\":\\"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****\\",\\"iotId\\":\\"1BE0F46275B17147E7D2****\\",\\"endorsementNames\\":\\"某公司,某某公司\\",\\"timestamp\\":\\"1591676312000\\",\\"blockHash\\":\\"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****\\",\\"previousHash\\":\\"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****\\",\\"dataHash\\":\\"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****\\"}}</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetBlockChainInfoResponse>","errorExample":""}]',
- 'title' => '查询数据区块链元信息',
- 'summary' => '用于查询上传数据的区块链元信息。',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnAuthorizeDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnAuthorizeDeviceResponse>","errorExample":""}]',
+ 'title' => '设备取消授权',
+ 'summary' => '取消指定设备接入区块链权限。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
+ .'| √ | × |',
'requestParamsDescription' => ' ',
- 'responseParamsDescription' => '**blockChainInfo**'."\n"
- .'|参数|类型|示例值|描述|'."\n"
- .'|-|-|-|-|'."\n"
- .'|chainName|String|某公司业务链|存储区块链名称。|'."\n"
- .'|blockHeight|Long|48971|区块链存证区块号。|'."\n"
- .'|transactionHash|String|ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20f********|交易哈希。|'."\n"
- .'|iotId|String|1BE0F46275B17147E7D2****|IoT设备ID。|'."\n"
- .'|endorsementNames|String|某公司,某某公司|区块链背书节点名称。|'."\n"
- .'|timestamp|String|1591676312000|存证时间。毫秒级时间戳。|'."\n"
- .'|blockHash|String|d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e********|区块哈希。|'."\n"
- .'|previousHash|String|c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4********|上一区块哈希。|'."\n"
- .'|dataHash|String|21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e********|数据哈希。|',
+ 'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
- .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ .'错误码详细信息,请参见错误码[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'GetData' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UnAuthorizeDeviceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Key',
- 'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzw******',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '1. 用户业务ID,同一个Key,业务ID必须唯一。格式为64字符,合法字符范围\\[0-9,a-f,A-F\\]。'."\n"
- .'2. 如果不包含该参数,则返回当前Key最新数据。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => 'IoT数据源组标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****'],
],
],
'responses' => [
@@ -6607,101 +3553,62 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '返回数据Key对应的Value数据。',
- 'type' => 'string',
- 'example' => '某业务数据。',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"某业务数据。\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDataResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>某业务数据。</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetDataResponse>","errorExample":""}]',
- 'title' => '查询数据',
- 'summary' => '用于确认之前上传的数据已处理成功。',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnAuthorizeDeviceGroupResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnAuthorizeDeviceGroupResponse>","errorExample":""}]',
+ 'title' => '数据源组取消授权',
+ 'summary' => '取消指定IoT数据源组下的设备接入区块链的权限。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
+ .'| √ | × |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'GetDataModelConfigInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UnLockMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'api版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => 'IoT数据源组ProductKey。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'DataModelCode',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据模型编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DF3K',
- ],
+ 'schema' => ['description' => '账户标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****'],
],
],
'responses' => [
@@ -6709,49 +3616,35 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误消息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'RequestID-1638240165139',
- ],
- 'Success' => [
- 'description' => '是否调用成功。-**true**:调用成功,但不代表调用的服务器端口和协议不存在。-**false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"{}\\",\\n \\"RequestId\\": \\"RequestID-1638240165139\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询模型配置',
- 'summary' => '用户查询自定义数据模型配置信息。',
- ],
- 'GetHistoryDataCount' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnLockMemberResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UnLockMemberResponse>","errorExample":""}]',
+ 'title' => '解锁使用方',
+ 'summary' => '解锁使用方账户,解锁后账户可访问区块链。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## 错误码'."\n"
+ .'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
+ ],
+ 'UpdateMPCoSAuthorizedInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6759,68 +3652,33 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '账户标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'AuthorizedPhaseList',
'in' => 'query',
- 'schema' => [
- 'description' => '起始时间戳。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608010000000',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '授权阶段标识列表。', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '["196487512811****","196487512812****"]'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间戳。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608019800000',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
],
'responses' => [
@@ -6828,159 +3686,88 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'Data' => [
- 'description' => '返回Key对应的记录条数。',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"10\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHistoryDataCountResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>10</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetHistoryDataCountResponse>","errorExample":""}]',
- 'title' => '查询历史数据条数',
- 'summary' => '历史数据数量查询,该API用于从 IoT区块链可信应用系统查询历史数据条数 。',
- 'description' => '> 若不传时间戳,则返回所有历史数据的数量。'."\n"
- ."\n"
- .'**可访问账号:**'."\n"
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateMPCoSAuthorizedInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateMPCoSAuthorizedInfoResponse>","errorExample":""}]',
+ 'title' => '更新使用方权限',
+ 'summary' => '更新账户在协同模型中的权限信息。',
+ 'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
+ .'| √ | × |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'GetHistoryDataList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadMPCoSPhaseDigestInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '数据Key唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '10000000',
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511***'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '起始时间戳。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608010000000',
- ],
+ 'schema' => ['description' => '数据序列号。', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'PhaseData',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间戳。毫秒级时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608019800000',
- ],
+ 'schema' => ['description' => '阶段数据的SHA256摘要值,要求长度为64字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dee68c73bdead5f717fc25803236924c165d0a3c1728aa58cbf05b1473c2****'],
+ ],
+ [
+ 'name' => 'RelatedDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '关联数据列表。详情请参见下表RelatedData。', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]'],
],
],
'responses' => [
@@ -6988,235 +3775,130 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '返回Key对应的所有Value数据列表(JSON格式)。',
- 'type' => 'object',
- 'example' => '[{"chainName":"PS-**","code":"9***","blockHeight":"605350","businessId":"129297272256****","totalCount":"2","value":"某公司业务数据。","transactionHash":"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****","seq":"1","timestamp":"1608005018000"},{"chainName":"PS-**","code":"9***","blockHeight":"605349","businessId":"129297272258****","totalCount":"2","value":"某公司业务数据。","transactionHash":"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****","seq":"2","timestamp":"1608003040000"}]',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Data\\": [\\n \\"[{\\\\\\"chainName\\\\\\":\\\\\\"PS-**\\\\\\",\\\\\\"code\\\\\\":\\\\\\"9***\\\\\\",\\\\\\"blockHeight\\\\\\":\\\\\\"605350\\\\\\",\\\\\\"businessId\\\\\\":\\\\\\"129297272256****\\\\\\",\\\\\\"totalCount\\\\\\":\\\\\\"2\\\\\\",\\\\\\"value\\\\\\":\\\\\\"某公司业务数据。\\\\\\",\\\\\\"transactionHash\\\\\\":\\\\\\"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****\\\\\\",\\\\\\"seq\\\\\\":\\\\\\"1\\\\\\",\\\\\\"timestamp\\\\\\":\\\\\\"1608005018000\\\\\\"},{\\\\\\"chainName\\\\\\":\\\\\\"PS-**\\\\\\",\\\\\\"code\\\\\\":\\\\\\"9***\\\\\\",\\\\\\"blockHeight\\\\\\":\\\\\\"605349\\\\\\",\\\\\\"businessId\\\\\\":\\\\\\"129297272258****\\\\\\",\\\\\\"totalCount\\\\\\":\\\\\\"2\\\\\\",\\\\\\"value\\\\\\":\\\\\\"某公司业务数据。\\\\\\",\\\\\\"transactionHash\\\\\\":\\\\\\"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****\\\\\\",\\\\\\"seq\\\\\\":\\\\\\"2\\\\\\",\\\\\\"timestamp\\\\\\":\\\\\\"1608003040000\\\\\\"}]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHistoryDataListResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <Data>[{\\"chainName\\":\\"PS-**\\",\\"code\\":\\"9***\\",\\"blockHeight\\":\\"605350\\",\\"businessId\\":\\"129297272256****\\",\\"totalCount\\":\\"2\\",\\"value\\":\\"某公司业务数据。\\",\\"transactionHash\\":\\"ba2fe24cbe23816bdbb18ad037dd5e5f58468cb3ad345e456d106308ed37****\\",\\"seq\\":\\"1\\",\\"timestamp\\":\\"1608005018000\\"},{\\"chainName\\":\\"PS-**\\",\\"code\\":\\"9***\\",\\"blockHeight\\":\\"605349\\",\\"businessId\\":\\"129297272258****\\",\\"totalCount\\":\\"2\\",\\"value\\":\\"某公司业务数据。\\",\\"transactionHash\\":\\"18440d577e7d77a5d423eee4495902fb29073a904786ee01babc869815c9****\\",\\"seq\\":\\"2\\",\\"timestamp\\":\\"1608003040000\\"}]</Data>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetHistoryDataListResponse>","errorExample":""}]',
- 'title' => '查询历史数据列表',
- 'summary' => '历史数据查询,该API用于从 IoT区块链可信应用系统查询历史数据 。',
- 'description' => '1. 当传递时间参数时开始时间和结束时间,最大查询区间为 30天 。'."\n"
- .'2. 当未传递时间参数时,限制数据量最大为500条,如超过该条数限制需添加时间戳参数方式查询。'."\n"
- ."\n\n"
- .'**可访问账号:**'."\n"
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseDigestInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseDigestInfoResponse>","errorExample":""}]',
+ 'title' => '摘要数据上传',
+ 'summary' => '上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
+ 'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => ' ',
+ 'requestParamsDescription' => '**RelatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListDependentDataModels' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadMPCoSPhaseDigestInfoByDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'api版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '产品的ProductKey。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应状态描述。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'RequestID-1638239980855',
- ],
- 'Success' => [
- 'description' => '是否成功。-**true**:表示是。-**false**:表示否。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'DataModelInfo' => [
- 'description' => '响应内容。',
- 'example' => '{}',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DataModelName' => [
- 'description' => '数据模型名称',
- 'type' => 'string',
- 'example' => '测算模型',
- ],
- 'DataModelCode' => [
- 'description' => '数据模型编码',
- 'type' => 'string',
- 'example' => 'KI8D',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'PhaseGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"RequestID-1638239980855\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DataModelInfo\\": [\\n {\\n \\"DataModelName\\": \\"测算模型\\",\\n \\"DataModelCode\\": \\"KI8D\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '查询自定义模型列表',
- 'summary' => '用于查询自定义模型列表。',
- ],
- 'ListMultiPartyCollaborationChain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
],
[
- 'name' => 'Num',
+ 'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '数据序列号。', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseData',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '阶段数据的SHA256摘要值,要求长度为64字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ebf44d78ae75288d7d0057a5ebf44d78a6b86d04502dcbda643c4d24ff2a****'],
],
[
- 'name' => 'Name',
+ 'name' => 'RelatedDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的业务链名称。'."\n"
- ."\n"
- .'> 不传则查询所有业务链。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '某业务链',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '关联数据列表。详情请参见下表RelatedData。', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]'],
+ ],
+ [
+ 'name' => 'IotAuthType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
+ ],
+ [
+ 'name' => 'IotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****'],
+ ],
+ [
+ 'name' => 'IotIdSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
+ ],
+ [
+ 'name' => 'IotIdServiceProvider',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****'],
+ ],
+ [
+ 'name' => 'IotDataDigest',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT可信数据Value摘要。'."\n"
+ .'1. Value数据UTF-8编码。'."\n"
+ .'2. SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******'],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备数据签名。'."\n"
+ .'使用IoT设备安全SDK进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******'],
],
],
'responses' => [
@@ -7224,179 +3906,94 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '业务链名称。',
- 'type' => 'string',
- 'example' => '某业务链',
- ],
- 'Remark' => [
- 'description' => '业务链备注。',
- 'type' => 'string',
- 'example' => '某业务某服务',
- ],
- 'RoleType' => [
- 'description' => '账号角色。'."\n"
- .'- **ADMIN**:业务管理方。'."\n"
- .'- **MEMBER**:业务使用方。',
- 'type' => 'string',
- 'example' => 'ADMIN',
- ],
- 'BizChainId' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'example' => '489973087549****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 1,\\n \\"Size\\": 1,\\n \\"PageData\\": [\\n {\\n \\"Name\\": \\"某业务链\\",\\n \\"Remark\\": \\"某业务某服务\\",\\n \\"RoleType\\": \\"ADMIN\\",\\n \\"BizChainId\\": \\"489973087549****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMultiPartyCollaborationChainResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <BizChainId>489973087549****</BizChainId>\\n <RoleType>ADMIN</RoleType>\\n <Remark>某业务某服务</Remark>\\n <Name>某业务链</Name>\\n </PageData>\\n <Size>1</Size>\\n <Num>1</Num>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListMultiPartyCollaborationChainResponse>","errorExample":""}]',
- 'title' => '查询多方任务协同业务链列表',
- 'summary' => '用于查询多方任务协同业务链列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseDigestInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseDigestInfoByDeviceResponse>","errorExample":""}]',
+ 'title' => '设备摘要数据上传',
+ 'summary' => '通过IoT设备签名后,上传阶段数据的摘要信息到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
.'| √ | √ |',
- 'requestParamsDescription' => ' ',
+ 'requestParamsDescription' => ' **RelatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListProofChain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadMPCoSPhaseTextInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Num',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****'],
],
[
- 'name' => 'Name',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的业务链名称。'."\n"
- ."\n"
- .'> 不传则查询所有存证服务业务链。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '某业务链',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****'],
+ ],
+ [
+ 'name' => 'DataKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
+ ],
+ [
+ 'name' => 'DataSeq',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据序列号。', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
+ ],
+ [
+ 'name' => 'PhaseData',
+ 'in' => 'query',
+ 'schema' => ['description' => '阶段数据。长度要求1~4096字节,一个中文字符占两位字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
+ ],
+ [
+ 'name' => 'RelatedDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '关联数据列表。详情请参见下表RelatedData。', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq ":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]'],
],
],
'responses' => [
@@ -7404,198 +4001,130 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Remark' => [
- 'description' => '业务链备注。',
- 'type' => 'string',
- 'example' => '某业务链的备注信息。',
- ],
- 'BizChainId' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'example' => '489973087549****',
- ],
- 'RoleType' => [
- 'description' => '账号角色。'."\n"
- .'- **ADMIN**:业务管理方。'."\n"
- .'- **MEMBER**:业务使用方。',
- 'type' => 'string',
- 'example' => 'ADMIN',
- ],
- 'BizChainCode' => [
- 'description' => '业务链编码。',
- 'type' => 'string',
- 'example' => 'SA7z9XkBMVPg****',
- ],
- 'Name' => [
- 'description' => '业务链名称。',
- 'type' => 'string',
- 'example' => '某业务链',
- ],
- 'DataTypeCode' => [
- 'description' => '类型编码。',
- 'type' => 'string',
- 'example' => 'B***',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"Remark\\": \\"某业务链的备注信息。\\",\\n \\"BizChainId\\": \\"489973087549****\\",\\n \\"RoleType\\": \\"ADMIN\\",\\n \\"BizChainCode\\": \\"SA7z9XkBMVPg****\\",\\n \\"Name\\": \\"某业务链\\",\\n \\"DataTypeCode\\": \\"B***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListProofChainResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <RoleType>ADMIN</RoleType>\\n <BizChainId>489973087549****</BizChainId>\\n <DataTypeCode>B***</DataTypeCode>\\n <BizChainCode>SA7z9XkBMVPg****</BizChainCode>\\n <Remark>某业务链的备注信息。</Remark>\\n <Name>某业务链</Name>\\n </PageData>\\n <PageData>\\n <RoleType>ADMIN</RoleType>\\n <BizChainId>489973087550****</BizChainId>\\n <DataTypeCode>C***</DataTypeCode>\\n <BizChainCode>SA7z9XkBMVPj****</BizChainCode>\\n <Remark>某某业务链的备注信息。</Remark>\\n <Name>某某业务链</Name>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListProofChainResponse>","errorExample":""}]',
- 'title' => '查询存证与溯源业务链列表',
- 'summary' => '用于查询存证与溯源业务链列表。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseTextInfoResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseTextInfoResponse>","errorExample":""}]',
+ 'title' => '文本数据上传',
+ 'summary' => '上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | √ |',
- 'requestParamsDescription' => ' ',
+ .'| √ | √ |'."\n",
+ 'requestParamsDescription' => '**RelatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。长度要求64字节。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
- 'ListPSMemberDataTypeCode' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadMPCoSPhaseTextInfoByDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API版本号,"1.0.0"。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API版本号,"1.0.0"。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0'],
],
[
- 'name' => 'Num',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定显示返回结果中的第几页,最小取值是1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '业务链标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****'],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '指定返回结果中每页显示的记录数量,最大值是100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '协同模型标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****'],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '业务链标识。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => '阶段标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****'],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '要查询的阿里云RAM用户UID。'."\n"
- .'> 不传则查询所有阿里云RAM用户UID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => '数据唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****'],
+ ],
+ [
+ 'name' => 'DataSeq',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据序列号。', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****'],
+ ],
+ [
+ 'name' => 'PhaseData',
+ 'in' => 'query',
+ 'schema' => ['description' => '阶段数据。长度要求1~4096字节,一个中文字符占两位字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。'],
+ ],
+ [
+ 'name' => 'RelatedDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '关联数据列表。详情请参见下表RelatedData。', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]'],
+ ],
+ [
+ 'name' => 'IotAuthType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT认证方式。'."\n"
+ .'**ID2**:阿里云Link ID²。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2'],
+ ],
+ [
+ 'name' => 'IotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****'],
+ ],
+ [
+ 'name' => 'IotIdSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方。'."\n"
+ .'- **1**:开放平台。'."\n"
+ .'- **2**:物联网平台。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'],
+ ],
+ [
+ 'name' => 'IotIdServiceProvider',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备服务提供方标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******'],
+ ],
+ [
+ 'name' => 'IotDataDigest',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT可信数据Value摘要:'."\n"
+ .'1:Value数据UTF-8编码。'."\n"
+ .'2:SHA256运算,结果为32字节数据转换为64字节字符串格式(大写字符)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******'],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'IoT设备数据签名。'."\n"
+ .'使用IoT设备安全SDK进行签名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******'],
],
],
'responses' => [
@@ -7603,335 +4132,87 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'The system is busy. Please try again later.',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**:调用成功。'."\n"
- .'- **false**:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Size' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageData' => [
- 'description' => '数据项。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'MemberId' => [
- 'description' => '账户标识。',
- 'type' => 'string',
- 'example' => '717534457003****',
- ],
- 'DataTypeCode' => [
- 'description' => '存证类型编码。',
- 'type' => 'string',
- 'example' => 'E***',
- ],
- 'MemberName' => [
- 'description' => '账户名称。',
- 'type' => 'string',
- 'example' => '某某公司账户',
- ],
- 'MemberUid' => [
- 'description' => '阿里云RAM用户UID。',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'The system is busy. Please try again later.'],
+ 'Data' => ['description' => '多余参数,请忽略。', 'type' => 'string', 'example' => '无'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**:调用成功。'."\n"
+ .'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => '系统繁忙,请稍候再试!'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Num\\": 1,\\n \\"Total\\": 10,\\n \\"Size\\": 2,\\n \\"PageData\\": [\\n {\\n \\"MemberId\\": \\"717534457003****\\",\\n \\"DataTypeCode\\": \\"E***\\",\\n \\"MemberName\\": \\"某某公司账户\\",\\n \\"MemberUid\\": \\"19720316234381****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListPSMemberDataTypeCodeResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data>\\n <PageData>\\n <MemberId>717534457003****</MemberId>\\n <MemberName>某某公司账户</MemberName>\\n <MemberUid>19720316234381****</MemberUid>\\n <DataTypeCode>E***</DataTypeCode>\\n </PageData>\\n <PageData>\\n <MemberId>717534457005****</MemberId>\\n <MemberName>某公司账户</MemberName>\\n <MemberUid>19720316234382****</MemberUid>\\n <DataTypeCode>D***</DataTypeCode>\\n </PageData>\\n <Size>2</Size>\\n <Num>1</Num>\\n <Total>10</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListPSMemberDataTypeCodeResponse>","errorExample":""}]',
- 'title' => '查询接入方类型编码',
- 'summary' => '查询接入方账号下存证类型编码。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The system is busy. Please try again later.\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D5C69894-9709-4653-B3D8-25234034C2FC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UploadMPCoSPhaseTextInfoByDeviceResponse>\\n <Message/>\\n <RequestId>D5C69894-9709-4653-B3D8-25234034C2FC</RequestId>\\n <Data/>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadMPCoSPhaseTextInfoByDeviceResponse>","errorExample":""}]',
+ 'title' => '设备文本数据上传',
+ 'summary' => '通过IoT设备签名后,上传文本类型的阶段数据到区块链,并同时可以绑定所关联的其它阶段数据。',
'description' => '**可访问账号:**'."\n"
.'| 业务管理方 | 业务使用方 |'."\n"
.'| :--------: | :-----: |'."\n"
- .'| √ | × |',
- 'requestParamsDescription' => ' ',
+ .'| √ | √ |',
+ 'requestParamsDescription' => ' **RelatedData**'."\n"
+ .'|参数|类型|是否必选|示例值|描述|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|是|987823074334****|关联的数据阶段ID。|'."\n"
+ .'|relatedDataKey|String|是|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|关联的数据Key值。|'."\n"
+ .'|relatedPhaseData|String|是|某公司某业务数据|关联的阶段数据。|'."\n"
+ .'|relatedDataSeq|String|否|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|关联的数据序列号。|',
'responseParamsDescription' => ' ',
'extraInfo' => '## 错误码'."\n"
.'错误码详细信息,请参见[错误码](~~184711~~)。',
+ 'changeSet' => [],
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚(悉尼)已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ltl.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.cn-shanghai.aliyuncs.com', 'endpoint' => 'ltl.cn-shanghai.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => '500', 'message' => 'The system is busy. Please try again later.', 'http_code' => 200, 'description' => '系统繁忙,请稍候再试!'],
+ ['code' => 'SYSTEMERROR', 'message' => 'The system is busy. Please try again later.', 'http_code' => 500, 'description' => '系统繁忙,请稍候再试!'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote-nebula-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'ltl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'ltl.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'ltl.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'ApplyDataModelConfigInfo'],
+ ['description' => '错误码发生变更', 'api' => 'GetDataModelConfigInfo'],
+ ['description' => '错误码发生变更', 'api' => 'ListDependentDataModels'],
+ ],
+ 'createdAt' => '2022-08-31T03:10:18.000Z',
+ 'description' => '下线无用API-3个',
],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
];