tccli-intl-en 3.0.1168.1__py2.py3-none-any.whl → 3.1.16.1__py2.py3-none-any.whl

tccli/services/tbaas/v20180416/api.json

@@ -0,0 +1,551 @@
+{
+  "actions": {
+    "DescribeFabricBlock": {
+      "document": "This API is used to retrieve the detailed information of a block in Fabric.",
+      "input": "DescribeFabricBlockRequest",
+      "name": "Retrieve detailed information of a Fabric block",
+      "output": "DescribeFabricBlockResponse",
+      "status": "online"
+    },
+    "DescribeFabricTransaction": {
+      "document": "This API is used to obtain detailed information of Fabric transactions.",
+      "input": "DescribeFabricTransactionRequest",
+      "name": "Retrieve detailed information of a Fabric transaction",
+      "output": "DescribeFabricTransactionResponse",
+      "status": "online"
+    },
+    "InvokeFabricChaincode": {
+      "document": "This API is used to call a Fabric user contract to execute a transaction.",
+      "input": "InvokeFabricChaincodeRequest",
+      "name": "Calls a Fabric user contract to execute a transaction",
+      "output": "InvokeFabricChaincodeResponse",
+      "status": "online"
+    },
+    "QueryFabricChaincode": {
+      "document": "This API is used to make a user contract call in Fabric for querying.",
+      "input": "QueryFabricChaincodeRequest",
+      "name": "Calls the Fabric user contract to query",
+      "output": "QueryFabricChaincodeResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2018-04-16",
+    "serviceNameCN": "腾讯云区块链服务平台 TBaaS",
+    "serviceShortName": "tbaas"
+  },
+  "objects": {
+    "DescribeFabricBlockRequest": {
+      "document": "DescribeFabricBlock request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Cluster ID, which can be obtained from the blockchain cluster details or in the list.",
+          "example": "fabric-65z42qi150",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Channel ID, which can be obtained from the channel list or channel detail.",
+          "example": "channel-9xej4d",
+          "member": "string",
+          "name": "ChannelId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Block height, starting from 0.",
+          "example": "4",
+          "member": "int64",
+          "name": "BlockHeight",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeFabricBlockResponse": {
+      "document": "DescribeFabricBlock response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Block height.",
+          "example": "1024",
+          "member": "int64",
+          "name": "BlockHeight",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Block Hash.",
+          "example": "90af8cff95cfc2b9caeafc9d53bc04a699ef47e381143d66e5d03548deab1aa5 ",
+          "member": "string",
+          "name": "BlockHash",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Pre-Block Hash.",
+          "example": "1d40d9c1fc8929c0b5ba4048f6a756543695664976cec7c8ac76e587587dfa01",
+          "member": "string",
+          "name": "PreBlockHash",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The number of transactions in a block.",
+          "example": "100",
+          "member": "int64",
+          "name": "TxCount",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction list in the block.",
+          "example": "无",
+          "member": "Transaction",
+          "name": "TransactionList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Creation Timestamp",
+          "example": "2023-08-05 07:44:04",
+          "member": "string",
+          "name": "CreateTimestamp",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Proposal organization.",
+          "example": "testorg",
+          "member": "string",
+          "name": "ProposerOrg",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeFabricTransactionRequest": {
+      "document": "DescribeFabricTransaction request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Cluster ID, which can be obtained from the blockchain cluster details or in the list.",
+          "example": "fabric-65z42qi150",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Channel ID, which can be obtained from the channel list or channel detail.",
+          "example": "channel-9xej4d",
+          "member": "string",
+          "name": "ChannelId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Transaction ID",
+          "example": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229",
+          "member": "string",
+          "name": "TxId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeFabricTransactionResponse": {
+      "document": "DescribeFabricTransaction response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Transaction ID",
+          "example": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229",
+          "member": "string",
+          "name": "TxId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction Hash.",
+          "example": "8e5b978d33cfbc0510b4e60406f8481f8ec00e390131d5b6ea6d38604e1bcb46",
+          "member": "string",
+          "name": "TxHash",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction status.",
+          "example": "VALID",
+          "member": "string",
+          "name": "TxStatus",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Organization list involved.",
+          "example": "[\"\"org-xxxx.fabric-ian2bqtylk\"\"]",
+          "member": "string",
+          "name": "JoinOrgList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction sender.",
+          "example": "org-xxxx.fabric-ian2bqtylk",
+          "member": "string",
+          "name": "Sender",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Creation time",
+          "example": "2023-07-07 10:10:10",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Block height.",
+          "example": "1024",
+          "member": "int64",
+          "name": "BlockHeight",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The contract to which the exchange belongs.",
+          "example": "fact",
+          "member": "string",
+          "name": "ChaincodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction data, base64 encoded, decoded as a json string.",
+          "example": "eyJjaGFpbmNvZGVfc3BlYyI6eyJ0aW1lb3V0IjowLCJ0eXBlIjoiVU5ERUZJTkVEIn19",
+          "member": "string",
+          "name": "TransactionData",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "InvokeFabricChaincodeRequest": {
+      "document": "InvokeFabricChaincode request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Cluster ID, which can be obtained from the blockchain cluster details.",
+          "example": "fabric-65z42qi150",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Channel ID, which can be obtained from the channel list or channel detail.",
+          "example": "channel-9xej4d",
+          "member": "string",
+          "name": "ChannelId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract name. it can be obtained from the contract list or contract details.",
+          "example": "fact",
+          "member": "string",
+          "name": "ChaincodeName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract method.",
+          "example": "Set",
+          "member": "string",
+          "name": "FuncName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract method input parameter.",
+          "example": "[\"key\",\"value\"]",
+          "member": "string",
+          "name": "FuncParam",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "Whether to execute asynchronously. if so, use the transaction TxID in the return value to query the execution result.",
+          "example": "false",
+          "member": "bool",
+          "name": "WithAsyncResult",
+          "required": false,
+          "type": "bool"
+        }
+      ],
+      "type": "object"
+    },
+    "InvokeFabricChaincodeResponse": {
+      "document": "InvokeFabricChaincode response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Transaction ID",
+          "example": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229",
+          "member": "string",
+          "name": "TxId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction status.",
+          "example": "VALID",
+          "member": "string",
+          "name": "TxStatus",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction result.",
+          "example": "value",
+          "member": "string",
+          "name": "TxResult",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "QueryFabricChaincodeRequest": {
+      "document": "QueryFabricChaincode request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Cluster ID, which can be obtained from the blockchain cluster details.",
+          "example": "fabric-65z42qi150",
+          "member": "string",
+          "name": "ClusterId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Channel ID, which can be obtained from the channel list or channel details.",
+          "example": "channel-9xej4d",
+          "member": "string",
+          "name": "ChannelId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract name. it can be obtained from the contract list or contract details.",
+          "example": "fact",
+          "member": "string",
+          "name": "ChaincodeName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract method.",
+          "example": "Get",
+          "member": "string",
+          "name": "FuncName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Contract method input parameter.",
+          "example": "[\"key\"]",
+          "member": "string",
+          "name": "FuncParam",
+          "required": false,
+          "type": "list"
+        }
+      ],
+      "type": "object"
+    },
+    "QueryFabricChaincodeResponse": {
+      "document": "QueryFabricChaincode response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Transaction ID",
+          "example": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229",
+          "member": "string",
+          "name": "TxId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction status.",
+          "example": "VALID",
+          "member": "string",
+          "name": "TxStatus",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction result.",
+          "example": "value",
+          "member": "string",
+          "name": "TxResult",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "Transaction": {
+      "document": "Transaction overview information display.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Transaction ID",
+          "example": "af5b8ec2e660461f9a32ec3c9ec151688a1c83e6ebb94815a21e84fbc29cf7c2",
+          "member": "string",
+          "name": "TxId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Contract name.",
+          "example": "save",
+          "member": "string",
+          "name": "ChaincodeName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction sender.",
+          "example": "zhangsan",
+          "member": "string",
+          "name": "Sender",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Transaction creation time.",
+          "example": "2023-07-07 10:10:10",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The block height where the trading platform is located.",
+          "example": "1024",
+          "member": "int64",
+          "name": "BlockHeight",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The serial number of a transaction in a block.",
+          "example": "0",
+          "member": "int64",
+          "name": "TxIndex",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    }
+  },
+  "version": "1.0"
+}

tccli/services/tbaas/v20180416/examples.json

@@ -0,0 +1,37 @@
+{
+  "actions": {
+    "DescribeFabricBlock": [
+      {
+        "document": "DescribeFabricBlock",
+        "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFabricBlock\n<Common request parameters>\n\n{\n    \"ClusterId\": \"fabric-65z42qi150\",\n    \"ChannelId\": \"channel-9xej4d\",\n    \"BlockHeight\": 4\n}",
+        "output": "{\n    \"Response\": {\n        \"BlockHash\": \"e0421ecc20340425a2cf01808469b2523651f8100da92a0287b3769115e57370\",\n        \"BlockHeight\": 4,\n        \"CreateTimestamp\": \"2023-08-05 07:44:04\",\n        \"PreBlockHash\": \"f69b2b5a1884e5bbb077a3025378e2210b83bbada23b5c17045b0bf537a53bd0\",\nProposerOrg: Blockchain test organization pettychen\n        \"RequestId\": \"a6288649-01c0-4d8f-bdd4-ba02163d0721\",\n        \"TransactionList\": [\n            {\n                \"BlockHeight\": 4,\n                \"ChaincodeName\": \"_lifecycle\",\n                \"CreateTime\": \"2023-08-05 15:44:04\",\nSender: Blockchain test organization\n                \"TxId\": \"03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229\"\n            }\n        ],\n        \"TxCount\": 1\n    }\n}",
+        "title": "DescribeFabricBlock"
+      }
+    ],
+    "DescribeFabricTransaction": [
+      {
+        "document": "DescribeFabricTransaction",
+        "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFabricTransaction\n<Common request parameters>\n\n{\n    \"ClusterId\": \"fabric-65z42qi150\",\n    \"ChannelId\": \"channel-9xej4d\",\n    \"TxId\": \"03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229\"\n}",
+        "output": "{\n    \"Response\": {\n        \"BlockHeight\": 4,\n        \"ChaincodeName\": \"_lifecycle\",\n        \"CreateTime\": \"2023-08-05 15:44:04\",\n        \"JoinOrgList\": [\n            \"org-xxxx.fabric-ian2bqtylk\"\n        ],\n        \"RequestId\": \"b5221353-8f20-4547-8260-c550b4b0175c\",\n        \"Sender\": \"org-xxxx.fabric-ian2bqtylk\",\n        \"TransactionData\": \"eyJjaGFpbmNvZGVfc3BlYyI6eyJjaGFpbmNvZGVfaWQiOnsibmFtZSI6Il9saWZlY3ljbGUiLCJwYXRoIjoiIiwidmVyc2lvbiI6IiJ9LCJpbnB1dCI6eyJhcmdzIjpbIkNvbW1pdENoYWluY29kZURlZmluaXRpb24iLCJcdTAwMDhcdTAwMDFcdTAwMTJcdTAwMDNteWNcdTAwMWFcdTAwMDR2MS4wXCJcdTAwMDRlc2NjKlx1MDAwNHZzY2MyMVxuL1x1MDAxMlx1MDAwOFx1MDAxMlx1MDAwNlx1MDAwOFx1MDAwMVx1MDAxMlx1MDAwMlx1MDAwOFx1MDAwMFx1MDAxYSNcdTAwMTIhXG5cdTAwMWZvcmctMjUxMDA1NzQ2LmZhYnJpYy02NXo0MnFpMTUwOlx1MDAwMCJdLCJkZWNvcmF0aW9ucyI6e30sImlzX2luaXQiOmZhbHNlfSwidGltZW91dCI6MCwidHlwZSI6IlVOREVGSU5FRCJ9fQ==\",\n        \"TxHash\": \"8e5b978d33cfbc0510b4e60406f8481f8ec00e390131d5b6ea6d38604e1bcb46\",\n        \"TxId\": \"03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229\",\n        \"TxStatus\": \"VALID\"\n    }\n}",
+        "title": "DescribeFabricTransaction"
+      }
+    ],
+    "InvokeFabricChaincode": [
+      {
+        "document": "InvokeFabricChaincode",
+        "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InvokeFabricChaincode\n<Common request parameters>\n\n{\n    \"ClusterId\": \"fabric-65z42qi150\",\n    \"ChannelId\": \"channel-9xej4d\",\n    \"ChaincodeName\": \"fact\",\n    \"FuncName\": \"Set\",\n    \"FuncParam\": [\n        \"D\",\n        \"40\"\n    ],\n    \"WithAsyncResult\": false\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"bab100f3-be40-415c-b29b-3a44c77b25fe\",\n        \"TxId\": \"0595a33e308170b035e0d97c1a79274ac55badf048c0c8fc569719e14a2990c5\",\n        \"TxResult\": \"\",\n        \"TxStatus\": \"VALID\"\n    }\n}",
+        "title": "InvokeFabricChaincode"
+      }
+    ],
+    "QueryFabricChaincode": [
+      {
+        "document": "QueryFabricChaincode",
+        "input": "POST / HTTP/1.1\nHost: tbaas.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryFabricChaincode\n<Common request parameters>\n\n{\n    \"ClusterId\": \"fabric-65z42qi150\",\n    \"ChannelId\": \"channel-9xej4d\",\n    \"ChaincodeName\": \"fact\",\n    \"FuncName\": \"Get\",\n    \"FuncParam\": [\n        \"A\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"e431d04c-2a5c-43b4-a480-f127b3f46eb6\",\n        \"TxId\": \"030acb112f9f2aa2ce537fea9d94d2f3c9ec6cf8e05aa62f5d3746167825dbe8\",\n        \"TxResult\": \"10\",\n        \"TxStatus\": \"VALID\"\n    }\n}",
+        "title": "QueryFabricChaincode"
+      }
+    ]
+  },
+  "version": "1.0"
+}