summaryrefslogtreecommitdiff
path: root/data/en_us/ltl
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/ltl')
-rw-r--r--data/en_us/ltl/2019-05-10/api-docs.php8176
1 files changed, 2701 insertions, 5475 deletions
diff --git a/data/en_us/ltl/2019-05-10/api-docs.php b/data/en_us/ltl/2019-05-10/api-docs.php
index c04012f..3c811a8 100644
--- a/data/en_us/ltl/2019-05-10/api-docs.php
+++ b/data/en_us/ltl/2019-05-10/api-docs.php
@@ -1,201 +1,73 @@
<?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' => null,
+ 'children' => ['CreateMember', 'LockMember', 'ModifyMember', 'UnLockMember', 'ListMember'],
'type' => 'directory',
- 'children' => [
- 'CreateMember',
- 'LockMember',
- 'ModifyMember',
- 'UnLockMember',
- 'ListMember',
- ],
+ 'title' => 'User',
],
[
- 'id' => 65767,
- 'title' => null,
+ 'children' => ['RegisterDeviceGroup', 'AuthorizeDevice', 'AuthorizeDeviceGroup', 'UnAuthorizeDevice', 'UnAuthorizeDeviceGroup', 'ListDevice', 'ListDeviceGroup'],
'type' => 'directory',
- 'children' => [
- 'RegisterDeviceGroup',
- 'AuthorizeDevice',
- 'AuthorizeDeviceGroup',
- 'UnAuthorizeDevice',
- 'UnAuthorizeDeviceGroup',
- 'ListDevice',
- 'ListDeviceGroup',
- ],
+ 'title' => 'Device',
],
[
- 'id' => 65775,
- 'title' => null,
+ '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' => 65787,
- 'title' => null,
+ 'children' => ['ApplyDataModelConfigInfo'],
'type' => 'directory',
- 'children' => [
- 'ApplyDataModelConfigInfo',
- ],
+ 'title' => 'Configuration',
],
[
- 'id' => 65789,
- 'title' => null,
+ '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' => 'Upload',
],
[
- 'id' => 65802,
- 'title' => null,
+ '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' => 'Query',
],
],
'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' => '',
- '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' => 'MemberUid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '19720316234381****',
- ],
- ],
- [
- 'name' => 'MemberName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The API version number. Set this parameter to "1.0.0".', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'MemberContact',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ProductKey of the IoT data source group.', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWz******g', 'title' => ''],
],
[
- 'name' => 'MemberPhone',
+ 'name' => 'DataModelCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1381111****',
- ],
+ 'schema' => ['description' => 'The data model identifier.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DF3K', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'Configuration',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The model configuration information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"productKey\\":\\"a1lPbm9Yq0v\\"}', 'title' => ''],
],
],
'responses' => [
@@ -203,101 +75,66 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The response content.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '180E5D71-FF24-5E87-9746-3DA837E686FE', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: Successful.'."\n"
+ .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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\\": \\"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' => 'CreateMember',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'LockMember' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => 'Apply data model configuration',
+ 'summary' => 'Applies custom data model configuration information.',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
- 'name' => 'MemberId',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => 'The data value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。', 'title' => ''],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'query',
+ 'schema' => ['description' => '1. The user business ID. For the same key, the business ID must be unique. The value is a 64-character string. Valid characters: \\[0-9, a-f, A-F\\].'."\n"
+ .'2. If this parameter is not specified, the latest data for the current key is returned.', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****', 'title' => ''],
],
],
'responses' => [
@@ -305,258 +142,115 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'LockMember',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload data multiple times',
+ 'summary' => 'Uploads data multiple times to the IoT blockchain trusted application system.',
+ 'description' => '- You can use AttachData to upload data multiple times for the same data key.'."\n"
+ .'- After a successful call, the system processes the data asynchronously. Use GetData to query the data for confirmation.'."\n"
+ .'- When uploading data multiple times for the same data key, each subsequent upload must wait until the previous data is confirmed and committed to the blockchain.'."\n"
+ ."\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ModifyMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => 'The data value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。', 'title' => ''],
],
[
- 'name' => 'MemberName',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
- 'name' => 'MemberContact',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
[
- 'name' => 'MemberPhone',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1381111****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****', 'title' => ''],
],
[
- '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' => '',
- '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":"<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' => 'ModifyMember',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'UnLockMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['description' => 'The digest of the IoT data value.'."\n"
+ .'1. Encode the value data in UTF-8.'."\n"
+ .'2. Perform a SHA256 operation. The result is 32 bytes of data.'."\n"
+ .'3. Convert the result to a 64-byte string in uppercase characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******', 'title' => ''],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The IoT device data signature.'."\n"
+ .'Use the IoT device security SDK to sign the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The IoT device service provider. Valid values:'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'MemberId',
+ 'name' => 'BusinessId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => '1. The business ID of the user. The business ID must be unique for the same key. The value is a 64-character string. Valid characters: \\[0-9,a-f,A-F\\].'."\n"
+ .'2. If this parameter is not specified, the latest data for the current key is returned.', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****', 'title' => ''],
],
],
'responses' => [
@@ -564,128 +258,72 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'UnLockMember',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload device data multiple times',
+ 'summary' => 'Uploads data multiple times to the IoT blockchain trusted application system. The uploaded data must be signed by the IoT device.',
+ 'description' => '- You can call AttachDataWithSignature multiple times to upload data for the same data key.'."\n"
+ .'- After a successful call, the system processes the data asynchronously. Use GetData to query and confirm the data.'."\n"
+ .'- When uploading data multiple times for the same data key, each subsequent upload must wait until the previous data is confirmed and committed to the blockchain.'."\n"
+ ."\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ListMember' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'DeviceId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '654887879557****', 'title' => ''],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => 'The ID of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****', 'title' => ''],
],
],
'responses' => [
@@ -693,196 +331,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'UNLOCK',
- ],
- 'MemberName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Remark' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'MemberUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- 'MemberPhone' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1381111****',
- ],
- 'MemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '717534457003****',
- ],
- 'MemberContact' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'ListMember',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Authorize a device',
+ 'summary' => 'Grants a specified device the permission to access a blockchain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'RegisterDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '981184817831****',
- ],
- ],
- [
- 'name' => 'DeviceGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'ProductKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'hKpHMh2****',
- ],
- ],
- [
- 'name' => 'AuthorizeType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'DeviceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ID of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****', 'title' => ''],
],
],
'responses' => [
@@ -890,58 +399,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.',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '256399502929****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'RegisterDeviceGroup',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Authorize device group',
+ 'summary' => 'Grants devices in an IoT data source group the permission to access a blockchain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'AuthorizeDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'BatchUploadMPCoSPhaseDigestInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -949,53 +444,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'DeviceId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '654887879557****',
- ],
+ 'schema' => ['description' => 'The identifier of the collaboration model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => 'The identifier of the phase.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of phase data. For more information, see the PhaseData table below.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]', 'title' => ''],
],
],
'responses' => [
@@ -1003,58 +478,58 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":"<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' => 'AuthorizeDevice',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload summary data in batches',
+ 'summary' => 'Uploads summary information of phase data to the blockchain in batches and associates the data with other related phase data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|Yes|987823074334****|The unique identifier of the data.|'."\n"
+ .'|phaseData|String|Yes|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|The phase data. The value must be 64 bytes in length.|'."\n"
+ .'|dataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The data sequence number.|'."\n"
+ .'|relatedDataList|List|No|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|The list of related data. For more information, see the relatedData table below.|.'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|某公司某业务数据|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
- ],
- 'AuthorizeDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'BatchUploadMPCoSPhaseDigestInfoByDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1062,155 +537,69 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
- ],
- '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of phase data. For more information, see the PhaseData table below.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****","dataSeq":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]', 'title' => ''],
],
- ],
- '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' => 'AuthorizeDeviceGroup',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'UnAuthorizeDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'IotAuthType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The IoT device service provider.'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT Platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'DeviceId',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '654887879557****',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****', 'title' => ''],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => 'The digest of the IoT trusted data value:'."\n"
+ .'1. Encode the value data in UTF-8.'."\n"
+ .'2. Perform SHA-256 hashing. Convert the 32-byte result to a 64-byte uppercase hexadecimal string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED', 'title' => ''],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data signature of the IoT device.'."\n"
+ .'Use the IoT device security SDK to generate the signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******', 'title' => ''],
],
],
'responses' => [
@@ -1218,58 +607,58 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":"<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' => 'UnAuthorizeDevice',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Batch upload digest data from devices',
+ 'summary' => 'Uploads digest information of phase data in batches to the blockchain after IoT device signing, and optionally binds associated data from other phases.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|Yes|987823074334****|The unique identifier of the data.|'."\n"
+ .'|phaseData|String|Yes|b42958ddf8a13dee78fcc906d0fb48e912ddc44b3c2c2759e4824b6e2d24****|The phase data. The value must be 64 bytes in length.|'."\n"
+ .'|dataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The data sequence number.|'."\n"
+ .'|relatedDataList|List|No|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|The list of related data. For more information, see the relatedData table below.|.'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|某公司某业务数据|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
- ],
- 'UnAuthorizeDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'BatchUploadMPCoSPhaseTextInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1277,42 +666,33 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'schema' => ['description' => 'The identifier of the collaboration model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The identifier of the phase.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****', 'title' => ''],
+ ],
+ [
+ 'name' => 'PhaseDataList',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of phase data. For more information, see the PhaseData table below.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]', 'title' => ''],
],
],
'responses' => [
@@ -1320,317 +700,128 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":"<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' => 'UnAuthorizeDeviceGroup',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload text data in batches',
+ 'summary' => 'Uploads text-type phase data to the blockchain in batches and associates the data with other phase data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|Yes|987823074334****|The unique identifier of the data.|'."\n"
+ .'|phaseData|String|Yes|Business data of a company|The phase data. The length must be 1 to 4,096 bytes. A Chinese character occupies two bytes.|'."\n"
+ .'|dataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The data sequence number.|'."\n"
+ .'|relatedDataList|List|No|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"Business data of a company.","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|The list of related data. For more information, see the relatedData table below.|.'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|Business data of a company|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
- ],
- 'ListDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
[
- 'name' => 'DeviceGroupId',
+ 'name' => 'PhaseDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '475020454741****',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of phase data. For more information, see the PhaseData table below.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '[{"dataKey":"987823074334****","phaseData":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","dataSeq":"某公司某业务数据。","relatedDataList":[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]}]', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'AUTHORIZED',
- ],
- 'LastSaveTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1606379090866',
- ],
- 'DeviceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '876055554040****',
- ],
- 'IotId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '183329761572****',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- '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\\": 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' => 'ListDevice',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'ListDeviceGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The IoT device service provider.'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT Platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The digest of the IoT trusted data value:'."\n"
+ .'1. Encode the value data in UTF-8.'."\n"
+ .'2. Perform SHA-256 hashing. Convert the 32-byte result to a 64-byte uppercase hexadecimal string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hKpHMh2****',
- ],
+ 'schema' => ['description' => 'The data signature of the IoT device.'."\n"
+ .'Use the IoT device security SDK to generate the signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******', 'title' => ''],
],
],
'responses' => [
@@ -1638,121 +829,58 @@
'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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'AUTHORIZED',
- ],
- 'DeviceGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '577187700697****',
- ],
- 'ProductKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'hKpHMh2****',
- ],
- 'Remark' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AuthorizeType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ID2',
- ],
- 'OwnerName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'OwnerUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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\\": 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' => 'ListDeviceGroup',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Batch upload text data from devices',
+ 'summary' => 'Uploads text-based phase data in batches to the blockchain after IoT device signing, and associates the data with other related phase data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**PhaseData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|dataKey|String|Yes|987823074334****|The unique identifier of the data.|'."\n"
+ .'|phaseData|String|Yes|Business data of a company|The phase data. The value must be 1 to 4,096 bytes in length. Each Chinese character occupies two bytes.|'."\n"
+ .'|dataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The data sequence number.|'."\n"
+ .'|relatedDataList|List|No|[{"relatedPhaseId":"987823074334××××","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2××××","relatedPhaseData":"Business data of a company.","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a××××"}]|The list of related data. For more information, see the relatedData table below.|.'."\n"
+ ."\n"
+ .'**relatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|Business data of a company|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'CreateMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1760,63 +888,33 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The phase name.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某阶段', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The remarks. The remarks can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => '某阶段的备注信息。', 'title' => ''],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
],
],
'responses' => [
@@ -1824,110 +922,72 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The phase ID.', 'type' => 'string', 'example' => '196487512811****', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":""}]',
- 'title' => 'CreateMPCoSPhase',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a phase',
+ 'summary' => 'Creates a phase in a collaboration model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The name of the collaborative model.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某协同模型', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The remarks of the collaborative model. The remarks can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => '某协同模型的备注信息。', 'title' => ''],
],
],
'responses' => [
@@ -1935,245 +995,90 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the collaborative model.', 'type' => 'string', 'example' => '987823074334****', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generated for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":""}]',
- 'title' => 'CreateMPCoSPhaseGroup',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a collaborative model',
+ 'summary' => 'Creates collaborative model information.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service provider | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ModifyMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The UID of the Resource Access Management (RAM) user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '19720316234381****', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'MemberName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The account name.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司', 'title' => ''],
],
[
- 'name' => 'PhaseId',
- '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' => '',
- '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' => 'ModifyMPCoSPhase',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'ModifyMPCoSPhaseGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
- [
- 'name' => 'ApiVersion',
+ 'name' => 'MemberContact',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The account contact.'."\n"
+ .'The value must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'MemberPhone',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The account phone number. The value can contain digits and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1381111****', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => 'The remarks.'."\n"
+ .'The value can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => '某应用某业务', 'title' => ''],
],
],
'responses' => [
@@ -2181,58 +1086,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.',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '717534457003****', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'ModifyMPCoSPhaseGroup',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Create a consumer',
+ 'summary' => 'Creates a consumer account by the management party.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Management party | Consumer party |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UpdateMPCoSAuthorizedInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeCapacityInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2240,65 +1131,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'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' => 'The identifier of the business chain to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
],
'responses' => [
@@ -2306,58 +1149,57 @@
'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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CountQuota' => ['description' => 'The record count quota of the business chain.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000', 'title' => ''],
+ 'CapacityQuota' => ['description' => 'The capacity quota of the business chain. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '800000000000', 'title' => ''],
+ 'UsedCount' => ['description' => 'The number of records used by the business chain.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000', 'title' => ''],
+ 'UsedCapacity' => ['description' => 'The capacity used by the business chain. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '870000000', 'title' => ''],
+ 'MemberUsedCapacity' => ['description' => 'The capacity used by the current user on the business chain. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '70000000', 'title' => ''],
+ 'MemberUsedCount' => ['description' => 'The number of records used by the current user on the business chain.', 'type' => 'integer', 'format' => 'int64', 'example' => '26666', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'UpdateMPCoSAuthorizedInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query capacity statistics information',
+ 'summary' => 'Queries resource capacity statistics information.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'DescribeMPCoSAuthorizedInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2365,53 +1207,27 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set this to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '717534457003****',
- ],
+ 'schema' => ['description' => 'The account ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****', 'title' => ''],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The collaborative model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
],
'responses' => [
@@ -2419,97 +1235,83 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response content.',
'type' => 'object',
'properties' => [
'AuthorizedPhaseList' => [
- 'description' => '',
+ 'description' => 'The list of authorized phases.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'PhaseName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'PhaseId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'PhaseName' => ['description' => 'The phase name.', 'type' => 'string', 'example' => '某阶段', 'title' => ''],
+ 'PhaseId' => ['description' => 'The phase ID.', 'type' => 'string', 'example' => '987823074334****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'UnAuthorizedPhaseList' => [
- 'description' => '',
+ 'description' => 'The list of unauthorized phases.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'PhaseName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'PhaseId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'PhaseName' => ['description' => 'The phase name.', 'type' => 'string', 'example' => '某某阶段', 'title' => ''],
+ 'PhaseId' => ['description' => 'The phase ID.', 'type' => 'string', 'example' => '987823074334****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":""}]',
- 'title' => 'DescribeMPCoSAuthorizedInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query consumer permissions',
+ 'summary' => 'Queries the permission information of an account in a collaborative model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'DescribeMPCoSPhaseInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2517,74 +1319,37 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The ID of the collaboration model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
[
'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
[
'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => 'The sequence number of the data.', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
],
],
'responses' => [
@@ -2592,140 +1357,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response content.',
'type' => 'object',
'properties' => [
- 'PreviousHash' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****',
- ],
- 'ProductKey' => [
- 'description' => '',
- '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' => 'The hash of the previous block.', 'type' => 'string', 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****', 'title' => ''],
+ 'ProductKey' => ['description' => 'The ProductKey of the IoT data source group.', 'type' => 'string', 'example' => 'hfoi7GQ****', 'title' => ''],
+ 'DataHash' => ['description' => 'The hash of the data.', 'type' => 'string', 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****', 'title' => ''],
+ 'DataValue' => ['description' => 'The on-chain value.', 'type' => 'string', 'example' => '某公司某业务数据。', 'title' => ''],
+ 'Timestamp' => ['description' => 'The time when the data is stored on the chain. The value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605885676000', 'title' => ''],
+ 'TransactionHash' => ['description' => 'The transaction hash.', 'type' => 'string', 'example' => 'c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****', 'title' => ''],
+ 'BlockHash' => ['description' => 'The block hash.', 'type' => 'string', 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****', 'title' => ''],
+ 'BlockNumber' => ['description' => 'The block height.', 'type' => 'integer', 'format' => 'int64', 'example' => '1942', 'title' => ''],
+ 'IotId' => ['description' => 'The device identifier.', 'type' => 'string', 'example' => 'DFA7B98AD494FB98A491****', 'title' => ''],
'RelatedDataList' => [
- 'description' => '',
+ 'description' => 'The list of associated data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'RelatedDataKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '256399502929****',
- ],
- 'RelatedPhaseDataHash' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****',
- ],
- 'RelatedDataSeq' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
- 'RelatedPhaseName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RelatedPhaseId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '987823074334****',
- ],
+ 'RelatedDataKey' => ['description' => 'The key of the associated data.', 'type' => 'string', 'example' => '256399502929****', 'title' => ''],
+ 'RelatedPhaseDataHash' => ['description' => 'The hash of the associated phase data.', 'type' => 'string', 'example' => '73b5c3dbc828fdf79749ff332af402036f7d591959fda00a2854a160fe66****', 'title' => ''],
+ 'RelatedDataSeq' => ['description' => 'The sequence number of the associated data.', 'type' => 'string', 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
+ 'RelatedPhaseName' => ['description' => 'The phase name of the associated data.', 'type' => 'string', 'example' => '某业务阶段', 'title' => ''],
+ 'RelatedPhaseId' => ['description' => 'The phase ID of the associated data.', 'type' => 'string', 'example' => '987823074334****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":""}]',
- 'title' => 'DescribeMPCoSPhaseInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query on-chain data',
+ 'summary' => 'Queries a unique on-chain data record and its associated data by phase ID, data unique identifier, and sequence number.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
'DescribeMPCoSResourceInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2733,31 +1437,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API version number, "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
],
'responses' => [
@@ -2765,114 +1455,73 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The request status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response content.',
'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' => 'The collaboration model quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'MemberQuota' => ['description' => 'The member quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'UsedMember' => ['description' => 'The number of added members.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'UsedPhaseGroup' => ['description' => 'The number of added collaboration models.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'PhaseQuotaInfoList' => [
- 'description' => '',
+ 'description' => 'The list of phase quotas.',
'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' => 'The collaboration model ID.', 'type' => 'string', 'example' => '383860792287****', 'title' => ''],
+ 'PhaseGroupName' => ['description' => 'The collaboration model name.', 'type' => 'string', 'example' => '某协同模型', 'title' => ''],
+ 'PhaseQuota' => ['description' => 'The phase quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'UsedPhase' => ['description' => 'The number of added phases.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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":""}]',
- 'title' => 'DescribeMPCoSResourceInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query Resource Usage Information',
+ 'summary' => 'Queries the quota and usage of a business chain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ListMPCoSPhase' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error Codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeMemberCapacityInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2880,80 +1529,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ID of the business chain to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
],
'responses' => [
@@ -2961,107 +1547,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'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' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PhaseId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '196487512811****',
- ],
- ],
- ],
+ 'description' => 'The response content.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UsedCapacity' => ['description' => 'The capacity that the user has used on the business chain. Unit: bytes.', 'type' => 'string', 'example' => '70000000', 'title' => ''],
+ 'MemberId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '717534457003****', 'title' => ''],
+ 'MemberName' => ['description' => 'The account name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'UsedCount' => ['description' => 'The number of entries that the user has used on the business chain.', 'type' => 'string', 'example' => '26666', 'title' => ''],
+ 'MemberUid' => ['description' => 'The UID of the Alibaba Cloud Resource Access Management (RAM) user.', 'type' => 'string', 'example' => '19720316234381****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'ListMPCoSPhase',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query service consumer capacity information',
+ 'summary' => 'Queries the capacity statistics information of a service consumer.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ListMPCoSPhaseGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'DescribeResourceInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3069,69 +1610,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
- ],
- [
- 'name' => 'Num',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The API version number. Set this to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
],
'responses' => [
@@ -3139,101 +1628,60 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response content.',
'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' => 'The status of the business chain. Valid values:'."\n"
+ .'- **NORMAL**: Normal.'."\n"
+ .'- **EXPIRED**: Expired.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''],
+ 'EffectiveTime' => ['description' => 'The activation time. The value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1586125838680', 'title' => ''],
+ 'AuthorizeType' => ['description' => 'The authorization type. Valid values:'."\n"
+ .'- **Enterprise Edition**: Enterprise Edition plan.'."\n"
+ .'- **Standard Edition**: Standard Edition plan.', 'type' => 'string', 'example' => '标准版', 'title' => ''],
+ 'ExpiredTime' => ['description' => 'The expiration time. The value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1666125838680', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'ListMPCoSPhaseGroup',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query resource information',
+ 'summary' => 'Queries resource activation information.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ListMPCoSPhaseHistory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'GetBlockChainInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3241,120 +1689,109 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'BusinessId',
'in' => 'query',
+ 'schema' => ['description' => '1. The user business ID. For the same key, the business ID must be unique. The value is a 64-character string. Valid characters: \\[0-9,a-f,A-F\\].'."\n"
+ .'2. If this parameter is not specified, the latest data for the current key is returned.', 'type' => 'string', 'required' => false, 'example' => '000000000000000000000000000000000000000000000000000000000001****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The blockchain metadata corresponding to the unique identifier key, in JSON format. For more information, see the blockChainInfo table below.', 'type' => 'string', 'example' => '{"blockChainInfo":{"chainName":"某公司业务链","blockHeight":48971,"transactionHash":"ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20fbf0d****","iotId":"1BE0F46275B17147E7D2****","endorsementNames":"某公司,某某公司","timestamp":"1591676312000","blockHash":"d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e909e****","previousHash":"c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4d07b****","dataHash":"21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e5faa****"}}', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query blockchain metadata of data',
+ 'summary' => 'Queries the blockchain metadata of uploaded data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => '**blockChainInfo**'."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|-|-|-|-|'."\n"
+ .'|chainName|String|某公司业务链|The name of the storage blockchain.|'."\n"
+ .'|blockHeight|Long|48971|The block number of the blockchain attestation.|'."\n"
+ .'|transactionHash|String|ea8752787f79be085d9ee244a1b9ed0deb198903a14b9b1a6800b20f********|The transaction hash.|'."\n"
+ .'|iotId|String|1BE0F46275B17147E7D2****|The IoT device ID.|'."\n"
+ .'|endorsementNames|String|某公司,某某公司|The names of the blockchain endorsement nodes.|'."\n"
+ .'|timestamp|String|1591676312000|The attestation time. The value is a millisecond-level timestamp.|'."\n"
+ .'|blockHash|String|d07bdaf2736c4d07bdaf2736e5faae508d77ceb82c0e9722a8bcca0e********|The block hash.|'."\n"
+ .'|previousHash|String|c4d07bdaf2736cc0ec0e909e60e5c21dc14d0eb823eb82f4f99791c4********|The previous block hash.|'."\n"
+ .'|dataHash|String|21dc1288bcc0e2730ae486fa04fdeb828ae5c21dc128c525a655972e********|The data hash.|.',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ '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' => 'The API version number. Set this to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'DataKey',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzw******', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '1606379090866',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b', 'title' => ''],
],
[
- '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. The business ID of the user. The business ID must be unique for the same key. The value is a 64-character string. Valid characters: \\[0-9,a-f,A-F\\].'."\n"
+ .'2. If this parameter is not specified, the latest data for the current key is returned.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '000000000000000000000000000000000000000000000000000000000001****', 'title' => ''],
],
],
'responses' => [
@@ -3362,138 +1799,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' => '',
- '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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'DFA7B98AD494FB98A491****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The value data corresponding to the data key.', 'type' => 'string', 'example' => '某业务数据。', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'ListMPCoSPhaseHistory',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query data',
+ 'summary' => 'Confirms that previously uploaded data has been processed successfully.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service provider | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'ApplyDataModelConfigInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'GetDataModelConfigInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3501,51 +1840,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number, "1.0.0".', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWz******g',
- ],
+ 'schema' => ['description' => 'The ProductKey of the IoT data source group.', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
'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' => 'The data model code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DF3K', 'title' => ''],
],
],
'responses' => [
@@ -3553,110 +1863,64 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The response content.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'RequestID-1638240165139', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. - **true**: The call was successful, but it does not indicate that the called server port and protocol do not exist. - **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'AttachData' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => 'Query Model Configuration',
+ 'summary' => 'Queries the configuration information of a custom data model.',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
- 'name' => 'Value',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The start timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608010000000', 'title' => ''],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => 'The end timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608019800000', 'title' => ''],
],
],
'responses' => [
@@ -3664,51 +1928,42 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The number of records that correspond to the specified key.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'AttachData',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query historical data count',
+ 'summary' => 'Queries the number of historical data records from the IoT blockchain trusted application system.',
+ 'description' => '> If no timestamp is specified, the total number of all historical data records is returned.'."\n"
+ ."\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'AttachDataWithSignature' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'GetHistoryDataList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3716,129 +1971,119 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
- ],
- [
- 'name' => 'Value',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The page number to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '0', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => 'The number of records to return on each page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => 'The start timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608010000000', 'title' => ''],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'EndTime',
'in' => 'query',
+ 'schema' => ['description' => 'The end timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9594629196518', 'minimum' => '0', 'example' => '1608019800000', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of all value data corresponding to the specified key, in JSON format.', '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"}]', 'title' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query historical data list',
+ 'summary' => 'Queries historical data from the IoT blockchain trusted application system.',
+ 'description' => '1. When time parameters are specified, the maximum query interval between the start time and end time is 30 days.'."\n"
+ .'2. When time parameters are not specified, the maximum number of returned records is 500. If the number of records exceeds this limit, specify timestamp parameters to query data.'."\n"
+ ."\n\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ListDependentDataModels' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IotSignature',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'IotIdSource',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The API version number. Set this to "1.0.0".', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'schema' => ['description' => 'The ProductKey of the product.', 'type' => 'string', 'required' => false, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
],
'responses' => [
@@ -3846,105 +2091,97 @@
'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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response status description.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'RequestID-1638239980855', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ .'- **true**: Successful.'."\n"
+ .'- **false**: Not successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DataModelInfo' => [
+ 'description' => 'The response content.',
+ 'example' => '{}',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataModelName' => ['description' => 'The name of the data model.', 'type' => 'string', 'example' => '测算模型', 'title' => ''],
+ 'DataModelCode' => ['description' => 'The code of the data model.', 'type' => 'string', 'example' => 'KI8D', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'AttachDataWithSignature',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'SetData' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => 'Query custom model list',
+ 'summary' => 'Queries a list of custom models.',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-31T03:09:46.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b',
- ],
+ 'schema' => ['description' => 'The page number to display in the returned results. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Value',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The number of records to display per page in the returned results. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWz******g',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DeviceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The identifier of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****', 'title' => ''],
+ ],
+ [
+ 'name' => 'IotId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the IoT device to query.'."\n"
+ ."\n"
+ .'> If this parameter is not specified, all IoT devices in the IoT data source group are queried.', 'type' => 'string', 'required' => false, 'example' => '183329761572****', 'title' => ''],
],
],
'responses' => [
@@ -3952,171 +2189,232 @@
'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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The authorization status. Valid values:'."\n"
+ .'- **AUTHORIZED**: Authorized.'."\n"
+ .'- **UNAUTHORIZED**: Unauthorized.', 'type' => 'string', 'example' => 'AUTHORIZED', 'title' => ''],
+ 'LastSaveTime' => ['description' => 'The last attestation time. The value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1606379090866', 'title' => ''],
+ 'DeviceId' => ['description' => 'The device identifier.', 'type' => 'string', 'example' => '876055554040****', 'title' => ''],
+ 'IotId' => ['description' => 'The IoT device ID.', 'type' => 'string', 'example' => '183329761572****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'SetData',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query device list',
+ 'summary' => 'Queries all devices in an IoT data source group.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'SetDataWithSignature' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListDeviceGroup' => [
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'API version number, "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => 'Specifies the page number to display in the returned results. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Value',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Specifies the number of records displayed per page in the returned results. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'BizChainId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Business chain identifier.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'ProductKey',
'in' => 'query',
+ 'schema' => ['description' => 'ProductKey of the IoT data source group.'."\n"
+ ."\n"
+ .'> If not specified, all IoT data source groups under the business chain are queried.', 'type' => 'string', 'required' => false, 'example' => 'hKpHMh2****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'Response data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Size' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'Data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Authorization status of the IoT data source group.'."\n"
+ .'- **AUTHORIZED**: Authorized.'."\n"
+ .'- **UNAUTHORIZED**: Unauthorized.', 'type' => 'string', 'example' => 'AUTHORIZED', 'title' => ''],
+ 'DeviceGroupId' => ['description' => 'IoT data source group identifier.', 'type' => 'string', 'example' => '577187700697****', 'title' => ''],
+ 'ProductKey' => ['description' => 'ProductKey of the IoT data source group.', 'type' => 'string', 'example' => 'hKpHMh2****', 'title' => ''],
+ 'Remark' => ['description' => 'Remarks.', 'type' => 'string', 'example' => '某业务某设备', 'title' => ''],
+ 'AuthorizeType' => ['description' => 'Authorization type of the IoT data source group.'."\n"
+ .'**ID2**: Alibaba Cloud ID² authentication.', 'type' => 'string', 'example' => 'ID2', 'title' => ''],
+ 'OwnerName' => ['description' => 'Name of the member to which the IoT data source group belongs.', 'type' => 'string', 'example' => '某公司', 'title' => ''],
+ 'OwnerUid' => ['description' => 'UID of the member account to which the IoT data source group belongs.', 'type' => 'string', 'example' => '19720316234381****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query Device Group List',
+ 'summary' => 'Query the list of IoT data source groups.'."\n"
+ .'Users can view IoT data source groups they have registered.'."\n"
+ .'Administrators can view all IoT data source groups under the project.',
+ 'description' => '1. Users can only view the list of IoT data source groups they have registered.'."\n"
+ .'2. Administrators can view the list of IoT data source groups for all users they have created.'."\n"
+ ."\n"
+ .'**Accessible Accounts:**'."\n"
+ .'| Business Administrator | Business User |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error Codes'."\n"
+ .'For detailed error code information, see [Error Codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ListMPCoSPhase' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IotAuthType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '00CCCC098D98F2BDD8BB****',
- ],
+ 'schema' => ['description' => 'The page number of the results to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'kKpACh5****',
- ],
+ 'schema' => ['description' => 'The number of records to display on each page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '31A200471049AEA3B8459455B4447D05DD1290A875A17792F71D5550F048****',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3~2~010253040257****~1599722505821~50sZwIXt9jtTTIoGAkEs4THSyCMghVVaYO1w2AcvQf0vm51MQYt0nfHUT7jQ****',
- ],
+ 'schema' => ['description' => 'The identifier of the collaboration model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The name of the phase to query.'."\n"
+ .'> If this parameter is not specified, all phases under the collaboration model are queried.', 'type' => 'string', 'required' => false, 'example' => '某阶段', 'title' => ''],
],
],
'responses' => [
@@ -4124,115 +2422,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.',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The phase name.', 'type' => 'string', 'example' => '某阶段', 'title' => ''],
+ 'Remark' => ['description' => 'The phase remarks.', 'type' => 'string', 'example' => '某阶段的备注信息。', 'title' => ''],
+ 'AccessPermission' => ['description' => 'The access permissions. Valid values:'."\n"
+ .'- **1**: read permission.'."\n"
+ .'- **2**: write permission.'."\n"
+ .'- **3**: read and write permission.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PhaseId' => ['description' => 'The phase identifier.', 'type' => 'string', 'example' => '196487512811****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'SetDataWithSignature',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query phase list',
+ 'summary' => 'Queries the list of phases that belong to a collaboration model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service provider | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'BatchUploadMPCoSPhaseDigestInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The page number to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'Name',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The name of the collaboration model to query.'."\n"
+ ."\n"
+ .'> If this parameter is not specified, all collaboration models are queried.', 'type' => 'string', 'required' => false, 'example' => '某业务链', 'title' => ''],
],
],
'responses' => [
@@ -4240,187 +2533,237 @@
'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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The response status code.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PhaseGroupId' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'example' => '987823074334****', 'title' => ''],
+ 'Name' => ['description' => 'The collaboration model name.', 'type' => 'string', 'example' => '某协同模型', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the collaboration model.', 'type' => 'string', 'example' => '某协同模型的备注信息。', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'BatchUploadMPCoSPhaseDigestInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query collaboration model list',
+ 'summary' => 'Queries the list of collaboration models that belong to a business chain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'BatchUploadMPCoSPhaseDigestInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'Num',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to display in the returned results. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of records to display per page in the returned results. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'DataKey',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The start time. This value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1606379090866', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'EndTime',
'in' => 'query',
+ 'schema' => ['description' => 'The end time. This value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1606389090866', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductKey' => ['description' => 'The ProductKey of the IoT data source group.', 'type' => 'string', 'example' => 'hfoi7GQ****', 'title' => ''],
+ 'PreviousHash' => ['description' => 'The hash of the previous block.', 'type' => 'string', 'example' => '2d921a60bf7cc0e9722a8bcc0e909e62d92120c0c749ff332af402036f7d****', 'title' => ''],
+ 'DataHash' => ['description' => 'The data hash.', 'type' => 'string', 'example' => '9608520d694520c0c414075a5c07672a4efaf609e62d921a60bf7cc0e972****', 'title' => ''],
+ 'DataSeq' => ['description' => 'The data sequence number.', 'type' => 'string', 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
+ 'DataValue' => ['description' => 'The on-chain value.', 'type' => 'string', 'example' => '某公司业务数据。', 'title' => ''],
+ 'Timestamp' => ['description' => 'The on-chain time. This value is a millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1606389620000', 'title' => ''],
+ 'TransactionHash' => ['description' => 'The transaction hash.', 'type' => 'string', 'example' => 'bf2cf40e5c21dc14d03eb824f99791c4d07bdaf2736e5faae508d7fb276d****', 'title' => ''],
+ 'BlockHash' => ['description' => 'The block hash.', 'type' => 'string', 'example' => '5a5c07672a4efaf609e62d921a60bf7cc0e9722a8b9608520d694520c0c4****', 'title' => ''],
+ 'BlockNumber' => ['description' => 'The block height.', 'type' => 'integer', 'format' => 'int64', 'example' => '9852', 'title' => ''],
+ 'IotId' => ['description' => 'The IoT device ID.', 'type' => 'string', 'example' => 'DFA7B98AD494FB98A491****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query historical data list',
+ 'summary' => 'Queries a list of historical data by phase ID, data unique identifier, start time, and end time.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ListMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IotIdSource',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => 'The page number of the page to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED',
- ],
+ 'schema' => ['description' => 'The number of records to return on each page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MemberUid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the Resource Access Management (RAM) user to query.'."\n"
+ .'> If this parameter is not specified, all RAM users under the business chain are queried.', 'type' => 'string', 'required' => false, 'example' => '19720316234381****', 'title' => ''],
],
],
'responses' => [
@@ -4428,121 +2771,107 @@
'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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The account lock status. Valid values:'."\n"
+ .'- **UNLOCK**: Unlocked.'."\n"
+ .'- **LOCK**: Locked.', 'type' => 'string', 'example' => 'UNLOCK', 'title' => ''],
+ 'MemberName' => ['description' => 'The account name.', 'type' => 'string', 'example' => '某公司', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '某应用某业务', 'title' => ''],
+ 'MemberUid' => ['description' => 'The UID of the Resource Access Management (RAM) user.', 'type' => 'string', 'example' => '19720316234381****', 'title' => ''],
+ 'MemberPhone' => ['description' => 'The phone number of the account.', 'type' => 'string', 'example' => '1381111****', 'title' => ''],
+ 'MemberId' => ['description' => 'The account identifier.', 'type' => 'string', 'example' => '717534457003****', 'title' => ''],
+ 'MemberContact' => ['description' => 'The contact person of the account.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'BatchUploadMPCoSPhaseDigestInfoByDevice',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query consumer list',
+ 'summary' => 'Queries the list of consumer accounts.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'BatchUploadMPCoSPhaseTextInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListMultiPartyCollaborationChain' => [
+ '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' => '',
- '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' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => 'The page number to display in the returned results. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '196487512811****',
- ],
+ 'schema' => ['description' => 'The number of records to display per page in the returned results. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'Name',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The name of the business chain to query.'."\n"
+ ."\n"
+ .'> If this parameter is not specified, all business chains are queried.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某业务链', 'title' => ''],
],
],
'responses' => [
@@ -4550,187 +2879,211 @@
'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' => 'The response status.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The name of the business chain.', 'type' => 'string', 'example' => '某业务链', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks of the business chain.', 'type' => 'string', 'example' => '某业务某服务', 'title' => ''],
+ 'RoleType' => ['description' => 'The account role. Valid values:'."\n"
+ .'- **ADMIN**: service manager.'."\n"
+ .'- **MEMBER**: service consumer.', 'type' => 'string', 'example' => 'ADMIN', 'title' => ''],
+ 'BizChainId' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'example' => '489973087549****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'BatchUploadMPCoSPhaseTextInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query multi-party task collaboration business chain list',
+ 'summary' => 'Queries the list of multi-party task collaboration business chains.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'BatchUploadMPCoSPhaseTextInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The page number to display in the returned results. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The number of records to display per page in the returned results. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'PhaseDataList',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['description' => 'The UID of the Resource Access Management (RAM) user to query.'."\n"
+ .'> If this parameter is not specified, all RAM user UIDs are queried.', 'type' => 'string', 'required' => false, 'example' => '19720316234381****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
- 'required' => true,
- 'docRequired' => true,
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MemberId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '717534457003****', 'title' => ''],
+ 'DataTypeCode' => ['description' => 'The evidence type code.', 'type' => 'string', 'example' => 'E***', 'title' => ''],
+ 'MemberName' => ['description' => 'The account name.', 'type' => 'string', 'example' => '某某公司账户', 'title' => ''],
+ 'MemberUid' => ['description' => 'The UID of the Resource Access Management (RAM) user.', 'type' => 'string', 'example' => '19720316234381****', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
'example' => '',
],
],
- [
- 'name' => 'IotAuthType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query accessor type codes',
+ 'summary' => 'Queries the evidence type codes under an accessor account.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ListProofChain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'Num',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => 'The page number to display in the returned results. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'Size',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => 'The number of records to display per page in the returned results. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '2', 'title' => ''],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => 'The name of the business chain to query.'."\n"
+ ."\n"
+ .'> If this parameter is not specified, all notarization service business chains are queried.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某业务链', 'title' => ''],
],
],
'responses' => [
@@ -4738,57 +3091,76 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The response content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Num' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageData' => [
+ 'description' => 'The data items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Remark' => ['description' => 'The remarks of the business chain.', 'type' => 'string', 'example' => '某业务链的备注信息。', 'title' => ''],
+ 'BizChainId' => ['description' => 'The identifier of the business chain.', 'type' => 'string', 'example' => '489973087549****', 'title' => ''],
+ 'RoleType' => ['description' => 'The account role. Valid values:'."\n"
+ .'- **ADMIN**: business administrator.'."\n"
+ .'- **MEMBER**: service consumer.', 'type' => 'string', 'example' => 'ADMIN', 'title' => ''],
+ 'BizChainCode' => ['description' => 'The code of the business chain.', 'type' => 'string', 'example' => 'SA7z9XkBMVPg****', 'title' => ''],
+ 'Name' => ['description' => 'The name of the business chain.', 'type' => 'string', 'example' => '某业务链', 'title' => ''],
+ 'DataTypeCode' => ['description' => 'The type code.', 'type' => 'string', 'example' => 'B***', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'BatchUploadMPCoSPhaseTextInfoByDevice',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Query notarization and traceability business chain list',
+ 'summary' => 'Queries the list of notarization and traceability business chains.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UploadMPCoSPhaseDigestInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'LockMember' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4796,94 +3168,100 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'MemberId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Lock a consumer account',
+ 'summary' => 'Locks a consumer account. After the account is locked, it cannot access the current blockchain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ModifyMPCoSPhase' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'PhaseId',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511***',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'DataKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'DataSeq',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => 'The phase name.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某阶段', 'title' => ''],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dee68c73bdead5f717fc25803236924c165d0a3c1728aa58cbf05b1473c2****',
- ],
+ 'schema' => ['description' => 'The remarks. The remarks can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => '某阶段的备注信息。', 'title' => ''],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****', 'title' => ''],
],
],
'responses' => [
@@ -4891,57 +3269,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.',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'UploadMPCoSPhaseDigestInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Modify a phase',
+ 'summary' => 'Modifies phase information in a collaboration model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UploadMPCoSPhaseDigestInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ModifyMPCoSPhaseGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4949,160 +3314,130 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The name of the collaborative model.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某协同模型', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '383860792287****',
- ],
+ 'schema' => ['description' => 'The remarks. The value can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某协同模型备注。', 'title' => ''],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
- ],
+ 'schema' => ['description' => 'The ID of the collaborative model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
],
[
- 'name' => 'DataKey',
+ 'name' => 'BizChainId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Modify a data model',
+ 'summary' => 'Modifies the information of a collaborative model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ebf44d78ae75288d7d0057a5ebf44d78a6b86d04502dcbda643c4d24ff2a****',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'MemberUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The UID of the Alibaba Cloud Resource Access Management (RAM) user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '19720316234381****', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'MemberName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => 'The account name.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司', 'title' => ''],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'MemberContact',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The account contact.'."\n"
+ .'The value must be 2 to 30 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三', 'title' => ''],
],
[
- 'name' => 'IotIdServiceProvider',
+ 'name' => 'MemberPhone',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'g9R4ghe****',
- ],
+ 'schema' => ['description' => 'The contact phone number of the account.'."\n"
+ .'The value can be up to 20 characters in length and can contain digits and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1381111****', 'title' => ''],
],
[
- 'name' => 'IotDataDigest',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => 'The remarks.'."\n"
+ .'The value can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '某应用某业务', 'title' => ''],
],
[
- 'name' => 'IotSignature',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => 'The account ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****', 'title' => ''],
],
],
'responses' => [
@@ -5110,152 +3445,84 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'UploadMPCoSPhaseDigestInfoByDevice',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Modify a consumer',
+ 'summary' => 'Modifies account information.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UploadMPCoSPhaseTextInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'RegisterDeviceGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'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' => '196487512811****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '981184817831****', 'title' => ''],
],
[
- 'name' => 'DataKey',
+ 'name' => 'DeviceGroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'schema' => ['description' => 'The name of the IoT data source group.'."\n"
+ .'The name must be 2 to 30 characters in length and can contain letters, digits, underscores (_), hyphens (-), periods (.), and parentheses (()).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某数据源组', 'title' => ''],
],
[
- 'name' => 'DataSeq',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => 'The ProductKey of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hKpHMh2****', 'title' => ''],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'AuthorizeType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => 'The authorization type.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'Remark',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The remarks. The value can be up to 100 characters in length.', 'type' => 'string', 'required' => false, 'example' => '某数据源组的备注信息。', 'title' => ''],
],
],
'responses' => [
@@ -5263,218 +3530,179 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the IoT data source group.', 'type' => 'string', 'example' => '256399502929****', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'UploadMPCoSPhaseTextInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Register a data source group',
+ 'summary' => 'Registers an IoT data source group.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Service administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UploadMPCoSPhaseTextInfoByDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'SetData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b', 'title' => ''],
],
[
- 'name' => 'PhaseGroupId',
+ 'name' => 'Value',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '987823074334****',
- ],
+ 'schema' => ['description' => 'The data value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。', 'title' => ''],
],
[
- 'name' => 'PhaseId',
+ 'name' => 'ProductKey',
'in' => 'query',
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWz******g', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '644208887511****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload data',
+ 'summary' => 'Uploads data to LTL.',
+ 'description' => 'After a successful call, the system performs asynchronous processing. Use [GetData](~~195376~~) to query and confirm the data.'."\n"
+ ."\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'SetDataWithSignature' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DataKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
[
- 'name' => 'DataSeq',
+ 'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'PhaseData',
+ 'name' => 'Key',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97bd45c71a509d****', 'title' => ''],
],
[
- 'name' => 'RelatedDataList',
+ 'name' => 'Value',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The data value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。', 'title' => ''],
],
[
- 'name' => 'IotAuthType',
+ 'name' => 'ProductKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ID2',
- ],
+ 'schema' => ['description' => 'The business chain code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HB5jyvZWzwcM****', 'title' => ''],
],
[
- 'name' => 'IotId',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '183329761572****',
- ],
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
[
- 'name' => 'IotIdSource',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '00CCCC098D98F2BDD8BB****', 'title' => ''],
],
[
'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'kKpACh5****', 'title' => ''],
],
[
'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******',
- ],
+ 'schema' => ['description' => 'The digest of the IoT trusted data value:'."\n"
+ .'1. Encode the value data in UTF-8.'."\n"
+ .'2. Perform a SHA-256 operation. The result is 32 bytes of data.'."\n"
+ .'3. Convert the result to a 64-byte string in uppercase.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '31A200471049AEA3B8459455B4447D05DD1290A875A17792F71D5550F048****', 'title' => ''],
],
[
'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******',
- ],
+ 'schema' => ['description' => 'The data signature of the IoT device. Use the IoT device security SDK to generate the signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3~2~010253040257****~1599722505821~50sZwIXt9jtTTIoGAkEs4THSyCMghVVaYO1w2AcvQf0vm51MQYt0nfHUT7jQ****', 'title' => ''],
+ ],
+ [
+ 'name' => 'IotIdSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The IoT device service provider.'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT Platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
],
'responses' => [
@@ -5482,89 +3710,70 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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":"<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' => 'UploadMPCoSPhaseTextInfoByDevice',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload device data',
+ 'summary' => 'Uploads data that must be signed by the IoT device.',
+ 'description' => 'After a successful call, the system processes the request asynchronously. Use [GetData](~~195376~~) to query the data and confirm the result.'."\n"
+ ."\n"
+ .'**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'DescribeCapacityInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DeviceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '654887879557****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DeviceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****', 'title' => ''],
],
],
'responses' => [
@@ -5572,127 +3781,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- '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' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'DescribeCapacityInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Revoke device authorization',
+ 'summary' => 'Revokes the blockchain access permission of a specified device.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'DescribeMemberCapacityInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'UnAuthorizeDeviceGroup' => [
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ [
+ 'name' => 'DeviceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the IoT data source group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '475020454741****', 'title' => ''],
],
],
'responses' => [
@@ -5700,119 +3849,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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 {\\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' => 'DescribeMemberCapacityInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Revoke authorization for a data source group',
+ 'summary' => 'Revokes the permission of devices in a specified IoT data source group to access the blockchain.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'DescribeResourceInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The ID of the business chain.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
+ ],
+ [
+ 'name' => 'MemberId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****', 'title' => ''],
],
],
'responses' => [
@@ -5820,86 +3917,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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NORMAL',
- ],
- 'EffectiveTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1586125838680',
- ],
- 'AuthorizeType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ExpiredTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1666125838680',
- ],
- 'Region' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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 \\"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' => 'DescribeResourceInfo',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Unlock a consumer',
+ 'summary' => 'Unlocks a consumer account so that the account can access the blockchain.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'GetBlockChainInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'UpdateMPCoSAuthorizedInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5907,52 +3958,33 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set this to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The account ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '717534457003****', 'title' => ''],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'AuthorizedPhaseList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of authorized phase IDs.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '["196487512811****","196487512812****"]', 'title' => ''],
+ ],
+ [
+ 'name' => 'PhaseGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The collaborative model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
],
'responses' => [
@@ -5960,197 +3992,93 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'GetBlockChainInfo',
- 'requestParamsDescription' => ' ',
- ],
- 'GetData' => [
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Update consumer permissions',
+ 'summary' => 'Updates the permission information of an account in a collaborative model.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business manager | Business consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | × |.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzw******',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcMFSFg_0X58_80aa976ac4d64a97b******a509d4c0b',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
- 'name' => 'BusinessId',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '000000000000000000000000000000000000000000000000000000000001****',
- ],
- ],
- ],
- '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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511***', 'title' => ''],
],
- ],
- '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' => 'GetData',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'GetDataModelConfigInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'DataKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The serial number of the data.', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'PhaseData',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The SHA256 digest of the phase data. The value must be 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dee68c73bdead5f717fc25803236924c165d0a3c1728aa58cbf05b1473c2****', 'title' => ''],
],
[
- 'name' => 'DataModelCode',
+ 'name' => 'RelatedDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DF3K',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of related data. For more information, see the RelatedData table below.', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]', 'title' => ''],
],
],
'responses' => [
@@ -6158,265 +4086,135 @@
'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' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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"}]',
- ],
- 'GetHistoryDataCount' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload summary data',
+ 'summary' => 'Uploads summary information of phase data to the blockchain and optionally associates it with other phase data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**RelatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|某公司某业务数据|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The serial number of the related data.|.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608010000000',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608019800000',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
- ],
- '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' => '10',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'DataSeq',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data serial number.', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
],
- ],
- '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' => 'GetHistoryDataCount',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'GetHistoryDataList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PhaseData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The SHA256 digest value of the phase data. The value must be 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ebf44d78ae75288d7d0057a5ebf44d78a6b86d04502dcbda643c4d24ff2a****', 'title' => ''],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'RelatedDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of related data. For more information, see the RelatedData table below.', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]', 'title' => ''],
],
[
- 'name' => 'Key',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0001_HB5jyvZWzwcM****_0X**_80aa976ac4d64a97bd45c71a509d****',
- ],
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****', 'title' => ''],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '10000000',
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The IoT device service provider.'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT Platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'g9R4ghe****', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'IotDataDigest',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608010000000',
- ],
+ 'schema' => ['description' => 'The digest of the IoT trusted data value.'."\n"
+ .'1. Encode the value data in UTF-8.'."\n"
+ .'2. Perform SHA256 hashing. Convert the 32-byte result to a 64-byte string in uppercase.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******', 'title' => ''],
],
[
- 'name' => 'EndTime',
+ 'name' => 'IotSignature',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9594629196518',
- 'minimum' => '0',
- 'example' => '1608019800000',
- ],
+ 'schema' => ['description' => 'The data signature of the IoT device.'."\n"
+ .'Use the IoT device security SDK to generate the signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******', 'title' => ''],
],
],
'responses' => [
@@ -6424,219 +4222,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.',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'example' => '',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- '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' => 'GetHistoryDataList',
- 'requestParamsDescription' => ' ',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload device digest data',
+ 'summary' => 'Uploads the digest information of phase data to the blockchain after IoT device signing, and optionally binds associated data from other phases.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' **RelatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key value of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|Business data of a company|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The serial number of the related data.|.',
'responseParamsDescription' => ' ',
- ],
- 'ListDependentDataModels' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'ProductKey',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HB5jyvZWzwcM****',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
- ],
- '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' => '',
- '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' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '383860792287****', 'title' => ''],
],
- ],
- '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"}]',
- ],
- 'ListMultiPartyCollaborationChain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PhaseId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '196487512811****', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'DataKey',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'DataSeq',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The data sequence number.', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseData',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The phase data. The value must be 1 to 4,096 bytes in length. Each Chinese character occupies two bytes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'RelatedDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of related data. For more information, see the RelatedData table below.', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq ":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]', 'title' => ''],
],
],
'responses' => [
@@ -6644,353 +4322,135 @@
'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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'ADMIN',
- ],
- 'BizChainId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '489973087549****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.'."\n"
+ .'- **true**: The call is successful.'."\n"
+ .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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\\": 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' => 'ListMultiPartyCollaborationChain',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload text data',
+ 'summary' => 'Uploads text-type phase data to the blockchain and optionally associates it with other phase data.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Service consumer |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => '**RelatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase. The value must be up to 64 bytes in length.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|某公司某业务数据|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
- ],
- 'ListProofChain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ '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' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'schema' => ['description' => 'The API version number. Set the value to "1.0.0".', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0.0', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'BizChainId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The business chain ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '489973087549****', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'PhaseGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The collaboration model ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '987823074334****', 'title' => ''],
],
[
- 'name' => 'Name',
+ 'name' => 'PhaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The phase ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '644208887511****', 'title' => ''],
],
- ],
- '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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => 'ADMIN',
- ],
- 'BizChainCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SA7z9XkBMVPg****',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataTypeCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B***',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'name' => 'DataKey',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32bfce96b4e2f9bec0f2ea5cc2f14ace1486cc146d5832d3a84e5332fe89****', 'title' => ''],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'SYSTEMERROR',
- 'errorMessage' => 'The system is busy. Please try again later.',
- ],
+ [
+ 'name' => 'DataSeq',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data sequence number.', 'type' => 'string', 'required' => false, 'example' => 'be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****', 'title' => ''],
],
- ],
- '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' => 'ListProofChain',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'ListPSMemberDataTypeCode' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PhaseData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The phase data. The length must be 1 to 4,096 bytes. Each Chinese character occupies two bytes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '某公司某业务数据。', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'ApiVersion',
+ 'name' => 'RelatedDataList',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.0.0',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'The list of related data. For more information, see the RelatedData table below.', 'type' => 'object', 'required' => false, 'example' => '[{"relatedPhaseId":"987823074334****","relatedDataKey":"be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****","relatedPhaseData":"某公司某业务数据。","relatedDataSeq":"b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****"}]', 'title' => ''],
],
[
- 'name' => 'Num',
+ 'name' => 'IotAuthType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The IoT authentication method.'."\n"
+ .'**ID2**: Alibaba Cloud Link ID².', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID2', 'title' => ''],
],
[
- 'name' => 'Size',
+ 'name' => 'IotId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The unique identifier of the IoT device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '183329761572****', 'title' => ''],
],
[
- 'name' => 'BizChainId',
+ 'name' => 'IotIdSource',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '489973087549****',
- ],
+ 'schema' => ['description' => 'The IoT device service provider.'."\n"
+ .'- **1**: open platform.'."\n"
+ .'- **2**: IoT Platform.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'IotIdServiceProvider',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19720316234381****',
- ],
+ 'schema' => ['description' => 'The identifier of the IoT device service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******', 'title' => ''],
+ ],
+ [
+ 'name' => 'IotDataDigest',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The digest of the IoT trusted data value:'."\n"
+ .'1: Encode the value data in UTF-8.'."\n"
+ .'2: Perform SHA-256 hashing. Convert the 32-byte result to a 64-byte uppercase hexadecimal string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '94894989498FDDABD51698BD1A49BF1AFB0AA94FAA8DB65A689164BEED******', 'title' => ''],
+ ],
+ [
+ 'name' => 'IotSignature',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The data signature of the IoT device.'."\n"
+ .'Use the IoT device security SDK to generate the signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2~2~192ADFB498AA****~1579198300000~J8E891NAgAhwHBHm8******/hnswr698HSb09ahS8709bn9s03jg98u4jg******', 'title' => ''],
],
],
'responses' => [
@@ -6998,326 +4458,92 @@
'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' => '',
- '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' => '',
- 'type' => 'string',
- 'example' => '19720316234381****',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The system is busy. Please try again later.', 'title' => ''],
+ 'Data' => ['description' => 'A redundant parameter. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'D5C69894-9709-4653-B3D8-25234034C2FC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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 \\"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' => 'ListPSMemberDataTypeCode',
- 'requestParamsDescription' => ' ',
+ ['errorCode' => 'SYSTEMERROR', 'errorMessage' => 'The system is busy. Please try again later.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
+ 'title' => 'Upload device text data',
+ 'summary' => 'Uploads text-type phase data to the blockchain after signing by an IoT device, and optionally binds associated phase data from other phases.',
+ 'description' => '**Accessible accounts:**'."\n"
+ .'| Business administrator | Business user |'."\n"
+ .'| :--------: | :-----: |'."\n"
+ .'| √ | √ |.',
+ 'requestParamsDescription' => ' **RelatedData**'."\n"
+ .'|Parameter|Type|Required|Example|Description|'."\n"
+ .'|-|-|-|-|-|'."\n"
+ .'|relatedPhaseId|String|Yes|987823074334****|The ID of the related data phase.|'."\n"
+ .'|relatedDataKey|String|Yes|be350cd52b0f47846f93df7d0d4febd86025ee6c028a6b22a6ff1ac6d3a2****|The key value of the related data.|'."\n"
+ .'|relatedPhaseData|String|Yes|某公司某业务数据|The related phase data.|'."\n"
+ .'|relatedDataSeq|String|No|b71cca5502d8d7d0057a5ebf44d78ae75280436b86dcbda643c4d264ff2a****|The sequence number of the related data.|.',
'responseParamsDescription' => ' ',
+ 'extraInfo' => '## Error codes'."\n"
+ .'For more information about error codes, see [Error codes](~~184711~~).',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ltl.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.cn-shanghai.aliyuncs.com', 'endpoint' => 'ltl.cn-shanghai.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ltl.aliyuncs.com', 'endpoint' => 'ltl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'The system is busy, please try again later!'],
+ ['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' => 'Error codes changed', 'api' => 'ApplyDataModelConfigInfo'],
+ ['description' => 'Error codes changed', 'api' => 'GetDataModelConfigInfo'],
+ ['description' => 'Error codes changed', 'api' => 'ListDependentDataModels'],
+ ],
+ 'createdAt' => '2022-08-31T03:10:18.000Z',
+ 'description' => '下线无用API-3个',
],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
];