diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/opt/2021-07-30/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/opt/2021-07-30/api-docs.php')
| -rw-r--r-- | data/en_us/opt/2021-07-30/api-docs.php | 608 |
1 files changed, 334 insertions, 274 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 index 0fd72ea..8fc2a97 100644 --- a/data/en_us/opt/2021-07-30/api-docs.php +++ b/data/en_us/opt/2021-07-30/api-docs.php @@ -1,27 +1,16 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'opt', - 'version' => '2021-07-30', - ], + 'info' => ['style' => 'RPC', 'product' => 'opt', 'version' => '2021-07-30'], 'directories' => [ [ - 'id' => 74350, - 'title' => null, + 'children' => ['GetOpenStatus'], 'type' => 'directory', - 'children' => [ - 'GetOpenStatus', - ], + 'title' => 'Service', ], [ - 'id' => 74352, - 'title' => null, + 'children' => ['GetOrderInfo', 'GetOrderUsage'], 'type' => 'directory', - 'children' => [ - 'GetOrderInfo', - 'GetOrderUsage', - ], + 'title' => 'License', ], ], 'components' => [ @@ -29,15 +18,9 @@ ], 'apis' => [ 'GetOpenStatus' => [ - 'summary' => '查询开通状态', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves the activation status of all services in Optimization Solver, currently including the mathematical programming service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49,96 +32,67 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREoptZKJ6K3', - ], + 'abilityTreeNodes' => ['FEATUREoptZKJ6K3'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', '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', - ], + 'Code' => ['description' => 'The result status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The detailed data. mpStatus: the activation status of the mathematical programming service. A value of 1 indicates activated, and a value of 0 indicates not activated. pk: the Alibaba Cloud account ID. parentPk: the parent account ID.', 'type' => 'object', '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"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0EB-FCAC-1B78-BBB8-500ED951E9EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyInvalid', - 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', - ], + ['errorCode' => 'LicenseKeyInvalid', 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Unauthorized', - 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', - ], + ['errorCode' => 'Unauthorized', 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ConcurrencyOverLimit', - 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', - ], + ['errorCode' => 'ConcurrencyOverLimit', 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyExpired', - 'errorMessage' => 'LicenseKey has expired.', - ], + ['errorCode' => 'LicenseKeyExpired', 'errorMessage' => 'LicenseKey has expired.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve activation status of all services', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOpenStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'summary' => 'Retrieves information about purchased licenses.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -150,164 +104,119 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREoptZKJ6K3', - ], + 'abilityTreeNodes' => ['FEATUREoptZKJ6K3'], ], 'parameters' => [ [ 'name' => 'RelService', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MP', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The category of the purchased Optimization Solver license. Valid values:'."\n" + ."\n" + .'- `MP`: mathematical programming.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MP', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', + 'description' => 'The version of the purchased solver. Only one value is supported:'."\n" + ."\n" + .'- `1`: local runtime edition.', + 'type' => 'integer', 'format' => 'int32', + 'required' => true, + 'docRequired' => true, 'maximum' => '1', 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - 'enum' => [ - '1', - ], + 'enum' => ['1'], + 'example' => '1', + 'title' => '', ], ], [ 'name' => 'ListReleased', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to include released instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'example' => '0', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'success', - 'type' => 'string', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '{"licenseKey":"eems7ri3b1u5nui*****","currentConcurrency":2,"instanceId":"opt_mplicense_public_cn-****","totalDays":124,"currentDays":103}', + 'description' => 'The business data. licenseKey: the license key. currentConcurrency: the concurrency. instanceId: the instance ID. totalDays: the total number of purchased days. currentDays: the number of remaining days.', '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', - ], + 'currentConcurrency' => ['description' => 'The concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'totalDays' => ['description' => 'The total number of purchased days.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'currentDays' => ['description' => 'The number of remaining days.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'licenseKey' => ['description' => 'The license key.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'opt_mplicense_public_cn-xxxxxx', 'title' => ''], + 'bizType' => ['description' => 'The commodity type.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'remark' => ['description' => 'The instance remarks.', 'type' => 'string', 'example' => 'remark', 'title' => ''], + 'isReleased' => ['description' => 'Indicates whether the instance is released.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '{"licenseKey":"eems7ri3b1u5nui*****","currentConcurrency":2,"instanceId":"opt_mplicense_public_cn-****","totalDays":124,"currentDays":103}', + 'title' => '', ], - 'RequestId' => [ - 'description' => '', - 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyInvalid', - 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', - ], + ['errorCode' => 'LicenseKeyInvalid', 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Unauthorized', - 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', - ], + ['errorCode' => 'Unauthorized', 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ConcurrencyOverLimit', - 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', - ], + ['errorCode' => 'ConcurrencyOverLimit', 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyExpired', - 'errorMessage' => 'LicenseKey has expired.', - ], + ['errorCode' => 'LicenseKeyExpired', 'errorMessage' => 'LicenseKey has expired.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query purchased license information', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOrderInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'summary' => 'Retrieves the License usage.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -319,141 +228,292 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREoptZKJ6K3', - ], + 'abilityTreeNodes' => ['FEATUREoptZKJ6K3'], ], 'parameters' => [ [ 'name' => 'RelService', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MP', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The category of the purchased Optimization Solver License. The following category is supported:'."\n" + ."\n" + .'- `MP`: mathematical programming.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MP', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', + 'description' => 'The version of the purchased solver. Only the following value is supported:'."\n" + ."\n" + .'- `1`: local runtime edition.', + 'type' => 'integer', 'format' => 'int32', + 'required' => true, + 'docRequired' => true, 'maximum' => '1', 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - 'enum' => [ - '1', - ], + 'enum' => ['1'], + 'example' => '1', + 'title' => '', ], ], [ 'name' => 'LicenseKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The LicenseKey of the solver.', 'type' => 'string', 'required' => true, 'example' => 'eya5169y2bg96zef03s7', 'title' => ''], ], [ 'name' => 'TimeRange', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => '* `1`: one day before and after'."\n" + .'* `2`: one week before and after'."\n" + .'* `3`: one month before and after.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'success', - 'type' => 'string', - ], + 'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'success', 'title' => ''], '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', - ], + 'description' => 'The usage data.', 'type' => 'array', + 'items' => ['description' => 'The data item. The fields are described as follows:'."\n" + ."\n" + .'- `dateTime`: the corresponding time.'."\n" + .'- `actualConcurrency`: the actual concurrency.'."\n" + .'- `maxConcurrency`: the maximum concurrency.', 'type' => 'object', '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}]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid. Please check again.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid. Please check again.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyInvalid', - 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', - ], + ['errorCode' => 'LicenseKeyInvalid', 'errorMessage' => 'The license key format is invalid, or the license key does not belong to the user.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Unauthorized', - 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', - ], + ['errorCode' => 'Unauthorized', 'errorMessage' => 'The user has not passed RAM verification and is not authorized to perform the operation.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ConcurrencyOverLimit', - 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', - ], + ['errorCode' => 'ConcurrencyOverLimit', 'errorMessage' => 'The concurrency exceeds the upper limit allowed by the license key.', 'description' => ''], ], [ - [ - 'errorCode' => 'LicenseKeyExpired', - 'errorMessage' => 'LicenseKey has expired.', - ], + ['errorCode' => 'LicenseKeyExpired', 'errorMessage' => 'LicenseKey has expired.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query license usage', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOrderUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'opt.cn-beijing.aliyuncs.com', 'endpoint' => 'opt.cn-beijing.aliyuncs.com', 'vpc' => 'opt-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'opt.us-east-1.aliyuncs.com', 'endpoint' => 'opt.us-east-1.aliyuncs.com', 'vpc' => 'opt-vpc.us-east-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'ConcurrencyOverLimit', 'message' => 'The concurrency exceeds the upper limit allowed by the license key.', 'http_code' => 409, 'description' => ''], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid. Please check again.', 'http_code' => 400, 'description' => ''], + ['code' => 'LicenseKeyExpired', 'message' => 'LicenseKey has expired.', 'http_code' => 410, 'description' => ''], + ['code' => 'LicenseKeyInvaild', 'message' => 'The license key format is invalid, or the license key does not belong to the user.', 'http_code' => 401, 'description' => ''], + ['code' => 'LicenseKeyInvalid', 'message' => 'The licence key format is invalid, or the licence key does not belong to the user.', 'http_code' => 401, 'description' => 'The authorization certificate is in the wrong format or does not belong to this user.'], + ['code' => 'Unauthorized', 'message' => 'The user has not passed RAM verification and is not authorized to perform the operation.', 'http_code' => 403, 'description' => ''], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'OPT', + 'productName' => 'Optimization Solver', + 'ramCodes' => ['opt', 'opt-inner'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ReleaseLicense', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opt:ReleaseLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFixedLicense', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'opt:ListFixedLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AcquireToken', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opt:AcquireToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'MpLicense', 'arn' => 'acs:opt:{#regionId}:{#accountId}:mplicense/{#LicenseKey}'], + ], + ], + ], + [ + 'apiName' => 'GenerateFixedLicense', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'opt:GenerateFixedLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'Remark', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'opt:Remark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetOpenStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOpenStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetOrderUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOrderUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FixedLicenseRefund', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'opt:FixedLicenseRefund', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseWholeKey', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opt:ReleaseWholeKey', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'MpLicense', 'arn' => 'acs:opt:{#regionId}:{#accountId}:mplicense/{#LicenseKey}'], + ], + ], + ], + [ + 'apiName' => 'GetOrderInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'opt:GetOrderInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseToken', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'opt:ReleaseToken', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'OPT', 'resourceType' => 'MpLicense', 'arn' => 'acs:opt:{#regionId}:{#accountId}:mplicense/{#LicenseKey}'], + ], + ], + ], ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'opt.us-east-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'MpLicense', 'arn' => 'acs:opt:{#regionId}:{#accountId}:mplicense/{#LicenseKey}'], + ['validationType' => 'conditional', 'resourceType' => 'MpLicense', 'arn' => 'acs:opt:{#regionId}:{#accountId}:mplicense/*'], ], ], ]; |
