diff options
Diffstat (limited to 'data/en_us/opt/2021-07-30')
| -rw-r--r-- | data/en_us/opt/2021-07-30/api-docs.php | 459 |
1 files changed, 459 insertions, 0 deletions
diff --git a/data/en_us/opt/2021-07-30/api-docs.php b/data/en_us/opt/2021-07-30/api-docs.php new file mode 100644 index 0000000..0fd72ea --- /dev/null +++ b/data/en_us/opt/2021-07-30/api-docs.php @@ -0,0 +1,459 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'opt', + 'version' => '2021-07-30', + ], + 'directories' => [ + [ + 'id' => 74350, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetOpenStatus', + ], + ], + [ + 'id' => 74352, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetOrderInfo', + 'GetOrderUsage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetOpenStatus' => [ + 'summary' => '查询开通状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREoptZKJ6K3', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'Code' => [ + 'description' => '', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Message' => [ + 'description' => '', + 'example' => 'success', + 'type' => 'string', + ], + 'Data' => [ + 'description' => '', + 'example' => '{"gmtModified":"2021-07-27T04:00:00.000+00:00","mpStatus":1,"id":11,"pk":"1084126944995576","gmtCreate":"2021-07-27T04:00:00.000+00:00","parentPk":"1084126944995576"}', + 'type' => 'object', + ], + 'RequestId' => [ + 'description' => '', + 'example' => '0EB-FCAC-1B78-BBB8-500ED951E9EB', + 'type' => 'string', + ], + 'Success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid. Please check again.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyInvalid', + 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConcurrencyOverLimit', + 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyExpired', + 'errorMessage' => 'LicenseKey has expired.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"gmtModified\\": \\"2021-07-27T04:00:00.000+00:00\\",\\n \\"mpStatus\\": 1,\\n \\"id\\": 11,\\n \\"pk\\": \\"1084126944995576\\",\\n \\"gmtCreate\\": \\"2021-07-27T04:00:00.000+00:00\\",\\n \\"parentPk\\": \\"1084126944995576\\"\\n },\\n \\"RequestId\\": \\"0EB-FCAC-1B78-BBB8-500ED951E9EB\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOpenStatusResponse>\\n <Message>Success</Message>\\n <RequestId>D66E40EB-FCAC-1B78-BBB8-500ED951E9EB</RequestId>\\n <Data>\\n <gmtModified>2021-07-27T04:00:00.000+00:00</gmtModified>\\n <mpStatus>1</mpStatus>\\n <id>11</id>\\n <pk>1084126944995576</pk>\\n <gmtCreate>2021-07-27T04:00:00.000+00:00</gmtCreate>\\n <parentPk>1084126944995576</parentPk>\\n </Data>\\n <Code>0</Code>\\n <Success>true</Success>\\n</GetOpenStatusResponse>","errorExample":""}]', + ], + 'GetOrderInfo' => [ + 'summary' => 'Obtain the information of the purchased license.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREoptZKJ6K3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RelService', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'MP', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'maximum' => '1', + 'minimum' => '1', + 'required' => true, + 'type' => 'integer', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'ListReleased', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'Code' => [ + 'description' => '', + 'example' => '0', + 'type' => 'string', + ], + 'Message' => [ + 'description' => '', + 'example' => 'success', + 'type' => 'string', + ], + 'Data' => [ + 'description' => '', + 'example' => '{"licenseKey":"eems7ri3b1u5nui*****","currentConcurrency":2,"instanceId":"opt_mplicense_public_cn-****","totalDays":124,"currentDays":103}', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'currentConcurrency' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'totalDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'currentDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'licenseKey' => [ + 'type' => 'string', + ], + 'instanceId' => [ + 'type' => 'string', + ], + 'bizType' => [ + 'type' => 'string', + ], + 'remark' => [ + 'type' => 'string', + ], + 'isReleased' => [ + 'type' => 'boolean', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', + 'type' => 'string', + ], + 'Success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid. Please check again.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyInvalid', + 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConcurrencyOverLimit', + 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyExpired', + 'errorMessage' => 'LicenseKey has expired.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n {\\n \\"currentConcurrency\\": 1,\\n \\"totalDays\\": 10,\\n \\"currentDays\\": 1,\\n \\"licenseKey\\": \\"xxxxxxxx\\",\\n \\"instanceId\\": \\"opt_mplicense_public_cn-xxxxxx\\",\\n \\"bizType\\": \\"0\\",\\n \\"remark\\": \\"remark\\",\\n \\"isReleased\\": true\\n }\\n ],\\n \\"RequestId\\": \\"5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOrderInfoResponse>\\n <Message>Success</Message>\\n <RequestId>3FCE6765-742C-1CE7-A44B-83D35C07F286</RequestId>\\n <Data>\\n <licenseKey>eems7ri3b1u5nuil***</licenseKey>\\n <currentConcurrency>2</currentConcurrency>\\n <instanceId>opt_mplicense_public_cn-****</instanceId>\\n <totalDays>124</totalDays>\\n <currentDays>103</currentDays>\\n </Data>\\n <Code>0</Code>\\n <Success>true</Success>\\n</GetOrderInfoResponse>","errorExample":""}]', + 'title' => 'Query purchased License information', + ], + 'GetOrderUsage' => [ + 'summary' => '查看Licence用量', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREoptZKJ6K3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RelService', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => 'MP', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'maximum' => '1', + 'minimum' => '1', + 'required' => true, + 'type' => 'integer', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'LicenseKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'Message' => [ + 'description' => '', + 'example' => 'success', + 'type' => 'string', + ], + 'Data' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '[{"dateTime":"2021-08-17 15:00:00","actualConcurrency":0,"maxConcurrency":2},{"dateTime":"2021-08-17 16:00:00","actualConcurrency":0,"maxConcurrency":2},{"dateTime":"2021-08-17 17:00:00","actualConcurrency":0,"maxConcurrency":2}]', + 'type' => 'object', + ], + 'type' => 'array', + ], + 'RequestId' => [ + 'description' => '', + 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', + 'type' => 'string', + ], + 'Success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + ], + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The parameter is invalid. Please check again.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyInvalid', + 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConcurrencyOverLimit', + 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', + ], + ], + [ + [ + 'errorCode' => 'LicenseKeyExpired', + 'errorMessage' => 'LicenseKey has expired.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n [\\n {\\n \\"dateTime\\": \\"2021-08-17 15:00:00\\",\\n \\"actualConcurrency\\": 0,\\n \\"maxConcurrency\\": 2\\n },\\n {\\n \\"dateTime\\": \\"2021-08-17 16:00:00\\",\\n \\"actualConcurrency\\": 0,\\n \\"maxConcurrency\\": 2\\n },\\n {\\n \\"dateTime\\": \\"2021-08-17 17:00:00\\",\\n \\"actualConcurrency\\": 0,\\n \\"maxConcurrency\\": 2\\n }\\n ]\\n ],\\n \\"RequestId\\": \\"5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOrderUsageResponse>\\n <Message>Success</Message>\\n <RequestId>B26B09CF-8F7F-1E6D-8E21-CD37A1BB32DB</RequestId>\\n <Data>\\n <dateTime>2021-08-17 15:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 16:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 17:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 18:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 19:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 20:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 21:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 22:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-17 23:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 00:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 01:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 02:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 03:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 04:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 05:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 06:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 07:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 08:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 09:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 10:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 11:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 12:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 13:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 14:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 15:00:00</dateTime>\\n <actualConcurrency>0</actualConcurrency>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 16:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 17:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 18:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 19:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 20:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 21:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 22:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-18 23:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 00:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 01:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 02:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 03:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 04:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 05:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 06:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 07:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 08:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 09:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 10:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 11:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 12:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 13:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 14:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Data>\\n <dateTime>2021-08-19 15:00:00</dateTime>\\n <maxConcurrency>2</maxConcurrency>\\n </Data>\\n <Success>true</Success>\\n</GetOrderUsageResponse>","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'opt.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'opt.us-east-1.aliyuncs.com', + ], + ], +]; |