diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/bssopenapi/2017-12-14/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/bssopenapi/2017-12-14/api-docs.php')
| -rw-r--r-- | data/en_us/bssopenapi/2017-12-14/api-docs.php | 22409 |
1 files changed, 22409 insertions, 0 deletions
diff --git a/data/en_us/bssopenapi/2017-12-14/api-docs.php b/data/en_us/bssopenapi/2017-12-14/api-docs.php new file mode 100644 index 0000000..0e1ea20 --- /dev/null +++ b/data/en_us/bssopenapi/2017-12-14/api-docs.php @@ -0,0 +1,22409 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'BssOpenApi', + 'version' => '2017-12-14', + ], + 'directories' => [ + [ + 'id' => 179160, + 'title' => 'Capital Flow', + 'type' => 'directory', + 'children' => [ + 'QueryAccountBalance', + 'QueryAccountTransactionDetails', + 'QueryAccountTransactions', + ], + ], + [ + 'id' => 116853, + 'title' => 'Financial Association', + 'type' => 'directory', + 'children' => [ + 'QueryRelationList', + 'QueryPermissionList', + 'GetAccountRelation', + 'AddAccountRelation', + 'ModifyAccountRelation', + 'ConfirmRelation', + 'RelieveAccountRelation', + ], + ], + [ + 'id' => 116859, + 'title' => 'Resource Tag', + 'type' => 'directory', + 'children' => [ + 'QueryInstanceByTag', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 116863, + 'title' => 'Card Coupon', + 'type' => 'directory', + 'children' => [ + 'QueryPrepaidCards', + 'QueryRedeem', + 'QueryCashCoupons', + ], + ], + [ + 'id' => 116874, + 'title' => 'Saving Plan', + 'type' => 'directory', + 'children' => [ + 'QuerySavingsPlansInstance', + 'QuerySavingsPlansDeductLog', + 'DescribeSavingsPlansUsageTotal', + 'DescribeSavingsPlansUsageDetail', + 'DescribeSavingsPlansCoverageTotal', + 'DescribeSavingsPlansCoverageDetail', + 'QuerySavingsPlansDiscount', + ], + ], + [ + 'id' => 116881, + 'title' => 'Virtual Quotient Quota', + 'type' => 'directory', + 'children' => [ + 'CreateResellerUserQuota', + 'SetResellerUserQuota', + 'ChangeResellerConsumeAmount', + 'QueryResellerAvailableQuota', + 'SetResellerUserAlarmThreshold', + 'QueryResellerUserAlarmThreshold', + 'SetResellerUserStatus', + ], + ], + [ + 'id' => 116886, + 'title' => 'Virtual Merchant Account', + 'type' => 'directory', + 'children' => [ + 'CreateAgAccount', + 'GetCustomerAccountInfo', + 'GetCustomerList', + ], + ], + [ + 'id' => 116890, + 'title' => 'Resource Package', + 'type' => 'directory', + 'children' => [ + 'QueryResourcePackageInstances', + 'QueryDPUtilizationDetail', + 'QueryRIUtilizationDetail', + 'DescribeResourceUsageTotal', + 'DescribeResourceUsageDetail', + 'DescribeResourceCoverageTotal', + 'DescribeResourceCoverageDetail', + 'DescribeResourcePackageProduct', + 'GetResourcePackagePrice', + 'RenewResourcePackage', + 'UpgradeResourcePackage', + ], + ], + [ + 'id' => 116904, + 'title' => 'Financial Bills', + 'type' => 'directory', + 'children' => [ + 'SubscribeBillToOSS', + 'UnsubscribeBillToOSS', + 'QueryBillToOSSSubscription', + 'QueryBillOverview', + 'QueryBill', + 'QueryAccountBill', + 'QuerySettleBill', + 'QueryInstanceBill', + 'DescribeInstanceBill', + 'QueryInstanceGaapCost', + 'DescribeInstanceAmortizedCostByAmortizationPeriod', + 'DescribeProductAmortizedCostByAmortizationPeriod', + 'DescribeInstanceAmortizedCostByConsumePeriod', + 'DescribeProductAmortizedCostByConsumePeriod', + 'DescribeSplitItemBill', + 'QuerySplitItemBill', + ], + ], + [ + 'id' => 116920, + 'title' => 'Inquiry', + 'type' => 'directory', + 'children' => [ + 'InquiryPriceRefundInstance', + 'GetPayAsYouGoPrice', + 'GetSubscriptionPrice', + ], + ], + [ + 'id' => 116924, + 'title' => 'Instance', + 'type' => 'directory', + 'children' => [ + 'QueryAvailableInstances', + 'ReleaseInstance', + 'CreateInstance', + 'ModifyInstance', + 'SetRenewal', + 'ConvertChargeType', + 'RenewInstance', + 'RefundInstance', + ], + ], + [ + 'id' => 116931, + 'title' => 'Order', + 'type' => 'directory', + 'children' => [ + 'GetOrderDetail', + 'QueryOrders', + 'CancelOrder', + ], + ], + [ + 'id' => 116935, + 'title' => 'Financial Unit', + 'type' => 'directory', + 'children' => [ + 'CreateCostUnit', + 'AllocateCostUnitResource', + 'DeleteCostUnit', + 'ModifyCostUnit', + 'QueryCostUnit', + 'QueryCostUnitResource', + 'QueryFinancialAccountInfo', + ], + ], + [ + 'id' => 116943, + 'title' => 'Invoice', + 'type' => 'directory', + 'children' => [ + 'QueryEvaluateList', + 'QueryCustomerAddressList', + 'QueryInvoicingCustomerList', + 'ApplyInvoice', + ], + ], + [ + 'id' => 116949, + 'title' => 'Product', + 'type' => 'directory', + 'children' => [ + 'QuerySkuPriceList', + 'QueryCommodityList', + 'QueryPriceEntityList', + 'DescribePricingModule', + 'QueryProductList', + ], + ], + [ + 'id' => 169993, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'QueryUserOmsData', + 'SetAllExpirationDay', + 'DescribeCostBudgetsSummary', + 'RenewChangeInstance', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'QueryAccountBalance' => [ + 'summary' => 'Queries the balance of your account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '16176743-6DC7-4CB3-BB25-A13982D8DFAD', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AvailableAmount' => [ + 'description' => 'The available balance of the account.'."\n", + 'type' => 'string', + 'example' => '10000.00', + ], + 'CreditAmount' => [ + 'description' => 'The credit balance of the account.'."\n", + 'type' => 'string', + 'example' => '0.00', + ], + 'MybankCreditAmount' => [ + 'description' => 'The credit line controlled by MYbank.'."\n", + 'type' => 'string', + 'example' => '0.00', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'* CNY: Chinese Yuan'."\n" + .'* USD: US dollar'."\n" + .'* JPY: Japanese Yen'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'AvailableCashAmount' => [ + 'description' => 'The available balance in cash.'."\n", + 'type' => 'string', + 'example' => '10000.00', + ], + 'QuotaLimit' => [ + 'description' => 'The quota limit for eco customers.', + 'type' => 'string', + 'example' => '10000.00'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => ' Some parameters arte mandatoryfor this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Some parametersare not valid.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specifiedowner doesn’t belong to caller', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'AuthSiteFail', + 'errorMessage' => 'auth site failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"16176743-6DC7-4CB3-BB25-A13982D8DFAD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AvailableAmount\\": \\"10000.00\\",\\n \\"CreditAmount\\": \\"0.00\\",\\n \\"MybankCreditAmount\\": \\"0.00\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"AvailableCashAmount\\": \\"10000.00\\",\\n \\"QuotaLimit\\": \\"10000.00\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAccountBalanceResponse>\\n <Message>success</Message>\\n <RequestId>16176743-6DC7-4CB3-BB25-A13982D8DFAD</RequestId>\\n <Data>\\n <AvailableCashAmount>0.00</AvailableCashAmount>\\n <MybankCreditAmount>0.00</MybankCreditAmount>\\n <Currency>CNY</Currency>\\n <AvailableAmount>-11.19</AvailableAmount>\\n <CreditAmount>0.00</CreditAmount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryAccountBalanceResponse>","errorExample":""}]', + 'title' => 'QueryAccountBalance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAccountTransactionDetails' => [ + 'summary' => 'Queries the details of transactions within your account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TransactionNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the transaction.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '410874027490089', + ], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order or bill.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022120336190912', + ], + ], + [ + 'name' => 'TransactionChannelSN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The serial number of the transaction channel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022112122001470591458665933', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the creation time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-20', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the creation time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-20', + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the transaction.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CHARGE', + ], + ], + [ + 'name' => 'TransactionChannel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The transaction channel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALIPAY', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used for paging.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ABEDSDS124DASA', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The responses.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'asadadad-edafafafaasd', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used for paging.'."\n", + 'type' => 'string', + 'example' => 'ASHDADS', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MaxResults' => [ + 'description' => 'This parameter is invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'yidi', + ], + 'AccountTransactionsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountTransactionsList' => [ + 'description' => 'The details of the transactions within the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => 'The billing cycle.'."\n", + 'type' => 'string', + 'example' => '2022-10', + ], + 'TransactionChannel' => [ + 'description' => 'The transaction channel.'."\n", + 'type' => 'string', + 'example' => 'ALIPAY', + ], + 'RecordID' => [ + 'description' => 'The ID of the order or bill.'."\n", + 'type' => 'string', + 'example' => '2022120336190912', + ], + 'Remarks' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + 'example' => 'Test'."\n", + ], + 'Amount' => [ + 'description' => 'The amount of the transaction.'."\n", + 'type' => 'string', + 'example' => '1.00', + ], + 'TransactionAccount' => [ + 'description' => 'The transaction account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'TransactionTime' => [ + 'description' => 'The time when the transaction was made.'."\n", + 'type' => 'string', + 'example' => '2022-10-01', + ], + 'TransactionType' => [ + 'description' => 'The type of the transaction. If one of the following transaction types is specified, results for the specified transaction type are returned. If the transaction type that you specified does not belong to the following transaction types, no result is returned. If the parameter is left empty, results for all transaction types are returned. Valid values:'."\n" + ."\n" + .'Payment, Withdraw, Refund, Consumption, Transfer, and Adjust.'."\n", + 'type' => 'string', + 'example' => 'Consumption', + ], + 'TransactionFlow' => [ + 'description' => 'Indicates whether the transaction is of the income type or the expenditure type. If one of the following types is specified, results for the specific type are returned. If the type that you specified for the parameter does not belong to the following types, no result is returned. If the parameter is left empty, results for transactions of the income and expenditure types are all returned. Valid values:'."\n" + ."\n" + .'Income and Expense.'."\n", + 'type' => 'string', + 'example' => 'Income', + ], + 'FundType' => [ + 'description' => 'The type of transaction payment. Valid values:'."\n" + ."\n" + .'Cash: pay for the transaction in cash. Deposit: pay for the transaction with deposit. RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank. DirectPay: directly pay for the transaction.'."\n", + 'type' => 'string', + 'example' => 'Cash', + ], + 'TransactionChannelSN' => [ + 'description' => 'The serial number of the transaction channel.'."\n", + 'type' => 'string', + 'example' => '123232434343532', + ], + 'TransactionNumber' => [ + 'description' => 'The number of the transaction.'."\n", + 'type' => 'string', + 'example' => '43342334', + ], + 'Balance' => [ + 'description' => 'The balance of the account.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"asadadad-edafafafaasd\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"ASHDADS\\",\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 0,\\n \\"AccountName\\": \\"yidi\\",\\n \\"AccountTransactionsList\\": {\\n \\"AccountTransactionsList\\": [\\n {\\n \\"BillingCycle\\": \\"2022-10\\",\\n \\"TransactionChannel\\": \\"Alipay\\",\\n \\"RecordID\\": \\"2022120336190912\\",\\n \\"Remarks\\": \\"测试\\",\\n \\"Amount\\": \\"1.00\\",\\n \\"TransactionAccount\\": \\"[email protected]\\",\\n \\"TransactionTime\\": \\"2022-10-01\\",\\n \\"TransactionType\\": \\"Consumption\\",\\n \\"TransactionFlow\\": \\"Income\\",\\n \\"FundType\\": \\"Cash\\",\\n \\"TransactionChannelSN\\": \\"123232434343532\\",\\n \\"TransactionNumber\\": \\"43342334\\",\\n \\"Balance\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'QueryAccountTransactions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TransactionNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the transaction.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '133314076', + ], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order or bill.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20200302', + ], + ], + [ + 'name' => 'TransactionChannelSN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The serial number of the transaction channel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12342134', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the creation time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-05T01:46:09Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the creation time range to query. By default, the transactions in the last month are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-06T01:55:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value is 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value is 20.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the transaction. If you specify one of the following transaction types for this parameter, the results for the specified transaction type are returned. If the transaction type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for all the following transaction types are returned by default. Valid values:'."\n" + ."\n" + .'* Payment'."\n" + .'* Withdraw'."\n" + .'* Refund'."\n" + .'* Consumption'."\n" + .'* Transfer'."\n" + .'* Adjust'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Payment', + 'enum' => [ + 'Adjust', + 'Payment', + 'Refund', + 'Withdraw', + 'Consumption', + 'Pay_Fail_Refund', + 'Transfer', + ], + ], + ], + [ + 'name' => 'TransactionFlow', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the transaction flow. If you specify one of the following types for this parameter, the results for the specified type are returned. If the type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for the following two types are returned by default. Valid values:'."\n" + ."\n" + .'* Income'."\n" + .'* Expense'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Income', + 'enum' => [ + 'Income', + 'Expense', + ], + ], + ], + [ + 'name' => 'TransactionChannel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The transaction channel. If you specify one of the following transaction channels for this parameter, the results for the specified transaction channel are returned. If the transaction channel that you specify does not belong to the following transaction channels, no result is returned. If you leave this parameter empty, the results for all the following transaction channels are returned by default. Valid values:'."\n" + ."\n" + .'* AccountBalance'."\n" + .'* BankTransfer'."\n" + .'* Alipay'."\n" + .'* AntCreditPay'."\n" + .'* OfflineRemittance'."\n" + .'* RegularBankCreditRefund'."\n" + .'* CreditCard'."\n" + .'* MyBankCredit'."\n" + .'* HuaxiaBankCInstallment'."\n" + .'* ApplePay'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AccountBalance', + 'enum' => [ + 'Alipay', + 'AntCreditPay', + 'MyBankCredit', + 'HuaxiaBankCInstallment', + 'BankTransfer', + 'OfflineRemittance', + 'CreditCard', + 'AccountBalance', + 'RegularBankCreditRefund', + 'ApplePay', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8634E02D-0942-4B1D-8295-5352FE9A1F39', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AccountName' => [ + 'description' => 'The name of your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AccountTransactionsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountTransactionsList' => [ + 'description' => 'The information about transactions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'TransactionChannel' => [ + 'description' => 'The transaction channel.'."\n" + ."\n" + .'* AccountBalance'."\n" + .'* BankTransfer'."\n" + .'* Alipay'."\n" + .'* AntCreditPay'."\n" + .'* OfflineRemittance'."\n" + .'* RegularBankCreditRefund'."\n" + .'* CreditCard'."\n" + .'* MyBankCredit'."\n" + .'* HuaxiaBankCInstallment'."\n" + .'* ApplePay'."\n", + 'type' => 'string', + 'example' => 'AccountBalance', + ], + 'RecordID' => [ + 'description' => 'The number of the order or bill.'."\n", + 'type' => 'string', + 'example' => '2020030242', + ], + 'Remarks' => [ + 'description' => 'The remarks on the transaction.'."\n", + 'type' => 'string', + 'example' => 'NAT_GW', + ], + 'Amount' => [ + 'description' => 'The amount.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'TransactionAccount' => [ + 'description' => 'The transaction account. For example, the account is a recharge account in Alipay or a transfer account.'."\n", + 'type' => 'string', + 'example' => '213562146', + ], + 'TransactionTime' => [ + 'description' => 'The time when the transaction was made.'."\n", + 'type' => 'string', + 'example' => '2020-03-10T02:03:20Z', + ], + 'TransactionType' => [ + 'description' => 'The type of the transaction.'."\n" + ."\n" + .'* Payment'."\n" + .'* Withdraw'."\n" + .'* Refund'."\n" + .'* Consumption'."\n" + .'* Transfer'."\n" + .'* Adjust'."\n", + 'type' => 'string', + 'example' => 'Consumption', + ], + 'TransactionFlow' => [ + 'description' => 'The type of the transaction flow.'."\n" + ."\n" + .'* Income'."\n" + .'* Expense'."\n", + 'type' => 'string', + 'example' => 'Expense', + ], + 'FundType' => [ + 'description' => 'The type of transaction payment. Valid values:'."\n" + ."\n" + .'* Cash: pay for the transaction in cash.'."\n" + .'* Deposit: pay for the transaction with deposit.'."\n" + .'* RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank.'."\n" + .'* DirectPay: directly pay for the transaction.'."\n", + 'type' => 'string', + 'example' => 'Cash', + ], + 'TransactionChannelSN' => [ + 'description' => 'The serial number of the transaction channel.'."\n", + 'type' => 'string', + 'example' => '1234354325', + ], + 'TransactionNumber' => [ + 'description' => 'The number of the transaction.'."\n", + 'type' => 'string', + 'example' => '43342334', + ], + 'Balance' => [ + 'description' => 'The balance of the account.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"8634E02D-0942-4B1D-8295-5352FE9A1F39\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"AccountTransactionsList\\": {\\n \\"AccountTransactionsList\\": [\\n {\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"TransactionChannel\\": \\"AccountBalance\\",\\n \\"RecordID\\": \\"2020030242\\",\\n \\"Remarks\\": \\"NAT_GW\\",\\n \\"Amount\\": \\"0\\",\\n \\"TransactionAccount\\": \\"213562146\\",\\n \\"TransactionTime\\": \\"2020-03-10T02:03:20Z\\",\\n \\"TransactionType\\": \\"Consumption\\",\\n \\"TransactionFlow\\": \\"Expense\\",\\n \\"FundType\\": \\"Cash\\",\\n \\"TransactionChannelSN\\": \\"1234354325\\",\\n \\"TransactionNumber\\": \\"43342334\\",\\n \\"Balance\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAccountTransactionsResponse>\\n <Message>Successful!</Message>\\n <RequestId>8C451EDE-8F92-4896-B4E6-68159A27B0F5</RequestId>\\n <Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <AccountTransactionsList>\\n <AccountTransactionsList>\\n <TransactionType>Consumption</TransactionType>\\n <BillingCycle>2020-03</BillingCycle>\\n <TransactionNumber>133xxxxxx90112</TransactionNumber>\\n <Amount>0.81</Amount>\\n <TransactionAccount/>\\n <TransactionTime>2020-03-10T02:03:20Z</TransactionTime>\\n <TransactionChannelSN/>\\n <Remarks>NAT_GW</Remarks>\\n <FundType>Cash</FundType>\\n <TransactionFlow>Expense</TransactionFlow>\\n <RecordID>2020xxxxx706693</RecordID>\\n <Balance>0.00</Balance>\\n <TransactionChannel>AccountBalance</TransactionChannel>\\n </AccountTransactionsList>\\n </AccountTransactionsList>\\n <AccountName>[email protected]</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryAccountTransactionsResponse>","errorExample":""}]', + 'title' => 'QueryAccountTransactions', + 'summary' => 'Queries transactions within your Alibaba Cloud account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRelationList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1990699401005016', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The states of the relationships between the management account and its members. The valid values of this parameter are the enumeration members of the RelationshipStatusEnum data type. If you do not specify this parameter, valid relationship states are queried by default.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'RELATED', + ], + 'required' => false, + 'example' => 'RELATED', + 'maxItems' => 8, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7FC5D662-37FD-40A6-85B1-33442D815184', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FinancialRelationInfoList' => [ + 'description' => 'The relationships.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The time when the relationship became invalid. If no value is returned, the relationship is still valid.'."\n", + 'type' => 'string', + 'example' => '2021-03-08T15:12Z', + ], + 'RelationType' => [ + 'description' => 'The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.'."\n", + 'type' => 'string', + 'example' => 'FinancialManagement', + ], + 'AccountNickName' => [ + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'test4', + ], + 'StartTime' => [ + 'description' => 'The time when the relationship became valid. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.'."\n", + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'State' => [ + 'description' => 'The state of the relationship. One of the enumeration members of the RelationshipStatusEnum data type is returned.'."\n", + 'type' => 'string', + 'example' => 'RELATED', + ], + 'AccountId' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1851253838840762', + ], + 'SetupTime' => [ + 'description' => 'The time when the relationship was established. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.'."\n", + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'AccountType' => [ + 'description' => 'The type of the account. Valid values: MASTER and MEMBER.'."\n", + 'type' => 'string', + 'example' => 'MEMBER', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'caiwuyun_test4', + ], + 'RelationId' => [ + 'description' => 'The ID of the relationship.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51463', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"7FC5D662-37FD-40A6-85B1-33442D815184\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"FinancialRelationInfoList\\": [\\n {\\n \\"EndTime\\": \\"2021-03-08T15:12Z\\",\\n \\"RelationType\\": \\"FinancialManagement\\",\\n \\"AccountNickName\\": \\"test4\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"State\\": \\"RELATED\\",\\n \\"AccountId\\": 1851253838840762,\\n \\"SetupTime\\": \\"2021-03-02T15:12Z\\",\\n \\"AccountType\\": \\"MEMBER\\",\\n \\"AccountName\\": \\"caiwuyun_test4\\",\\n \\"RelationId\\": 51463\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>7FC5D662-37FD-40A6-85B1-33442D815184</RequestId>\\n<Data>\\n <TotalCount>100</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <FinancialRelationInfoList>\\n <AccountId>1851253838840762</AccountId>\\n <EndTime/>\\n <State>RELATED</State>\\n <RelationType>FinancialManagement</RelationType>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <SetupTime>2021-03-02T15:12Z</SetupTime>\\n <RelationId>51463</RelationId>\\n <AccountNickName>test4</AccountNickName>\\n <AccountType>MEMBER</AccountType>\\n <AccountName>caiwuyun_test4</AccountName>\\n </FinancialRelationInfoList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'summary' => 'Queries the members of a management account.', + 'requestParamsDescription' => 'Enumeration members of RelationshipStatusEnum'."\n" + ."\n" + .'|Enumeration member|Description|Remarks|'."\n" + .'|---|:---:|---:|'."\n" + .'|INITIAL|The relationship is initialized.|The relationship is invalid.|'."\n" + .'|CONFIRMING|The invitation is to be confirmed.|The relationship is invalid.|'."\n" + .'|REJECTED|The invitation is rejected.|The relationship is invalid.|'."\n" + .'|CONNECTION\\_CANCELED|The relationship is removed.|The relationship is invalid.|'."\n" + .'|RELATED|The relationship is established.|The relationship is valid.|'."\n" + .'|CHANGE\\_CONFIRMING|The valid relationship is changed and to be confirmed.|The relationship is valid.|'."\n" + .'|CONNECTION\\_MASTER\\_CANCEL|The invitation is canceled.|The relationship is invalid.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPermissionList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the relationship. Set this parameter to the value of the RelationId response parameter returned by calling the QueryRelationList operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F6E29451-A3CD-4705-806D-0112D08F5C49', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The time when the relationship expired. If no value is returned, the relationship is still valid.'."\n", + 'type' => 'string', + 'example' => '2021-03-06T15:12Z', + ], + 'RelationType' => [ + 'description' => 'The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.'."\n", + 'type' => 'string', + 'example' => 'FinancialManagement', + ], + 'StartTime' => [ + 'description' => 'The time when the relationship took effect. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the relationship took effect at 20:00:00 on May 23, 2016 (UTC+8).'."\n", + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'State' => [ + 'description' => 'The status of the relationship. For more information about valid values of this parameter, see the enumeration values of the RelationshipStatusEnum type in the following table.'."\n", + 'type' => 'string', + 'example' => 'RELATED', + ], + 'MasterId' => [ + 'description' => 'The ID of the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'MemberId' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1851253838840762', + ], + 'SetupTime' => [ + 'description' => 'The time when the relationship was established. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the relationship was established at 20:00:00 on May 23, 2016 (UTC+8).'."\n", + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'PermissionList' => [ + 'description' => 'The list of permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The time when the permission expired. If no value is returned, the permission is still valid. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the permission expired at 20:00:00 on May 23, 2016 (UTC+8).'."\n", + 'type' => 'string', + 'example' => '2021-03-05T15:12Z', + ], + 'StartTime' => [ + 'description' => 'The time when the permission took effect. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the permission took effect at 20:00:00 on May 23, 2016 (UTC+8).'."\n", + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'PermissionCode' => [ + 'description' => 'The code of the permission.'."\n", + 'type' => 'string', + 'example' => 'allow_synchronize_finance_identity', + ], + 'PermissionName' => [ + 'description' => 'The name of the permission.'."\n", + 'type' => 'string', + 'example' => 'The management account shares the credit control identity with the member.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F6E29451-A3CD-4705-806D-0112D08F5C49\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"RelationType\\": \\"FinancialManagement\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"State\\": \\"RELATED\\",\\n \\"MasterId\\": 1990699401005016,\\n \\"MemberId\\": 1851253838840762,\\n \\"SetupTime\\": \\"2021-03-02T15:12Z\\",\\n \\"PermissionList\\": [\\n {\\n \\"EndTime\\": \\"2021-03-05T15:12Z\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"PermissionCode\\": \\"allow_synchronize_finance_identity\\",\\n \\"PermissionName\\": \\"主账号 子账号共享主账号信控身份\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>F6E29451-A3CD-4705-806D-0112D08F5C49</RequestId>\\n<Data>\\n <MemberId>1851253838840762</MemberId>\\n <EndTime/>\\n <State>RELATED</State>\\n <RelationType>FinancialManagement</RelationType>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <SetupTime>2021-03-02T15:12Z</SetupTime>\\n <MasterId>1990699401005016</MasterId>\\n <PermissionList>\\n <EndTime/>\\n <PermissionName>主账号允许子账号共享主账号信控身份</PermissionName>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <PermissionCode>allow_synchronize_finance_identity</PermissionCode>\\n </PermissionList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'summary' => 'Queries, by relationship ID, permissions granted to accounts between which a management-member relationship is established.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The following table describes the RelationshipStatusEnum type.'."\n" + ."\n" + .'|Enumeration value|Description|Remarks|'."\n" + .'|---|:---:|---:|'."\n" + .'|INITIAL|The relationship is being initialized.|The relationship does not take effect.|'."\n" + .'|CONFIRMING|The invitation is to be confirmed.|The relationship does not take effect.|'."\n" + .'|REJECTED|The invitation is rejected.|The relationship does not take effect.|'."\n" + .'|CONNECTION\\_CANCELED|The relationship is terminated.|The relationship does not take effect.|'."\n" + .'|RELATED|The relationship is established.|The relationship is effective.|'."\n" + .'|CHANGE\\_CONFIRMING|The effective relationship has changed and needs to be confirmed.|The relationship is effective.|'."\n" + .'|CONNECTION\\_MASTER\\_CANCEL|The invitation is canceled.|The relationship does not take effect.|', + 'extraInfo' => ' ', + ], + 'GetAccountRelation' => [ + 'summary' => 'Queries the details of a financial relationship.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'relationId', + 'description' => 'The ID of the financial relationship. Value returned by calling the AddAccountRelation operation.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'title' => 'requestId', + 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'requestId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Message returned'."\n", + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'RequestId', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'id', + 'description' => 'The ID of the financial relationship.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ID of the financial relationship'."\n", + ], + 'ParentUserId' => [ + 'title' => 'parentUserId', + 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ID of the Alibaba Cloud account that is used as the management account'."\n", + ], + 'ChildUserId' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as a member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ID of the Alibaba Cloud account that is used as a member'."\n", + ], + 'StartTime' => [ + 'description' => 'The time when the financial relationship between the management account and the member was established.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-11-01', + ], + 'EndTime' => [ + 'description' => 'The time when the financial relationship between the management account and the member was terminated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-01', + ], + 'Type' => [ + 'title' => 'type', + 'description' => 'The type of the financial relationship.'."\n", + 'type' => 'string', + 'example' => 'enterprise_group', + ], + 'Status' => [ + 'description' => 'The status of the financial relationship between the management account and the member.'."\n" + ."\n" + .'- RELATED [Association established]'."\n" + .'- CONFIRMING [To be confirmed by the other party]'."\n" + .'- REJECTED [Refused by the other party]'."\n" + .'- CONNECTION_CANCELED [Financial sub-account cancel request]'."\n" + .'- CONNECTION_MASTER_CANCEL [Financial master account cancel invitation]'."\n" + .'- CHANGE_CONFIRMING [Relationship change to be confirmed]'."\n" + .'- INITIAL [Initial new relationship status]', + 'type' => 'string', + 'example' => 'RELATED', + ], + 'GmtModified' => [ + 'description' => 'The time when the financial relationship between the management account and the member was modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-01', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"提示信息\\",\\n \\"RequestId\\": \\"RequestId\\",\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"ParentUserId\\": 0,\\n \\"ChildUserId\\": 0,\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Type\\": \\"enterprise_group\\",\\n \\"Status\\": \\"RELATED 【已建立关联】\\",\\n \\"GmtModified\\": 0\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetAccountRelation', + ], + 'AddAccountRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildNick', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the member. This helps clarify the scenario in which the account is used.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'xxx project'."\n", + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '32324242444', + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The permissions that can be granted to the member. Valid values:'."\n" + ."\n" + .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" + .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" + .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" + .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" + .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" + .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" + .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n" + ."\n" + .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The permission that is granted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + ], + 'required' => false, + 'example' => 'CHECK_TARGET_CONSUMPTION', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The roles that can be assigned to the member. Set the value to trusteeship.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The role that is assigned to the member in a trusteeship.'."\n" + .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', + 'type' => 'string', + 'required' => false, + 'example' => 'trusteeship', + ], + 'required' => false, + 'example' => 'trusteeship', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Message returned'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'Request ID'."\n", + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'The IP address of the request', + 'type' => 'string', + 'example' => 'HostId', + ], + 'RelationId' => [ + 'description' => 'The ID of the financial relationship.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'RelationId', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"请求标识\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\",\\n \\"RelationId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId/>\\n<Data>\\n <HostId/>\\n</Data>\\n<Code/>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'AddAccountRelation', + 'summary' => 'Creates a financial relationship.', + 'description' => 'For more information about a financial relationship, see <props="intl">[Usage notes on the trusteeship]( https://www.alibabacloud.com/help/doc-detail/116383.html)</props>. '."\n" + ."\n" + .'If enterprise names used by the management account and a member for real-name verification are the same, you do not need to call an API operation for confirmation. Otherwise, you must call the ConfirmRelation operation for confirmation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'RelationOperation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to be performed. Valid values:'."\n" + ."\n" + .'* ADD'."\n" + .'* DELETE'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ADD', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildNick', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display name of the member. This helps clarify the scenario in which the account is used.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Display name of the member'."\n", + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The roles that can be assigned to the member. You cannot modify the roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The role that is assigned to the member.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'trusteeship', + ], + 'required' => false, + 'example' => 'trusteeship', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The permissions that can be modified. Valid values:'."\n" + ."\n" + .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" + .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" + .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" + .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" + .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" + .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" + .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission that is granted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + ], + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the financial relationship. Set this parameter to the value of the relationId response parameter returned by calling the QueryRelationList operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Message returned'."\n", + ], + 'RequestId' => [ + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'example' => 'request_id', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'HostId'."\n", + 'type' => 'string', + 'example' => 'HostId', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回消息\\",\\n \\"RequestId\\": \\"48602faf-abbe-4d46-8029-654cc5aead5d\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"127.0.0.1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId/>\\n<Data>\\n <HostId/>\\n</Data>\\n<Code/>\\n<Success/>","errorExample":""}]', + 'summary' => 'Adds or removes permissions granted to a member in a financial relationship.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConfirmRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Type of the financial relationship'."\n", + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ConfirmCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to be performed to confirm the invitation. Valid values:'."\n" + ."\n" + .'* child_agree: The member accepts the invitation.'."\n" + .'* child_disagree: The member rejects the invitation.'."\n" + .'* Canceled by the master account: The management account cancels the confirmation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'child_agree', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The permissions that can be granted to the member. Valid values:'."\n" + ."\n" + .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" + .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" + .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" + .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" + .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" + .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" + .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + ], + 'required' => true, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the financial relationship. Set this parameter to the value of the RelationId response parameter returned by calling the QueryRelationList operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Message returned'."\n", + ], + 'RequestId' => [ + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'example' => 'request_id', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'HostId'."\n", + 'type' => 'string', + 'example' => 'HostId', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"request_id\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\"\\n }\\n}","errorExample":""}]', + 'summary' => 'Confirms the invitation initiated by the master account.', + 'description' => '1\\. A member needs to confirm an invitation only if a financial management relationship is established between the management account and the member and enterprise names used by the management account and the member for real-name verification are different. 2. The permissions to be confirmed must be the same as those granted to the member when the management account initiates the invitation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RelieveAccountRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the management account. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account that is used as the member. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the financial relationship between the management account and the member. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'RelationId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Message returned'."\n", + ], + 'RequestId' => [ + 'description' => 'The unique ID of the request.'."\n", + 'type' => 'string', + 'example' => 'request_id', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'hostid'."\n", + 'type' => 'string', + 'example' => 'HostId', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回消息\\",\\n \\"RequestId\\": \\"request_id\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\"\\n }\\n}","type":"json"}]', + 'summary' => 'Terminates a financial relationship between the management account and a member.', + ], + 'QueryInstanceByTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Specify the savings plan instance as the type of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spn-XXXXXX', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key-value pair.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '001', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The values returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'param is null', + ], + 'NextToken' => [ + 'description' => 'The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the QueryInstanceByTag operation was called.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCm', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9EC6C0B7-3397-5FAE-9915-8972CDDB1211', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagResource' => [ + 'description' => 'The instances returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'spn-xxxxx', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource. The returned resource type indicates a savings plan instance.'."\n", + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key-value pair.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"param is null\\",\\n \\"NextToken\\": \\"CAESEgoQCg4KCm\\",\\n \\"RequestId\\": \\"9EC6C0B7-3397-5FAE-9915-8972CDDB1211\\",\\n \\"Success\\": true,\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"spn-xxxxx\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"10\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'summary' => 'Queries instances by tag.', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Specify savings plan instance as the type of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spn-XXXXXX', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag. You can create N tag keys at a time. Valid values of N: 1 to 20. The value of this parameter can be an empty string.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The value of the tag N. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '001', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'InternalError', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InternalError\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1537A007-72D7-4165-8A26-8694A38E219A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'summary' => 'Add tags to resources.', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Specify the savings plan instance as the type of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags. This parameter is valid only if the TagKey.n parameter is not set. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'spn-xxxxxx', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag N. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'codename', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The values returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"C7C15585-8349-4C62-BEE4-5A391841B9BE\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'summary' => 'Removes tags from resources.', + ], + 'QueryPrepaidCards' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the prepaid card takes effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '7EA6C02D-06D0-4213-9C3B-E67910F7D1EB', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PrepaidCard' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the prepaid card. Valid values:'."\n" + ."\n" + .'* Available: The prepaid card is valid.'."\n" + .'* Expired: The prepaid card expired.'."\n" + .'* Cancelled: The prepaid card is invalid.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'ExpiryTime' => [ + 'description' => 'The time when the prepaid card expired.'."\n", + 'type' => 'string', + 'example' => '2019-08-04T01:39:11Z', + ], + 'GrantedTime' => [ + 'description' => 'The time when the prepaid card was issued.'."\n", + 'type' => 'string', + 'example' => '2018-08-03T01:39:11Z', + ], + 'NominalValue' => [ + 'description' => 'The nominal value of the prepaid card.'."\n", + 'type' => 'string', + 'example' => '100.00', + ], + 'EffectiveTime' => [ + 'description' => 'The time when the prepaid card took effect.'."\n", + 'type' => 'string', + 'example' => '2018-08-03T01:39:11Z', + ], + 'PrepaidCardNo' => [ + 'description' => 'The number of the prepaid card.'."\n", + 'type' => 'string', + 'example' => 'Q-7edaab979fc9', + ], + 'ApplicableScenarios' => [ + 'description' => 'The scenario to which the prepaid card is applicable.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PrepaidCardId' => [ + 'description' => 'The ID of the prepaid card.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '213432432', + ], + 'ApplicableProducts' => [ + 'description' => 'The services to which the prepaid card is applicable.'."\n", + 'type' => 'string', + 'example' => 'All Alibaba Cloud services'."\n", + ], + 'Balance' => [ + 'description' => 'The balance of the prepaid card.'."\n", + 'type' => 'string', + 'example' => '100.00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => ' Some parameters arte mandatoryfor this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Some parameters are not valid.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specifiedowner doesn’t belong to caller', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"7EA6C02D-06D0-4213-9C3B-E67910F7D1EB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PrepaidCard\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"ExpiryTime\\": \\"2019-08-04 01:39:11\\",\\n \\"GrantedTime\\": \\"2019-08-04 01:39:11\\",\\n \\"NominalValue\\": \\"100.00\\",\\n \\"EffectiveTime\\": \\"2019-08-04 01:39:11\\",\\n \\"PrepaidCardNo\\": \\"Q-7edaab979fc9\\",\\n \\"ApplicableScenarios\\": \\"阿里云按量付费账单,阿里云新购\\",\\n \\"PrepaidCardId\\": 213432432,\\n \\"ApplicableProducts\\": \\"通用\\",\\n \\"Balance\\": \\"100.00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'summary' => 'Queries prepaid cards.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRedeem' => [ + 'summary' => 'Queries the information about a voucher.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the redemption coupon takes effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Redeem' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Redeem' => [ + 'description' => 'The details of the redemption coupon.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiryTime' => [ + 'description' => 'The time when the redemption coupon expired.'."\n", + 'type' => 'string', + 'example' => '2018-06-13 20:25:00', + ], + 'GrantedTime' => [ + 'description' => 'The time when the redemption coupon was issued.'."\n", + 'type' => 'string', + 'example' => '2018-05-14 20:25:00', + ], + 'Status' => [ + 'description' => 'The status of the redemption coupon. Valid values:'."\n" + ."\n" + .'* Generated'."\n" + .'* CallBack'."\n" + .'* RefundPending'."\n" + .'* Canceled'."\n" + .'* Order_Canceled'."\n" + .'* ActivePending'."\n" + .'* ActiveSuccess'."\n" + .'* ExchangePending'."\n" + .'* ExchangeSuccess'."\n" + .'* Expired'."\n", + 'type' => 'string', + 'example' => 'Generated', + ], + 'Specification' => [ + 'description' => 'The specifications of the redemption coupon.'."\n", + 'type' => 'string', + 'example' => 'N/A'."\n", + ], + 'NominalValue' => [ + 'description' => 'The nominal value of the redemption coupon.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'EffectiveTime' => [ + 'description' => 'The time when the redemption coupon took effect.'."\n", + 'type' => 'string', + 'example' => '2018-05-14 20:25:00', + ], + 'RedeemId' => [ + 'description' => 'The ID of the redemption coupon.'."\n", + 'type' => 'string', + 'example' => '1342', + ], + 'RedeemNo' => [ + 'description' => 'The number of the redemption coupon.'."\n", + 'type' => 'string', + 'example' => '4889*****1610', + ], + 'ApplicableProducts' => [ + 'description' => 'The services to which the redemption coupon is applicable.'."\n", + 'type' => 'string', + 'example' => 'Elastic Compute Service (ECS)'."\n", + ], + 'Balance' => [ + 'description' => 'The balance of the redemption coupon.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller. ', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller. ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Redeem\\": {\\n \\"Redeem\\": [\\n {\\n \\"ExpiryTime\\": \\"2018-06-13 20:25:00\\",\\n \\"GrantedTime\\": \\"2018-05-14 20:25:00\\",\\n \\"Status\\": \\"Generated\\",\\n \\"Specification\\": \\"无\\",\\n \\"NominalValue\\": \\"0\\",\\n \\"EffectiveTime\\": \\"2018-05-14 20:25:00\\",\\n \\"RedeemId\\": \\"1342\\",\\n \\"RedeemNo\\": \\"4889*****1610\\",\\n \\"ApplicableProducts\\": \\"云服务器\\",\\n \\"Balance\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRedeemResponse>\\n <Message>Successful!</Message>\\n <RequestId>E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNum>1</PageNum>\\n <Redeem>\\n </Redeem>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRedeemResponse>","errorExample":""}]', + 'title' => 'QueryRedeem', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCashCoupons' => [ + 'summary' => 'Queries the information about vouchers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the voucher takes effect. Valid values:'."\n" + ."\n" + .'* true: The voucher takes effect.'."\n" + .'* false: The voucher does not take effect.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '147B566E-DB4C-4E43-BDBB-5DB1D9D268DB', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CashCoupon' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the voucher. Valid values:'."\n" + ."\n" + .'* Available: The voucher is valid.'."\n" + .'* Expired: The voucher has expired.'."\n" + .'* Cancelled: The voucher is canceled.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'ExpiryTime' => [ + 'description' => 'The time when the voucher expired.'."\n", + 'type' => 'string', + 'example' => '2019-01-29T15:15:50Z', + ], + 'GrantedTime' => [ + 'description' => 'The time when the voucher was released.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:15:50Z', + ], + 'NominalValue' => [ + 'description' => 'The denomination of the voucher.'."\n", + 'type' => 'string', + 'example' => '100.00', + ], + 'EffectiveTime' => [ + 'description' => 'The time when the voucher took effect.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:15:50Z', + ], + 'ApplicableScenarios' => [ + 'description' => 'The scenario to which the voucher is applicable.'."\n", + 'type' => 'string', + 'example' => 'Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service'."\n", + ], + 'CashCouponId' => [ + 'description' => 'The ID of the voucher.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34534253254325', + ], + 'ApplicableProducts' => [ + 'description' => 'The service to which the voucher is applicable.'."\n", + 'type' => 'string', + 'example' => 'All Alibaba Cloud services'."\n", + ], + 'CashCouponNo' => [ + 'description' => 'The code of the voucher.'."\n", + 'type' => 'string', + 'example' => 'Q-b1485def8f04a', + ], + 'Balance' => [ + 'description' => 'The remaining quota of the voucher.'."\n", + 'type' => 'string', + 'example' => '100.00', + ], + 'Description' => [ + 'description' => 'The description of the voucher.', + 'type' => 'string', + 'example' => 'This voucher is used for testing product function', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => ' Some parameters arte mandatoryfor this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Some parameter sare not valid.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specifiedowner doesn’t belong to caller', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"147B566E-DB4C-4E43-BDBB-5DB1D9D268DB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CashCoupon\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"ExpiryTime\\": \\"2018-08-10T00:00:00Z\\",\\n \\"GrantedTime\\": \\"2018-08-02T15:15:50Z\\",\\n \\"NominalValue\\": \\"100.00\\",\\n \\"EffectiveTime\\": \\"2018-08-02T15:15:50Z\\",\\n \\"ApplicableScenarios\\": \\"阿里云按量付费账单,阿里云新购\\",\\n \\"CashCouponId\\": 34534253254325,\\n \\"ApplicableProducts\\": \\"通用\\",\\n \\"CashCouponNo\\": \\"Q-b1485def8f04a\\",\\n \\"Balance\\": \\"100.00\\",\\n \\"Description\\": \\"该代金券用于产品功能验证的测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryCashCoupons', + ], + 'QuerySavingsPlansInstance' => [ + 'summary' => 'Queries the information about the savings plans of the current user.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the return data. Valid values:'."\n" + ."\n" + .'* ZH: Chinese'."\n" + .'* EN: English'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ZH', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the savings plan instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn-xxxxxxx', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2020-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Value' => [ + 'description' => 'The value of the tag to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '001', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the Instance. '."\n" + ."\n" + .'* NORMAL'."\n" + .'* RELEASE', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => 'The details about the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* NORMAL: normal'."\n" + .'* LIMIT: stopped due to overdue payment'."\n" + .'* RELEASE: released'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Cycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1:Year', + ], + 'StartTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663135741039', + ], + 'SavingsType' => [ + 'description' => 'The type of the savings plan. Valid values:'."\n" + ."\n" + .'* universal: general-purpose'."\n" + .'* ecs: ECS compute'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'Utilization' => [ + 'description' => 'The total usage.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'PrepayFee' => [ + 'description' => 'The prepaid amount.'."\n", + 'type' => 'string', + 'example' => '8760.00', + ], + 'InstanceId' => [ + 'description' => 'The ID of the savings plan instance.'."\n", + 'type' => 'string', + 'example' => 'spn-xxxxxxxx', + ], + 'Currency' => [ + 'description' => 'The currency. Valid values: CNY and USD.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'EndTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663135741039', + ], + 'EndTime' => [ + 'description' => 'The time when the instance expires. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2021-01-01 00:00:00', + ], + 'StartTime' => [ + 'description' => 'The time when the instance takes effect. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2020-01-01 00:00:00', + ], + 'AllocationStatus' => [ + 'description' => 'The allocation status. Valid values:'."\n" + ."\n" + .'* unallocated'."\n" + .'* allocated'."\n" + .'* beAllocated'."\n", + 'type' => 'string', + 'example' => 'unallocated', + ], + 'InstanceFamily' => [ + 'description' => 'The instance family information. For an instance of the Elastic Compute Service (ECS) compute type, the value indicates the ECS instance family or the ECS instance family package.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6', + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => 'cn-zhangjiakou-na62-a01', + ], + 'LastBillTotalUsage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100.0', + ], + 'LastBillUtilization' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.8', + ], + 'TotalSave' => [ + 'description' => 'The total amount that is saved.'."\n", + 'type' => 'string', + 'example' => '20.00', + ], + 'PoolValue' => [ + 'description' => 'The commitment.'."\n", + 'type' => 'string', + 'example' => '1.00', + ], + 'PayMode' => [ + 'description' => 'The payment type. Valid values:'."\n" + ."\n" + .'* total: All Upfront'."\n" + .'* half: Partial Upfront'."\n" + .'* zero: No Upfront'."\n", + 'type' => 'string', + 'example' => 'total', + ], + 'Tags' => [ + 'description' => 'The details about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'DeductCycleType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HOUR', + ], + 'RestPoolValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100.0', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'savingplan_common_public_cn', + ], + 'CurrentPoolValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner does not belong to caller.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'The specified API is not applicable for the user.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'The user is not authorized for the specified API.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"61293E7A-3406-4447-8620-EC88B0AA66AD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Cycle\\": \\"1:Year\\",\\n \\"StartTimestamp\\": 1663135741039,\\n \\"SavingsType\\": \\"ECS\\",\\n \\"Utilization\\": \\"1.0\\",\\n \\"PrepayFee\\": \\"8760.00\\",\\n \\"InstanceId\\": \\"spn-xxxxxxxx\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"EndTimestamp\\": 1663135741039,\\n \\"EndTime\\": \\"2021-01-01 00:00:00\\",\\n \\"StartTime\\": \\"2020-01-01 00:00:00\\",\\n \\"AllocationStatus\\": \\"unallocated\\",\\n \\"InstanceFamily\\": \\"ecs.g6\\",\\n \\"Region\\": \\"cn-zhangjiakou-na62-a01\\",\\n \\"LastBillTotalUsage\\": \\"100.0\\",\\n \\"LastBillUtilization\\": \\"0.8\\",\\n \\"TotalSave\\": \\"20.00\\",\\n \\"PoolValue\\": \\"1.00\\",\\n \\"PayMode\\": \\"total\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"标签1\\",\\n \\"Value\\": \\"标签1\\"\\n }\\n ],\\n \\"DeductCycleType\\": \\"HOUR\\",\\n \\"RestPoolValue\\": \\"100.0\\",\\n \\"CommodityCode\\": \\"savingplan_common_public_cn\\",\\n \\"CurrentPoolValue\\": \\"100.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful</Message>\\n<RequestId>61293E7A-3406-4447-8620-EC88B0AA66AD</RequestId>\\n<Data>\\n <TotalCount>100</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Status>NORMAL</Status>\\n <AllocationStatus>unallocated</AllocationStatus>\\n <EndTime>2021-01-01 00:00:00</EndTime>\\n <InstanceFamily>ecs.g6</InstanceFamily>\\n <InstanceId>spn-xxxxxxxx</InstanceId>\\n <StartTime>2020-01-01 00:00:00</StartTime>\\n <TotalSave>20.00</TotalSave>\\n <PrepayFee>8760.00</PrepayFee>\\n <PayMode>total</PayMode>\\n <Utilization>1.0</Utilization>\\n <Currency>CNY</Currency>\\n <PoolValue>1.00</PoolValue>\\n <Region>cn-zhangjiakou-na62-a01</Region>\\n <SavingsType>ECS</SavingsType>\\n <Tags>\\n <Value>标签1</Value>\\n <Key>标签1</Key>\\n </Tags>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'QuerySavingsPlansInstance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySavingsPlansDeductLog' => [ + 'summary' => 'Queries the deduction details of savings plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the instance ID based on which the data is queried. Valid values:'."\n" + ."\n" + .'* spn: queries data based on the ID of the savings plan instance.'."\n" + .'* product: queries data based on the ID of the cloud service instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the return data. Valid values:'."\n" + ."\n" + .'* ZH: Chinese'."\n" + .'* EN: English'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ZH', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn-XXXXXXX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-01-05 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Items' => [ + 'description' => 'The deduction details.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end of the billing cycle for which the fee is deducted.'."\n", + 'type' => 'string', + 'example' => '2020-12-01 01:00:00', + ], + 'StartTime' => [ + 'description' => 'The beginning of the billing cycle for which the fee is deducted. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2020-12-01 00:00:00', + ], + 'SavingsType' => [ + 'description' => 'The type of the savings plan. Valid values:'."\n" + ."\n" + .'* universal: general-purpose'."\n" + .'* ecs: ECS compute'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'DiscountRate' => [ + 'description' => 'The discount used for the current deduction.'."\n", + 'type' => 'string', + 'example' => '0.069', + ], + 'BillModule' => [ + 'description' => 'The billable item for which the fee is deducted.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'InstanceId' => [ + 'description' => 'The ID of the savings plan instance.'."\n", + 'type' => 'string', + 'example' => 'spn-xxxxxxx', + ], + 'DeductInstanceId' => [ + 'description' => 'The ID of the instance for which the fee is deducted.'."\n", + 'type' => 'string', + 'example' => 'i-XXXXXXXXX', + ], + 'DeductCommodity' => [ + 'description' => 'The service for which the fee is deducted.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DeductRate' => [ + 'description' => 'The deduction rate.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'DeductFee' => [ + 'description' => 'The deducted amount.'."\n", + 'type' => 'string', + 'example' => '0.52', + ], + 'OwnerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'BillingCycle' => [ + 'title' => '账期', + 'type' => 'string', + ], + 'Region' => [ + 'title' => '被抵扣实例地域', + 'type' => 'string', + ], + 'InstanceSpec' => [ + 'title' => '被抵扣实例规格', + 'type' => 'string', + ], + 'InstanceTypeFamily' => [ + 'title' => '被抵扣实例规格族', + 'type' => 'string', + ], + 'BillingOfficialPrice' => [ + 'title' => '被抵扣账单的官网价', + 'type' => 'string', + ], + 'DeductedOfficialPrice' => [ + 'title' => '被抵扣部分官网价', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner does not belong to caller.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'The specified API is not applicable for the user.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'The user is not authorized for the specified API.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"请校验入参正确性\\",\\n \\"RequestId\\": \\"61293E7A-3406-4447-8620-EC88B0AA66AD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"EndTime\\": \\"2020-12-01 01:00:00\\",\\n \\"StartTime\\": \\"2020-12-01 00:00:00\\",\\n \\"SavingsType\\": \\"ecs\\",\\n \\"UserId\\": 1906589291020438,\\n \\"DiscountRate\\": \\"0.069\\",\\n \\"BillModule\\": \\"云服务器配置\\",\\n \\"InstanceId\\": \\"spn-xxxxxxx\\",\\n \\"DeductInstanceId\\": \\"i-XXXXXXXXX\\",\\n \\"DeductCommodity\\": \\"云服务器ECS-按量付费\\",\\n \\"DeductRate\\": \\"1.0\\",\\n \\"DeductFee\\": \\"0.52\\",\\n \\"OwnerId\\": 1906589291020438,\\n \\"BillingCycle\\": \\"202312\\",\\n \\"Region\\": \\"cn-shanghai-eu13-a01\\",\\n \\"InstanceSpec\\": \\"ecs.g7.xlarge\\",\\n \\"InstanceTypeFamily\\": \\"ecs.g7\\",\\n \\"BillingOfficialPrice\\": \\"375.35\\",\\n \\"DeductedOfficialPrice\\": \\"375.37\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QuerySavingsPlansDeductLog', + ], + 'DescribeSavingsPlansUsageTotal' => [ + 'summary' => 'Queries the usage summary of savings plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which usage summary are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query usage summary. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'FilterParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'SelectType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'SelectType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => 'The usage in different periods.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => 'The usage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Period' => [ + 'description' => 'The period.'."\n" + ."\n" + .'The value is in the format of yyyyMMddHH.'."\n", + 'type' => 'string', + 'example' => '2021041500', + ], + ], + ], + ], + 'TotalUsage' => [ + 'description' => 'The usage summary.'."\n", + 'type' => 'object', + 'properties' => [ + 'PostpaidCost' => [ + 'description' => 'The pay-as-you-go cost.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'SavedCost' => [ + 'description' => 'The amount that is saved.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UsagePercentage' => [ + 'description' => 'The total usage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PoolValue' => [ + 'description' => 'The total amount of the savings plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"Percentage\\": 1,\\n \\"Period\\": \\"2021041500\\"\\n }\\n ],\\n \\"TotalUsage\\": {\\n \\"PostpaidCost\\": 200,\\n \\"SavedCost\\": 100,\\n \\"UsagePercentage\\": 1,\\n \\"PoolValue\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSavingsPlansUsageTotalResponse>\\n <Code>success</Code>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PeriodCoverage>\\n <Percentage>1</Percentage>\\n <Period>2021041500</Period>\\n </PeriodCoverage>\\n <TotalUsage>\\n <PostpaidCost>200</PostpaidCost>\\n <SavedCost>100</SavedCost>\\n <UsagePercentage>1</UsagePercentage>\\n <PoolValue>100</PoolValue>\\n </TotalUsage>\\n </Data>\\n</DescribeSavingsPlansUsageTotalResponse>","errorExample":""}]', + 'title' => 'DescribeSavingsPlansUsageTotal', + ], + 'DescribeSavingsPlansUsageDetail' => [ + 'summary' => 'Queries the usage details of savings plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query usage details within a specific time range for the first time. The response returns a token that you can use to query usage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query usage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'FilterParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'NextToken' => [ + 'description' => 'The token of the next page.'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9', + ], + 'Items' => [ + 'description' => 'The data entries.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the instance.'."\n" + ."\n" + .'A value of -1 indicates that the payment is overdue. A value of 1 indicates that the instance is active.'."\n", + 'type' => 'string', + 'example' => '-1', + ], + 'Type' => [ + 'description' => 'The type of the savings plan. Valid values: universal and ECS compute.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'UsagePercentage' => [ + 'description' => 'The usage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'UserId' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123745698925000', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'spn-a1fhs54c243hP22', + ], + 'Currency' => [ + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'PostpaidCost' => [ + 'description' => 'The pay-as-you-go cost.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '4.2', + ], + 'DeductValue' => [ + 'description' => 'The used amount of the savings plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '3.94', + ], + 'StartPeriod' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '2021-08-01 00:00:00', + ], + 'SavedCost' => [ + 'description' => 'The amount that is saved.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.08', + ], + 'PoolValue' => [ + 'description' => 'The total amount of the savings plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '29.84', + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'EndPeriod' => [ + 'description' => 'The end time.'."\n", + 'type' => 'string', + 'example' => '2021-08-09 00:00:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalCount\\": 1000,\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"-1\\",\\n \\"Type\\": \\"通用型\\",\\n \\"UsagePercentage\\": 0.9,\\n \\"UserId\\": 123745698925000,\\n \\"InstanceId\\": \\"spn-a1fhs54c243hP22\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"PostpaidCost\\": 4.2,\\n \\"DeductValue\\": 3.94,\\n \\"StartPeriod\\": \\"2021-08-01 00:00:00\\",\\n \\"SavedCost\\": 0.08,\\n \\"PoolValue\\": 29.84,\\n \\"UserName\\": \\"[email protected]\\",\\n \\"EndPeriod\\": \\"2021-08-09 00:00:00\\"\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => 'DescribeSavingsPlansUsageDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSavingsPlansCoverageTotal' => [ + 'summary' => 'Queries the coverage summary of savings plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-07-15 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-20 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which coverage summary are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query coverage summary. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'FilterParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => 'The coverage in different periods.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => 'The coverage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Period' => [ + 'description' => 'The period.'."\n" + ."\n" + .'The value is in the format of yyyyMMddHH.'."\n", + 'type' => 'string', + 'example' => '2021071500', + ], + ], + ], + ], + 'TotalCoverage' => [ + 'description' => 'The coverage summary.'."\n", + 'type' => 'object', + 'properties' => [ + 'CoveragePercentage' => [ + 'description' => 'The total coverage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductAmount' => [ + 'description' => 'The total deducted amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"Percentage\\": 1,\\n \\"Period\\": \\"2021071500\\"\\n }\\n ],\\n \\"TotalCoverage\\": {\\n \\"CoveragePercentage\\": 1,\\n \\"DeductAmount\\": 100\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSavingsPlansCoverageTotal', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSavingsPlansCoverageDetail' => [ + 'summary' => 'Queries the coverage details of savings plans.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-07-15 13:40:45', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-08-09 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which coverage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DAY', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query coverage details.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'FilterParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'SelectType' => [ + 'type' => 'string', + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The return data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'NextToken' => [ + 'description' => 'The token of the next page.'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'Items' => [ + 'description' => 'The data entries.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2831685687844416', + ], + 'OwnerId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'spn-a1fhs54c243hP22', + ], + 'Currency' => [ + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'InstanceSpec' => [ + 'description' => 'The specifications.'."\n", + 'type' => 'string', + 'example' => '7th_generation_X86_group', + ], + 'PostpaidCost' => [ + 'description' => 'The pay-as-you-go cost.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'CoveragePercentage' => [ + 'description' => 'The coverage.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DeductAmount' => [ + 'description' => 'The deducted amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'StartPeriod' => [ + 'description' => 'The start time.'."\n", + 'type' => 'string', + 'example' => '2021-05-05 14:00:00', + ], + 'TotalAmount' => [ + 'description' => 'The total expenditure.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'EndPeriod' => [ + 'description' => 'The end time.'."\n", + 'type' => 'string', + 'example' => '2021-05-05 15:00:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"Items\\": [\\n {\\n \\"UserId\\": 1906589291020438,\\n \\"OwnerId\\": 1906589291020438,\\n \\"InstanceId\\": \\"i-bp1d9x623987rlj0dx4xx\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"PostpaidCost\\": 200,\\n \\"CoveragePercentage\\": 0.9,\\n \\"Region\\": \\"华东1（杭州）\\",\\n \\"DeductAmount\\": 5.5,\\n \\"StartPeriod\\": \\"2023-04-01 00:00:00\\",\\n \\"TotalAmount\\": 6.11,\\n \\"UserName\\": \\"[email protected]\\",\\n \\"EndPeriod\\": \\"2023-05-01 00:00:00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSavingsPlansCoverageDetail', + ], + 'QuerySavingsPlansDiscount' => [ + 'summary' => 'Queries discounts on savings plans.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ModuleCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'moduleCode', + 'description' => 'The code of the pricing module.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'instance_type', + ], + ], + [ + 'name' => 'PayMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'payMode', + 'description' => 'The payment mode. Valid values: total: all upfront. half: half upfront. zero: no upfront.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'zero' => '', + 'total' => '', + 'half' => '', + ], + 'example' => 'total', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'pageSize', + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SpnType', + 'in' => 'query', + 'schema' => [ + 'title' => 'spnType', + 'description' => 'The type of the savings plan. Valid values: ecs: Elastic Compute Service (ECS) compute type. universal: general-purpose type.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ecs' => '', + 'universal' => '', + ], + 'example' => 'universal', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'title' => 'locale', + 'description' => 'The identifier of the language.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* EN: English.'."\n" + .'* ZH: Chinese.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EN' => '', + 'ZH' => '', + ], + 'example' => 'ZH', + ], + ], + [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => [ + 'title' => 'cycle', + 'description' => 'The cycle based on which queries are performed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1:Year', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => 'pageNum', + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'title' => 'spec', + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'commodityCode', + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SpnCommodityCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => 'The IP address of the request.'."\n", + 'type' => 'string', + 'example' => '100.104.180.109', + ], + 'Items' => [ + 'description' => 'The information about the discounts on saving plans.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the discount.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommodityName' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'Pay-as-you-go Elastic Compute Service (ECS) instance'."\n", + ], + 'ModuleName' => [ + 'description' => 'The name of the pricing module.'."\n", + 'type' => 'string', + 'example' => 'Instance'."\n", + ], + 'SpnType' => [ + 'description' => 'The type of the savings plan.'."\n", + 'type' => 'string', + 'example' => 'universal', + ], + 'PayMode' => [ + 'description' => 'The payment mode. Valid values:'."\n" + ."\n" + .'* total: all upfront'."\n" + .'* half: half upfront'."\n" + .'* zero: no upfront'."\n", + 'type' => 'string', + 'example' => 'total', + ], + 'Cycle' => [ + 'description' => 'The cycle based on which queries were performed.'."\n", + 'type' => 'string', + 'example' => '1:Year', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-zhangjiakou-na62-a01', + ], + 'RegionCode' => [ + 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation to query the region ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Spec' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6', + ], + 'DiscountRate' => [ + 'description' => 'The discount provided by the official website.'."\n", + 'type' => 'string', + 'example' => '0.85', + ], + 'ContractDiscountRate' => [ + 'description' => 'The contracted discount.'."\n", + 'type' => 'string', + 'example' => '0.85', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'The error code returned.'."\n", + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"100.104.180.109\\",\\n \\"Items\\": [\\n {\\n \\"CommodityName\\": \\"云服务器ECS-按量付费\\",\\n \\"ModuleName\\": \\"实例\\",\\n \\"SpnType\\": \\"universal\\",\\n \\"PayMode\\": \\"total\\",\\n \\"Cycle\\": \\"1:Year\\",\\n \\"Region\\": \\"张家口\\",\\n \\"RegionCode\\": \\"cn-hangzhou\\",\\n \\"Spec\\": \\"ecs.g6\\",\\n \\"DiscountRate\\": \\"0.85\\",\\n \\"ContractDiscountRate\\": \\"0.85\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'QuerySavingsPlansDiscount', + ], + 'CreateResellerUserQuota' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CNY', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7ed0bedc-056e-4a71-9249-4581615c028f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter.', + ], + [ + 'errorCode' => '-303', + 'errorMessage' => 'Record is exists already.', + ], + [ + 'errorCode' => 'CreditInnerError', + 'errorMessage' => 'This interface has some error. Please try again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'summary' => 'Creates a quota ledger and a consumption ledger.', + ], + 'SetResellerUserQuota' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The quota of a quota ledger. Unit: CNY.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '750', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => 'You do not need to set the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N/A'."\n", + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the business.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OD2022040818295234777795624764689', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of this topic.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter.', + ], + ], + 500 => [ + [ + 'errorCode' => 'CreditInnerError', + 'errorMessage' => 'This interface has some error. Please try again.', + ], + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify the quota ledger and consumption ledger.', + 'summary' => 'Modify the quota ledger and consumption ledger.', + ], + 'ChangeResellerConsumeAmount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AdjustType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the consumption amount adjustment. Valid values: increase: The consumption amount increases because new consumption occurs. decrease: The consumption amount decreases because funds are added to the account. This parameter is required.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'increase/decrease', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount to be adjusted. Unit: CNY'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10.00', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the currency.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CNY', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the business.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'quota_amount_adjust', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the request. Specify the system name for the parameter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'system', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the primary key for external business. The ID is used for idempotence verification.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1647396865', + ], + ], + [ + 'name' => 'ExtendMap', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended field of a message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of the topic.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => 'The consumption quota for the quota ledger after adjustment.'."\n", + 'type' => 'string', + 'example' => '300.00', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter.', + ], + [ + 'errorCode' => '-1101', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"300.00\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QueryResellerAvailableQuota' => [ + 'summary' => 'Queries the remaining quota that can be used in the current account to make payments for other accounts.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ItemCodes', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter.', + ], + [ + 'errorCode' => '-304', + 'errorMessage' => 'Record is not exists.', + ], + [ + 'errorCode' => 'CreditInnerError', + 'errorMessage' => 'This interface has some error. Please try again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": \\"300\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SetResellerUserAlarmThreshold' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AlarmType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'quota_low_balance', + ], + ], + [ + 'name' => 'AlarmThresholds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"denominator\\":100,\\"numerator\\":30,\\"thresholdType\\":1}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter', + ], + ], + 500 => [ + [ + 'errorCode' => 'CreditInnerError', + 'errorMessage' => 'This interface has some error. Please try again.', + ], + [ + 'errorCode' => 'UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QueryResellerUserAlarmThreshold' => [ + 'summary' => '查询用户的信控预警阀值,该接口暂未测试启用', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AlarmType', + 'in' => 'query', + 'schema' => [ + 'title' => '预警类型 [必填,quota_low_balance:Quota低额预警 month_consume_high:月消费高额预警', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'quota_low_balance' => 'quota_low_balance', + ], + 'example' => 'quota_low_balance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult<AlarmThresholdPop>', + 'description' => 'ListResult<AlarmThresholdPop>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ThresholdType' => [ + 'title' => '报警类型 0 数值 1比例 其他默认为 数值', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ThresholdAmount' => [ + 'title' => '预警额度 为0有效', + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Numerator' => [ + 'title' => '预警百分比_分子 为1有效', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Denominator' => [ + 'title' => '预警百分比_分母 为1有效', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + 'Count' => [ + 'title' => '根据查询', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'title' => '标识本次调用是否返回', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => '本次调用返回code，一般为错误代码', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '本次调用返回的消息，一般为错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller. ', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller. ', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure. ', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ThresholdType\\": 0,\\n \\"ThresholdAmount\\": \\"100\\",\\n \\"Numerator\\": 10,\\n \\"Denominator\\": 100\\n }\\n ],\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\"\\n}","type":"json"}]', + ], + 'SetResellerUserStatus' => [ + 'summary' => '设置生态终端客户状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account status that you want to set. Valid values: Freeze: The account is frozen. Thaw: The account is unfrozen. Trusteeship: The account is hosted. TrusteeshipCancel: The account is not hosted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Freeze', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the business. Valid values: FREEZE: the frozen business of the account. TRUSTEESHIP: the hosted business of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FREEZE', + ], + ], + [ + 'name' => 'StopMode', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '停机模式'."\n" + .'取值：'."\n" + .' 0：普通停机'."\n" + .' 1：立即停机', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of this topic.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => '-116', + 'errorMessage' => 'Fail to modify Enduser status, Quota is less than 0.', + ], + ], + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Missing the must parameter.', + ], + [ + 'errorCode' => 'SYSTEM_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'CreditInnerError', + 'errorMessage' => 'This interface has some error. Please try again.', + ], + [ + 'errorCode' => 'NOT_ALLOW_CANCEL_TRUSTSHIP', + 'errorMessage' => 'Only supports setting to trusteeship.', + ], + ], + 500 => [ + [ + 'errorCode' => ' UndefinedError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateAgAccount' => [ + 'summary' => 'Creates an account to establish a financial relationship.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'LoginEmail', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address used to log on to the account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'email', + ], + ], + [ + 'name' => 'AccountAttr', + 'in' => 'query', + 'schema' => [ + 'description' => 'The attribute of the account. To view the attribute of the account, use the account to log on to the Alibaba Cloud Management Console, move the pointer over the profile picture in the upper-right corner, and then click **Security Settings**.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'EnterpriseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Dongguan ChuangNeng Electric Appliance Co., Ltd'."\n", + ], + ], + [ + 'name' => 'FirstName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The first name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Zhicheng'."\n", + ], + ], + [ + 'name' => 'LastName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The last name.'."\n" + ."\n" + .'The last name can be up to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Wu'."\n", + ], + ], + [ + 'name' => 'NationCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The country code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'ProvinceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the province. This parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Beijing'."\n", + ], + ], + [ + 'name' => 'CityName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the city.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Beijing'."\n", + ], + ], + [ + 'name' => 'Postcode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zip code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '350000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'LOGIN_EMAIL_HAS_BEEN_USED', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => '[email protected],has used', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AgRelationDto' => [ + 'description' => 'The relationship between the account that is used to call the CreateAgAccount operation and the account that is created.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the relationship.'."\n", + 'type' => 'string', + 'example' => 'FINACE_CLOUD', + ], + 'Pk' => [ + 'description' => 'The ID of the account that is created.'."\n", + 'type' => 'string', + 'example' => '1728240534507590', + ], + 'RamAdminRoleName' => [ + 'description' => 'The role of the account that is created.'."\n", + 'type' => 'string', + 'example' => 'admin-role', + ], + 'Mpk' => [ + 'description' => 'The ID of the account that is used to call the CreateAgAccount operation.'."\n", + 'type' => 'string', + 'example' => '1785287436011964', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"LOGIN_EMAIL_HAS_BEEN_USED\\",\\n \\"Message\\": \\"[email protected],has used\\",\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\",\\n \\"Success\\": true,\\n \\"AgRelationDto\\": {\\n \\"Type\\": \\"FINACE_CLOUD\\",\\n \\"Pk\\": \\"1728240534507590\\",\\n \\"RamAdminRoleName\\": \\"admin-role\\",\\n \\"Mpk\\": \\"1785287436011964\\"\\n }\\n}","type":"json"}]', + 'description' => 'You can call this operation to create an account so as to establish a master-member financial relationship.'."\n", + ], + 'GetCustomerAccountInfo' => [ + 'summary' => 'Queries the account information about a customer of a virtual network operator (VNO).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '94017C56-1725-5DD9-AB41-B3BAE791D600', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Mpk' => [ + 'description' => 'The ID of the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1051360339779133', + ], + 'LoginEmail' => [ + 'description' => 'The email address of the customer.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'HostingStatus' => [ + 'description' => 'The hosting status of the credit information and instances of the customer. If the credit information and instances of the customer are managed on Alibaba Cloud, Alibaba Cloud suspends a customer service upon overdue payment. Valid values:'."\n" + ."\n" + .'FREEZE: The business of the customer is frozen.'."\n" + ."\n" + .'TRUSTEESHIP: The business of the customer is hosted.'."\n", + 'type' => 'string', + 'example' => 'FREEZE', + ], + 'AccountType' => [ + 'description' => 'The type of the account. A value of 1 indicates an enterprise account. A value of 0 indicates an individual account.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'CreditLimitStatus' => [ + 'description' => 'The business status of the customer. Valid values:'."\n" + ."\n" + .'Freeze: The business is frozen.'."\n" + ."\n" + .'Thaw: The business is unfrozen.'."\n" + ."\n" + .'Trusteeship: The business is hosted.'."\n" + ."\n" + .'TrusteeshipCancel: The business is not hosted.'."\n", + 'type' => 'string', + 'example' => 'Freeze', + ], + 'IsCertified' => [ + 'description' => 'Indicates whether the account passes the real-name verification.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + ], + [ + [ + 'errorCode' => 'VnoNoDataError', + 'errorMessage' => 'There is no data by this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"94017C56-1725-5DD9-AB41-B3BAE791D600\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Mpk\\": 1051360339779133,\\n \\"LoginEmail\\": \\"[email protected]\\",\\n \\"HostingStatus\\": \\"FREEZE\\",\\n \\"AccountType\\": \\"1\\",\\n \\"CreditLimitStatus\\": \\"Freeze\\",\\n \\"IsCertified\\": true\\n }\\n}","type":"json"}]', + ], + 'GetCustomerList' => [ + 'summary' => 'Queries the IDs of customers of a virtual network operator (VNO).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'* **true**: The call is successful.'."\n" + .'* **false**: The call failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'UidList' => [ + 'description' => 'The list of customer IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the customer.'."\n", + 'type' => 'string', + 'example' => '6210322125051645960', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + ], + [ + [ + 'errorCode' => 'VnoNoDataError', + 'errorMessage' => 'There is no data by this request.', + ], + ], + [ + [ + 'errorCode' => 'NotFoundRamAction', + 'errorMessage' => 'Not found ramAction for apiActon: GetCustomerList', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"UidList\\": [\\n \\"6210322125051645960\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetCustomerList', + 'description' => 'The system queries the IDs of customers of a VNO based on the AccessKey pair used in the request.'."\n", + ], + 'QueryResourcePackageInstances' => [ + 'summary' => 'Queries the instances of a resource plan. You can query the resource plans that are valid.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T13:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IncludePartner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether partners are involved.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Page' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'string', + 'example' => '12', + ], + 'HostId' => [ + 'description' => 'The ID of the host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The details of the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiryTime' => [ + 'description' => 'The time when the resource plan expired.'."\n", + 'type' => 'string', + 'example' => '2019-03-12T16:00:00Z', + ], + 'Status' => [ + 'description' => 'The status of the resource plan. Valid values:'."\n" + ."\n" + .'* Available'."\n" + .'* Expired'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'Remark' => [ + 'description' => 'The remarks on the resource plan. The remarks must be made in Chinese.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RemainingAmountUnit' => [ + 'description' => 'The unit of the remaining quota.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma01', + ], + 'PackageType' => [ + 'description' => 'The type of the resource plan.'."\n", + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_sh', + ], + 'EffectiveTime' => [ + 'description' => 'The time when the resource plan took effect.'."\n", + 'type' => 'string', + 'example' => '2018-09-12T09:51:56Z', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TotalAmount' => [ + 'description' => 'The total quota of the resource plan.'."\n", + 'type' => 'string', + 'example' => '40.000', + ], + 'DeductType' => [ + 'description' => 'The deduction type. Example: Absolute.'."\n", + 'type' => 'string', + 'example' => 'Absolute', + ], + 'TotalAmountUnit' => [ + 'description' => 'The unit of the total quota.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'RemainingAmount' => [ + 'description' => 'The remaining quota.'."\n", + 'type' => 'string', + 'example' => '40.000', + ], + 'ApplicableProducts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => 'The services to which the resource plan is applicable.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service to which the resource plan is applicable.'."\n", + 'type' => 'string', + 'example' => '{"Product": ["oss"] }', + ], + ], + ], + ], + 'CommodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'OwnerIdInvalid', + 'errorMessage' => 'Parameter ownerId is invalid.', + ], + [ + 'errorCode' => 'OwnerIdMissing', + 'errorMessage' => 'Paramter ownerId is missing.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"PageSize\\": 20,\\n \\"Total\\": 12,\\n \\"Page\\": 1,\\n \\"Data\\": {\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"TotalCount\\": \\"12\\",\\n \\"HostId\\": \\"cn\\",\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"ExpiryTime\\": \\"2019-03-12T16:00:00Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"Remark\\": \\"标准存储包(华东2)\\",\\n \\"RemainingAmountUnit\\": \\"GB\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-v0h1s4hma01\\",\\n \\"PackageType\\": \\"FPT_ossbag_absolute_Storage_sh\\",\\n \\"EffectiveTime\\": \\"2018-09-12T09:51:56Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"TotalAmount\\": \\"40.000\\",\\n \\"DeductType\\": \\"Absolute\\",\\n \\"TotalAmountUnit\\": \\"GB\\",\\n \\"RemainingAmount\\": \\"40.000\\",\\n \\"ApplicableProducts\\": {\\n \\"Product\\": [\\n \\"{\\\\\\"Product\\\\\\": [\\\\\\"oss\\\\\\"] }\\"\\n ]\\n },\\n \\"CommodityCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryResourcePackageInstancesResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <Instances>\\n <Instance>\\n <RemainingAmountUnit>GB</RemainingAmountUnit>\\n <ApplicableProducts>\\n <Product>oss</Product>\\n </ApplicableProducts>\\n <InstanceId>OSSBAG-cn-v0h1s4hma018</InstanceId>\\n <DeductType>Absolute</DeductType>\\n <RemainingAmount>40.000</RemainingAmount>\\n <Status>Available</Status>\\n <Region>cn-shanghai</Region>\\n <TotalAmountUnit>GB</TotalAmountUnit>\\n <PackageType>FPT_ossbag_absolute_Storage_sh</PackageType>\\n <TotalAmount>40.000</TotalAmount>\\n <Remark>标准存储包(华东2)</Remark>\\n <EffectiveTime>2018-09-12T09:51:56Z</EffectiveTime>\\n <ExpiryTime>2019-03-12T16:00:00Z</ExpiryTime>\\n </Instance>\\n </Instances>\\n <HostId>cn</HostId>\\n <PageNum>1</PageNum>\\n </Data>\\n</QueryResourcePackageInstancesResponse>","errorExample":""}]', + 'title' => 'QueryResourcePackageInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDPUtilizationDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance to query. If this parameter is not specified, the details of all used instances are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss-123123', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Instancetyp', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the resource, such as ecsRi and scu_bag. If this parameter is specified, the ProdCode parameter does not take effect for the request.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecsRi', + ], + ], + [ + 'name' => 'DeductedInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deducted instance. If this parameter is not specified, the details of all instances are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss-123123', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'LastToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of results. For the first query, set the value to null. For subsequent queries, set the value to the token that is obtained from the NextToken parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESF***zNTAw', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IncludeShare', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query the resource plan usage of linked accounts. Valid values:'."\n" + ."\n" + .'* true: queries the resource plan usage of linked accounts.'."\n" + .'* false: does not query the resource plan usage of linked accounts.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service. Example: ecs.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'oss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used to retrieve the next page of results. You can set the LastToken parameter to this value in the next request. If null is returned, all results are queried.'."\n", + 'type' => 'string', + 'example' => 'CAESF***zNTAw', + ], + 'DetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailList' => [ + 'description' => 'The detailed resource plan usage.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeductedInstanceId' => [ + 'description' => 'The ID of the deducted instance.'."\n", + 'type' => 'string', + 'example' => 'oss-123123', + ], + 'InstanceId' => [ + 'description' => 'The ID of the RI.'."\n", + 'type' => 'string', + 'example' => 'oss-123123', + ], + 'DeductHours' => [ + 'description' => 'The deduct factor. This parameter is returned only if the CommodityCode parameter is set to ecsRi.', + 'type' => 'number', + 'format' => 'float', + 'example' => '24', + ], + 'ShareUid' => [ + 'description' => 'The UID of the deducted instance.'."\n" + ."\n" + .'* If the deduction is shared, the value of this parameter indicates the UID of the deducted instance.'."\n" + .'* If the deduction is not shared, the value of this parameter is the same as that of the uid parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + 'DeductDate' => [ + 'description' => 'The deduction date.'."\n", + 'type' => 'string', + 'example' => '2019/5/23 12:00', + ], + 'InstanceSpec' => [ + 'description' => 'The instance type of the deducted instance.'."\n", + 'type' => 'string', + 'example' => 'rds.mysql.s3.large', + ], + 'DeductedCommodityCode' => [ + 'description' => 'The code of the deducted service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedProductDetail' => [ + 'description' => 'The name of the deducted service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'DeductMeasure' => [ + 'description' => 'The original measured amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Region' => [ + 'description' => 'The region in which the instance resides. This parameter can be left empty.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou ', + ], + 'DeductQuantity' => [ + 'description' => 'The computing capacity or storage capacity that is deducted in a pay-as-you-go instance.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductFactorTotal' => [ + 'description' => 'The total computing capacity or storage capacity of the RI or SCU during the deduction.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'ResCode' => [ + 'description' => 'The billable item.'."\n", + 'type' => 'string', + 'example' => 'PutRequest', + ], + 'Uid' => [ + 'description' => 'The UID of the deducted instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner does not belong to caller.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'The specified API is not applicable for the user.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'The user is not authorized for the specified API.', + ], + [ + 'errorCode' => 'InvalidInstanceSpec', + 'errorMessage' => 'The specified Instance specification is not valid.', + ], + [ + 'errorCode' => 'InvalidQueryTime', + 'errorMessage' => 'The specified start time and end time are incorrect', + ], + [ + 'errorCode' => 'CommodityNotSupported', + 'errorMessage' => 'The specified commodity is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESF***zNTAw\\",\\n \\"DetailList\\": {\\n \\"DetailList\\": [\\n {\\n \\"DeductedInstanceId\\": \\"oss-123123\\",\\n \\"InstanceId\\": \\"oss-123123\\",\\n \\"DeductHours\\": 24,\\n \\"ShareUid\\": 1111111111,\\n \\"DeductDate\\": \\"2019/5/23 12:00\\",\\n \\"InstanceSpec\\": \\"rds.mysql.s3.large\\",\\n \\"DeductedCommodityCode\\": \\"rds\\",\\n \\"DeductedProductDetail\\": \\"云数据库RDS\\",\\n \\"DeductMeasure\\": 1,\\n \\"Region\\": \\"cn-hangzhou \\",\\n \\"DeductQuantity\\": 1,\\n \\"DeductFactorTotal\\": 1,\\n \\"ResCode\\": \\"PutRequest\\",\\n \\"Uid\\": 1111111111\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful！</Message>\\n<RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n<Data>\\n <TotalCount/>\\n <PageSize/>\\n <PageNum/>\\n <DetailList>\\n <DetailList>\\n <ResCode/>\\n <Uid/>\\n <DeductDate/>\\n <InstanceSpec/>\\n <DeductMeasure/>\\n <InstanceId/>\\n <DeductFactorTotal/>\\n <DeductedProductDetail/>\\n <Region/>\\n <DeductedCommodityCode/>\\n <DeductedInstanceId/>\\n <DeductHours/>\\n <DeductQuantity/>\\n </DetailList>\\n </DetailList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'QueryDPUtilizationDetail', + 'summary' => 'Queries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs).', + 'description' => 'Limits:'."\n" + ."\n" + .'* Only the usage records within the past year can be queried.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRIUtilizationDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RIInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the RI. If this parameter is left empty, the usage details of all RIs are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dsudfgdsjh', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the RI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Instancetyp', + ], + ], + [ + 'name' => 'RICommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the RI is applied. Default value: ecsRi. Valid values:'."\n" + ."\n" + .'* ecsRi: ECS RI.'."\n" + .'* scu_bag: storage capacity unit (SCU).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecsRi', + ], + ], + [ + 'name' => 'DeductedInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance whose fees are deducted by using the RI. If this parameter is left empty, the usage details of all instances are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jsdgfsdhgsdjh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the RI was created. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the RI expires. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailList' => [ + 'description' => 'The usage details of the RI.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeductedCommodityCode' => [ + 'description' => 'The code of the service whose fees are deducted by using the RI.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedProductDetail' => [ + 'description' => 'The name of the service whose fees are deducted by using the RI.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'DeductedInstanceId' => [ + 'description' => 'The ID of the instance whose fees are deducted by using the RI.'."\n", + 'type' => 'string', + 'example' => 'safdffghfgh', + ], + 'DeductFactorTotal' => [ + 'description' => 'The total amount of computing power of the RI or capacity of SCU in the time period.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductQuantity' => [ + 'description' => 'The computing power or capacity of the pay-as-you-go instance whose fees are deducted by using the RI.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductHours' => [ + 'description' => 'The deduct factor. This parameter is returned only if the RICommodityCode parameter is set to ecsRi.', + 'type' => 'string', + 'example' => '24', + ], + 'DeductDate' => [ + 'description' => 'The time when the fees are deducted by using the RI.'."\n", + 'type' => 'string', + 'example' => '2019-05-23 12:00:00', + ], + 'RIInstanceId' => [ + 'description' => 'The ID of the RI.'."\n", + 'type' => 'string', + 'example' => '324253645', + ], + 'InstanceSpec' => [ + 'description' => 'The instance type of the instance whose fees are deducted by using the RI.'."\n", + 'type' => 'string', + 'example' => 'rds.mysql.s3.large', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'InvalidQueryTime', + 'errorMessage' => 'The specified start time and end time are incorrect', + ], + [ + 'errorCode' => 'InvalidInstanceSpec', + 'errorMessage' => 'The specified Instance specification is not valid.', + ], + [ + 'errorCode' => 'CommodityNotSupported', + 'errorMessage' => 'The specified RI commodity is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 0,\\n \\"DetailList\\": {\\n \\"DetailList\\": [\\n {\\n \\"DeductedCommodityCode\\": \\"rds\\",\\n \\"DeductedProductDetail\\": \\"云数据库RDS\\",\\n \\"DeductedInstanceId\\": \\"safdffghfgh\\",\\n \\"DeductFactorTotal\\": 1,\\n \\"DeductQuantity\\": 1,\\n \\"DeductHours\\": \\"24\\",\\n \\"DeductDate\\": \\"2019-05-23 12:00:00\\",\\n \\"RIInstanceId\\": \\"324253645\\",\\n \\"InstanceSpec\\": \\"rds.mysql.s3.large\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRIUtilizationDetailResponse>\\n <RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <DetailList>\\n </DetailList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRIUtilizationDetailResponse>","errorExample":""}]', + 'title' => 'QueryRIUtilizationDetail', + 'summary' => 'Queries the usage details of a reserved instance (RI).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceUsageTotal' => [ + 'summary' => 'Queries the total usage data of reserved instances or storage capacity units (SCUs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is included in the time range.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is excluded from the time range. If you do not specify this parameter, this parameter is set to the current time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which the data is queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'MONTH' => 'MONTH', + 'HOUR' => 'HOUR', + 'DAY' => 'DAY', + ], + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current account and its linked accounts is queried. To query the data of a linked account, specify the ID of the linked account. You can specify only one account ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource plan. Valid values: RI and SCU.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'SCU' => 'SCU', + 'RI' => 'RI', + ], + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '364C7C81-5E5E-51A0-B738-1969D2671B05', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Data' => [ + 'description' => 'The queried data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => 'The usage of resource plans in the specified period.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UsagePercentage' => [ + 'description' => 'The usage of resource plans.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Period' => [ + 'description' => 'The period.'."\n", + 'type' => 'string', + 'example' => '2021071500', + ], + ], + ], + ], + 'TotalUsage' => [ + 'description' => 'The total usage of resource plans.'."\n", + 'type' => 'object', + 'properties' => [ + 'PostpaidCost' => [ + 'description' => 'The total costs of pay-as-you-go instances.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'SavedCost' => [ + 'description' => 'The total savings.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UsagePercentage' => [ + 'description' => 'The total usage of resource plans.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PotentialSavedCost' => [ + 'description' => 'The total potential savings.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'ReservationCost' => [ + 'description' => 'The fee of purchased resource plans.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"364C7C81-5E5E-51A0-B738-1969D2671B05\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"UsagePercentage\\": 0.1,\\n \\"Period\\": \\"2021071500\\"\\n }\\n ],\\n \\"TotalUsage\\": {\\n \\"PostpaidCost\\": 200,\\n \\"SavedCost\\": 100,\\n \\"UsagePercentage\\": 1,\\n \\"PotentialSavedCost\\": 100,\\n \\"ReservationCost\\": 10\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourceUsageTotalResponse>\\n <RequestId>BD1DC347-905C-1D6E-8BA1-D724266842D2</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalUsage>\\n <ReservationCost>0</ReservationCost>\\n <PostpaidCost>0</PostpaidCost>\\n <PotentialSavedCost>0</PotentialSavedCost>\\n <UsagePercentage>0</UsagePercentage>\\n </TotalUsage>\\n <PeriodCoverage>\\n <Period>2021050100</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050200</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050300</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050400</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050500</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050600</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050700</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050800</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050900</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021051000</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribeResourceUsageTotalResponse>","errorExample":""}]', + 'title' => 'DescribeResourceUsageTotal', + ], + 'DescribeResourceUsageDetail' => [ + 'summary' => 'Queries the usage details of reserved instances (RIs) or storage capacity units (SCUs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. The maximum value is 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current Alibaba Cloud account and its Resource Access Management (RAM) users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of deduction plan whose usage details are queried. Valid values: RI and SCU.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Items' => [ + 'description' => 'The data entries.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the deduction plan.'."\n", + 'type' => 'string', + 'example' => 'Valid', + ], + 'UsagePercentage' => [ + 'description' => 'The usage rate of the deduction plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'ResourceInstanceId' => [ + 'description' => 'The ID of the deduction plan.'."\n", + 'type' => 'string', + 'example' => 'ecsri-bp147nnfz21225k9mpix00', + ], + 'TotalQuantity' => [ + 'description' => 'The total capacity of the deduction plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'ReservationCost' => [ + 'description' => 'The fee of the deduction plan.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'RegionNo' => [ + 'description' => 'The code of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'UserId' => [ + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => '123745698925000', + ], + 'StatusName' => [ + 'description' => 'The name of the status.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The unit that is used to measure the resources that are deducted.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PotentialSavedCost' => [ + 'description' => 'The potential net savings.'."\n", + 'type' => 'string', + 'example' => '0.13', + ], + 'Currency' => [ + 'description' => 'The type of the currency.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ZoneName' => [ + 'description' => 'The code of the zone.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'InstanceSpec' => [ + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ecs.t5-lc2m1.nano', + ], + 'EndTime' => [ + 'description' => 'The end of the time range in which the usage details were queried.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 01:00:00', + ], + 'PostpaidCost' => [ + 'description' => 'The equivalent of pay-as-you-go costs.'."\n", + 'type' => 'string', + 'example' => '0.06', + ], + 'ImageType' => [ + 'description' => 'The operating system.'."\n", + 'type' => 'string', + 'example' => 'linux', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range in which the usage details were queried.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 00:00:00', + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DeductQuantity' => [ + 'description' => 'The amount of the deducted resources.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'SavedCost' => [ + 'description' => 'The net savings.'."\n", + 'type' => 'string', + 'example' => '0.06', + ], + 'Zone' => [ + 'description' => 'The zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Quantity' => [ + 'description' => 'The number of deduction plans.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"TotalCount\\": 10000,\\n \\"MaxResults\\": 200,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Valid\\",\\n \\"UsagePercentage\\": 0.5,\\n \\"ResourceInstanceId\\": \\"ecsri-bp147nnfz21225k9mpix00\\",\\n \\"TotalQuantity\\": 2,\\n \\"ReservationCost\\": \\"0\\",\\n \\"RegionNo\\": \\"cn-hangzhou-dg-a01\\",\\n \\"UserId\\": \\"123745698925000\\",\\n \\"StatusName\\": \\"生效\\",\\n \\"CapacityUnit\\": \\"算力*小时\\",\\n \\"PotentialSavedCost\\": \\"0.13\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"ZoneName\\": \\"杭州 可用区I\\",\\n \\"InstanceSpec\\": \\"ecs.t5-lc2m1.nano\\",\\n \\"EndTime\\": \\"2021-04-01 01:00:00\\",\\n \\"PostpaidCost\\": \\"0.06\\",\\n \\"ImageType\\": \\"linux\\",\\n \\"StartTime\\": \\"2021-04-01 00:00:00\\",\\n \\"Region\\": \\"华东1（杭州）\\",\\n \\"DeductQuantity\\": 1,\\n \\"SavedCost\\": \\"0.06\\",\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"UserName\\": \\"[email protected]\\",\\n \\"Quantity\\": 2\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => 'DescribeResourceUsageDetail', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceCoverageTotal' => [ + 'summary' => 'Queries the total coverage data of reserved instances (RIs) or storage capacity units (SCUs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which total coverage data is queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query total coverage data. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of deduction plans whose total coverage data is queried. Valid values: RI and SCU.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => 'The information about the coverage rate of deduction plans within a period.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CoveragePercentage' => [ + 'description' => 'The coverage rate of deduction plans within the specified period.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Period' => [ + 'description' => 'The period.'."\n" + ."\n" + .'The value is in the format of yyyyMMddHH.'."\n", + 'type' => 'string', + 'example' => '2020110100', + ], + ], + ], + ], + 'TotalCoverage' => [ + 'description' => 'The information about the total coverage data of deduction plans.'."\n", + 'type' => 'object', + 'properties' => [ + 'CapacityUnit' => [ + 'description' => 'The unit that is used to measure the resources deducted from deduction plans.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DeductQuantity' => [ + 'description' => 'The total amount of the resources deducted from deduction plans.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'CoveragePercentage' => [ + 'description' => 'The total coverage rate of deduction plans.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'TotalQuantity' => [ + 'description' => 'The total amount of resources consumed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"CoveragePercentage\\": 0.1,\\n \\"Period\\": \\"2020110100\\"\\n }\\n ],\\n \\"TotalCoverage\\": {\\n \\"CapacityUnit\\": \\"算力*小时\\",\\n \\"DeductQuantity\\": 1,\\n \\"CoveragePercentage\\": 1,\\n \\"TotalQuantity\\": 1\\n }\\n }\\n}","errorExample":""}]', + 'title' => 'DescribeResourceCoverageTotal', + 'description' => 'The queried total coverage data is the same as the aggregated data displayed on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" + ."\n" + .'You can call this operation to query the total coverage data of RIs or SCUs.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceCoverageDetail' => [ + 'summary' => 'Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time granularity at which coverage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the account for which you want to query coverage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of deduction plans whose coverage details are queried. Valid values: RI and SCU.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token of the next page.'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Items' => [ + 'description' => 'The data entries.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'TotalQuantity' => [ + 'description' => 'The total amount of resources consumed.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'RegionNo' => [ + 'description' => 'The code of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'UserId' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '123745698925000', + ], + 'CommodityName' => [ + 'description' => 'The name and billing method of the service.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'CapacityUnit' => [ + 'description' => 'The unit that is used to measure the resources deducted from deduction plans.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'InstanceId' => [ + 'description' => 'The ID of a pay-as-you-go instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1d9x623987rlj0dx4xx', + ], + 'Currency' => [ + 'description' => 'The currency in which deduction plans were priced.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ZoneName' => [ + 'description' => 'The zone.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'InstanceSpec' => [ + 'description' => 'The specifications of a deduction plan.'."\n", + 'type' => 'string', + 'example' => 'ecs.t5-lc2m1.nano', + ], + 'EndTime' => [ + 'description' => 'The end of the time range in which the coverage details were queried.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 01:00:00', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range in which the coverage details were queried.'."\n", + 'type' => 'string', + 'example' => '2021-04-01 00:00:00', + ], + 'PaymentAmount' => [ + 'description' => 'The amount of the bill.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CoveragePercentage' => [ + 'description' => 'The coverage rate of a deduction plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DeductQuantity' => [ + 'description' => 'The amount of the resources deducted from a deduction plan.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Zone' => [ + 'description' => 'The code of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"TotalCount\\": 10000,\\n \\"MaxResults\\": 200,\\n \\"Items\\": [\\n {\\n \\"CommodityCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"云服务器 ECS\\",\\n \\"TotalQuantity\\": 1,\\n \\"RegionNo\\": \\"cn-hangzhou-dg-a01\\",\\n \\"UserId\\": \\"123745698925000\\",\\n \\"CommodityName\\": \\"云服务器ECS-按量付费\\",\\n \\"CapacityUnit\\": \\"算力*小时\\",\\n \\"InstanceId\\": \\"i-bp1d9x623987rlj0dx4xx\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"ZoneName\\": \\"杭州 可用区I\\",\\n \\"InstanceSpec\\": \\"ecs.t5-lc2m1.nano\\",\\n \\"EndTime\\": \\"2021-04-01 01:00:00\\",\\n \\"StartTime\\": \\"2021-04-01 00:00:00\\",\\n \\"PaymentAmount\\": 0,\\n \\"CoveragePercentage\\": 1,\\n \\"Region\\": \\"华东1（杭州）\\",\\n \\"DeductQuantity\\": 1,\\n \\"Zone\\": \\"cn-hangzhou-i\\",\\n \\"UserName\\": \\"[email protected]\\",\\n \\"ProductCode\\": \\"ecs\\"\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => 'DescribeResourceCoverageDetail', + 'description' => '1\\. The queried coverage details are the same as those displayed in the table on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" + ."\n" + .'2\\. You can call this operation to query the coverage details of RIs or SCUs.'."\n" + ."\n" + .'3\\. You can call this operation to query coverage details at an hourly, daily, or monthly granularity.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourcePackageProduct' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ossbag', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72353765387', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourcePackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourcePackage' => [ + 'description' => 'The details about the resource plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'ossbag', + ], + 'Name' => [ + 'description' => 'The name of the resource plan.'."\n", + 'type' => 'string', + 'example' => 'Object Storage Service (OSS) resource plan (monthly)'."\n", + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'ossbag', + ], + 'PackageTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PackageType' => [ + 'description' => 'The types of the resource plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the resource plan.'."\n", + 'type' => 'string', + 'example' => 'FPT_ossbag_deadlineAcc_CdnOut_common_sz', + ], + 'Name' => [ + 'description' => 'The name of the resource plan type.'."\n", + 'type' => 'string', + 'example' => 'Back-to-origin traffic plan - China (Shenzhen)'."\n", + ], + 'Properties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Property' => [ + 'description' => 'The properties of the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the property.'."\n", + 'type' => 'string', + 'example' => 'region', + ], + 'Value' => [ + 'description' => 'The value of the property.'."\n", + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + ], + ], + ], + ], + ], + 'Specifications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Specification' => [ + 'description' => 'The specifications of the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the specification.'."\n", + 'type' => 'string', + 'example' => '1TB', + ], + 'Value' => [ + 'description' => 'The value of the specification.'."\n", + 'type' => 'string', + 'example' => '1024', + ], + 'AvailableDurations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableDuration' => [ + 'description' => 'The validity periods available for the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the validity period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Name' => [ + 'description' => 'The name of the validity period.'."\n", + 'type' => 'string', + 'example' => '6 Month', + ], + 'Unit' => [ + 'description' => 'The unit of the validity period for the resource plan. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'Default value: Month.'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'ProductCodeMissing', + 'errorMessage' => 'Parameter ProductCode is missing.', + ], + [ + 'errorCode' => 'ProductNotSupported', + 'errorMessage' => 'Product currently is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 72353765387,\\n \\"Data\\": {\\n \\"ResourcePackages\\": {\\n \\"ResourcePackage\\": [\\n {\\n \\"ProductType\\": \\"ossbag\\",\\n \\"Name\\": \\"对象存储OSS资源包(包月)\\",\\n \\"ProductCode\\": \\"ossbag\\",\\n \\"PackageTypes\\": {\\n \\"PackageType\\": [\\n {\\n \\"Code\\": \\"FPT_ossbag_deadlineAcc_CdnOut_common_sz\\",\\n \\"Name\\": \\"回源流量包(华南1)\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Name\\": \\"region\\",\\n \\"Value\\": \\"cn-shenzhen\\"\\n }\\n ]\\n },\\n \\"Specifications\\": {\\n \\"Specification\\": [\\n {\\n \\"Name\\": \\"1TB\\",\\n \\"Value\\": \\"1024\\",\\n \\"AvailableDurations\\": {\\n \\"AvailableDuration\\": [\\n {\\n \\"Value\\": 6,\\n \\"Name\\": \\"6 Month\\",\\n \\"Unit\\": \\"Month\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourcePackageProductResponse>>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <ResourcePackages>\\n <ResourcePackage>\\n <Name>对象存储OSS资源包(包月)</Name>\\n <ProductCode>ossbag</ProductCode>\\n <PackageTypes>\\n <PackageType>\\n <Name>回源流量包(华南1)</Name>\\n <Specifications>\\n <Specification>\\n <Name>1TB</Name>\\n <Value>1024</Value>\\n <AvailableDurations>\\n <AvailableDuration>\\n <Name>6 Month</Name>\\n <Value>6</Value>\\n <Unit>Month</Unit>\\n </AvailableDuration>\\n </AvailableDurations>\\n </Specification>\\n </Specifications>\\n <Code>FPT_ossbag_deadlineAcc_CdnOut_common_sz</Code>\\n <Properties>\\n <Property>\\n <Name>region</Name>\\n <Value>cn-shenzhen</Value>\\n </Property>\\n <Property>\\n <Name>ossbag_type</Name>\\n <Value>cdn2oss_flow_out</Value>\\n </Property>\\n </Properties>\\n </PackageType>\\n <PackageType>\\n <Name>标准存储包(华北2)</Name>\\n <Specifications>\\n <Specification>\\n <Name>40GB</Name>\\n <Value>40</Value>\\n <AvailableDurations>\\n <AvailableDuration>\\n <Name>6 Month</Name>\\n <Value>6</Value>\\n <Unit>Month</Unit>\\n </AvailableDuration>\\n </AvailableDurations>\\n </Specification>\\n </Specifications>\\n <Code>FPT_ossbag_absolute_Storage_bj</Code>\\n <Properties>\\n <Property>\\n <Name>region</Name>\\n <Value>cn-beijing</Value>\\n </Property>\\n <Property>\\n <Name>ossbag_type</Name>\\n <Value>storage</Value>\\n </Property>\\n </Properties>\\n </PackageType>\\n </PackageTypes>\\n </ResourcePackage>\\n </ResourcePackages>\\n </Data>\\n</DescribeResourcePackageProductResponse>","errorExample":""}]', + 'title' => 'DescribeResourcePackageProduct', + 'summary' => 'Queries the information about resource plans of an Alibaba Cloud service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetResourcePackagePrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of service. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ossbag', + ], + ], + [ + 'name' => 'PackageType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource plan. The value must be the same as the value of the **ProductCode** parameter that is returned when you call the **DescribeResourcePackageProduct** operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the resource plan takes effect. If you do not specify this parameter, the resource plan immediately takes effect by default. '."\n" + .'When the **OrderType** is **BUY**, resource packs with the **EffectiveDate longer than the current time of 6 months** are not supported. '."\n" + .'If the **OrderType** is **UPGRADE**, the **EffectiveDate** **must be less than or equal to** the actual expiration time of the upgraded instance.'."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-10T12:00:00Z', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the resource plan.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the resource plan. The value must be the same as the duration of the resource plan specified in the specifications.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of validity period of the resource plan. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'* BUY: You place the order to purchase an instance.'."\n" + .'* UPGRADE: You place the order to upgrade an instance.'."\n" + .'* RENEW: You place the order to renew an instance.'."\n" + ."\n" + .'Default value: BUY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance. **This parameter is required when the order type is renewal or upgrade.**', + 'type' => 'string', + 'required' => false, + 'example' => 'OSSBAG-cn-0xl0002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => 'The original price. Unit: CNY.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1290240', + ], + 'DiscountPrice' => [ + 'description' => 'The discounted amount. Unit: CNY.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '215040', + ], + 'Currency' => [ + 'description' => 'The type of the currency.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'TradePrice' => [ + 'description' => 'The price at which the transaction is made. Unit: CNY.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1075200', + ], + 'Promotions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Promotion' => [ + 'description' => 'The details of the discount.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The description of the discount.'."\n", + 'type' => 'string', + 'example' => 'A discount of 17% is offered if you purchase a resource plan for six months.'."\n", + ], + 'Id' => [ + 'description' => 'The ID of the promotion.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000680914', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'DurationInvalid', + 'errorMessage' => 'Parameter duration can only be positive integer.', + ], + [ + 'errorCode' => 'ProductNotFound', + 'errorMessage' => 'Product not found.', + ], + [ + 'errorCode' => 'PackageTypeNotFound', + 'errorMessage' => 'No such resource package type found.', + ], + [ + 'errorCode' => 'SpecificationInvalid', + 'errorMessage' => 'Parameter specification can only be positive integer.', + ], + [ + 'errorCode' => 'IdInvalid', + 'errorMessage' => 'Parameter ownerId is invalid.', + ], + [ + 'errorCode' => 'EffectiveDateInvalid', + 'errorMessage' => 'Parameter effectiveDate is invalid.', + ], + [ + 'errorCode' => 'IdMissing', + 'errorMessage' => 'Paramter ownerId is missing.', + ], + [ + 'errorCode' => 'PackageTypeNotSupported', + 'errorMessage' => 'Package type currently is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OriginalPrice\\": 1290240,\\n \\"DiscountPrice\\": 215040,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 1075200,\\n \\"Promotions\\": {\\n \\"Promotion\\": [\\n {\\n \\"Name\\": \\"购买半年，立享8.3折优惠\\",\\n \\"Id\\": 1000680914\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResourcePackagePriceResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <DiscountPrice>215040</DiscountPrice>\\n <Promotions>\\n <Promotion>\\n <Name>购买半年，立享8.3折优惠</Name>\\n <Id>1000680914</Id>\\n </Promotion>\\n </Promotions>\\n <OriginalPrice>1290240</OriginalPrice>\\n <TradePrice>1075200</TradePrice>\\n <Currency>CNY</Currency>\\n </Data>\\n</GetResourcePackagePriceResponse>","errorExample":""}]', + 'title' => 'GetResourcePackagePrice', + 'summary' => 'Queries the price of a resource plan.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewResourcePackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource plan.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lskd****sljhsdj', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal period of the resource plan.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the validity period for the resource plan. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'Default value: Month.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204322301110333', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204322560333', + ], + 'InstanceId' => [ + 'description' => 'The ID of the resource plan.'."\n", + 'type' => 'string', + 'example' => 'OSSBAG-cn-0xl0n****003', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'DurationInvalid', + 'errorMessage' => 'Parameter duration can only be positive integer.', + ], + [ + 'errorCode' => 'ProductNotFound', + 'errorMessage' => 'Product not found.', + ], + [ + 'errorCode' => 'PackageTypeNotFound', + 'errorMessage' => 'No such resource package type found.', + ], + [ + 'errorCode' => 'SpecificationInvalid', + 'errorMessage' => 'Parameter specification can only be positive integer.', + ], + [ + 'errorCode' => 'IdInvalid', + 'errorMessage' => 'Parameter ownerId is invalid.', + ], + [ + 'errorCode' => 'EffectiveDateInvalid', + 'errorMessage' => 'Parameter effectiveDate is invalid.', + ], + [ + 'errorCode' => 'IdMissing', + 'errorMessage' => 'Paramter ownerId is missing.', + ], + [ + 'errorCode' => 'PackageTypeNotSupported', + 'errorMessage' => 'Package type currently is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 204322301110333,\\n \\"Data\\": {\\n \\"OrderId\\": 204322560333,\\n \\"InstanceId\\": \\"OSSBAG-cn-0xl0n****003\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewResourcePackageResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InstanceId>OSSBAG-cn-0xl0****d003</InstanceId>\\n <OrderId>204322301110333</OrderId>\\n </Data>\\n</RenewResourcePackageResponse>","errorExample":""}]', + 'summary' => 'Renews a resource plan.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeResourcePackage' => [ + 'summary' => 'Upgrades a resource plan.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource plan.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSSBAG-cn-0xl*****x002', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications to which you want to upgrade the resource plan.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '51200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73387246238746', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73387246238746', + ], + 'InstanceId' => [ + 'description' => 'The ID of the resource plan.'."\n", + 'type' => 'string', + 'example' => 'OSSBAG-cn-0xl*****002', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'DurationInvalid', + 'errorMessage' => 'Parameter duration can only be positive integer.', + ], + [ + 'errorCode' => 'ProductNotFound', + 'errorMessage' => 'Product not found.', + ], + [ + 'errorCode' => 'PackageTypeNotFound', + 'errorMessage' => 'No such resource package type found.', + ], + [ + 'errorCode' => 'SpecificationInvalid', + 'errorMessage' => 'Parameter specification can only be positive integer.', + ], + [ + 'errorCode' => 'IdInvalid', + 'errorMessage' => 'Parameter ownerId is invalid.', + ], + [ + 'errorCode' => 'EffectiveDateInvalid', + 'errorMessage' => 'Parameter effectiveDate is invalid.', + ], + [ + 'errorCode' => 'IdMissing', + 'errorMessage' => 'Paramter ownerId is missing.', + ], + [ + 'errorCode' => 'PackageTypeNotSupported', + 'errorMessage' => 'Package type currently is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 73387246238746,\\n \\"Data\\": {\\n \\"OrderId\\": 73387246238746,\\n \\"InstanceId\\": \\"OSSBAG-cn-0xl*****002\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpgradeResourcePackageResponse>\\r\\n <Message>Successful!</Message>\\r\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>Success</Code>\\r\\n <Data>\\r\\n <InstanceId>OSSBAG-cn-0xl*****d003</InstanceId>\\r\\n <OrderId>204322301110333</OrderId>\\r\\n </Data>\\r\\n</UpgradeResourcePackageResponse>","errorExample":""}]', + 'title' => 'UpgradeResourcePackage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubscribeBillToOSS' => [ + 'summary' => 'Subscribes to the bills that are stored in Object Storage Service (OSS) buckets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OSS bucket that stores the bills to which you want to subscribe.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxxxxx-bucket', + ], + ], + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the bill to which you want to subscribe. Valid values:'."\n" + ."\n" + .'* BillingItemDetailForBillingPeriod: detailed bills of billable items'."\n" + .'* InstanceDetailForBillingPeriod: detailed bills of instances'."\n" + .'* BillingItemDetailMonthly: billable item-based bills summarized by billing cycle'."\n" + .'* InstanceDetailMonthly: instance-based bills summarized by billing cycle'."\n" + .'* SplitItemDetailDaily: split bills summarized by day'."\n" + .'* MonthBill: monthly bills in the PDF format. You can subscribe to the monthly PDF bills only of the master account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'MultAccountRelSubscribe', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the account whose bills are to be pushed if multi-tier accounts are involved. Valid values:'."\n" + ."\n" + .'* MA: the master account and a non-managed member account in Finance Cloud'."\n" + .'* ACP1: a member account of a virtual network operator (VNO)'."\n" + ."\n" + .'Default value: MA.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MA', + ], + ], + [ + 'name' => 'BucketOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The owner ID of the OSS bucket that stores the bills. This parameter is required if you are a bidder or reseller and want to push data to an OSS bucket of a member account. In this case, you must specify this account as the account used to call this operation and grant the AliyunConsumeDump2OSSRole permission to this account. If you are a regular user, you do not need to set this parameter. By default, your account is used to call this operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12341324', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The initial billing cycle from which bills start to be pushed. After you subscribe to the bills, the system automatically pushes the data that is generated from the initial billing cycle to the current time. If the SubscribeType parameter is set to MonthBill, this parameter is invalid. Historical data is not pushed again. The data generated within the last year can be pushed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-03', + ], + ], + [ + 'name' => 'BucketPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'OSS Bucket存储路径', + 'description' => 'The path of the OSS bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testpath', + ], + ], + [ + 'name' => 'RowLimitPerFile', + 'in' => 'query', + 'schema' => [ + 'description' => 'The upper limit of the number of lines in a single file. When the bill file exceeds the upper limit, it will be split into multiple files and merged into a compressed package.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300000', + ], + ], + [ + 'name' => 'UsingSsl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to protect network communications through the SSL (Secure Sockets Layer) encryption protocol. When this parameter is set to true, it means that SSL encryption is enabled to ensure the security and integrity of data transmission.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F61FCE4B-9B56-4FD9-A17E-******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F61FCE4B-9B56-4FD9-A17E-******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SubscribeBillToOSSResponse>\\n <Message>Successful!</Message>\\n <RequestId>F61FCE4B-9B56-4FD9-A17E-******</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</SubscribeBillToOSSResponse>","errorExample":""}]', + 'title' => 'SubscribeBillToOSS', + 'description' => 'Before you call this operation, take note of the following items:'."\n" + ."\n" + .'* You can subscribe to only one type of bill at a time.'."\n" + .'* The bills generated on the previous day are pushed on a daily basis the next day after you subscribe to the bills. The full-data bills for the previous month are pushed on the fourth day of each month. The monthly bills in the PDF format for the previous month are pushed on the fourth day of each month.'."\n" + .'* The daily bills may be delayed. The delayed bills are pushed the next day after they are generated. The delayed bills may include the bills that should have been pushed on the previous day. We recommend that you query the full-data bills for the previous month at the beginning of each month.'."\n" + .'* The bill subscriber must have the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission.'."\n" + .'* The SubscribeBillToOSS operation has the same functionality as the Save Expense Details to OSS Bucket feature in User Center.'."\n" + .'* To subscribe to the bills stored in an OSS bucket, make sure that the directory name specified for the OSS bucket conforms to the following naming rules:'."\n" + ."\n" + .'1. 1. The directory name can contain only UTF-8 characters and cannot contain emoticons.'."\n" + .'2. 2. Forward slashes (/) are used to separate paths and can be used to create subdirectories with ease. The directory name cannot start with a forward slash (/), a backslash (\\\\), or consecutive forward slashes (/).'."\n" + .'3. 3. The name of a subdirectory cannot be set to two consecutive periods (..).'."\n" + .'4. 4. The directory name must be 1 to 254 characters in length.'."\n" + ."\n" + .'* File names:'."\n" + ."\n" + .' * **BillingItemDetailForBillingPeriod** (Detailed bills of billable items)'."\n" + ."\n" + .' * File name format for a daily push: `UID_BillingItemDetail_YYYYMMDD`. Example: `169**_BillingItemDetail_20190310`.'."\n" + .' * File name format for a full-data push at the beginning of the next month: `UID_BillingItemDetail_YYYYMM`. Example: `169**_BillingItemDetail_201903`.'."\n" + ."\n" + .' * **InstanceDetailForBillingPeriod** (Detailed bills of instances)'."\n" + ."\n" + .' * File name format for a daily push: `UID_InstanceDetail_YYYYMMDD`. Example: `169**_InstanceDetail_20190310`.'."\n" + .' * File name format for a full-data push at the beginning of the next month: `UID_InstanceDetail_YYYYMM`. Example: `169**_InstanceDetail_201903`.'."\n" + ."\n" + .' * **InstanceDetailMonthly** (Instance-based bills summarized by billing cycle)'."\n" + ."\n" + .' * File name format for a daily push: `UID_InstanceDetailMonthly_YYYYMM`. Example: `169**_InstanceDetailMonthly_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" + ."\n" + .' * **BillingItemDetailMonthly** (Billable item-based bills summarized by billing cycle)'."\n" + ."\n" + .' * File name format for a daily push: `UID_BillingItemDetailMonthly_YYYYMM`. Example: `169**_BillingItemDetailMonthly_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" + ."\n" + .' * **SplitItemDetailDaily** (Split bills summarized by day)'."\n" + ."\n" + .' * File name format for a daily push: `UID_SplitItemDetailDaily_YYYYMM`. Example: `169**_SplitItemDetailDaily_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" + ."\n" + .' * **MonthBill** (Monthly bill in the PDF format)'."\n" + ."\n" + .' * File name format for a monthly push: `UID_MonthBill_YYYYMM`. Example: `169**_MonthBill_201903`. The bill for the previous month is pushed on the fourth day of each month.'."\n" + ."\n" + .'* The bills of the MonthBill type are PDF files, whereas the bills of other types are CSV files. If the number of data rows in a bill exceeds a threshold, the bill is automatically split into multiple CSV files. Then, the multiple CSV files are automatically merged and compressed into a ZIP file that has the same name format as the original file.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnsubscribeBillToOSS' => [ + 'summary' => 'Unsubscribes from the bills that are stored in Object Storage Service (OSS) buckets.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the bill to which you want to subscribe. Valid values:'."\n" + ."\n" + .'* BillingItemDetailForBillingPeriod: bills of billable items'."\n" + .'* InstanceDetailForBillingPeriod: bills of instances'."\n" + .'* BillingItemDetailMonthly: billable item-based bills summarized by billing cycle'."\n" + .'* InstanceDetailMonthly: instance-based bills summarized by billing cycle'."\n" + .'* SplitItemDetailDaily: split bills summarized by day'."\n" + .'* MonthBill: monthly bills in the PDF format You can subscribe to the monthly PDF bills only of the master account.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'MultAccountRelSubscribe', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of accounts whose bills are to be pushed if multi-tier accounts are involved. Valid values:'."\n" + ."\n" + .'* MA: management account.'."\n" + .'* ACP1: member account of a virtual network operator (VNO).'."\n" + ."\n" + .'Default value: MA.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D23FE74C-742F-4624-A82B-******', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D23FE74C-742F-4624-A82B-******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnsubscribeBillToOSSResponse>\\n <Message>Successful!</Message>\\n <RequestId>D23FE74C-742F-4624-A82B-******</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</UnsubscribeBillToOSSResponse>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBillToOSSSubscription' => [ + 'summary' => 'Queries the subscribed bills that are stored in Object Storage Service (OSS) bucket.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '9EEAE43F-1E4D-4734-AE93-5049878AC103', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccountName' => [ + 'description' => 'The name of the account used to perform the query.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AccountID' => [ + 'description' => 'The ID of the account used to perform the query.'."\n", + 'type' => 'string', + 'example' => '185xxxxx03489', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the subscribed bill.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the subscribed bill.'."\n", + 'type' => 'object', + 'properties' => [ + 'BucketOwnerId' => [ + 'description' => 'The owner ID of the Object Storage Service (OSS) bucket.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1369168081849304', + ], + 'SubscribeType' => [ + 'description' => 'The type of the subscribed bill. Valid values:'."\n" + ."\n" + .'* BillingItemDetailForBillingPeriod: the bill of a billable item.'."\n" + .'* InstanceDetailForBillingPeriod: the bill of an instance.'."\n", + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'SubscribeBucket' => [ + 'description' => 'The ID of the OSS bucket that stores the subscribed bill.'."\n", + 'type' => 'string', + 'example' => 'billingtestbucket', + ], + 'SubscribeTime' => [ + 'description' => 'The time when the subscribed bill was stored in the OSS bucket. The time is displayed in the YYYY-MM-DD hh:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '2019-10-30 15:40:11', + ], + 'SubscribeLanguage' => [ + 'description' => 'The code of the language.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* en: English'."\n" + .'* zh: Chinese', + 'type' => 'string', + 'enumValueTitles' => [ + 'en' => '', + 'zh' => '', + ], + 'example' => 'zh', + ], + 'BucketPath' => [ + 'description' => 'The path in the OSS bucket.'."\n", + 'type' => 'string', + 'example' => 'Billing/BillingItemDetailMonthly/', + ], + 'RowLimitPerFile' => [ + 'description' => 'The maximum number of data rows in a single file. If the number of data rows in a bill exceeds the upper limit, the bill is split into multiple files. Then, multiple files are merged and compressed into a package.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"9EEAE43F-1E4D-4734-AE93-5049878AC103\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"AccountID\\": \\"185xxxxx03489\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"BucketOwnerId\\": 1369168081849304,\\n \\"SubscribeType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"SubscribeBucket\\": \\"billingtestbucket\\",\\n \\"SubscribeTime\\": \\"2019-10-30 15:40:11\\",\\n \\"SubscribeLanguage\\": \\"zh\\",\\n \\"BucketPath\\": \\"Billing/BillingItemDetailMonthly/\\",\\n \\"RowLimitPerFile\\": 300000\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryBillToOSSSubscriptionResponse>\\n <Message>Successful!</Message>\\n <RequestId>9EEAE43F-1E4D-4734-AE93-5049878AC103</RequestId>\\n <Data>\\n <AccountID>185xxxxx03489</AccountID>\\n <Items>\\n </Items>\\n <AccountName>[email protected]</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryBillToOSSSubscriptionResponse>","errorExample":""}]', + 'title' => 'QueryBillToOSSSubscription', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBillOverview' => [ + 'summary' => 'Queries the bill overview information in a billing cycle.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BCB1E1BC-05BF-4217-80EE-BF09A29407BA', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoundDownDiscount' => [ + 'description' => 'The round down discount.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => 'The type of the bill. Valid values:'."\n" + ."\n" + .'* SubscriptionOrder'."\n" + .'* PayAsYouGoBill'."\n" + .'* Refund'."\n" + .'* Adjustment'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'* CNY'."\n" + .'* USD'."\n" + .'* JPY'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'example' => 'Subscription', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'BizType' => [ + 'description' => 'The business type.'."\n", + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OutstandingAmount' => [ + 'description' => 'The unsettled amount or the amount deducted by using credits. This may be an unsettled amount of a regular user or credits consumed by a credit user.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AfterTaxAmount' => [ + 'description' => 'The amount paid after the tax is deducted.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PretaxAmountLocal' => [ + 'description' => 'The pretax amount paid in local currency.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Tax' => [ + 'description' => 'The tax.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PipCode' => [ + 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'NAT Gateway'."\n", + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'AdjustAmount' => [ + 'description' => 'The amount deducted by using credit refunds.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'NAT Gateway (Pay-As-You-Go)', + ], + 'PaymentCurrency' => [ + 'description' => 'The currency used for payment.'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'OwnerID' => [ + 'description' => 'The ID of the bill owner.'."\n", + 'type' => 'string', + 'example' => '1222', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentAmount' => [ + 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is included.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CashAmount' => [ + 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is not included.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BCB1E1BC-05BF-4217-80EE-BF09A29407BA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"AccountID\\": \\"185766xxxx\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"RoundDownDiscount\\": \\"0\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"OutstandingAmount\\": 0,\\n \\"AfterTaxAmount\\": 0,\\n \\"PretaxAmountLocal\\": 0,\\n \\"Tax\\": 0,\\n \\"PipCode\\": \\"rds\\",\\n \\"PretaxAmount\\": 100,\\n \\"ProductName\\": \\"Nat网关\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"NAT Gateway (Pay-As-You-Go)\\",\\n \\"PaymentCurrency\\": \\"USD\\",\\n \\"OwnerID\\": \\"1222\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ProductType\\": \\"rds\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"PaymentAmount\\": 100,\\n \\"BillAccountID\\": \\"185766xxxx\\",\\n \\"PretaxGrossAmount\\": 100,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BCB1E1BC-05BF-4217-80EE-BF09A29407BA</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>185766xxxx</AccountID>\\n <AccountName>[email protected]</AccountName>\\n <Items>\\n <Item>\\n <AfterTaxAmount>0</AfterTaxAmount>\\n <ProductName>Nat网关</ProductName>\\n <BillAccountID>185766xxxx</BillAccountID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <PaymentCurrency>USD</PaymentCurrency>\\n <Tax>0</Tax>\\n <PaymentAmount>100</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>100</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <AdjustAmount>0</AdjustAmount>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductDetail>NAT Gateway (Pay-As-You-Go)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <PipCode>rds</PipCode>\\n <OwnerID>1222</OwnerID>\\n <PretaxAmount>100</PretaxAmount>\\n <BillAccountName>[email protected]</BillAccountName>\\n <CashAmount>0</CashAmount>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'QueryBillOverview', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBill' => [ + 'summary' => 'Queries the bills in a billing cycle.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the bill. Valid values:'."\n" + ."\n" + .'* SubscriptionOrder'."\n" + .'* PayAsYouGoBill'."\n" + .'* Refund'."\n" + .'* Adjustment'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SubscriptionOrder', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription'."\n" + .'* PayAsYouGo'."\n" + ."\n" + .'This parameter must be used together with the ProductCode parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to filter out a bill whose pretax gross amount is 0. By default, a bill whose pretax gross amount is 0 is not filtered out. Valid values:'."\n" + ."\n" + .'* true: filters out a bill whose pretax gross amount is 0.'."\n" + .'* false: does not filter out a bill whose pretax gross amount is 0.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsDisplayLocalCurrency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display local currency information in bills. The parameter will be discontinued.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'example' => '2020-02', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185xxxxx489', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The payment status of the bill. Valid values:'."\n" + ."\n" + .'* PayFinish: The bill is paid.'."\n" + .'* PayUnclear: The bill is not cleared.'."\n" + .'* PayUnsettle: The bill is not settled.'."\n" + .'* NoSettle: The bill is free of settlement.'."\n", + 'type' => 'string', + 'example' => 'PayFinish', + ], + 'RoundDownDiscount' => [ + 'description' => 'The round down discount.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => 'The type of the bill.'."\n" + ."\n" + .'* SubscriptionOrder'."\n" + .'* PayAsYouGoBill'."\n" + .'* Refund'."\n" + .'* Adjustment'."\n", + 'type' => 'string', + 'example' => 'SubscriptionOrder', + ], + 'Currency' => [ + 'description' => 'The type of the currency.'."\n" + ."\n" + .'* CNY'."\n" + .'* USD'."\n" + .'* JPY'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'UsageStartTime' => [ + 'description' => 'The time when the bill starts.'."\n", + 'type' => 'string', + 'example' => '2020-03-11 07:00:00', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription'."\n" + .'* PayAsYouGo'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'UsageEndTime' => [ + 'description' => 'The time when the bill ends.'."\n", + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SubOrderId' => [ + 'description' => 'The ID of the order corresponding to the bill.'."\n", + 'type' => 'string', + 'example' => '325345254353', + ], + 'OutstandingAmount' => [ + 'description' => 'The unsettled amount of the bill.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AfterTaxAmount' => [ + 'description' => 'The amount paid after tax is deducted.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => 'The time when the order was paid.'."\n", + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'PretaxAmountLocal' => [ + 'description' => 'The pretax amount paid in local currency.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Tax' => [ + 'description' => 'The tax.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PipCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'PaymentTransactionID' => [ + 'description' => 'The ID of the transaction.'."\n", + 'type' => 'string', + 'example' => '2O3AADJFEAF2PDKSFAMFCB11918', + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'RecordID' => [ + 'description' => 'The ID of the order or bill.'."\n", + 'type' => 'string', + 'example' => '2020xxxx5912', + ], + 'AdjustAmount' => [ + 'description' => 'The amount deducted by using credit refunds.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS (subscription)'."\n", + ], + 'PaymentCurrency' => [ + 'description' => 'The currency used for payment.'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'OwnerID' => [ + 'description' => 'The ID of the member. This parameter is returned in a multi-account payment scenario.'."\n", + 'type' => 'string', + 'example' => '3532535235', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentAmount' => [ + 'description' => 'The amount paid with cash.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is not included.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"AE3F4057-DFC9-4B81-8858-F620651010C9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"BillingCycle\\": \\"2020-02\\",\\n \\"AccountID\\": \\"185xxxxx489\\",\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 20,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"Status\\": \\"PayFinish\\",\\n \\"RoundDownDiscount\\": \\"0\\",\\n \\"Item\\": \\"SubscriptionOrder\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"UsageStartTime\\": \\"2020-03-11 07:00:00\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"UsageEndTime\\": \\"2020-03-11 08:00:00\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"SubOrderId\\": \\"325345254353\\",\\n \\"OutstandingAmount\\": 0,\\n \\"AfterTaxAmount\\": 0,\\n \\"PaymentTime\\": \\"2020-03-11 08:00:00\\",\\n \\"PretaxAmountLocal\\": 0,\\n \\"Tax\\": 0,\\n \\"PipCode\\": \\"rds\\",\\n \\"PaymentTransactionID\\": \\"2O3AADJFEAF2PDKSFAMFCB11918\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\n \\"PaymentCurrency\\": \\"USD\\",\\n \\"OwnerID\\": \\"3532535235\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ProductType\\": \\"rds\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"PaymentAmount\\": 0,\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryBillResponse>\\n <Message>Successful!</Message>\\n <RequestId>347A769E-CA83-4213-964D-41A974DE0F3D</RequestId>\\n <Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>47</TotalCount>\\n <AccountID>185xxxxx489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Item>\\n <Status>PayFinish</Status>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductName>云数据库RDS</ProductName>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <SubOrderId/>\\n <ProductType>rds</ProductType>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <OutstandingAmount>0</OutstandingAmount>\\n <PaymentTime/>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <UsageEndTime>2020-03-11 08:00:00</UsageEndTime>\\n <Item>PayAsYouGoBill</Item>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <OwnerID/>\\n <PretaxAmount>0</PretaxAmount>\\n <Currency>CNY</Currency>\\n <UsageStartTime>2020-03-11 07:00:00</UsageStartTime>\\n <RecordID>2020xxxx5912</RecordID>\\n </Item>\\n </Items>\\n <AccountName>[email protected]</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryBillResponse>","errorExample":""}]', + 'title' => 'QueryBill', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAccountBill' => [ + 'summary' => 'Queries the bills of your Alibaba Cloud account within a billing cycle. You can summarize the bills by resource owner.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'OwnerID', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'IsGroupByProduct', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to summarize bills based on service codes. Valid values:'."\n" + ."\n" + .'* true: summarizes bills based on service codes.'."\n" + .'* false: does not summarize bills based on service codes.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The granularity at which bills are queried. Valid values:'."\n" + ."\n" + .'* MONTHLY: queries bills by month. The data queried is consistent with the data that is displayed for the specified billing cycle on the Billing Details tab of the Bill Details page in User Center.'."\n" + .'* DAILY: queries bills by day. The data queried is consistent with the data that is displayed for the specified day on the Billing Details tab of the Bill Details page in User Center.'."\n" + ."\n" + .'You must set the BillingDate parameter before you can set the Granularity parameter to DAILY.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Monthly', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing date. This parameter is required only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-06-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => 'The ID of your Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '1857xxxxx489', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccountName' => [ + 'description' => 'The name of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PipCode' => [ + 'description' => 'The code of the service. The service code is consistent with that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'BillingDate' => [ + 'description' => 'The billing date.'."\n", + 'type' => 'string', + 'example' => '2021-03-01', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n" + ."\n" + .'> A value is returned only if the **IsGroupByProduct** parameter is set to true.', + 'type' => 'string', + 'example' => 'rds', + ], + 'OwnerName' => [ + 'description' => 'The name of the member.'."\n", + 'type' => 'string', + 'example' => 'aligzncloudtest2', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'* CNY'."\n" + .'* USD'."\n" + .'* JPY'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n" + ."\n" + .'> A value is returned only if the IsGroupByProduct parameter is set to true.', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'BizType' => [ + 'description' => 'The business type.'."\n", + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'OwnerID' => [ + 'description' => 'The ID of the member.'."\n", + 'type' => 'string', + 'example' => '325434254', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '1857xxxxx489', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CostUnit' => [ + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n" + ."\n" + .'> A value is returned only if the **IsGroupByProduct** parameter is set to true.', + 'type' => 'string', + 'example' => 'rds', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"3BFC23FE-A182-4D96-A1E4-7521B30B8E43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"AccountID\\": \\"1857xxxxx489\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"PipCode\\": \\"rds\\",\\n \\"PretaxAmount\\": 0,\\n \\"BillingDate\\": \\"2021-03-01\\",\\n \\"ProductName\\": \\"rds\\",\\n \\"AdjustAmount\\": 0,\\n \\"OwnerName\\": \\"aligzncloudtest2\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"BizType\\": \\"trusteeship\\",\\n \\"OwnerID\\": \\"325434254\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"DeductedByCoupons\\": 0,\\n \\"BillAccountID\\": \\"1857xxxxx489\\",\\n \\"PaymentAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"OutstandingAmount\\": 0,\\n \\"CostUnit\\": \\"未分配\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3BFC23FE-A182-4D96-A1E4-7521B30B8E43</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>1857xxxxx489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <AccountName>[email protected]</AccountName>\\n <Items>\\n <Item>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <OwnerName>aligzncloudtest2</OwnerName>\\n <ProductName>rds</ProductName>\\n <ProductCode>rds</ProductCode>\\n <BillAccountID>1857xxxxx489</BillAccountID>\\n <OutstandingAmount>0</OutstandingAmount>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <BizType>trusteeship</BizType>\\n <BillingDate>2021-03-01</BillingDate>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <PipCode>rds</PipCode>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <OwnerID>325434254</OwnerID>\\n <PretaxAmount>0</PretaxAmount>\\n <Currency>CNY</Currency>\\n <BillAccountName>[email protected]</BillAccountName>\\n <CostUnit>未分配</CostUnit>\\n <CashAmount>0</CashAmount>\\n <AdjustAmount>0</AdjustAmount>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'QueryAccountBill', + 'description' => 'Before you call this operation, take note of the following items:'."\n" + ."\n" + .'* Account bills are summarized based on instance bills. In most cases, the account bills do not include the data generated on the last day of the specified period.'."\n" + .'* You can query the data generated in June 2020 or later for Cloud Communications services. However, the query results do not include the data of Alibaba Cloud Domains.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySettleBill' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SubscriptionOrder', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsDisplayLocalCurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12233', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + 'BillingCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-02', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '185xxxxx489', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PayFinish', + ], + 'RoundDownDiscount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SubscriptionOrder', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'SubscriptionType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'UsageStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-03-11 07:00:00', + ], + 'BizType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'UsageEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'DeductedByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SubOrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '325345254353', + ], + 'AfterTaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OutstandingAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'Tax' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PretaxAmountLocal' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PipCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'PaymentTransactionID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2O3AADJFEAF2PDKSFAMFCB11918', + ], + 'PretaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CommodityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RecordID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020xxxx5912', + ], + 'AdjustAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PaymentCurrency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USD', + ], + 'OwnerID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3532535235', + ], + 'BillAccountID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '185xxxxx489', + ], + 'PaymentAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"AE3F4057-DFC9-4B81-8858-F620651010C9\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\",\\n \\"BillingCycle\\": \\"2020-02\\",\\n \\"MaxResults\\": 20,\\n \\"AccountID\\": \\"185xxxxx489\\",\\n \\"TotalCount\\": 200,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"Status\\": \\"PayFinish\\",\\n \\"RoundDownDiscount\\": \\"0\\",\\n \\"Item\\": \\"Subscription\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"UsageStartTime\\": \\"2020-03-11 07:00:00\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"UsageEndTime\\": \\"2020-03-11 08:00:00\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"SubOrderId\\": \\"325345254353\\",\\n \\"AfterTaxAmount\\": 0,\\n \\"OutstandingAmount\\": 0,\\n \\"PaymentTime\\": \\"2020-03-11 08:00:00\\",\\n \\"Tax\\": 0,\\n \\"PretaxAmountLocal\\": 0,\\n \\"PipCode\\": \\"rds\\",\\n \\"PaymentTransactionID\\": \\"2O3AADJFEAF2PDKSFAMFCB11918\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\n \\"PaymentCurrency\\": \\"USD\\",\\n \\"OwnerID\\": \\"3532535235\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"BillAccountID\\": \\"185xxxxx489\\",\\n \\"PaymentAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"ProductType\\": \\"rds\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>AE3F4057-DFC9-4B81-8858-F620651010C9</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>200</TotalCount>\\n <BillingCycle>2020-02</BillingCycle>\\n <AccountID>185xxxxx489</AccountID>\\n <NextToken>CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U</NextToken>\\n <MaxResults>20</MaxResults>\\n <AccountName>[email protected]</AccountName>\\n <Items>\\n <Item>\\n <AfterTaxAmount>0</AfterTaxAmount>\\n <ProductName>云数据库RDS</ProductName>\\n <BillAccountID>185xxxxx489</BillAccountID>\\n <SubOrderId>325345254353</SubOrderId>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <PaymentCurrency>USD</PaymentCurrency>\\n <Tax>0</Tax>\\n <PaymentTime>2020-03-11 08:00:00</PaymentTime>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <UsageEndTime>2020-03-11 08:00:00</UsageEndTime>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>SubscriptionOrder</Item>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <UsageStartTime>2020-03-11 07:00:00</UsageStartTime>\\n <AdjustAmount>0</AdjustAmount>\\n <PaymentTransactionID>2O3AADJFEAF2PDKSFAMFCB11918</PaymentTransactionID>\\n <Status>PayFinish</Status>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <PipCode>rds</PipCode>\\n <OwnerID>3532535235</OwnerID>\\n <PretaxAmount>100</PretaxAmount>\\n <BillAccountName>[email protected]</BillAccountName>\\n <RecordID>2020xxxx5912</RecordID>\\n <CashAmount>0</CashAmount>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'summary' => 'Queries the bills in a billing cycle. You can call this operation to query a bill that contains more than 50,000 entries in an account that is created on the Alibaba Cloud China site.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInstanceBill' => [ + 'summary' => 'Queries the bills of instances or billable items in a billing cycle.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-03', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service. This parameter is required if the ProductCode parameter is set to the service code of Alibaba Cloud Marketplace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n" + ."\n" + .'**'."\n" + ."\n" + .'****This parameter must be used together with the **ProductCode** parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'IsBillingItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query data by billable item. Valid values:'."\n" + ."\n" + .'* false: does not query data by billable item. The data queried is consistent with the data that is displayed for the specified instance on the Billing Details tab of the Bill Details page in User Center.'."\n" + .'* true: queries data by billable item. The data queried is consistent with the data that is displayed for the specified billable item on the Billing Details tab of the Bill Details page in User Center.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to filter out a bill whose pretax gross amount and pretax amount are 0. Default value: false.******** Valid values:'."\n" + ."\n" + .'* false: does not filter the bill.'."\n" + .'* true: filters the bill.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing date. This parameter is required only if the **Granularity** parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-03', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The granularity at which bills are queried. Valid values:'."\n" + ."\n" + .'* MONTHLY: queries bills by month. The data queried is consistent with the data that is displayed for the specified billing cycle on the Billing Details tab of the Bill Details page in User Center.'."\n" + .'* DAILY: queries bills by day. The data queried is consistent with the data that is displayed for the specified day on the Billing Details tab of the Bill Details page in User Center.'."\n" + ."\n" + .'You must set the **BillingDate** parameter before you can set the Granularity parameter to DAILY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MONTHLY', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle in the YYYY-MM format.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the bill.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingDate' => [ + 'description' => 'The billing date. This parameter is returned only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'InstanceConfig' => [ + 'description' => 'The configurations of the instance.'."\n", + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'InternetIP' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => 'The type of the bill.'."\n" + ."\n" + .'* SubscriptionOrder: subscription order'."\n" + .'* PayAsYouGoBill: pay-as-you-go bill'."\n" + .'* Refund: refund'."\n" + .'* Adjustment: reconciliation'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Tag' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'* CNY'."\n" + .'* USD'."\n" + .'* JPY'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n" + ."\n" + .'**'."\n" + ."\n" + .'****This parameter is returned together with the ProductCode parameter.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillingItem' => [ + 'description' => 'The billable item. This parameter is returned only if the IsBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'CostUnit' => [ + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'ListPriceUnit' => [ + 'description' => 'The unit of the unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'CNY'."\n", + ], + 'ResourceGroup' => [ + 'description' => 'The resource group.'."\n", + 'type' => 'string', + 'example' => 'Default resource group'."\n", + ], + 'PipCode' => [ + 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriodUnit' => [ + 'description' => 'The unit of the validity period.'."\n", + 'type' => 'string', + 'example' => 'Seconds'."\n", + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'NickName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'Usage' => [ + 'description' => 'The usage of the billable item. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'OwnerID' => [ + 'description' => 'The ID of the member account. This parameter is returned in a multi-account payment scenario.'."\n", + 'type' => 'string', + 'example' => '169***013', + ], + 'UsageUnit' => [ + 'description' => 'The unit of usage. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'DeductedByResourcePackage' => [ + 'description' => 'The amount deducted by using resource plans.'."\n", + 'type' => 'string', + 'example' => 'NULL', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriod' => [ + 'description' => 'The validity period.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Zone' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ListPrice' => [ + 'description' => 'The unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'BillingType' => [ + 'description' => 'The billing type.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"AccountID\\": \\"185xxxx3489\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"BillingDate\\": \\"2020-03\\",\\n \\"InstanceConfig\\": \\"CPU:12\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"Tag\\": \\"tag\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"BillingItem\\": \\"其他\\",\\n \\"Region\\": \\"杭州\\",\\n \\"OutstandingAmount\\": 0,\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"PretaxAmount\\": 0,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"AdjustAmount\\": 0,\\n \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"OwnerID\\": \\"169***013\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"UsageUnit\\": \\"GB\\",\\n \\"PaymentAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"DeductedByResourcePackage\\": \\"NULL\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"ServicePeriod\\": \\"10\\",\\n \\"Zone\\": \\"cn-hangzhou-h\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\",\\n \\"BillingType\\": \\"其它\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryInstanceBillResponse>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>2</TotalCount>\\n <AccountID>18xxxxx3489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Item>\\n <InstanceSpec>rds.mysql.s3.large</InstanceSpec>\\n <ProductName>云数据库RDS</ProductName>\\n <InstanceID>rm-bp1xxxxxxxe</InstanceID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <ListPriceUnit/>\\n <BillingDate/>\\n <ListPrice/>\\n <PaymentAmount>0.01</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>11447.99</InvoiceDiscount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <Item>SubscriptionOrder</Item>\\n <PretaxGrossAmount>11448</PretaxGrossAmount>\\n <InstanceConfig>数据库类型:MySQL;实例规格:rds.mysql.s3.large;存储:5;内存:8192</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CostUnit>未分配</CostUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage/>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>cn-hangzhou-b</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BillingItem/>\\n <NickName/>\\n <IntranetIP/>\\n <ServicePeriod>31583763</ServicePeriod>\\n <ServicePeriodUnit>秒</ServicePeriodUnit> \\n <DeductedByResourcePackage/>\\n <UsageUnit/>\\n <OwnerID>18576xxxxx489</OwnerID>\\n <PretaxAmount>0.01</PretaxAmount>\\n <InternetIP/>\\n <Region>华东1（杭州）</Region>\\n <Tag/>\\n </Item>\\n </Items>\\n <AccountName>[email protected]</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryInstanceBillResponse>","errorExample":""}]', + 'description' => '##'."\n" + ."\n" + .'* This API operation has been upgraded to DescribeInstanceBill. We recommend that you call the [DescribeInstanceBill](~~209402~~) operation to query the bills of instances or billable items in a billing cycle. You can call the QueryInstanceBill operation to query a maximum of 50,000 data rows in a bill.'."\n" + .'* Instance bills are generated after bills are split. In most cases, the instance bills do not include data generated on the last day of the specified period.'."\n" + .'* The instance information changes within a billing cycle. The instance configurations and specifications and the time when the instance was used in the billing cycle are all recorded. For more information, see the corresponding bill details.'."\n" + .'* You can query the data generated in June 2020 or later for Cloud Communications services, and the data generated in November 2020 or later for Alibaba Cloud Domains.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceBill' => [ + 'summary' => 'Queries the billing information about instances or billable items in a billing cycle.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle. Specify the parameter in the YYYY-MM format.'."\n" + .'Only the latest 18 month billing cycle is supported.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-03', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method.'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'IsBillingItem', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query data by billable items. Valid values:'."\n" + ."\n" + .'* false: The data that you query is the same as the data searched by instances on the Billing Details tab of the Bill Details page in the User Center console.'."\n" + .'* true: The data that you query is the same as the data searched by billable items on the Billing Details tab of the Bill Details page in the User Center console.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to indicate the position where the results for the current call start. The parameter must be left empty or set to the value of the NextToken parameter that is returned from the last call. Otherwise, an error is returned. If the parameter is left empty, data is queried from the first item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCm', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to filter bills if both the pretax gross amount and pretax amount are 0. Valid values:'."\n" + ."\n" + .'* false: does not filter bills.'."\n" + .'* true: filters bills.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing date. This parameter is required only when the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-02', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The granularity at which bills are queried. Valid values:'."\n" + ."\n" + .'* MONTHLY: queries bills on a monthly basis. The data that you query is the same as the data searched by instances on the Billing Details tab of the Bill Details page in the User Center console.'."\n" + .'* DAILY: queries bills on a daily basis. The data that you query is the same as the data searched by days on the Billing Details tab of the Bill Details page in the User Center console.'."\n" + ."\n" + .'The BillingDate parameter is required if you set the Granularity parameter to DAILY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MONTHLY', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify this parameter, the bills of the member are queried. If you do not specify this parameter, the bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + [ + 'name' => 'InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service. The code is the same as that in Cost Center.', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The position where the query stopped. If this parameter is left empty, all the results are returned. If you perform another call, you must set the NextToken parameter to the value of this parameter.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCm', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle in the YYYY-MM format.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '122', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'description' => 'The details of the bill.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingDate' => [ + 'description' => 'The billing date. This parameter is returned only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'example' => '2020-03-20', + ], + 'InstanceConfig' => [ + 'description' => 'The configurations of the instance.'."\n", + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'InternetIP' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '34.xx.x.x ', + ], + 'Item' => [ + 'description' => 'The type of the bill.'."\n" + ."\n" + .'* SubscriptionOrder: the subscription bill.'."\n" + .'* PayAsYouGoBill: the pay-as-you-go bill,'."\n" + .'* Refund: the refund.'."\n" + .'* Adjustment: the adjustment bill.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Tag' => [ + 'description' => 'The tag of the resource.'."\n", + 'type' => 'string', + 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-dadada', + ], + 'Currency' => [ + 'description' => 'The type of currency. Valid values:'."\n" + ."\n" + .'* CNY'."\n" + .'* USD'."\n" + .'* JPY'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method.'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'BizType' => [ + 'description' => 'The type of business.'."\n", + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'InstanceSpec' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge ', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted with coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'BillingItem' => [ + 'description' => 'The billable item. A value is returned only if the IsBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'Bandwidth'."\n", + ], + 'BillingItemCode' => [ + 'description' => 'The code of the billable item.'."\n", + 'type' => 'string', + 'example' => 'disk', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'CostUnit' => [ + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'ListPriceUnit' => [ + 'description' => 'The unit of the unit price. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'CNY'."\n", + ], + 'ResourceGroup' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'Default resource group'."\n", + ], + 'PipCode' => [ + 'description' => 'The code of the service. The code is the same as that in Cost Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriodUnit' => [ + 'description' => 'The unit of the service duration.'."\n", + 'type' => 'string', + 'example' => 'Second'."\n", + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity. The code is the same as that in Cost Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'NickName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'Usage' => [ + 'description' => 'The usage of the service. This parameter is valid only when the isBillingItem parameter is set to true. The usage is the total usage in all bills in the billing cycle, not the amount that you purchase. For example, if 1 GB of storage is used and bills are generated every hour, the usage is 1 GB per hour. In this case, the usage is 24 GB per day.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'OwnerID' => [ + 'description' => 'The ID of the account that owns the resource. This parameter is returned in multi-account payment scenario.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'UsageUnit' => [ + 'description' => 'The unit of usage. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '122', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'DeductedByResourcePackage' => [ + 'description' => 'The amount deducted with resource plans. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '0.1', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriod' => [ + 'description' => 'The service duration.'."\n", + 'type' => 'string', + 'example' => '3600', + ], + 'Zone' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou Zone B'."\n", + ], + 'ListPrice' => [ + 'description' => 'The unit price of the service. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'BillingType' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + 'ItemName' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCm\\",\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"MaxResults\\": 20,\\n \\"AccountID\\": \\"122\\",\\n \\"TotalCount\\": 20,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": [\\n {\\n \\"BillingDate\\": \\"2020-03-20\\",\\n \\"InstanceConfig\\": \\"CPU：12\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\\\t\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"Tag\\": \\"key:testKey value:testValue; key:testKey1 value:testValues1\\",\\n \\"InstanceID\\": \\"i-dadada\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"DeductedByCashCoupons\\": 0.1,\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\\\t\\",\\n \\"DeductedByCoupons\\": 0.1,\\n \\"BillingItem\\": \\"带宽\\",\\n \\"BillingItemCode\\": \\"disk\\",\\n \\"Region\\": \\"杭州\\",\\n \\"OutstandingAmount\\": 0.1,\\n \\"CostUnit\\": \\"未分配\\\\t\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\t\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"PretaxAmount\\": 0.1,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\\\t\\",\\n \\"AdjustAmount\\": 0,\\n \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\t\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"OwnerID\\": \\"123\\",\\n \\"DeductedByPrepaidCard\\": 0.1,\\n \\"UsageUnit\\": \\"GB\\",\\n \\"BillAccountID\\": \\"122\\",\\n \\"PaymentAmount\\": 0.1,\\n \\"InvoiceDiscount\\": 0.1,\\n \\"DeductedByResourcePackage\\": \\"0.1\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"ServicePeriod\\": \\"3600\\",\\n \\"Zone\\": \\"杭州1\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"PretaxGrossAmount\\": 0.1,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"AfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>20</TotalCount>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>122</AccountID>\\n <NextToken>CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U</NextToken>\\n <MaxResults>20</MaxResults>\\n <AccountName>[email protected]</AccountName>\\n <Items>\\n <InstanceSpec>ecs.sn1ne.3xlarge\\t</InstanceSpec>\\n <ProductName>云数据库RDS\\t</ProductName>\\n <InstanceID>i-dadada</InstanceID>\\n <BillAccountID>122</BillAccountID>\\n <DeductedByCashCoupons>0.1</DeductedByCashCoupons>\\n <ListPriceUnit>元</ListPriceUnit>\\n <BillingDate>2020-03-20</BillingDate>\\n <ListPrice>100</ListPrice>\\n <PaymentAmount>0.1</PaymentAmount>\\n <DeductedByPrepaidCard>0.1</DeductedByPrepaidCard>\\n <InvoiceDiscount>0.1</InvoiceDiscount>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>0.1</PretaxGrossAmount>\\n <InstanceConfig>CPU：12</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <CostUnit>未分配\\t</CostUnit>\\n <AdjustAmount>0</AdjustAmount>\\n <ResourceGroup>默认资源组\\t</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage>100</Usage>\\n <DeductedByCoupons>0.1</DeductedByCoupons>\\n <ProductDetail>云数据库RDS\\t</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>杭州1</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0.1</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <BillingItem>带宽</BillingItem>\\n <NickName>test</NickName>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <PipCode>rds</PipCode>\\n <ServicePeriodUnit>秒</ServicePeriodUnit>\\n <ServicePeriod>3600</ServicePeriod>\\n <DeductedByResourcePackage>0.1</DeductedByResourcePackage>\\n <UsageUnit>GB</UsageUnit>\\n <OwnerID>123</OwnerID>\\n <PretaxAmount>0.1</PretaxAmount>\\n <InternetIP>34.xx.x.x\\t</InternetIP>\\n <Region>杭州</Region>\\n <BillAccountName>[email protected]</BillAccountName>\\n <Tag>key:testKey value:testValue; key:testKey1 value:testValues1</Tag>\\n <CashAmount>0</CashAmount>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'DescribeInstanceBill', + 'description' => '* Instance bills are generated after the total bill is split. In most cases, the instance bills do not include data generated on the last day of the specified billing cycle.'."\n" + .'* The instance information may change during the billing cycle. The instance configurations and types in monthly bills are subject to the point in time when you query bills. For more information, see the corresponding bill details.'."\n" + .'* You can query data generated after June 2020 for Cloud Communications services. You can query data generated after November 2020 for Alibaba Cloud Domains.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInstanceGaapCost' => [ + 'summary' => 'Queries the monthly allocated costs of instances. The AccessKey pair of the management account is required for queries. You can query the full generally accepted accounting principles (GAAP) bills of the previous month after 12:00 on the fourth day of each month. If you query the GAAP bills before 12:00 on the fourth day of each month, the bills returned may be incomplete.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-03', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CCBB1BB9-22F1-4177-867B-7A75D665B488', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'HostId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'Modules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Module' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GaapDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'SubscriptionType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'MonthGaapPretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'SubOrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12434345', + ], + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'New', + ], + 'MonthGaapDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'PretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'BillingCycle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-03', + ], + 'PayerAccount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23534534', + ], + 'MonthGaapPretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.99', + ], + 'AccountingUnit' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'GaapPretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'ProductType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'PaymentAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'MonthGaapPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.99', + ], + 'BillType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SubscriptionOrder', + ], + 'PayTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2018-06-15 15:59:57', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '213123213123', + ], + 'UnallocatedPricingDiscount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'MonthGaapDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0.75', + ], + 'UnallocatedPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'InstanceID' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OSSBAG-cn-0xl0xxxxxx', + ], + 'Tag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tag', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'GaapDeductedByCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'GaapDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'GaapPaymentAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedPretaxAmountLocal' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'MonthGaapPricingDiscount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0,.25', + ], + 'PricingDiscount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'GaapPricingDiscount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'ResourceGroup' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'UnallocatedDeductedByCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedPretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'GaapPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedPaymentAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'PaymentCurrency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'OwnerID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123213123123', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'GaapPretaxAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'MonthGaapDeductedByCoupons' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'MonthGaapPaymentAmount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'UsageEndDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-05-01 00:00:00', + ], + 'UsageStartDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-04-01 00:00:00', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'Absent some mandatory parameter for this request.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'This request contain some invalid parameter', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'DurationInvalid', + 'errorMessage' => 'Parameter duration can only be positive integer.', + ], + [ + 'errorCode' => 'ProductNotFound', + 'errorMessage' => 'Product not found.', + ], + [ + 'errorCode' => 'InvalidBillingCycle', + 'errorMessage' => 'BillingCycle not Invalid.', + ], + [ + 'errorCode' => 'ProdCodeNotFind', + 'errorMessage' => 'Product code not find. ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"CCBB1BB9-22F1-4177-867B-7A75D665B488\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20,\\n \\"HostId\\": \\"1.1.1.1\\",\\n \\"Modules\\": {\\n \\"Module\\": [\\n {\\n \\"GaapDeductedByCashCoupons\\": \\"0\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"MonthGaapPretaxAmount\\": \\"0\\",\\n \\"DeductedByCoupons\\": \\"0\\",\\n \\"SubOrderId\\": \\"12434345\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OrderType\\": \\"New\\",\\n \\"MonthGaapDeductedByPrepaidCard\\": \\"0\\",\\n \\"UnallocatedDeductedByCashCoupons\\": \\"0\\",\\n \\"PretaxAmountLocal\\": \\"0\\",\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"PayerAccount\\": \\"23534534\\",\\n \\"MonthGaapPretaxAmountLocal\\": \\"0.99\\",\\n \\"AccountingUnit\\": \\"无\\",\\n \\"GaapPretaxAmountLocal\\": \\"0\\",\\n \\"UnallocatedDeductedByPrepaidCard\\": \\"0\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"PaymentAmount\\": \\"0\\",\\n \\"MonthGaapPretaxGrossAmount\\": \\"0.99\\",\\n \\"BillType\\": \\"SubscriptionOrder\\",\\n \\"PayTime\\": \\"2018-06-15 15:59:57\\",\\n \\"PretaxGrossAmount\\": \\"123\\",\\n \\"OrderId\\": \\"213123213123\\",\\n \\"UnallocatedPricingDiscount\\": \\"0\\",\\n \\"MonthGaapDeductedByCashCoupons\\": \\"0.75\\",\\n \\"UnallocatedPretaxGrossAmount\\": \\"0\\",\\n \\"InstanceID\\": \\"OSSBAG-cn-0xl0xxxxxx\\",\\n \\"Tag\\": \\"tag\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"GaapDeductedByCoupons\\": \\"0\\",\\n \\"DeductedByCashCoupons\\": \\"0\\",\\n \\"GaapDeductedByPrepaidCard\\": \\"0\\",\\n \\"GaapPaymentAmount\\": \\"0\\",\\n \\"UnallocatedPretaxAmountLocal\\": \\"0\\",\\n \\"MonthGaapPricingDiscount\\": \\"0,.25\\",\\n \\"PricingDiscount\\": \\"1\\",\\n \\"GaapPricingDiscount\\": \\"0\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"UnallocatedDeductedByCoupons\\": \\"0\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"UnallocatedPretaxAmount\\": \\"0\\",\\n \\"GaapPretaxGrossAmount\\": \\"0\\",\\n \\"UnallocatedPaymentAmount\\": \\"0\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"OwnerID\\": \\"123213123123\\",\\n \\"DeductedByPrepaidCard\\": \\"0\\",\\n \\"GaapPretaxAmount\\": \\"0\\",\\n \\"MonthGaapDeductedByCoupons\\": \\"0\\",\\n \\"MonthGaapPaymentAmount\\": \\"0\\",\\n \\"UsageEndDate\\": \\"2019-05-01 00:00:00\\",\\n \\"UsageStartDate\\": \\"2019-04-01 00:00:00\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryInstanceGaapCostResponse>\\n <Data>\\n <TotalCount>2</TotalCount>\\n <Modules>\\n <Module>\\n <PayerAccount>null</PayerAccount>\\n <GaapDeductedByCashCoupons>0</GaapDeductedByCashCoupons>\\n <PricingDiscount>0</PricingDiscount>\\n <MonthGaapPretaxAmount>0.74</MonthGaapPretaxAmount>\\n <MonthGaapDeductedByCoupons>0</MonthGaapDeductedByCoupons>\\n <PretaxAmount>0</PretaxAmount>\\n <UnallocatedPaymentAmount>0</UnallocatedPaymentAmount>\\n <UnallocatedPretaxGrossAmount>0</UnallocatedPretaxGrossAmount>\\n <UnallocatedPretaxAmount>0</UnallocatedPretaxAmount>\\n <UnallocatedPricingDiscount>0</UnallocatedPricingDiscount>\\n <PayTime>2018-06-15 14:06:53</PayTime>\\n <PaymentCurrency>CNY</PaymentCurrency>\\n <ProductType>ossbag</ProductType>\\n <UnallocatedDeductedByCoupons>0</UnallocatedDeductedByCoupons>\\n <OrderType>Renewal</OrderType>\\n <UnallocatedPretaxAmountLocal>0</UnallocatedPretaxAmountLocal>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <GaapPretaxAmountLocal>0</GaapPretaxAmountLocal>\\n <GaapPaymentAmount>0</GaapPaymentAmount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <BillingCycle>2019-04</BillingCycle>\\n <ProductCode>flowpack</ProductCode>\\n <InstanceID>OSSBAG-cn-0xl0njdtx002</InstanceID>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n <GaapDeductedByCoupons>0</GaapDeductedByCoupons>\\n <GaapPretaxAmount>0</GaapPretaxAmount>\\n <OrderId>202143356070333</OrderId>\\n <GaapDeductedByPrepaidCard>0</GaapDeductedByPrepaidCard>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <GaapPretaxGrossAmount>0</GaapPretaxGrossAmount>\\n <SubOrderId>202143356070333</SubOrderId>\\n <MonthGaapPaymentAmount>0</MonthGaapPaymentAmount>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <UsageEndDate>2019-05-01 00:00:00</UsageEndDate>\\n <UnallocatedDeductedByPrepaidCard>0</UnallocatedDeductedByPrepaidCard>\\n <MonthGaapDeductedByPrepaidCard>0</MonthGaapDeductedByPrepaidCard>\\n <UsageStartDate>2019-04-01 00:00:00</UsageStartDate>\\n <MonthGaapPretaxGrossAmount>0.99</MonthGaapPretaxGrossAmount>\\n <PaymentAmount>0</PaymentAmount>\\n <MonthGaapPricingDiscount>0.25</MonthGaapPricingDiscount>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <OwnerID>1028728862215453</OwnerID>\\n <MonthGaapDeductedByCashCoupons>0.74</MonthGaapDeductedByCashCoupons>\\n <UnallocatedDeductedByCashCoupons>0</UnallocatedDeductedByCashCoupons>\\n <MonthGaapPretaxAmountLocal>0.74</MonthGaapPretaxAmountLocal>\\n <GaapPricingDiscount>0</GaapPricingDiscount>\\n <BillType>SubscriptionOrder</BillType>\\n </Module>\\n </Modules>\\n <PageSize>20</PageSize>\\n <HostId>cn</HostId>\\n <PageNum>1</PageNum>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>AEAA504C-FCCA-4FB9-9E05-162CABC6EB40</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</QueryInstanceGaapCostResponse>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ + 'summary' => 'Queries the monthly allocated costs of instances by allocation month.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => [ + 'title' => '账期月、摊销月', + 'description' => 'The allocation month. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '账期月筛选条件', + 'description' => 'The billing cycle that is used to filter bills. You can specify a maximum of 10 billing cycles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-09', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '订阅类型', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The code of the service. You can obtain the value of this parameter by calling the QueryProductList operation or the DescribeResourcePackageProduct operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The specific service resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元code', + 'description' => 'The code of the cost center.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123#', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the member that needs to settle the bill. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member account. If you leave this parameter empty, the bills of the current account and all members of the current account are queried by default. You can specify a maximum of 10 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member that needs to settle the bill.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the member to which the bill belongs. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account and all members of the current account are queried. You can specify a maximum of 10 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member to which the bill belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance ID that is used to filter bills. You can specify multiple instance IDs to query bills of multiple instances. If you leave this parameter empty, the bills of all instances are queried by default. You can specify a maximum of 10 instance IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The position from which the query starts. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult<BssCostBillBaseResponse>', + 'description' => 'BssResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The position from which the results started to return. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data entry.'."\n", + 'type' => 'object', + 'properties' => [ + 'CostUnit' => [ + 'title' => '财务单元', + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'CostUnitCode' => [ + 'title' => '财务单元code', + 'description' => 'The code of the cost center.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'ResourceGroup' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'example' => 'Default resource group'."\n", + ], + 'Tag' => [ + 'description' => 'The tag of the instance.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + 'InternetIP' => [ + 'description' => 'The public IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'IntranetIP' => [ + 'description' => 'The private IP address of the instance.'."\n", + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'Region' => [ + 'description' => 'The region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'Zone' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou'."\n", + ], + 'SplitAccountName' => [ + 'description' => 'The name of the account to which the split item belongs.'."\n", + 'type' => 'string', + 'example' => 'test**1122', + ], + 'SplitProductDetail' => [ + 'description' => 'The name of the specific service resource to which the split item belongs.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'SplitItemID' => [ + 'description' => 'The ID of the split item.'."\n", + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'SplitItemName' => [ + 'description' => 'The name of the split item.'."\n", + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ConsumePeriod' => [ + 'title' => '账期', + 'description' => 'The billing cycle. Format: YYYYMM.'."\n", + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'title' => '摊销状态', + 'description' => 'The allocation status. Valid values:'."\n" + ."\n" + .'* amortized: allocated'."\n" + .'* unAmortized: not allocated'."\n", + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'title' => '摊销月', + 'description' => 'The allocation month. Format: YYYYMM.'."\n", + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'BillOwnerID' => [ + 'description' => 'The ID of the account to which the resource belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => 'The name of the account to which the resource belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'ProductDetailCode' => [ + 'description' => 'The code of the specific service resource.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => 'The specific service resource.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'BizType' => [ + 'description' => 'The business type.'."\n", + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PretaxGrossAmount' => [ + 'title' => '官网价', + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'title' => '优惠金额', + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RoundDownDiscount' => [ + 'title' => '抹零金额', + 'description' => 'The round-off amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'title' => '应付金额', + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'title' => '代金券抵扣', + 'description' => 'The amount deducted by using vouchers.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'title' => '优惠券抵扣', + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByPrepaidCard' => [ + 'title' => '储值卡支付金额', + 'description' => 'The amount deducted by using prepaid cards.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExpenditureAmount' => [ + 'title' => '消费金额（可开票）', + 'description' => 'The expenditure amount. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedInvoiceDiscount' => [ + 'description' => 'The discount amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedRoundDownDiscount' => [ + 'description' => 'The round-off amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxAmount' => [ + 'description' => 'The pretax amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedExpenditureAmount' => [ + 'description' => 'The expenditure amount allocated before the allocation month. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationInvoiceDiscount' => [ + 'description' => 'The discount amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationRoundDownDiscount' => [ + 'description' => 'The round-off amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxAmount' => [ + 'description' => 'The pretax amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationExpenditureAmount' => [ + 'description' => 'The expenditure amount allocated to the current allocation month. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationInvoiceDiscount' => [ + 'description' => 'The discount amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationRoundDownDiscount' => [ + 'description' => 'The round-off amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxAmount' => [ + 'description' => 'The pretax amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationExpenditureAmount' => [ + 'description' => 'The expenditure amount to be allocated to one or more future allocation months. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotActiveService', + 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\",\\n \\"AccountID\\": \\"185766xxxx\\",\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"CostUnit\\": \\"未分配\\",\\n \\"CostUnitCode\\": \\"1234\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\t\\",\\n \\"Tag\\": \\"tag\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"Region\\": \\"杭州\\",\\n \\"Zone\\": \\"杭州1\\",\\n \\"SplitAccountName\\": \\"test**1122\\",\\n \\"SplitProductDetail\\": \\"rds\\",\\n \\"SplitItemID\\": \\"i-28bycvyb4\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"[email protected]\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"ProductDetailCode\\": \\"rds\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\t\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"RoundDownDiscount\\": 0,\\n \\"PretaxAmount\\": 0,\\n \\"DeductedByCashCoupons\\": 0,\\n \\"DeductedByCoupons\\": 0,\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ExpenditureAmount\\": 0,\\n \\"PreviouslyAmortizedPretaxGrossAmount\\": 0,\\n \\"PreviouslyAmortizedInvoiceDiscount\\": 0,\\n \\"PreviouslyAmortizedRoundDownDiscount\\": 0,\\n \\"PreviouslyAmortizedPretaxAmount\\": 0,\\n \\"PreviouslyAmortizedDeductedByCashCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByPrepaidCard\\": 0,\\n \\"PreviouslyAmortizedExpenditureAmount\\": 0,\\n \\"CurrentAmortizationPretaxGrossAmount\\": 0,\\n \\"CurrentAmortizationInvoiceDiscount\\": 0,\\n \\"CurrentAmortizationRoundDownDiscount\\": 0,\\n \\"CurrentAmortizationPretaxAmount\\": 0,\\n \\"CurrentAmortizationDeductedByCashCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByPrepaidCard\\": 0,\\n \\"CurrentAmortizationExpenditureAmount\\": 0,\\n \\"RemainingAmortizationPretaxGrossAmount\\": 0,\\n \\"RemainingAmortizationInvoiceDiscount\\": 0,\\n \\"RemainingAmortizationRoundDownDiscount\\": 0,\\n \\"RemainingAmortizationPretaxAmount\\": 0,\\n \\"RemainingAmortizationDeductedByCashCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByPrepaidCard\\": 0,\\n \\"RemainingAmortizationExpenditureAmount\\": 0,\\n \\"AfterDiscountAmount\\": 0,\\n \\"PreviouslyAmortizedAfterDiscountAmount\\": 0,\\n \\"CurrentAmortizationAfterDiscountAmount\\": 0,\\n \\"RemainingAmortizationAfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'description' => 'You can view and export the allocated costs of the current month after 10:00 on the fourth day of the next month. The allocated costs of a single allocation month may involve orders or bills in different billing cycles. If a historical allocated amount is incorrect, the historical allocated costs need to be adjusted. As a result, the allocated costs displayed for a single allocation month may be different at different time points.'."\n", + ], + 'DescribeProductAmortizedCostByAmortizationPeriod' => [ + 'summary' => 'Queries the allocated costs of services by allocation month.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The allocation month. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The billing cycle that is used to filter bills. You can specify a maximum of 10 billing cycles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2022-09', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The code of the service. You can obtain the value of this parameter by calling the QueryProductList operation or the DescribeResourcePackageProduct operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The specific service resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The code of the cost center.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123#'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The ID of the member that needs to settle the bill. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account and all members of the current account are queried by default. You can specify a maximum of 10 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the member that needs to settle the bill.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The instance ID that is used to filter bills. You can specify multiple instance IDs to query bills of multiple instances. If you leave this parameter empty, the bills of all instances are queried by default. You can specify a maximum of 10 instance IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The position from which the query starts. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', + 'description' => 'BssResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => '200'."\n", + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！'."\n", + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The position from which the results started to return. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => 'The data entries returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data entry.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConsumePeriod' => [ + 'description' => 'The billing cycle. Format: YYYYMM.'."\n", + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'description' => 'The allocation status. Valid values:'."\n" + ."\n" + .'* amortized: allocated'."\n" + .'* unAmortized: not allocated'."\n", + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'description' => 'The allocation month. Format: YYYYMM.'."\n", + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'BillOwnerID' => [ + 'description' => 'The ID of the account to which the resource belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => 'The name of the account to which the resource belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'ProductDetailCode' => [ + 'description' => 'The code of the specific service resource.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => 'The specific service resource.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'BizType' => [ + 'description' => 'The business type.'."\n", + 'type' => 'string', + 'example' => 'trusteeship'."\n", + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RoundDownDiscount' => [ + 'description' => 'The round-off amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExpenditureAmount' => [ + 'description' => 'The expenditure amount. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedInvoiceDiscount' => [ + 'description' => 'The discount amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedRoundDownDiscount' => [ + 'description' => 'The round-off amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxAmount' => [ + 'description' => 'The pretax amount allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and allocated before the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedExpenditureAmount' => [ + 'description' => 'The expenditure amount allocated before the current allocation month. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationInvoiceDiscount' => [ + 'description' => 'The discount amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationRoundDownDiscount' => [ + 'description' => 'The round-off amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxAmount' => [ + 'description' => 'The pretax amount allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and allocated to the current allocation month.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationExpenditureAmount' => [ + 'description' => 'The expenditure amount allocated to the current allocation month. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxGrossAmount' => [ + 'description' => 'The pretax gross amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationInvoiceDiscount' => [ + 'description' => 'The discount amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationRoundDownDiscount' => [ + 'description' => 'The round-off amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxAmount' => [ + 'description' => 'The pretax amount to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCashCoupons' => [ + 'description' => 'The amount deducted by using vouchers and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByPrepaidCard' => [ + 'description' => 'The amount deducted by using prepaid cards and to be allocated to one or more future allocation months.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationExpenditureAmount' => [ + 'description' => 'The expenditure amount to be allocated to one or more future allocation months. Invoicing is supported.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotActiveService', + 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Message\\": \\"Successful！\\\\n\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\\\n\\",\\n \\"AccountID\\": \\"185766xxxx\\",\\n \\"AccountName\\": \\"[email protected]\\\\n\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"[email protected]\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"[email protected]\\\\n\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\\\n\\",\\n \\"ProductDetailCode\\": \\"rds\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\n\\",\\n \\"BizType\\": \\"trusteeship\\\\n\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"RoundDownDiscount\\": 0,\\n \\"PretaxAmount\\": 0,\\n \\"DeductedByCashCoupons\\": 0,\\n \\"DeductedByCoupons\\": 0,\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ExpenditureAmount\\": 0,\\n \\"PreviouslyAmortizedPretaxGrossAmount\\": 0,\\n \\"PreviouslyAmortizedInvoiceDiscount\\": 0,\\n \\"PreviouslyAmortizedRoundDownDiscount\\": 0,\\n \\"PreviouslyAmortizedPretaxAmount\\": 0,\\n \\"PreviouslyAmortizedDeductedByCashCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByPrepaidCard\\": 0,\\n \\"PreviouslyAmortizedExpenditureAmount\\": 0,\\n \\"CurrentAmortizationPretaxGrossAmount\\": 0,\\n \\"CurrentAmortizationInvoiceDiscount\\": 0,\\n \\"CurrentAmortizationRoundDownDiscount\\": 0,\\n \\"CurrentAmortizationPretaxAmount\\": 0,\\n \\"CurrentAmortizationDeductedByCashCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByPrepaidCard\\": 0,\\n \\"CurrentAmortizationExpenditureAmount\\": 0,\\n \\"RemainingAmortizationPretaxGrossAmount\\": 0,\\n \\"RemainingAmortizationInvoiceDiscount\\": 0,\\n \\"RemainingAmortizationRoundDownDiscount\\": 0,\\n \\"RemainingAmortizationPretaxAmount\\": 0,\\n \\"RemainingAmortizationDeductedByCashCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByPrepaidCard\\": 0,\\n \\"RemainingAmortizationExpenditureAmount\\": 0,\\n \\"AfterDiscountAmount\\": 0,\\n \\"PreviouslyAmortizedAfterDiscountAmount\\": 0,\\n \\"CurrentAmortizationAfterDiscountAmount\\": 0,\\n \\"RemainingAmortizationAfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'description' => 'You can view and export the allocated costs of the current month after 10:00 on the fourth day of the next month. The allocated costs of a single allocation month may involve orders or bills in different billing cycles. If a historical allocated amount is incorrect, the historical allocated costs need to be adjusted. As a result, the allocated costs displayed for a single allocation month may be different at different time points.'."\n", + ], + 'DescribeInstanceAmortizedCostByConsumePeriod' => [ + 'summary' => '实例账期月摊销成本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '2022-10', + 'maxLength' => 256, + 'required' => true, + 'title' => '账期月、摊销月', + 'type' => 'string', + ], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '2022-09'."\n", + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 10, + 'required' => false, + 'title' => '摊销月筛选条件', + 'type' => 'array', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'Subscription', + 'maxLength' => 256, + 'required' => false, + 'title' => '订阅类型', + 'type' => 'string', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'rds', + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'rds', + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '123#'."\n", + 'maxLength' => 256, + 'required' => false, + 'title' => '财务单元code', + 'type' => 'string', + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '123', + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => '123', + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'example' => 'abc', + 'maxLength' => 256, + 'required' => false, + 'type' => 'string', + ], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + 'maxLength' => 2560, + 'required' => false, + 'type' => 'string', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'example' => '20', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'BssResult<BssCostBillBaseResponse>', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + 'type' => 'string', + ], + 'Success' => [ + 'description' => '', + 'example' => 'true', + 'type' => 'boolean', + ], + 'Code' => [ + 'description' => '', + 'example' => '200', + 'type' => 'string', + ], + 'Message' => [ + 'description' => '', + 'example' => 'Successful！'."\n", + 'type' => 'string', + ], + 'Data' => [ + 'description' => '', + 'properties' => [ + 'NextToken' => [ + 'description' => '', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + 'type' => 'string', + ], + 'AccountID' => [ + 'description' => '', + 'example' => '185766xxxx'."\n", + 'type' => 'string', + ], + 'AccountName' => [ + 'description' => '', + 'example' => '[email protected]'."\n", + 'type' => 'string', + ], + 'MaxResults' => [ + 'description' => '', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + ], + 'TotalCount' => [ + 'description' => '', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + ], + 'Items' => [ + 'description' => '', + 'items' => [ + 'description' => '', + 'properties' => [ + 'CostUnit' => [ + 'description' => '', + 'example' => '', + 'title' => '财务单元', + 'type' => 'string', + ], + 'CostUnitCode' => [ + 'description' => '', + 'example' => '1234', + 'title' => '财务单元code', + 'type' => 'string', + ], + 'InstanceID' => [ + 'description' => '', + 'example' => 'i-kjhdskjgshfdlkjfdh'."\n", + 'type' => 'string', + ], + 'ResourceGroup' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'Tag' => [ + 'description' => '', + 'example' => 'tag', + 'type' => 'string', + ], + 'InternetIP' => [ + 'description' => '', + 'example' => '34.xx.x.x'."\n", + 'type' => 'string', + ], + 'IntranetIP' => [ + 'description' => '', + 'example' => '192.xx.xx.xx'."\n", + 'type' => 'string', + ], + 'Region' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'Zone' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'SplitAccountName' => [ + 'description' => '', + 'example' => 'test**1122'."\n", + 'type' => 'string', + ], + 'SplitProductDetail' => [ + 'description' => '', + 'example' => 'rds', + 'type' => 'string', + ], + 'SplitItemID' => [ + 'description' => '', + 'example' => 'i-28bycvyb4'."\n", + 'type' => 'string', + ], + 'SplitItemName' => [ + 'description' => '', + 'example' => 'iZ28bycvyb4Z'."\n", + 'type' => 'string', + ], + 'ConsumePeriod' => [ + 'description' => '', + 'example' => '202210', + 'title' => '账期', + 'type' => 'string', + ], + 'AmortizationStatus' => [ + 'description' => '', + 'example' => 'amortized', + 'title' => '摊销状态', + 'type' => 'string', + ], + 'AmortizationPeriod' => [ + 'description' => '', + 'example' => '202210', + 'title' => '摊销月', + 'type' => 'string', + ], + 'BillAccountID' => [ + 'description' => '', + 'example' => '185xxxxx489', + 'format' => 'int64', + 'type' => 'integer', + ], + 'BillAccountName' => [ + 'description' => '', + 'example' => '[email protected]'."\n", + 'type' => 'string', + ], + 'BillOwnerID' => [ + 'description' => '', + 'example' => '185xxxxx489', + 'format' => 'int64', + 'type' => 'integer', + ], + 'BillOwnerName' => [ + 'description' => '', + 'example' => '[email protected]'."\n", + 'type' => 'string', + ], + 'ProductCode' => [ + 'description' => '', + 'example' => 'rds', + 'type' => 'string', + ], + 'ProductName' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'ProductDetailCode' => [ + 'description' => '', + 'example' => 'rds'."\n", + 'type' => 'string', + ], + 'ProductDetail' => [ + 'description' => '', + 'example' => '', + 'type' => 'string', + ], + 'BizType' => [ + 'description' => '', + 'example' => 'trusteeship', + 'type' => 'string', + ], + 'SubscriptionType' => [ + 'description' => '', + 'example' => 'PayAsYouGo', + 'type' => 'string', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '官网价', + 'type' => 'number', + ], + 'InvoiceDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '优惠金额', + 'type' => 'number', + ], + 'RoundDownDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '抹零金额', + 'type' => 'number', + ], + 'PretaxAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '应付金额', + 'type' => 'number', + ], + 'DeductedByCashCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '代金券抵扣', + 'type' => 'number', + ], + 'DeductedByCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '优惠券抵扣', + 'type' => 'number', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '储值卡支付金额', + 'type' => 'number', + ], + 'ExpenditureAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'title' => '消费金额（可开票）', + 'type' => 'number', + ], + 'PreviouslyAmortizedPretaxGrossAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedInvoiceDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedRoundDownDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedPretaxAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedDeductedByCashCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedDeductedByCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedDeductedByPrepaidCard' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'PreviouslyAmortizedExpenditureAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationPretaxGrossAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationInvoiceDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationRoundDownDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationPretaxAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationDeductedByCashCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationDeductedByCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationDeductedByPrepaidCard' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'CurrentAmortizationExpenditureAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationPretaxGrossAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationInvoiceDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationRoundDownDiscount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationPretaxAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationDeductedByCashCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationDeductedByCoupons' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationDeductedByPrepaidCard' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'RemainingAmortizationExpenditureAmount' => [ + 'description' => '', + 'example' => '0', + 'format' => 'double', + 'type' => 'number', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + 'type' => 'object', + ], + 'type' => 'array', + ], + ], + 'type' => 'object', + ], + ], + 'title' => 'BssResult<BssCostBillBaseResponse>', + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotActiveService', + 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful！\\\\n\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\\\n\\",\\n \\"AccountID\\": \\"185766xxxx\\\\n\\",\\n \\"AccountName\\": \\"[email protected]\\\\n\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"CostUnit\\": \\"未分配\\\\n\\",\\n \\"CostUnitCode\\": \\"1234\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\\\n\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\t\\\\n\\",\\n \\"Tag\\": \\"tag\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\\\n\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\\\n\\",\\n \\"Region\\": \\"杭州\\",\\n \\"Zone\\": \\"杭州1\\\\n\\",\\n \\"SplitAccountName\\": \\"test**1122\\\\n\\",\\n \\"SplitProductDetail\\": \\"rds\\",\\n \\"SplitItemID\\": \\"i-28bycvyb4\\\\n\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\\\n\\",\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"[email protected]\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"[email protected]\\\\n\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\\\n\\",\\n \\"ProductDetailCode\\": \\"rds\\\\n\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\t\\\\n\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"RoundDownDiscount\\": 0,\\n \\"PretaxAmount\\": 0,\\n \\"DeductedByCashCoupons\\": 0,\\n \\"DeductedByCoupons\\": 0,\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ExpenditureAmount\\": 0,\\n \\"PreviouslyAmortizedPretaxGrossAmount\\": 0,\\n \\"PreviouslyAmortizedInvoiceDiscount\\": 0,\\n \\"PreviouslyAmortizedRoundDownDiscount\\": 0,\\n \\"PreviouslyAmortizedPretaxAmount\\": 0,\\n \\"PreviouslyAmortizedDeductedByCashCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByPrepaidCard\\": 0,\\n \\"PreviouslyAmortizedExpenditureAmount\\": 0,\\n \\"CurrentAmortizationPretaxGrossAmount\\": 0,\\n \\"CurrentAmortizationInvoiceDiscount\\": 0,\\n \\"CurrentAmortizationRoundDownDiscount\\": 0,\\n \\"CurrentAmortizationPretaxAmount\\": 0,\\n \\"CurrentAmortizationDeductedByCashCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByPrepaidCard\\": 0,\\n \\"CurrentAmortizationExpenditureAmount\\": 0,\\n \\"RemainingAmortizationPretaxGrossAmount\\": 0,\\n \\"RemainingAmortizationInvoiceDiscount\\": 0,\\n \\"RemainingAmortizationRoundDownDiscount\\": 0,\\n \\"RemainingAmortizationPretaxAmount\\": 0,\\n \\"RemainingAmortizationDeductedByCashCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByPrepaidCard\\": 0,\\n \\"RemainingAmortizationExpenditureAmount\\": 0,\\n \\"AfterDiscountAmount\\": 0,\\n \\"PreviouslyAmortizedAfterDiscountAmount\\": 0,\\n \\"CurrentAmortizationAfterDiscountAmount\\": 0,\\n \\"RemainingAmortizationAfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeProductAmortizedCostByConsumePeriod' => [ + 'summary' => '产品账期月摊销成本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '摊销月筛选条件', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09'."\n", + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123#'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful！'."\n", + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + 'AccountID' => [ + 'description' => '', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConsumePeriod' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'BillOwnerID' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ProductDetailCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'BizType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'SubscriptionType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PretaxGrossAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RoundDownDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExpenditureAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedInvoiceDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedRoundDownDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedPretaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedExpenditureAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationInvoiceDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationRoundDownDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationPretaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationExpenditureAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxGrossAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationInvoiceDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationRoundDownDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationPretaxAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCashCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationDeductedByPrepaidCard' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationExpenditureAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotActiveService', + 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful！\\\\n\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\",\\n \\"AccountID\\": \\"185766xxxx\\",\\n \\"AccountName\\": \\"[email protected]\\\\n\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"[email protected]\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"[email protected]\\\\n\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\\\n\\",\\n \\"ProductDetailCode\\": \\"rds\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\n\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"RoundDownDiscount\\": 0,\\n \\"PretaxAmount\\": 0,\\n \\"DeductedByCashCoupons\\": 0,\\n \\"DeductedByCoupons\\": 0,\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"ExpenditureAmount\\": 0,\\n \\"PreviouslyAmortizedPretaxGrossAmount\\": 0,\\n \\"PreviouslyAmortizedInvoiceDiscount\\": 0,\\n \\"PreviouslyAmortizedRoundDownDiscount\\": 0,\\n \\"PreviouslyAmortizedPretaxAmount\\": 0,\\n \\"PreviouslyAmortizedDeductedByCashCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByCoupons\\": 0,\\n \\"PreviouslyAmortizedDeductedByPrepaidCard\\": 0,\\n \\"PreviouslyAmortizedExpenditureAmount\\": 0,\\n \\"CurrentAmortizationPretaxGrossAmount\\": 0,\\n \\"CurrentAmortizationInvoiceDiscount\\": 0,\\n \\"CurrentAmortizationRoundDownDiscount\\": 0,\\n \\"CurrentAmortizationPretaxAmount\\": 0,\\n \\"CurrentAmortizationDeductedByCashCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByCoupons\\": 0,\\n \\"CurrentAmortizationDeductedByPrepaidCard\\": 0,\\n \\"CurrentAmortizationExpenditureAmount\\": 0,\\n \\"RemainingAmortizationPretaxGrossAmount\\": 0,\\n \\"RemainingAmortizationInvoiceDiscount\\": 0,\\n \\"RemainingAmortizationRoundDownDiscount\\": 0,\\n \\"RemainingAmortizationPretaxAmount\\": 0,\\n \\"RemainingAmortizationDeductedByCashCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByCoupons\\": 0,\\n \\"RemainingAmortizationDeductedByPrepaidCard\\": 0,\\n \\"RemainingAmortizationExpenditureAmount\\": 0,\\n \\"AfterDiscountAmount\\": 0,\\n \\"PreviouslyAmortizedAfterDiscountAmount\\": 0,\\n \\"CurrentAmortizationAfterDiscountAmount\\": 0,\\n \\"RemainingAmortizationAfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSplitItemBill' => [ + 'summary' => 'Queries split bills.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle. Specify the parameter in the YYYY-MM format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-03', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values: Subscription: the subscription billing method. PayAsYouGo: the pay-as-you-go billing method. This parameter must be used with the ProductCode parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used for the next query. The parameter must be left empty or set to the value of the NextToken parameter returned in the last call. Otherwise, an error is returned. If the parameter is left empty, the data is queried from the first entry.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmd', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries to query. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify this parameter, the bills of the member are queried. If you do not specify this parameter, the bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + [ + 'name' => 'InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + ], + [ + 'name' => 'SplitItemID', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the split item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The granularity at which bills are queried. Valid values:'."\n" + ."\n" + .'* MONTHLY: queries bills on a monthly basis. The data that you query is the same as the data that is queried by billing cycles in the Split Bill module of the User Center console.'."\n" + .'* DAILY: queries bills on a daily basis. The data that you query is the same as the data that is queried by days in the Split Bill module of the User Center console.'."\n" + ."\n" + .'If you specify DAILY for this parameter, the BillingDate parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Monthly', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing date. This parameter is required only when the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-02', + ], + ], + [ + 'name' => 'TagFilter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags that are used to filter split bills. You can specify multiple tag values. If you specify multiple tag values, split bills that match one of the tag values are queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about tags that are used to filter split bills'."\n", + 'type' => 'object', + 'properties' => [ + 'TagValues' => [ + 'description' => 'You can specify the TagValues.N parameter to query bills that match the specified tag value. The value of the TagValues.N parameter must be a string. The tag value must be 1 to 128 characters in length. Valid values of N: 1 to 20.'."\n" + ."\n" + .'* If you specify the TagValues.N parameter, the TagFilter.N.TagKey parameter is required. Otherwise, the error message InvalidParameter.TagValues is returned.'."\n" + .'* If you specify multiple tag values, split bills that match one of the tag values are queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about tag keys.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'required' => false, + 'example' => 'TestValue', + 'maxItems' => 20, + ], + 'TagKey' => [ + 'description' => 'The TagFilter.N parameter is used to query bills that match a specified tag. The value of the TagFilter.N parameter must be a key-value pair. The tag key must be 1 to 128 characters in length. Valid values of N: 1 to 20.'."\n" + ."\n" + .'* If only the TagFilter.N.TagKey parameter is specified, all bills associated with the tag key are queried.'."\n" + .'* If you specify multiple tag key-value pairs at the same time, bills that meet any one of the tag key-value pairs are queried.'."\n" + .'* If the tags added to resources change, you can query only the bills that are generated within the period in which the tags and resources are associated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to filter bills if both the pretax gross amount and pretax amount are 0. Valid values:'."\n" + ."\n" + .'* false: does not filter bills.'."\n" + .'* true: filters bills.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service. The code is the same as that in Cost Center.', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token used for the next query. If this parameter is empty, all the results are returned. When you perform the next query, you must set the NextToken parameter to this value.'."\n", + 'type' => 'string', + 'example' => 'CAESEgoQCg4K', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'description' => 'The details of the bill.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => [ + 'description' => 'The ID of the account to which the split bill belongs.'."\n", + 'type' => 'string', + 'example' => '12**122', + ], + 'BillAccountName' => [ + 'description' => 'The name of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values: Subscription: the subscription billing method. PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => 'The type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted with coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'PipCode' => [ + 'description' => 'The code of the service. The code is the same as that displayed in the Split Bill module of the User Center console.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity. The code is the same as that displayed in the Split Bill module of the User Center console.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'NickName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'nick', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'Usage' => [ + 'description' => 'The amount of resource usage.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'UsageUnit' => [ + 'description' => 'The unit of usage.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'SplitCommodityCode' => [ + 'description' => 'The code of the split item.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'BillAccountID' => [ + 'description' => 'The ID of the account to which the bill belongs.'."\n", + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedByResourcePackage' => [ + 'description' => 'The amount deducted with resource plans.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'SplitBillingCycle' => [ + 'description' => 'The billing cycle in which the bill is split.'."\n", + 'type' => 'string', + 'example' => '2021-06', + ], + 'ServicePeriod' => [ + 'description' => 'The duration of the service.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'SplitItemName' => [ + 'description' => 'The name of the split item.'."\n", + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ListPrice' => [ + 'description' => 'The unit price.'."\n", + 'type' => 'string', + 'example' => '0.12', + ], + 'Zone' => [ + 'description' => 'The zone.'."\n", + 'type' => 'string', + 'example' => 'Qingdao Zone B'."\n", + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InstanceConfig' => [ + 'description' => 'The configurations of the instance.'."\n", + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'BillingDate' => [ + 'description' => 'The billing date. Format: YYYY-MM-DD. This parameter is not supported.'."\n", + 'type' => 'string', + 'example' => '2020-01-20', + ], + 'InternetIP' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => 'The type of the bill. Valid values: SubscriptionOrder: the subscription bill. PayAsYouGoBill: the pay-as-you-go bill. Refund: the refund. Adjustment: the adjustment bill.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'SplitItemID' => [ + 'description' => 'The ID of the split item.'."\n", + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Tag' => [ + 'description' => 'The tag of the resource. If tags added to resources change, the bills generated during the period in which resources and tags are associated are returned.'."\n", + 'type' => 'string', + 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', + ], + 'Currency' => [ + 'description' => 'The type of currency. Valid values: CNY, USD, and JPY.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'BizType' => [ + 'description' => 'The type of the business.'."\n", + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'BillingItem' => [ + 'description' => 'The billable item.'."\n", + 'type' => 'string', + 'example' => 'Bandwidth'."\n", + ], + 'BillingItemCode' => [ + 'description' => 'The code of the billable item.'."\n", + 'type' => 'string', + 'example' => 'disk', + ], + 'CostUnit' => [ + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'ListPriceUnit' => [ + 'description' => 'The unit of the unit price.'."\n", + 'type' => 'string', + 'example' => 'CNY/GB'."\n", + ], + 'ResourceGroup' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'Default resource group'."\n", + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ServicePeriodUnit' => [ + 'description' => 'The unit of the service duration.'."\n", + 'type' => 'string', + 'example' => 'Hour'."\n", + ], + 'SplitBillingDate' => [ + 'description' => 'The day on which the bill is split.'."\n", + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'SplitProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'OwnerID' => [ + 'description' => 'The ID of the account that owns the resource. This parameter is returned in multi-account scenario.'."\n", + 'type' => 'string', + 'example' => '169***013', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitAccountName' => [ + 'description' => 'The name of the account to which the split item belongs.'."\n", + 'type' => 'string', + 'example' => 'test**1122', + ], + 'BillingType' => [ + 'description' => 'The billing method.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ItemName' => [ + 'description' => 'The name of the split item.'."\n", + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'AfterDiscountAmount' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NextToken\\": \\"CAESEgoQCg4K\\",\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"MaxResults\\": 20,\\n \\"AccountID\\": \\"185xxxx3489\\",\\n \\"TotalCount\\": 20,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": [\\n {\\n \\"SplitAccountID\\": \\"12**122\\",\\n \\"BillAccountName\\": \\"[email protected]\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"Region\\": \\"杭州\\",\\n \\"OutstandingAmount\\": 0.1,\\n \\"PipCode\\": \\"rds\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"NickName\\": \\"nick\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"UsageUnit\\": \\"GB\\",\\n \\"SplitCommodityCode\\": \\"rds\\",\\n \\"BillAccountID\\": \\"185xxxx3489\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"DeductedByResourcePackage\\": \\"0\\",\\n \\"PaymentAmount\\": 0,\\n \\"SplitBillingCycle\\": \\"2021-06\\",\\n \\"ServicePeriod\\": \\"20\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"ListPrice\\": \\"0.12\\",\\n \\"Zone\\": \\"华北1\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"InstanceConfig\\": \\"CPU:12\\",\\n \\"BillingDate\\": \\"2020-01-20\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"SplitItemID\\": \\"i-28bycvyb4\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\",\\n \\"Tag\\": \\"key:testKey value:testValue; key:testKey1 value:testValues1\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"BizType\\": \\"trusteeship\\",\\n \\"BillingItem\\": \\"带宽\\",\\n \\"BillingItemCode\\": \\"disk\\",\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元/GB\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PretaxAmount\\": 0,\\n \\"ServicePeriodUnit\\": \\"小时\\",\\n \\"SplitBillingDate\\": \\"2021-06-01\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"SplitProductDetail\\": \\"云数据库\\",\\n \\"AdjustAmount\\": 0,\\n \\"OwnerID\\": \\"169***013\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"SplitAccountName\\": \\"test**1122\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"AfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSplitItemBillResponse>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Success>true</Success>\\n <Data>\\n <NextToken>CAESEgoQCg4K</NextToken>\\n <BillingCycle>2020-03</BillingCycle>\\n <MaxResults>20</MaxResults>\\n <AccountID>185xxxx3489</AccountID>\\n <TotalCount>20</TotalCount>\\n <AccountName>[email protected]</AccountName>\\n <Items>\\n <SplitAccountID>12**122</SplitAccountID>\\n <BillAccountName>[email protected]</BillAccountName>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceSpec>ecs.sn1ne.3xlarge</InstanceSpec>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <Region>杭州</Region>\\n <OutstandingAmount>0.1</OutstandingAmount>\\n <PipCode>rds</PipCode>\\n <CommodityCode>rds</CommodityCode>\\n <NickName>nick</NickName>\\n <ProductDetail>云数据库RDS</ProductDetail>\\n <Usage>100</Usage>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <UsageUnit>GB</UsageUnit>\\n <SplitCommodityCode>rds</SplitCommodityCode>\\n <BillAccountID>185xxxx3489</BillAccountID>\\n <ProductType>rds</ProductType>\\n <DeductedByResourcePackage>0</DeductedByResourcePackage>\\n <PaymentAmount>0</PaymentAmount>\\n <SplitBillingCycle>2021-06</SplitBillingCycle>\\n <ServicePeriod>20</ServicePeriod>\\n <SplitItemName>iZ28bycvyb4Z</SplitItemName>\\n <ListPrice>0.12</ListPrice>\\n <Zone>华北1</Zone>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <CashAmount>0</CashAmount>\\n <InstanceConfig>CPU:12</InstanceConfig>\\n <BillingDate>2020-01-20</BillingDate>\\n <InternetIP>34.xx.x.x</InternetIP>\\n <Item>PayAsYouGoBill</Item>\\n <SplitItemID>i-28bycvyb4</SplitItemID>\\n <InstanceID>i-kjhdskjgshfdlkjfdh</InstanceID>\\n <Tag>key:testKey value:testValue; key:testKey1 value:testValues1</Tag>\\n <Currency>CNY</Currency>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <BizType>trusteeship</BizType>\\n <BillingItem>带宽</BillingItem>\\n <BillingItemCode>disk</BillingItemCode>\\n <CostUnit>未分配</CostUnit>\\n <ListPriceUnit>元/GB</ListPriceUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <PretaxAmount>0</PretaxAmount>\\n <ServicePeriodUnit>小时</ServicePeriodUnit>\\n <SplitBillingDate>2021-06-01</SplitBillingDate>\\n <ProductName>云数据库RDS</ProductName>\\n <SplitProductDetail>云数据库</SplitProductDetail>\\n <AdjustAmount>0</AdjustAmount>\\n <OwnerID>169***013</OwnerID>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SplitAccountName>test**1122</SplitAccountName>\\n <BillingType>其它</BillingType>\\n <ProductCode>rds</ProductCode>\\n <ItemName>iZ28bycvyb4Z</ItemName>\\n </Items>\\n </Data>\\n</DescribeSplitItemBillResponse>","errorExample":""}]', + 'title' => 'DescribeSplitItemBill', + 'description' => '* The data that you query by calling this operation is the same as the data that is queried by billing cycles in the Split Bill module of Cost Allocation.'."\n" + .'* You can query split bills that were generated within the last 12 months by calling this operation.'."\n" + .'* You can query split bills only after you enable the [Split Bill](https://usercenter2-intl.aliyun.com/finance/split-bill) service in the User Center console.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySplitItemBill' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-03', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go This parameter must be used together with the ProductCode parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the split bills of the specified member. If you leave this parameter empty, the split bills of the current account are queried by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => 'The ID of the account.'."\n", + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on each page. Default value: 20. Maximum value: 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccountName' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The details of the bills.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => [ + 'description' => 'The ID of the account to which the split bill belongs.'."\n", + 'type' => 'string', + 'example' => '122', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go This parameter is returned together with the ProductCode parameter.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => 'The instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => 'The amount deducted by using coupons.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PipCode' => [ + 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'CommodityCode' => [ + 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'NickName' => [ + 'description' => 'The name of the instance.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => 'The details of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'Usage' => [ + 'description' => 'The usage of the split item. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'UsageUnit' => [ + 'description' => 'The unit of usage. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'SplitCommodityCode' => [ + 'description' => 'The commodity code of the split item.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedByResourcePackage' => [ + 'description' => 'The amount deducted by using resource plans.'."\n", + 'type' => 'string', + 'example' => 'NULL', + ], + 'SplitBillingCycle' => [ + 'description' => 'The month in which the split item is used.'."\n", + 'type' => 'string', + 'example' => '2020-06', + ], + 'ServicePeriod' => [ + 'description' => 'The validity period.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'SplitItemName' => [ + 'description' => 'The name of the split item.'."\n", + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ListPrice' => [ + 'description' => 'The unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'Zone' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InstanceConfig' => [ + 'description' => 'The configurations of the instance.'."\n", + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'BillingDate' => [ + 'description' => 'The billing date, in the YYYY-MM-DD format.'."\n", + 'type' => 'string', + 'example' => '2020-01-20', + ], + 'InternetIP' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => 'The type of the bill. Valid values: SubscriptionOrder: subscription order PayAsYouGoBill: pay-as-you-go bill Refund: refund Adjustment: reconciliation'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'SplitItemID' => [ + 'description' => 'The ID of the split item.'."\n", + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Tag' => [ + 'description' => 'The tag.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + 'Currency' => [ + 'description' => 'The type of the currency. Valid values: CNY, USD, and JPY.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillingItem' => [ + 'description' => 'The billable item.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + 'CostUnit' => [ + 'description' => 'The cost center.'."\n", + 'type' => 'string', + 'example' => 'Not allocated'."\n", + ], + 'ListPriceUnit' => [ + 'description' => 'The unit of the unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", + 'type' => 'string', + 'example' => 'CNY'."\n", + ], + 'ResourceGroup' => [ + 'description' => 'The resource group.'."\n", + 'type' => 'string', + 'example' => 'Default resource group'."\n", + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ServicePeriodUnit' => [ + 'description' => 'The unit of the validity period.'."\n", + 'type' => 'string', + 'example' => 'Seconds'."\n", + ], + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB RDS'."\n", + ], + 'SplitProductDetail' => [ + 'description' => 'The name of the service to which the split item belongs.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'OwnerID' => [ + 'description' => 'The ID of the member. This parameter is returned in a multi-account payment scenario.'."\n", + 'type' => 'string', + 'example' => '169***013', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount amount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitAccountName' => [ + 'description' => 'The name of the account to which the split item belongs.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'BillingType' => [ + 'description' => 'The billing type.'."\n", + 'type' => 'string', + 'example' => 'Other'."\n", + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"AccountID\\": \\"185xxxx3489\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"SplitAccountID\\": \\"122\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"OutstandingAmount\\": 0,\\n \\"PipCode\\": \\"rds\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"UsageUnit\\": \\"GB\\",\\n \\"SplitCommodityCode\\": \\"rds\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"DeductedByResourcePackage\\": \\"NULL\\",\\n \\"PaymentAmount\\": 0,\\n \\"SplitBillingCycle\\": \\"2020-06\\",\\n \\"ServicePeriod\\": \\"10\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"Zone\\": \\"cn-hangzhou-h\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"InstanceConfig\\": \\"CPU:12\\",\\n \\"BillingDate\\": \\"2020-01-20\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"SplitItemID\\": \\"i-28bycvyb4\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\",\\n \\"Tag\\": \\"tag\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"BillingItem\\": \\"其他\\",\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PretaxAmount\\": 0,\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"SplitProductDetail\\": \\"rds\\",\\n \\"AdjustAmount\\": 0,\\n \\"OwnerID\\": \\"169***013\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"SplitAccountName\\": \\"[email protected]\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>2</TotalCount>\\n <AccountID>185xxxx3489</AccountID>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Items>\\n <Item>\\n <InstanceSpec>ecs.sn1ne.3xlarge</InstanceSpec>\\n <ProductName>云数据库RDS</ProductName>\\n <InstanceID>i-kjhdskjgshfdlkjfdh</InstanceID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <ListPriceUnit>元</ListPriceUnit>\\n <BillingDate/>\\n <ListPrice>100</ListPrice>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SplitItemName>iZ28bycvyb4Z</SplitItemName>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <InstanceConfig>CPU:12</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CostUnit>未分配</CostUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage>100</Usage>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <ProductDetail>云数据库RDS</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>cn-hangzhou-h</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BillingItem>其他</BillingItem>\\n <NickName>test</NickName>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <ServicePeriod>10</ServicePeriod>\\n <SplitItemID>i-28bycvyb4</SplitItemID>\\n <DeductedByResourcePackage>NULL</DeductedByResourcePackage>\\n <UsageUnit>GB</UsageUnit>\\n <OwnerID>169***013</OwnerID>\\n <PretaxAmount>0</PretaxAmount>\\n <InternetIP>34.xx.x.x</InternetIP>\\n <Region>cn-hangzhou</Region>\\n <Tag>tag</Tag>\\n </Item>\\n </Items>\\n <AccountName>[email protected]</AccountName>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'summary' => 'Queries split bills.', + 'description' => '* This API operation has been upgraded to DescribeSplitItemBill. We recommend that you call the [DescribeSplitItemBill](~~208169~~) operation to query split bills. You can call the QuerySplitItemBill operation to query a maximum of 50,000 data rows in a bill.'."\n" + .'* The data queried by calling the QuerySplitItemBill operation is consistent with the data that is displayed for the specified billing cycle on the Split Bill page in User Center.'."\n" + .'* You can call this operation to query split bills generated within the last 12 months.'."\n" + .'* This operation returns split bills only after you activate the [Split Bill](https://usercenter2.aliyun.com/finance/split-bill) service in User Center.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InquiryPriceRefundInstance' => [ + 'summary' => 'Queries the refundable amount for an instance from which you want to unsubscribe.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'description' => 'This parameter is required for scenarios that need idempotence. The UUID that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '793F021C-B589-1225-82A9-99232AEBE494', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => 'The code of the service. This parameter is required for unsubscription scenarios.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceId', + 'description' => 'The ID of the instance. This parameter is required for unsubscription scenarios.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1etb69sqxgl4*******', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => 'The type of the service. This parameter is required for unsubscription scenarios. Unless otherwise specified, set this parameter to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '”“', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'The description of the execution result.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => 'The site of the execution host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'InstanceId' => [ + 'title' => 'instanceId', + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp1etb69sqxgl4*******', + ], + 'Currency' => [ + 'title' => 'currency', + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'example' => 'CNY. CNY: Chinese Yuan. USD: United States dollar. JPY: Japanese Yen.', + ], + 'RefundAmount' => [ + 'title' => 'refundAmount', + 'description' => 'The refundable amount.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '12.34', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotExists', + 'errorMessage' => 'The specific resource is not exists.', + ], + [ + 'errorCode' => 'ResourceStatusError', + 'errorMessage' => 'The resource status error.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner does not belong to caller.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'The specified API is not applicable for the user.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'The user is not authorized for the specified API.', + ], + [ + 'errorCode' => 'BindMirrorInstanceError', + 'errorMessage' => 'Charged images that are related to ECS.', + ], + [ + 'errorCode' => 'ExceedRefundQuotaError', + 'errorMessage' => 'The number of unsubscription times has reached the upper limit.', + ], + [ + 'errorCode' => 'ExistUnPaidOrderError', + 'errorMessage' => 'The instance has an unsettled order.', + ], + [ + 'errorCode' => 'ExistRefundingOrderError', + 'errorMessage' => 'The instance ID is invalid: the instance may have expired, been refunded, or been released.', + ], + [ + 'errorCode' => 'NoRestValueError', + 'errorMessage' => 'The refund amount is 0.', + ], + [ + 'errorCode' => 'AmbassadorOrderLimitError', + 'errorMessage' => 'The instance has an ambassador order that may raise risks.', + ], + [ + 'errorCode' => 'ActivityForbiddenError', + 'errorMessage' => 'Promotional orders do not support refunds.', + ], + [ + 'errorCode' => 'ProductCheckError', + 'errorMessage' => 'The cloud service failed SPI preflight verification.', + ], + [ + 'errorCode' => 'CommodityNotSupported', + 'errorMessage' => 'The specified commodity is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\",\\n \\"InstanceId\\": \\"i-bp1etb69sqxgl4*******\\",\\n \\"Currency\\": \\"退款金额本币币种： CNY：人民币。 USD：美元。 JPY：日元。\\",\\n \\"RefundAmount\\": 12.34\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'InquiryPriceRefundInstance', + 'description' => '1. **Check the information about unsubscription and confirm the unsubscription terms and refundable amount. The resource that is unsubscribed cannot be restored.**'."\n" + .'2. Refunds are applicable only for the actual paid amount. Vouchers used for the purchase are non-refundable.'."\n" + .'3. For more information, see [Rules for unsubscribing from resources](https://www.alibabacloud.com/help/en/user-center/user-guide/refund-rules).', + 'extraInfo' => '**Error codes that are returned if a request is blocked**'."\n" + ."\n" + .'* ResourceNotExists: The instance does not exist.'."\n" + .'* ResourceStatusError: The instance is not in the expected state.'."\n" + .'* BindMirrorInstanceError: The ECS instance is bound to a paid image.'."\n" + .'* ExceedRefundQuotaError: The number of times that you unsubscribe from the instance exceeds the quota.'."\n" + .'* ExistUnPaidOrderError: An order that is not paid exists in the instance.'."\n" + .'* ExistRefundingOrderError: The ID of the instance is invalid because the instance expires, the instance is released, or the instance is refunded.'."\n" + .'* NoRestValueError: The refundable amount is 0.'."\n" + .'* AmbassadorOrderLimitError: The instance has an ambassador order that may raise risks.'."\n" + .'* ActivityForbiddenError: You cannot request a refund for an instance that is purchased during the marketing campaigns.'."\n" + .'* ProductCheckError: The instance does not pass the precheck.'."\n", + ], + 'GetPayAsYouGoPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Set the value to PayAsYouGo.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of pricing modules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The pricing modules.'."\n", + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => 'The code of the Nth pricing module.'."\n" + ."\n" + .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the module code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType', + ], + 'PriceType' => [ + 'description' => 'The price type of the Nth pricing module. Valid values:'."\n" + ."\n" + .'* Hour: hourly price'."\n" + .'* Usage: usage price'."\n" + .'* Month: monthly price'."\n" + .'* Year: annual price'."\n" + ."\n" + .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the configuration parameters of the pricing module.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Hour', + ], + 'Config' => [ + 'description' => 'The configuration of the Nth pricing module. Valid values of N: 1 to 50. Format: AA:aa,BB:bb. The values of AA and BB are the property IDs of the pricing module. The values of aa and bb are the property values of the pricing module.'."\n" + ."\n" + .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the configuration parameters of the pricing module.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'description' => 'The type of the currency. Valid values:'."\n" + ."\n" + .'* CNY: Chinese Yuan'."\n" + .'* USD: US dollar'."\n" + .'* JPY: Japanese Yen'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => 'The price details of the pricing module.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The price details of the pricing module.'."\n", + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => [ + 'description' => 'The discount price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount that was applied.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'UnitPrice' => [ + 'description' => 'The unit price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OriginalCost' => [ + 'description' => 'The original price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1.77', + ], + 'ModuleCode' => [ + 'description' => 'The code of the pricing module.'."\n", + 'type' => 'string', + 'example' => 'InstanceType', + ], + ], + ], + ], + ], + ], + 'PromotionDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionDetail' => [ + 'description' => 'The details of the discount.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the discount.'."\n", + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => [ + 'description' => 'The description of the discount.'."\n", + 'type' => 'string', + 'example' => 'This discount allows you to use a service at the minimum price and is provided for testing purposes only.'."\n", + ], + 'PromotionId' => [ + 'description' => 'The ID of the discount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10200210', + ], + 'PromotionName' => [ + 'description' => 'The name of the discount.'."\n", + 'type' => 'string', + 'example' => 'This discount allows you to use a service at the minimum price and is provided for testing purposes only.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"1537A007-72D7-4165-8A26-8694A38E219A\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"ModuleDetails\\": {\\n \\"ModuleDetail\\": [\\n {\\n \\"CostAfterDiscount\\": 100,\\n \\"InvoiceDiscount\\": 20,\\n \\"UnitPrice\\": 0,\\n \\"OriginalCost\\": 1.77,\\n \\"ModuleCode\\": \\"InstanceType\\"\\n }\\n ]\\n },\\n \\"PromotionDetails\\": {\\n \\"PromotionDetail\\": [\\n {\\n \\"PromotionDesc\\": \\"仅提供测试使用的1分钱活动\\",\\n \\"PromotionId\\": 10200210,\\n \\"PromotionName\\": \\"仅提供测试使用的1分钱活动\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPayAsYouGoPriceResponse>\\n <Message>Successful!</Message>\\n <RequestId>1537A007-72D7-4165-8A26-8694A38E219A</RequestId>\\n <Data>\\n <Currency>CNY</Currency>\\n <ModuleDetails>\\n <ModuleDetail>\\n <UnitPrice>0</UnitPrice>\\n <ModuleCode>InstanceType</ModuleCode>\\n <CostAfterDiscount>0.01</CostAfterDiscount>\\n <OriginalCost>1.77</OriginalCost>\\n <InvoiceDiscount>1.76</InvoiceDiscount>\\n </ModuleDetail>\\n </ModuleDetails>\\n <PromotionDetails>\\n <PromotionDetail>\\n <PromotionName>仅提供测试使用的1分钱活动</PromotionName>\\n <PromotionId>10200210</PromotionId>\\n </PromotionDetail>\\n </PromotionDetails>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</GetPayAsYouGoPriceResponse>","errorExample":""}]', + 'summary' => 'Queries the pay-as-you-go price of an Alibaba Cloud service.', + 'description' => '### Usage notes'."\n" + ."\n" + .'1. Call the QueryProductList operation to obtain the code of the service. For more information, see [QueryProductList](~~95984~~).'."\n" + .'2. Call the DescribePricingModule operation to obtain the configuration parameters of the service. For more information, see [DescribePricingModule](~~96469~~).'."\n" + .'3. Call the GetPayAsYouGoPrice operation to obtain the pay-as-you-go price of the service based on the returned configuration parameters.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSubscriptionPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ServicePeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the service duration. Valid values:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Set the value to Subscription.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service. For more information about the service code, see **Codes of Alibaba Cloud Services**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'* NewOrder: purchases an instance of an Alibaba Cloud service.'."\n" + .'* Renewal: renews an instance of an Alibaba Cloud service.'."\n" + .'* Upgrade: upgrades an instance of an Alibaba Cloud service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NewOrder', + ], + ], + [ + 'name' => 'ServicePeriodQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service duration.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service. Specify the parameter based on the pricing document of the specific service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which the price is queried. This parameter is required if you upgrade an instance. You can specify this parameter to obtain the pre-upgrade configurations of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-khkjhxxxxxxxxx', + ], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The quantity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the pricing module.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleStatus' => [ + 'description' => 'The status of the pricing module. This parameter is required only if the order type is Upgrade. Valid values:'."\n" + ."\n" + .'* 1: adds one or more instances.'."\n" + .'* 2: modifies the configurations of an instance. In the upgrade scenario, if the configurations of the pricing module change, you must specify this value for the parameter.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ModuleCode' => [ + 'description' => 'The identifier of the Nth pricing module.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PackageCode', + ], + 'Tag' => [ + 'description' => 'The tag of the specified resource. This parameter is required only if you upgrade or modify the configurations of an Alibaba Cloud service. For example, if you want to modify the configurations of a disk, you can use a tag to identify the ID of the disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '213213123', + ], + 'Config' => [ + 'description' => 'The configurations of the Nth pricing module. Valid values of N: 1 to 50. Format: AA:aa,BB:bb. The values of AA and BB are the property IDs of the pricing module. The values of aa and bb are the property values of the pricing module.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PackageCode:version_1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'InvalidConfigCod', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '30E7066E-AE6F-4E59-AFE6-11386CE3AFA7', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about the service price.'."\n", + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => 'The original price of the service.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '900', + ], + 'DiscountPrice' => [ + 'description' => 'The discount that was applied.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Currency' => [ + 'description' => 'The type of currency. Valid values:'."\n" + ."\n" + .'* CNY: Chinese Yuan'."\n" + .'* USD: US dollar'."\n" + .'* JPY: Japanese Yen'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'Quantity' => [ + 'description' => 'The quantity.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TradePrice' => [ + 'description' => 'The discount price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => 'The price details of the pricing module.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => [ + 'description' => 'The discount price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => 'The discount that was applied.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UnitPrice' => [ + 'description' => 'The unit price.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OriginalCost' => [ + 'description' => 'The original price of the service.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'ModuleCode' => [ + 'description' => 'The identifier of the pricing module.'."\n", + 'type' => 'string', + 'example' => 'PackageCode', + ], + ], + ], + ], + ], + ], + 'PromotionDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionDetail' => [ + 'description' => 'The details of the discount.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => [ + 'description' => 'The description of the discount.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PromotionId' => [ + 'description' => 'The ID of the discount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1021199213', + ], + 'PromotionName' => [ + 'description' => 'The name of the discount.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"InvalidConfigCod\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"30E7066E-AE6F-4E59-AFE6-11386CE3AFA7\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OriginalPrice\\": 900,\\n \\"DiscountPrice\\": 100,\\n \\"Currency\\": \\"CNY\\",\\n \\"Quantity\\": 1,\\n \\"TradePrice\\": 0,\\n \\"ModuleDetails\\": {\\n \\"ModuleDetail\\": [\\n {\\n \\"CostAfterDiscount\\": 0,\\n \\"InvoiceDiscount\\": 100,\\n \\"UnitPrice\\": 0,\\n \\"OriginalCost\\": 200,\\n \\"ModuleCode\\": \\"PackageCode\\"\\n }\\n ]\\n },\\n \\"PromotionDetails\\": {\\n \\"PromotionDetail\\": [\\n {\\n \\"PromotionDesc\\": \\"test\\",\\n \\"PromotionId\\": 1021199213,\\n \\"PromotionName\\": \\"test\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSubscriptionPriceResponse>\\n <Data>\\n <Quantity>1</Quantity>\\n <DiscountPrice>900</DiscountPrice>\\n <ModuleDetails>\\n <ModuleDetail>\\n <ModuleCode>ExtBandwidth</ModuleCode>\\n <UnitPrice>0</UnitPrice>\\n <CostAfterDiscount>0</CostAfterDiscount>\\n <OriginalCost>800</OriginalCost>\\n <InvoiceDiscount>800</InvoiceDiscount>\\n </ModuleDetail>\\n <ModuleDetail>\\n <ModuleCode>PackageCode</ModuleCode>\\n <UnitPrice>0</UnitPrice>\\n <CostAfterDiscount>0</CostAfterDiscount>\\n <OriginalCost>100</OriginalCost>\\n <InvoiceDiscount>100</InvoiceDiscount>\\n </ModuleDetail>\\n </ModuleDetails>\\n <PromotionDetails>\\n <PromotionDetail>\\n <PromotionId>1021199213</PromotionId>\\n <PromotionName/>\\n </PromotionDetail>\\n </PromotionDetails>\\n <OriginalPrice>900</OriginalPrice>\\n <TradePrice>0</TradePrice>\\n <Currency>CNY</Currency>\\n </Data>\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n</GetSubscriptionPriceResponse>","errorExample":""}]', + 'summary' => 'Queries the subscription price of an Alibaba Cloud service.', + 'description' => '1. Call the QueryProductList operation to obtain the code of the service. For more information, see [QueryProductList](~~95984~~).'."\n" + .'2. Call the DescribePricingModule operation to obtain the configuration parameters of the service. For more information, see [DescribePricingModule](~~96469~~).'."\n" + .'3. Call the GetSubscriptionPrice operation to obtain the pricing of the service based on the returned configuration parameters.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAvailableInstances' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud services**.'."\n" + ."\n" + .'>This parameter cannot be left empty if the region is specified.', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'InstanceIDs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance. Separate multiple IDs with commas (,). You can specify a maximum of 100 IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'EndTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-05-23T12:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'EndTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-05-23T12:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal status of the specified instance. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + .'* NotRenewal: The instance is not renewed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'InstanceList' => [ + 'description' => 'The instances returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubStatus' => [ + 'description' => 'The sub-status of the specified instance.'."\n", + 'type' => 'string', + 'example' => 'Normal: The pay-as-you-go module can properly run. WaitForLimit: The pay-as-you-go module is about to be limited due to overdue payments. BandwidthLimited: The pay-as-you-go module is limited due to overdue payments.'."\n", + ], + 'Status' => [ + 'description' => 'The status of the instance.'."\n", + 'type' => 'string', + 'example' => 'Creating: The instance is being created. WaitForExpire: The instance is about to expire. Normal: The instance can properly run. Expired: The instance is expired.'."\n", + ], + 'ExpectedReleaseTime' => [ + 'description' => 'The time when the specified instance was expected to be released.'."\n", + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewStatus' => [ + 'description' => 'The renewal status of the specified instance. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + .'* NotRenewal: The instance is not renewed.'."\n", + 'type' => 'string', + 'example' => 'ManualRenewal', + ], + 'CreateTime' => [ + 'description' => 'The time when the specified instance was created.'."\n", + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'SellerId' => [ + 'description' => 'The ID of the seller.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123123', + ], + 'InstanceID' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => '1049056', + ], + 'Seller' => [ + 'description' => 'The seller.'."\n", + 'type' => 'string', + 'example' => '123123123', + ], + 'StopTime' => [ + 'description' => 'The time when the specified instance was suspended.'."\n", + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewalDurationUnit' => [ + 'description' => 'The unit of the auto-renewal cycle. Valid values:'."\n" + ."\n" + .'* M: month'."\n" + .'* Y: year'."\n", + 'type' => 'string', + 'example' => 'M', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'Subscription', + ], + 'OwnerId' => [ + 'description' => 'The ID of the instance owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '325352345', + ], + 'EndTime' => [ + 'description' => 'The time when the instance was expired.'."\n", + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'Region' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ReleaseTime' => [ + 'description' => 'The time when the instance was released.'."\n", + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewalDuration' => [ + 'description' => 'The number of auto-renewal cycles.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"C7C15585-8349-4C62-BEE4-5A391841B9BE\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"InstanceList\\": [\\n {\\n \\"SubStatus\\": \\"Normal-后付费模块正常\\\\nWaitForLimit-后付费模块即将欠费受限\\\\nBandwidthLimited-后付费模块欠费受限\\",\\n \\"Status\\": \\"Creating-资源创建中\\\\nWaitForExpire-即将停服\\\\nNormal-正常\\\\nExpired-停服\\",\\n \\"ExpectedReleaseTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewStatus\\": \\"ManualRenewal\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"SellerId\\": 123123123,\\n \\"InstanceID\\": \\"1049056\\",\\n \\"Seller\\": \\"123123123\\",\\n \\"StopTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewalDurationUnit\\": \\"M\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"OwnerId\\": 325352345,\\n \\"EndTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ReleaseTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewalDuration\\": 1,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAvailableInstancesResponse>\\n <Data>\\n <TotalCount>51</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-ji2gz****</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-6dyrc****</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-ne1nt5uw1</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-vj5ry82x1</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-e6oupf251</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-10T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988643</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988647</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988648</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988649</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988651</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>1049056</InstanceID>\\n <ProductCode>cmjj011399</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>1049052</InstanceID>\\n <ProductCode>cmjj011399</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>C7C15585-8349-4C62-BEE4-5A391841B9BE</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</QueryAvailableInstancesResponse>","errorExample":""}]', + 'summary' => 'Queries available instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReleaseInstance' => [ + 'summary' => 'Releases instances by Virtual Network Operators (VNOs).', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'title' => 'subscriptionType', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'Subscription: the subscription billing method.'."\n" + ."\n" + .'PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceIds', + 'description' => 'The ID of the instance. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rm-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'renewStatus', + 'description' => 'The method that is used to renew the instance. Valid values:'."\n" + ."\n" + .'AutoRenewal: automatically renews the instance.'."\n" + ."\n" + .'ManualRenewal: manually renews the instance.'."\n" + ."\n" + .'NotRenewal: does not renew the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => 'The region in which the instance resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'The return result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'The description of the execution result.'."\n", + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The ID of the request, which can be used for troubleshooting.'."\n", + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'description' => 'data'."\n", + 'type' => 'object', + 'properties' => [ + 'ReleaseResult' => [ + 'title' => 'releaseResult', + 'description' => 'Indicates whether the instance is released.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HostId' => [ + 'title' => 'hostId', + 'description' => 'The site of the execution host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'Invalid_Product_Code', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'A value of true indicates that the execution is complete.'."\n" + ."\n" + .'A value of false indicates that an error occurs during the execution.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"ReleaseResult\\": true,\\n \\"HostId\\": \\"cn\\"\\n },\\n \\"Code\\": \\"Invalid_Product_Code\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ReleaseInstance', + 'description' => 'This operation is provided for only VNOs to release instances. If a non-specific VNO calls this operation, the request is blocked.'."\n", + ], + 'CreateInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the instance belongs. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method.'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration. Unit: month. The value must be an integral multiple of 12.'."\n" + ."\n" + .'> This parameter is required if you create a subscription instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The renewal method. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + ."\n" + .'Default value: ManualRenewal.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ManualRenewal', + ], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal period. Unit: month.'."\n" + ."\n" + .'> This parameter is required if the **RenewalStatus** parameter is set to **AutoRenewal**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. The server checks whether a request that uses the same client token has been received. If a request that uses the same client token has been received, the server returns the same request result as the previous request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'JASIOFKVNVIXXXXXX', + ], + ], + [ + 'name' => 'Logistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logistics address of this order. This parameter is generally valid for physical orders.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"cityCode":"330100","cityName":"Hangzhou","contactName":"Test","countryCode":"","districtName":"Puyan Street","email":"\\*\\*@example.com","mobilePhone":"153564848844","phone":"1234567","provCode":"330000","provName":"Zhejiang","streetCode":"33010610","streetName":"Zhuantang","zipCode":"0000"}'."\n", + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the modules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The modules.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value property of the Nth module. Value of N: 1 to 100.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'disk', + ], + 'Code' => [ + 'description' => 'The code property of the Nth module. Value of N: 1 to 100. If multiple module property parameters are involved, concatenate multiple parameters based on the value of N in sequence.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The cycle type of the prepaid period'."\n" + .'- PricingCycle=1 indicates that the unit of the prepaid period is in years; '."\n" + .'- PricingCycle=2 indicates that the unit of the prepaid period is in months; '."\n" + .'- PricingCycle=3 indicates that the unit of the prepaid period is in days;'."\n" + .'- Default value: PricingCycle=2'."\n" + ."\n" + .'Applicable only to certain product types (ProductType being ddos_originpre_public_cn, ddosDip, ddoscoo, ddos_originpre_public_intl, ddosDip_intl, ddoscoo_intl)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order that was created.'."\n", + 'type' => 'string', + 'example' => '20240xxxx21', + ], + 'InstanceId' => [ + 'description' => 'The ID of the instance for which the order was created.'."\n", + 'type' => 'string', + 'example' => 'OSSBAG-cn-v1hxxxxx23', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'INSUFFICIENT.AVAILABLE.QUOTA', + 'errorMessage' => 'The account balance is negative. Add funds to the account and try again.', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', + 'errorMessage' => 'Please complete your basic personal information first.', + ], + [ + 'errorCode' => '400', + 'errorMessage' => 'Failure to check order before create instance.', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_INFORMATION_INCOMPLETE', + 'errorMessage' => 'Your information is incomplete. Complete your information before ordering', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"20240xxxx21\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-v1hxxxxx23\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InstanceId>OSSBAG-cn-v1hxxxxx23</InstanceId>\\n <OrderId>20240xxxx21</OrderId>\\n </Data>\\n</CreateInstanceResponse>","errorExample":""}]', + 'title' => 'CreateInstance', + 'summary' => 'Creates an instance. If you call this operation, an order for a new instance is created and the order is automatically paid for. You cannot create Elastic Compute Service (ECS) instances or ApsaraDB RDS instances by calling the operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'After the creation is successful, you can use the [instance query service](https://www.alibabacloud.com/help/en/boa/latest/api-bssopenapi-2017-12-14-queryavailableinstances?spm=a2c63.p38356.0.0.53aa436fJ6R68k) to query the created instances.', + 'translator' => 'machine', + ], + 'ModifyInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of configuration modifications. Valid values:'."\n" + ."\n" + .'* Upgrade: upgrades the configurations of the instance.'."\n" + .'* Downgrade: downgrades the configurations of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance for which you want to modify the configurations.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rm-akjhkdsjhfskjfhd', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'JAKSJFHFAKJSF', + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details about the parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'The value of the parameter n. Valid values of n: 1 to 100.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'Code' => [ + 'description' => 'The code of the parameter n. Valid values of n: 1 to 100. Multiple parameters are concatenated in the order of n.'."\n" + ."\n" + .'> Only the parameters of the attributes that you want to modify for the instance must be configured. For example, if the instance has Attribute A and Attribute B and only Attribute A must be modified, configure only the parameter of Attribute A.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order that was created.'."\n", + 'type' => 'string', + 'example' => '202653252354351', + ], + 'HostId' => [ + 'description' => 'The ID of the host.'."\n", + 'type' => 'string', + 'example' => 'testId', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'ResourceNotExists', + 'errorMessage' => 'The specific resource is not exists.', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', + 'errorMessage' => 'Please complete your basic personal information first.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202653252354351\\",\\n \\"HostId\\": \\"testId\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202653252354351</OrderId>\\n </Data>\\n</ModifyInstanceResponse>","errorExample":""}]', + 'summary' => 'Modifies the configurations of an instance. When you call this operation, the system generates a modification order and automatically completes the payment. You cannot call this operation to modify the configurations of an Elastic Compute Service (ECS) instance or ApsaraDB RDS instance. To modify the configurations of an ECS or ApsaraDB RDS instance, call the dedicated operation of the corresponding service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetRenewal' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RenewalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal period. Valid values:'."\n" + ."\n" + .'* 1'."\n" + .'* 2'."\n" + .'* 3'."\n" + .'* 6'."\n" + .'* 12'."\n" + ."\n" + .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceIDs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance. You can enable auto-renewal for up to 100 subscription instances at a time. Separate multiple instance IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-askjdhaskfjh', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'RenewalPeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the auto-renewal period. Valid values:'."\n" + ."\n" + .'* M: months'."\n" + .'* Y: years'."\n" + ."\n" + .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'M', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of renewal. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + .'* NotRenewal: The instance is not renewed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AutoRenewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetRenewalResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</SetRenewalResponse>","errorExample":""}]', + 'title' => 'SetRenewal', + 'summary' => 'Enables auto-renewal for an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConvertChargeType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n" + ."\n" + .'> After the call is successful, the billing method of the instance is switched.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration. Unit: months. This parameter is required if you switch the billing method to subscription. Valid values:'."\n" + ."\n" + .'* 1 to 9'."\n" + .'* 12'."\n" + .'* 24'."\n" + .'* 36'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-kasjgfjshgf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '202657601410661', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + 405 => [ + [ + 'errorCode' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', + 'errorMessage' => '您购买的数量超过限制。请重新购买。', + ], + [ + 'errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', + 'errorMessage' => '您选购的服务存在未支付订单，请支付或作废后再下单！', + ], + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => '必选模块未选择', + ], + [ + 'errorCode' => 'ORDER.QUANTITY_INVALID', + 'errorMessage' => '您购买的数量超过限制。请重新购买。', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202657601410661\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ConvertChargeTypeResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202657601410661</OrderId>\\n </Data>\\n</ConvertChargeTypeResponse>","errorExample":""}]', + 'summary' => 'Changes the billing method of an instance. You can call this operation to switch the billing method from pay-as-you-go to subscription for Server Load Balancer (SLB) instances, elastic IP addresses (EIPs), and NAT gateways, and switch the billing method from subscription to pay-as-you-go for SLB instances and EIPs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service to which the instance belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-skjdhaskjdh', + ], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration of the subscription renewal. Unit: months. Valid values:'."\n" + ."\n" + .'* 1 to 9'."\n" + .'* 12'."\n" + .'* 24'."\n" + .'* 36'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASKJHKLASJHAFSLKJH', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '202657601410661', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + [ + 'errorCode' => 'ResourceStatusError', + 'errorMessage' => 'The resource status error.', + ], + [ + 'errorCode' => 'ResourceNotExists', + 'errorMessage' => 'The specific resource is not exists.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202657601410661\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202657601410661</OrderId>\\n </Data>\\n</RenewInstanceResponse>","errorExample":""}]', + 'summary' => 'Renews a specified instance. You cannot call this operation to renew Elastic Compute Service (ECS) instances, ApsaraDB RDS instances, or ApsaraDB for Redis instances. To renew these types of instances, call the dedicated operation of the corresponding service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefundInstance' => [ + 'summary' => 'Unsubscribes from an instance that is no longer needed.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'description' => 'This parameter is required for scenarios that need idempotence. The UUID that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '793F021C-B589-1225-82A9-99232AEBE494', + ], + ], + [ + 'name' => 'ImmediatelyRelease', + 'in' => 'query', + 'schema' => [ + 'title' => 'immediatelyRelease', + 'description' => 'This parameter is required for unsubscription scenarios. Valid values: 1 and 0. A value of 1 specifies that the instance is immediately released. A value of 0 specifies that the instance is shut down based on the shutdown policy. This parameter is supported only for specified services. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => 'The code of the service. This parameter is required for unsubscription scenarios.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceId', + 'description' => 'The ID of the instance. This parameter is required for unsubscription scenarios. Do not specify a custom name for this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1etb69sqxgl4*******', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => 'The type of the service. This parameter is required for unsubscription scenarios. Unless otherwise specified, set this parameter to an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '”“', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => 'The description of the execution result.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => 'The site of the execution host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'OrderId' => [ + 'title' => 'orderId', + 'description' => 'The ID of the refund order that is returned only if the instance is unsubscribed from.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2100000000***', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'ResourceNotExists', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotExists', + 'errorMessage' => 'The specific resource is not exists.', + ], + [ + 'errorCode' => 'ResourceStatusError', + 'errorMessage' => 'The resource status error.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner does not belong to caller.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'The specified API is not applicable for the user.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'The user is not authorized for the specified API.', + ], + [ + 'errorCode' => 'BindMirrorInstanceError', + 'errorMessage' => 'Charged images that are related to ECS.', + ], + [ + 'errorCode' => 'ExceedRefundQuotaError', + 'errorMessage' => 'The number of unsubscription times has reached the upper limit.', + ], + [ + 'errorCode' => 'ExistUnPaidOrderError', + 'errorMessage' => 'The instance has an unsettled order.', + ], + [ + 'errorCode' => 'ExistRefundingOrderError', + 'errorMessage' => 'The instance ID is invalid: the instance may have expired, been refunded, or been released.', + ], + [ + 'errorCode' => 'NoRestValueError', + 'errorMessage' => 'The refund amount is 0.', + ], + [ + 'errorCode' => 'AmbassadorOrderLimitError', + 'errorMessage' => 'The instance has an ambassador order that may raise risks.', + ], + [ + 'errorCode' => 'ActivityForbiddenError', + 'errorMessage' => 'Promotional orders do not support refunds.', + ], + [ + 'errorCode' => 'ProductCheckError', + 'errorMessage' => 'The cloud service failed SPI preflight verification.', + ], + [ + 'errorCode' => 'CommodityNotSupported', + 'errorMessage' => 'The specified commodity is not supported.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\",\\n \\"OrderId\\": 0\\n },\\n \\"Code\\": \\"ResourceNotExists\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'RefundInstance', + 'description' => '1. Refunds are applicable only for the actual paid amount. Vouchers used for the purchase are non-refundable.'."\n" + .'2. Check the information about unsubscription and confirm the unsubscription terms and refundable amount. The resource that is unsubscribed cannot be restored.'."\n" + .'3. For more information, see [Rules for unsubscribing from resources](https://www.alibabacloud.com/help/en/user-center/refund-rules).', + 'extraInfo' => '**Error codes that are returned if a request is blocked**'."\n" + ."\n" + .'* ResourceNotExists: The instance does not exist.'."\n" + .'* ResourceStatusError: The instance is not in the expected state.'."\n" + .'* BindMirrorInstanceError: The ECS instance is bound to a paid image.'."\n" + .'* ExceedRefundQuotaError: The number of times that you unsubscribe from the instance exceeds the quota.'."\n" + .'* ExistUnPaidOrderError: An order that is not paid exists in the instance.'."\n" + .'* ExistRefundingOrderError: The ID of the instance is invalid because the instance expires, the instance is released, or the instance is refunded.'."\n" + .'* NoRestValueError: The refundable amount is 0.'."\n" + .'* AmbassadorOrderLimitError: The instance has an ambassador order that may raise risks.'."\n" + .'* ActivityForbiddenError: You cannot request a refund for an instance that is purchased during the marketing campaigns.'."\n" + .'* ProductCheckError: The instance does not pass the precheck.', + ], + 'GetOrderDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '32453453', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => 'The orders returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the order.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderSubType' => [ + 'description' => 'The type of the suborder. A value of productsuborder indicates service suborder. A value of refundsuborder indicates refund suborder.'."\n", + 'type' => 'string', + 'example' => 'ProductSubOrder', + ], + 'CreateTime' => [ + 'description' => 'The time when the order was created.'."\n", + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Currency' => [ + 'description' => 'The currency. Valid values: CNY, USD, and JPY.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'Config' => [ + 'description' => 'The configurations of the main service.'."\n", + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'SubscriptionType' => [ + 'title' => '', + 'description' => 'The billing method. Valid values: Subscription and PayAsYouGo.'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'UsageStartTime' => [ + 'description' => 'The time when the service starts.'."\n", + 'type' => 'string', + 'example' => '2017-06-08T16:00:00Z', + ], + 'UsageEndTime' => [ + 'description' => 'The time when the service ends.'."\n", + 'type' => 'string', + 'example' => '2117-06-08T16:00:00Z', + ], + 'SubOrderId' => [ + 'description' => 'The ID of the suborder.'."\n", + 'type' => 'string', + 'example' => '234343', + ], + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AfterTaxAmount' => [ + 'description' => 'The aftertaxt amount of the order.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => 'The time of payment.'."\n", + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Operator' => [ + 'description' => 'The ID of the Resource Access Management (RAM) user that performs operations on the order. If no RAM user is involved, this parameter is empty.'."\n", + 'type' => 'string', + 'example' => '23424243432', + ], + 'OrderType' => [ + 'description' => 'The type of the order. Valid values: new, renew, upgrade, and refund.'."\n", + 'type' => 'string', + 'example' => 'New', + ], + 'PaymentStatus' => [ + 'description' => 'The payment state. Valid values: unpaid, paid, and canceled.'."\n", + 'type' => 'string', + 'example' => 'Paid', + ], + 'Quantity' => [ + 'description' => 'The number of main services.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PretaxAmountLocal' => [ + 'description' => 'The pretax amount of the order in local currency.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Tax' => [ + 'description' => 'The tax of the order.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'OriginalConfig' => [ + 'description' => 'The configuration information that is not formatted.'."\n", + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'PretaxAmount' => [ + 'description' => 'The pretax amount of the order.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'RelatedOrderId' => [ + 'description' => 'The ID of the associated order.'."\n", + 'type' => 'string', + 'example' => '4353453534543', + ], + 'PaymentCurrency' => [ + 'description' => 'The currency used for payment. Valid values: CNY, USD, and JPY.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ProductType' => [ + 'description' => 'The type of the main service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'InstanceIDs' => [ + 'description' => 'The instance IDs.'."\n", + 'type' => 'string', + 'example' => '["rm-bp1a2vsr018313t6o"]', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount of the order.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '3453425324', + ], + 'ProductCode' => [ + 'description' => 'The code of the main service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ExtendInfos' => [ + 'description' => 'The additional information about the order.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The additional information about the order.'."\n" + ."\n" + .'* A value of true for isAutoRenew indicates that automatic renewal is enabled. If automatic renewal is disabled, this parameter is not returned.'."\n" + .'* couponNo indicates the coupon number.'."\n" + .'* couponAmount indicates the amount deducted by using the coupon.'."\n" + .'* discountAmount indicates the amount deducted.'."\n", + 'example' => '{"key":"Order extension information"}', + ], + ], + 'BillModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleConfig' => [ + 'description' => 'The billing information about the configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'Data disk'."\n", + ], + 'Code' => [ + 'description' => 'The code of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'datadisk', + ], + 'ApiCode' => [ + 'description' => 'The API code of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'datadisk', + ], + 'BillModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleProperties' => [ + 'description' => 'The attributes of the configured item.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleApiCode' => [ + 'description' => 'The API code of the configured item.'."\n", + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'AttrApiCode' => [ + 'description' => 'The attribute code of the configured item.'."\n", + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'Value' => [ + 'description' => 'The attribute value of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + 'OriginalModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'originalModuleConfig' => [ + 'description' => 'The information about the configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'System disk'."\n", + ], + 'Code' => [ + 'description' => 'The code of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'systemdisk', + ], + 'ModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleProperties' => [ + 'description' => 'The attributes of the configured item.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The attribute code of the configured item.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency'."\n", + ], + 'Name' => [ + 'description' => 'The attribute name of the configured item.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Value' => [ + 'description' => 'The attribute value of the configured item.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"OrderSubType\\": \\"子订单类型\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Currency\\": \\" CNY\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Operator\\": \\"23424243432\\",\\n \\"OrderType\\": \\"new\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"Quantity\\": \\"1\\",\\n \\"PretaxAmountLocal\\": \\"0\\",\\n \\"Tax\\": \\"1\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"4353453534543\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"InstanceIDs\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderId\\": \\"3453425324\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"Name\\": \\"数据盘\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"ModuleApiCode\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"Value\\": \\"cloud_ssd\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"Name\\": \\"系统盘\\",\\n \\"Code\\": \\"systemdisk\\",\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Code\\": \\"高效云盘\\",\\n \\"Name\\": \\"cloud_efficiency\\",\\n \\"Value\\": \\"cloud_efficiency\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetOrderDetail', + 'summary' => 'Queries the details of an order that belongs to your Alibaba Cloud account or distributors.', + ], + 'QueryOrders' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'* New: purchases an instance.'."\n" + .'* Renew: renews an instance.'."\n" + .'* Upgrade: upgrades the configurations of an instance.'."\n" + .'* Refund: applies for a refund.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'New', + ], + ], + [ + 'name' => 'PaymentStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of payment. Valid values for a non-refund order:'."\n" + ."\n" + .'* Unpaid: The order is not paid.'."\n" + .'* Paid: The order is paid.'."\n" + .'* Cancelled: The order is canceled.'."\n" + ."\n" + .'> : You can set this parameter to NULL for a refund order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Paid', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T13:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => 'The orders returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PretaxAmount' => [ + 'description' => 'The pretax amount of the order.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => 'The service code.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'RelatedOrderId' => [ + 'description' => 'The ID of the associated order.'."\n", + 'type' => 'string', + 'example' => '234535345345342', + ], + 'CreateTime' => [ + 'description' => 'The time when the order was created.'."\n", + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Currency' => [ + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PaymentCurrency' => [ + 'description' => 'The currency of payment.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ProductType' => [ + 'description' => 'The type of the main service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'AfterTaxAmount' => [ + 'description' => 'The aftertax amount of the order.'."\n", + 'type' => 'string', + 'example' => '66', + ], + 'PaymentTime' => [ + 'description' => 'The time of payment.'."\n", + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'PretaxGrossAmount' => [ + 'description' => 'The pretax gross amount of the order.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'* New: purchases an instance.'."\n" + .'* Renew: renews an instance.'."\n" + .'* Upgrade: upgrades the configurations of an instance.'."\n" + .'* Refund: applies for a refund.'."\n", + 'type' => 'string', + 'example' => 'New', + ], + 'PaymentStatus' => [ + 'description' => 'The status of payment. Valid values for a non-refund order:'."\n" + ."\n" + .'* Unpaid: The order is not paid.'."\n" + .'* Paid: The order is paid.'."\n" + .'* Cancelled: The order is canceled.'."\n" + ."\n" + .'> : The value is NULL for a refund order.'."\n", + 'type' => 'string', + 'example' => 'Paid', + ], + 'OrderId' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'example' => '34532532', + ], + 'Tax' => [ + 'description' => 'The tax of the order.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PretaxAmountLocal' => [ + 'description' => 'The pretax amount of the order in local currency.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => 'The code of the main service.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"61293E7A-3406-4447-8620-EC88B0AA66AD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"PretaxAmount\\": \\"0\\",\\n \\"CommodityCode\\": \\"ecs\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"OrderId\\": \\"34532532\\",\\n \\"Tax\\": \\"1\\",\\n \\"PretaxAmountLocal\\": \\"0\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryOrdersResponse>\\n <Message>Successful!</Message>\\n <RequestId>61293E7A-3406-4447-8620-EC88B0AA66AD</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <OrderList>\\n </OrderList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryOrdersResponse>","errorExample":""}]', + 'summary' => 'Queries the orders of your Alibaba Cloud account or distributors. By default, orders within the last hour are queried. To query earlier orders, specify the CreateTimeStart and CreateTimeEnd parameters.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelOrder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the order.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '73465432785', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '30D2285E-A848-4ECB-AA74-4954C60858A1', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'The ID of the host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"30D2285E-A848-4ECB-AA74-4954C60858A1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelOrderResponse>\\n <Data>\\n <HostId>cn</HostId>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>30D2285E-A848-4ECB-AA74-4954C60858A1</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</CancelOrderResponse>","errorExample":""}]', + 'summary' => 'Cancels an unpaid order.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCostUnit' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'UnitEntityList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of cost centers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the owner of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '982375623', + ], + 'UnitName' => [ + 'description' => 'The name of the cost center.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'Indicates whether the call is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'CostUnitDtoList' => [ + 'description' => 'The list of cost center entities.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'UnitName' => [ + 'description' => 'The name of the cost center.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '84327659328', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the owner of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26387563', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CostUnitDtoList\\": [\\n {\\n \\"ParentUnitId\\": -1,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 84327659328,\\n \\"OwnerUid\\": 26387563\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateCostUnitResponse>\\n <Data>\\n <CostUnitDtoList>\\n <UnitName>dd</UnitName>\\n <ParentUnitId>12***********45</ParentUnitId>\\n <OwnerUid>16************86</OwnerUid>\\n </CostUnitDtoList>\\n </Data>\\n <Message>Successful</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</CreateCostUnitResponse>","errorExample":""}]', + 'summary' => 'Creates a cost center. You can create multiple cost centers at a time.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateCostUnitResource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FromUnitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID of the owner of the source cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '273394581313325532', + ], + ], + [ + 'name' => 'FromUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the source cost center.'."\n" + ."\n" + .'* A value of 0 indicates that the resources to be transferred have not been allocated to a cost center.'."\n" + .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ToUnitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID of the owner of the destination cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '241021678450941490', + ], + ], + [ + 'name' => 'ToUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination cost center.'."\n" + ."\n" + .'* A value of -1 indicates that the allocated resources are changed to unallocated.'."\n" + .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '186419', + ], + ], + [ + 'name' => 'ResourceInstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource instances to be transferred.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApportionCode' => [ + 'description' => 'The split item of the shared instance. This parameter is required only for shared instances.'."\n" + ."\n" + .'* Eight cloud services support bill splitting. The commodity codes of the eight services are oss, dcdn, snapshot, vod, cdn, live, and cbwp.'."\n" + .'* You can obtain the split item of a shared instance by calling QueryCostUnitResource operation to obtain all resource instances within a cost center.', + 'type' => 'string', + 'required' => false, + 'example' => 'qwer1-cn-beijing', + ], + 'CommodityCode' => [ + 'description' => 'The commodity code of the resource instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + ], + 'ResourceUserId' => [ + 'description' => 'The user ID of the resource instance owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '273394581313325532', + ], + 'ResourceId' => [ + 'description' => 'The ID of the resource instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou;standard', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '845C629F-47A7-4F46-A470-ED5047C4C250', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ToUnitUserId' => [ + 'description' => 'The user ID of the owner of the destination cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34857693874', + ], + 'IsSuccess' => [ + 'description' => 'Indicates whether resources are allocated to the specified cost center. Valid values:'."\n" + ."\n" + .'* true: The resources are allocated to the specified cost center.'."\n" + .'* false: The resources fail to be allocated to the specified cost center.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ToUnitId' => [ + 'description' => 'The ID of the destination cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32857346527', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"845C629F-47A7-4F46-A470-ED5047C4C250\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ToUnitUserId\\": 34857693874,\\n \\"IsSuccess\\": true,\\n \\"ToUnitId\\": 32857346527\\n }\\n}","errorExample":""},{"type":"xml","example":"<AllocateCostUnitResourceResponse>\\r\\n <Data>\\r\\n <CostUnitOperate>\\r\\n <IsSuccess>true</IsSuccess>\\r\\n <ToUnitId>1245</ToUnitId>\\r\\n <ToUnitUserId>1686</ToUnitUserId>\\r\\n </CostUnitOperate>\\r\\n </Data>\\r\\n <Message>Successful!</Message>\\r\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>success</Code>\\r\\n</AllocateCostUnitResourceResponse>","errorExample":""}]', + 'title' => 'AllocateCostUnitResource', + 'summary' => 'Transfers resource instances from the source cost center to the destination cost center.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCostUnit' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2135342', + ], + ], + [ + 'name' => 'UnitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '376348', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => 'Indicates whether the call is complete.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123412343', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12431', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IsSuccess\\": true,\\n \\"UnitId\\": 123412343,\\n \\"OwnerUid\\": 12431\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteCostUnitResponse>\\n <Data>\\n <CostUnitOperate>\\n <IsSuccess>true</IsSuccess>\\n <OwnerUid>1245</OwnerUid>\\n <UnitId>1686</UnitId>\\n </CostUnitOperate>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</DeleteCostUnitResponse>","errorExample":""}]', + 'summary' => 'Deletes a cost center.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCostUnit' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'UnitEntityList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The cost centers to be modified.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2524352', + ], + 'NewUnitName' => [ + 'description' => 'The new name of the cost center.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'newTest', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1321312312', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => 'Indicates whether the cost center was modified.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '356349875', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '823756287', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"UnitId\\": 356349875,\\n \\"OwnerUid\\": 823756287\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyCostUnitResponse>\\n <Data>\\n <CostUnitOperate>\\n <IsSuccess>true</IsSuccess>\\n <OwnerUid>1245</OwnerUid>\\n <UnitId>1686</UnitId>\\n </CostUnitOperate>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</ModifyCostUnitResponse>","errorExample":""}]', + 'summary' => 'Modifies one or more cost centers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCostUnit' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '28394563429587', + ], + ], + [ + 'name' => 'ParentUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. A maximum of 300 entries can be returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CostUnitDtoList' => [ + 'description' => 'The cost centers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'UnitName' => [ + 'description' => 'The name of the cost center.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23534', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2343464', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CostUnitDtoList\\": [\\n {\\n \\"ParentUnitId\\": -1,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 23534,\\n \\"OwnerUid\\": 2343464\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCostUnitResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <PageNum/>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n </Data>\\n</QueryCostUnitResponse>","errorExample":""}]', + 'title' => 'QueryCostUnit', + 'summary' => 'Queries all cost centers within the current node of the cost center tree. If the ParentUnitId parameter is set to -1, all cost centers are queried.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCostUnitResource' => [ + 'summary' => 'Queries the resource instances that are allocated to a cost center. If the unitId parameter is set to 0, the unallocated primary resource instances and sub-resource instances are queried.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23453245', + ], + ], + [ + 'name' => 'UnitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '235325', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04332CB7-9A57-4461-97E0-02821D044414', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'ResourceInstanceDtoList' => [ + 'description' => 'The resource instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => 'The product code of the resource.'."\n", + 'type' => 'string', + 'example' => 'rds', + ], + 'ResourceUserName' => [ + 'description' => 'The username of the resource owner.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'CommodityName' => [ + 'description' => 'The commodity name of the resource.'."\n", + 'type' => 'string', + 'example' => 'ApsaraDB'."\n", + ], + 'ResourceUserId' => [ + 'description' => 'The user ID of the resource owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2424242134', + ], + 'ApportionName' => [ + 'description' => 'The split name of the resource.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ApportionCode' => [ + 'description' => 'The split code of the resource.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n", + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_bj', + ], + 'ResourceNick' => [ + 'description' => 'The custom name of the resource.'."\n", + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceTag' => [ + 'description' => 'The tags of the resource.'."\n", + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceId' => [ + 'description' => 'The instance ID of the resource.'."\n", + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma018', + ], + 'ResourceGroup' => [ + 'description' => 'The resource group to which the resource belongs.'."\n", + 'type' => 'string', + 'example' => 'Default Resource Group'."\n", + ], + 'RelatedResources' => [ + 'description' => 'The resources related to the resource instance.'."\n", + 'type' => 'string', + 'example' => 'oss', + ], + 'ResourceStatus' => [ + 'description' => 'The status of the resource.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'PipCode' => [ + 'description' => 'The code of the service. The code is the same as that in Cost Center.', + 'type' => 'string', + 'example' => 'rds', + ], + 'ResourceSource' => [ + 'description' => 'The source of the resource. Value:'."\n" + .'- AUTO_ALLOCATE'."\n" + .'- MANUAL_ALLOCATE', + 'type' => 'string', + 'example' => 'MANUAL_ALLOCATE', + ], + ], + ], + ], + 'CostUnit' => [ + 'description' => 'The information about the cost center.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23421', + ], + 'UnitName' => [ + 'description' => 'The name of the cost center.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => 'The ID of the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123412', + ], + 'OwnerUid' => [ + 'description' => 'The user ID of the cost center owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '321432', + ], + ], + ], + 'CostUnitStatisInfo' => [ + 'description' => 'The statistical information about the cost center.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalResourceCount' => [ + 'description' => 'The total number of resource instances, including resource instances of sub-cost centers, in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ResourceCount' => [ + 'description' => 'The number of resource instances in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalUserCount' => [ + 'description' => 'The total number of the associated accounts, including associated accounts of sub-cost centers, in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SubUnitCount' => [ + 'description' => 'The number of sub-cost centers in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ResourceGroupCount' => [ + 'description' => 'The number of resource groups in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalResourceGroupCount' => [ + 'description' => 'The total number of resource groups, including resource groups of sub-cost centers, in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UserCount' => [ + 'description' => 'The number of sub-cost centers in the cost center.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"04332CB7-9A57-4461-97E0-02821D044414\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"ResourceInstanceDtoList\\": [\\n {\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ResourceUserName\\": \\"[email protected]\\",\\n \\"CommodityName\\": \\"云数据库\\",\\n \\"ResourceUserId\\": 2424242134,\\n \\"ApportionName\\": \\"test\\",\\n \\"ApportionCode\\": \\"test\\",\\n \\"ResourceType\\": \\"FPT_ossbag_absolute_Storage_bj\\",\\n \\"ResourceNick\\": \\"testResource\\",\\n \\"ResourceTag\\": \\"testResource\\",\\n \\"ResourceId\\": \\"OSSBAG-cn-v0h1s4hma018\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"RelatedResources\\": \\"oss\\",\\n \\"ResourceStatus\\": \\"Available\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\"\\n }\\n ],\\n \\"CostUnit\\": {\\n \\"ParentUnitId\\": 23421,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 123412,\\n \\"OwnerUid\\": 321432\\n },\\n \\"CostUnitStatisInfo\\": {\\n \\"TotalResourceCount\\": 3,\\n \\"ResourceCount\\": 1,\\n \\"TotalUserCount\\": 2,\\n \\"SubUnitCount\\": 2,\\n \\"ResourceGroupCount\\": 1,\\n \\"TotalResourceGroupCount\\": 2,\\n \\"UserCount\\": 0\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCostUnitResourceResponse>\\n <Code>Success</Code>\\n <Message>Successful！</Message>\\n <RequestId>04332CB7-9A57-4461-97E0-02821D044414</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <TotalCount>12</TotalCount>\\n <ResourceInstanceDtoList>\\n <CommodityCode>rds</CommodityCode>\\n <ResourceUserName>[email protected]</ResourceUserName>\\n <CommodityName>云数据库</CommodityName>\\n <ResourceUserId>2424242134</ResourceUserId>\\n <ApportionName>test</ApportionName>\\n <ApportionCode>test</ApportionCode>\\n <ResourceType>FPT_ossbag_absolute_Storage_bj</ResourceType>\\n <ResourceNick>testResource</ResourceNick>\\n <ResourceTag>testResource</ResourceTag>\\n <ResourceId>OSSBAG-cn-v0h1s4hma018</ResourceId>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <RelatedResources>oss</RelatedResources>\\n <ResourceStatus>Available</ResourceStatus>\\n <PipCode>rds</PipCode>\\n <ResourceSource>MANUAL_ALLOCATE</ResourceSource>\\n </ResourceInstanceDtoList>\\n <CostUnit>\\n <ParentUnitId>23421</ParentUnitId>\\n <UnitName>test</UnitName>\\n <UnitId>123412</UnitId>\\n <OwnerUid>321432</OwnerUid>\\n </CostUnit>\\n <CostUnitStatisInfo>\\n <TotalResourceCount>3</TotalResourceCount>\\n <ResourceCount>1</ResourceCount>\\n <TotalUserCount>2</TotalUserCount>\\n <SubUnitCount>2</SubUnitCount>\\n <ResourceGroupCount>1</ResourceGroupCount>\\n <TotalResourceGroupCount>2</TotalResourceGroupCount>\\n <UserCount>0</UserCount>\\n </CostUnitStatisInfo>\\n </Data>\\n</QueryCostUnitResourceResponse>","errorExample":""}]', + 'title' => 'QueryCostUnitResource', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFinancialAccountInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1990699401005016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '97426BC2-792E-41F5-92B8-73C710DA7779', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'MemberNickName' => [ + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'Test'."\n", + ], + 'IsFinancialAccount' => [ + 'description' => 'Indicates whether the account is a financial account. A value of true indicates that the account is a financial account. A value of false indicates that the account is not a financial account.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MemberGroupName' => [ + 'description' => 'The name of the group to which the member belongs.'."\n", + 'type' => 'string', + 'example' => 'Test group'."\n", + ], + 'UserName' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'killortop3', + ], + 'AccountType' => [ + 'description' => 'The type of the financial account. A value of MASTER indicates that the account is a management account. A value of MEMBER indicates that the account is a member.'."\n", + 'type' => 'string', + 'example' => 'MEMBER', + ], + 'MemberGroupId' => [ + 'description' => 'The ID of the group to which the member belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '124', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An error occurred in the internal server.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"97426BC2-792E-41F5-92B8-73C710DA7779\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MemberNickName\\": \\"测试\\",\\n \\"IsFinancialAccount\\": true,\\n \\"MemberGroupName\\": \\"测试组\\",\\n \\"UserName\\": \\"killortop3\\",\\n \\"AccountType\\": \\"MEMBER\\",\\n \\"MemberGroupId\\": 124\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>97426BC2-792E-41F5-92B8-73C710DA7779</RequestId>\\n<Data>\\n <UserName>killortop3</UserName>\\n <MemberGroupName>测试组</MemberGroupName>\\n <MemberNickName>测试</MemberNickName>\\n <IsFinancialAccount>true</IsFinancialAccount>\\n <MemberGroupId>124</MemberGroupId>\\n <AccountType>MEMBER</AccountType>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'summary' => 'Queries the information about a financial account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEvaluateList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of orders to be queried. Valid values:'."\n" + ."\n" + .'* 1: the orders in which the invoiceable amount is negative.'."\n" + .'* 2: the orders in which the invoiceable amount is positive.'."\n" + .'* 3: the orders in which the invoiceable amount is not 0.'."\n" + .'* 4: the orders in which the amount that has been invoiced is greater than 0.'."\n" + ."\n" + .'> By default, this parameter is left empty. If this parameter is left empty, all orders are queried.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2387432832696', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'StartAmount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum amount to be queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'EndAmount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum amount to be queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'StartBizTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest time when an order is paid. Specify the time in the yyyy-mm-dd hh:mm:ss format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 12:00:00', + ], + ], + [ + 'name' => 'EndBizTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest time when an order is paid Specify the time in the yyyy-mm-dd hh:mm:ss format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 15:00:00', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the sort. Valid values:'."\n" + ."\n" + .'* 1: Sort invoices by ID in descending order.'."\n" + .'* 2: Sort invoices by invoice type in descending order, and then sort invoices of the same type by ID in descending order.'."\n" + .'* 3: Sort invoices by invoice type in ascending order, and then sort invoices of the same type by ID in descending order.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartSearchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 12:00:00', + ], + ], + [ + 'name' => 'EndSearchTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-02 12:00:00', + ], + ], + [ + 'name' => 'BillCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '202003', + ], + ], + [ + 'name' => 'BizTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The market types in invoices.'."\n" + ."\n" + .'> By default, this parameter is left empty. If this parameter is left empty, all market types are queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The market type in the invoice. Valid values:'."\n" + ."\n" + .'* ALIYUN: Alibaba Cloud'."\n" + .'* MARKETPLACE: Alibaba Cloud Marketplace'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'example' => 'ALIYUN', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D35FF10E-1B2E-4ABA-8401-0AE17725F50B', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The number of the page returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalUnAppliedInvoiceAmount' => [ + 'description' => 'The invoiceable amount that meets the query conditions. Unit: Cent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12344', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalInvoiceAmount' => [ + 'description' => 'The invoiced amount that meets the query conditions. Unit: Cent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12344', + ], + 'HostId' => [ + 'description' => 'The ID of the host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'EvaluateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Evaluate' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of orders that are queried. Valid values:'."\n" + ."\n" + .'* 1: the orders in which the invoiceable amount is negative.'."\n" + .'* 2: the orders in which the invoiceable amount is positive.'."\n" + .'* 3: the orders in which the invoiceable amount is not 0.'."\n" + .'* 4: the orders in which the amount that has been invoiced is greater than 0.'."\n" + ."\n" + .'> By default, this parameter is left empty. If this parameter is left empty, all orders are queried.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'The status of the invoiceable amount.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillId' => [ + 'description' => 'The ID of the bill.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234543254325', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2738543', + ], + 'BillCycle' => [ + 'description' => 'The billing cycle.'."\n", + 'type' => 'string', + 'example' => '202002', + ], + 'CanInvoiceAmount' => [ + 'description' => 'The invoiceable amount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123213', + ], + 'OffsetAcceptAmount' => [ + 'description' => 'If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the **OffsetCostAmount** parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'ItemId' => [ + 'description' => 'The ID of the item.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23453245', + ], + 'OutBizId' => [ + 'description' => 'The ID of the external order.'."\n", + 'type' => 'string', + 'example' => '124324213421', + ], + 'UserNick' => [ + 'description' => 'The nickname of the user.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'GmtModified' => [ + 'description' => 'The modification time.'."\n", + 'type' => 'string', + 'example' => '2018-10-10 18:05:44', + ], + 'OpId' => [ + 'description' => 'The ID of the external object.'."\n", + 'type' => 'string', + 'example' => '12341', + ], + 'BizType' => [ + 'description' => 'The market type in the invoice. Valid values:'."\n" + ."\n" + .'* ALIYUN: Alibaba Cloud'."\n" + .'* MARKETPLACE: Alibaba Cloud Marketplace'."\n", + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'OriginalAmount' => [ + 'description' => 'The original amount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-10000', + ], + 'InvoicedAmount' => [ + 'description' => 'The invoiced amount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'GmtCreate' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2018-10-10 18:05:44', + ], + 'PresentAmount' => [ + 'description' => 'The balance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-10000', + ], + 'BizTime' => [ + 'description' => 'The time.'."\n", + 'type' => 'string', + 'example' => '2018-10-10 18:05:44', + ], + 'Name' => [ + 'description' => 'The name of the object to be invoiced.'."\n", + 'type' => 'string', + 'example' => 'Refund of a voucher with denomination marked'."\n", + ], + 'OffsetCostAmount' => [ + 'description' => 'The refund amount used to offset the amount of the invoice. If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the **OffsetAcceptAmount** parameter.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'Id' => [ + 'description' => 'The ID of the invoice.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1325321532', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"D35FF10E-1B2E-4ABA-8401-0AE17725F50B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"TotalUnAppliedInvoiceAmount\\": 12344,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"TotalInvoiceAmount\\": 10000,\\n \\"HostId\\": \\"\\",\\n \\"EvaluateList\\": {\\n \\"Evaluate\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 1,\\n \\"BillId\\": 0,\\n \\"UserId\\": 2738543,\\n \\"BillCycle\\": \\"202502\\",\\n \\"CanInvoiceAmount\\": 5000,\\n \\"OffsetAcceptAmount\\": -5000,\\n \\"ItemId\\": 0,\\n \\"OutBizId\\": \\"124324213421\\",\\n \\"UserNick\\": \\"HelloWorld\\",\\n \\"GmtModified\\": \\"2025-01-01 00:00:00\\",\\n \\"OpId\\": \\"\\",\\n \\"BizType\\": \\"ALIYUN\\",\\n \\"OriginalAmount\\": 10000,\\n \\"InvoicedAmount\\": 10000,\\n \\"GmtCreate\\": \\"2025-02-01 00:00:00\\",\\n \\"PresentAmount\\": 10000,\\n \\"BizTime\\": \\"2025-02-01 00:00:00\\",\\n \\"Name\\": \\"云服务器ECS(包月)\\",\\n \\"OffsetCostAmount\\": 5000,\\n \\"Id\\": 1325321532\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEvaluateListResponse>\\n <Message>Successful!</Message>\\n <RequestId>D35FF10E-1B2E-4ABA-8401-0AE17725F50B</RequestId>\\n <Data>\\n <TotalInvoiceAmount>8532</TotalInvoiceAmount>\\n <TotalCount>23</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <TotalUnAppliedInvoiceAmount>8532</TotalUnAppliedInvoiceAmount>\\n <HostId>cn</HostId>\\n <EvaluateList>\\n <Evaluate>\\n <Status>1</Status>\\n <OffsetCostAmount>0</OffsetCostAmount>\\n <BizTime>2020-03-09 10:43:57</BizTime>\\n <GmtModified>2020-03-09 10:45:02</GmtModified>\\n <BillCycle>202003</BillCycle>\\n <BizType>ALIYUN_SERVICE</BizType>\\n <PresentAmount>1</PresentAmount>\\n <OriginalAmount>1</OriginalAmount>\\n <Name>关系型数据库RDS(包月)</Name>\\n <GmtCreate>2020-03-09 10:45:02</GmtCreate>\\n <Type>1</Type>\\n <UserId>1857xxxxxx3489</UserId>\\n <OffsetAcceptAmount>0</OffsetAcceptAmount>\\n <Id>23345345553</Id>\\n <OutBizId>20xxxxxxx112</OutBizId>\\n <InvoicedAmount>0</InvoicedAmount>\\n <CanInvoiceAmount>1</CanInvoiceAmount>\\n </Evaluate>\\n </EvaluateList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryEvaluateListResponse>","errorExample":""}]', + 'summary' => 'Queries the information about the orders for which you want to apply for invoices.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCustomerAddressList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomerInvoiceAddressList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomerInvoiceAddress' => [ + 'description' => 'The details of addresses to which invoices are mailed.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Addressee' => [ + 'description' => 'The addressee.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'PostalCode' => [ + 'description' => 'The postcode.'."\n", + 'type' => 'string', + 'example' => '000000', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4382956342857', + ], + 'City' => [ + 'description' => 'The city to which the invoice is mailed.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou'."\n", + ], + 'UserNick' => [ + 'description' => 'The nickname of the user.'."\n", + 'type' => 'string', + 'example' => 'testNick', + ], + 'Street' => [ + 'description' => 'The name of the street to which the invoice is mailed.'."\n", + 'type' => 'string', + 'example' => 'Test Street'."\n", + ], + 'Phone' => [ + 'description' => 'The phone number of the addressee.'."\n", + 'type' => 'string', + 'example' => '138xxxxxxxx', + ], + 'County' => [ + 'description' => 'The name of the district to which the invoice is mailed.'."\n", + 'type' => 'string', + 'example' => 'Test District'."\n", + ], + 'BizType' => [ + 'description' => 'The business type.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'DeliveryAddress' => [ + 'description' => 'The detailed address to which the invoice is mailed. This parameter is returned after fields are concatenated.'."\n", + 'type' => 'string', + 'example' => 'Test Address'."\n", + ], + 'Id' => [ + 'description' => 'The ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '311601051', + ], + 'Province' => [ + 'description' => 'The province to which the invoice is mailed.'."\n", + 'type' => 'string', + 'example' => 'Zhejiang'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CustomerInvoiceAddressList\\": {\\n \\"CustomerInvoiceAddress\\": [\\n {\\n \\"Addressee\\": \\"\\",\\n \\"PostalCode\\": \\"\\",\\n \\"UserId\\": 0,\\n \\"City\\": \\"\\",\\n \\"UserNick\\": \\"\\",\\n \\"Street\\": \\"\\",\\n \\"Phone\\": \\"\\",\\n \\"County\\": \\"\\",\\n \\"BizType\\": \\"\\",\\n \\"DeliveryAddress\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Province\\": \\"\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCustomerAddressListResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <CustomerInvoiceAddressList>\\n <CustomerInvoiceAddress>\\n <Phone>186********</Phone>\\n <Street>测试街道</Street>\\n <PostalCode>000000</PostalCode>\\n <County>测试区</County>\\n <DeliveryAddress>浙江省杭州市**********</DeliveryAddress>\\n <Id>311601051</Id>\\n <Addressee>test</Addressee>\\n <UserId>169***********</UserId>\\n <Province>浙江*</Province>\\n <City>杭州*</City>\\n </CustomerInvoiceAddress>\\n </CustomerInvoiceAddressList>\\n </Data>\\n</QueryCustomerAddressListResponse>","errorExample":""}]', + 'summary' => 'Queries the addresses to which invoices are mailed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInvoicingCustomerList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomerInvoiceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomerInvoice' => [ + 'description' => 'The information about the invoice.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the invoice. Valid values:'."\n" + ."\n" + .'* 0: plain value-added tax (VAT) invoice'."\n" + .'* 1: special VAT invoice'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => 'The status of the invoice title.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AdjustType' => [ + 'description' => 'The type of invoice that was changed to.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Bank' => [ + 'description' => 'The bank that issues the invoice.'."\n", + 'type' => 'string', + 'example' => 'Test Bank'."\n", + ], + 'StartCycle' => [ + 'description' => 'The time when the payment started.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202002', + ], + 'TitleChangeInstructions' => [ + 'description' => 'The instruction document of the invoice title change.'."\n", + 'type' => 'string', + 'example' => 'instruction.doc', + ], + 'UserId' => [ + 'description' => 'The ID of the user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34565465675', + ], + 'OperatingLicenseAddress' => [ + 'description' => 'The address of the business license.'."\n", + 'type' => 'string', + 'example' => 'XXX, XXX district, XXX city, XXX province'."\n", + ], + 'InvoiceTitle' => [ + 'description' => 'The company name in the invoice title.'."\n", + 'type' => 'string', + 'example' => 'Test Company'."\n", + ], + 'UserNick' => [ + 'description' => 'The nickname of the user.'."\n", + 'type' => 'string', + 'example' => 'testNick', + ], + 'OperatingLicensePhone' => [ + 'description' => 'The phone number of the business license.'."\n", + 'type' => 'string', + 'example' => '138xxxxxxxx', + ], + 'EndCycle' => [ + 'description' => 'The time when the payment ended.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202003', + ], + 'DefaultRemark' => [ + 'description' => 'The default note that is attached when the title is specified.'."\n", + 'type' => 'string', + 'example' => 'PO Code: 12984554'."\n", + ], + 'TaxationLicense' => [ + 'description' => 'The path and file name of the scanned copy of the tax registration certificate.'."\n", + 'type' => 'string', + 'example' => 'taxationLicense.jpg', + ], + 'RegisterNo' => [ + 'description' => 'The tax registration number.'."\n", + 'type' => 'string', + 'example' => '21343245342534', + ], + 'GmtCreate' => [ + 'description' => 'The time when the invoice was created. The time was in the yyyy-mm-dd hh:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '2018-09-07 15:26:20', + ], + 'TaxpayerType' => [ + 'description' => 'The type of the taxpayer. Valid values:'."\n" + ."\n" + .'* 1: general taxpayer'."\n" + .'* 2: special taxpayer'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomerType' => [ + 'description' => 'The authentication type of Alipay. Valid values:'."\n" + ."\n" + .'* 1: individual'."\n" + .'* 2: company'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IssueType' => [ + 'description' => 'The type of issue.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Id' => [ + 'description' => 'The ID of the invoice.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '239875502738', + ], + 'BankNo' => [ + 'description' => 'The bank account number.'."\n", + 'type' => 'string', + 'example' => '389576348573296349853476', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CustomerInvoiceList\\": {\\n \\"CustomerInvoice\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 2,\\n \\"AdjustType\\": 1,\\n \\"Bank\\": \\"测试银行\\",\\n \\"StartCycle\\": 202002,\\n \\"TitleChangeInstructions\\": \\"instruction.doc\\",\\n \\"UserId\\": 34565465675,\\n \\"OperatingLicenseAddress\\": \\"某某省某某市某某区某地址\\",\\n \\"InvoiceTitle\\": \\"测试公司\\",\\n \\"UserNick\\": \\"testNick\\",\\n \\"OperatingLicensePhone\\": \\"138xxxxxxxx\\",\\n \\"EndCycle\\": 202003,\\n \\"DefaultRemark\\": \\"PO代码：12984554\\",\\n \\"TaxationLicense\\": \\"taxationLicense.jpg\\",\\n \\"RegisterNo\\": \\"21343245342534\\",\\n \\"GmtCreate\\": \\"2025-02-01 00:00:00\\",\\n \\"TaxpayerType\\": 1,\\n \\"CustomerType\\": 1,\\n \\"IssueType\\": 1,\\n \\"Id\\": 239875502738,\\n \\"BankNo\\": \\"389576348573296349853476\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryInvoicingCustomerListResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <CustomerInvoiceList>\\n <CustomerInvoice>\\n <Status>2</Status>\\n <CustomerType>2</CustomerType>\\n <Id>50000************</Id>\\n <InvoiceTitle>个人</InvoiceTitle>\\n <UserId>169***********</UserId>\\n <GmtCreate>2018-09-07 15:26:20</GmtCreate>\\n <TaxpayerType>2</TaxpayerType>\\n </CustomerInvoice>\\n </CustomerInvoiceList>\\n </Data>\\n</QueryInvoicingCustomerListResponse>","errorExample":""}]', + 'summary' => 'Queries the information about invoice titles.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApplyInvoice' => [ + 'summary' => 'Submits an application for an invoice.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InvoiceAmount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of the invoice. Unit: Cent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '124132', + ], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the customer. Set the ID to the value of the CustomerId parameter returned by calling the QueryInvoicingCustomerList operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '124132423', + ], + ], + [ + 'name' => 'AddressId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the address to which the invoice is delivered. This parameter is required if the invoice is a paper invoice. Set the ID to the value of the AddressId parameter returned by calling the QueryCustomerAddressList operation.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '237958367', + ], + ], + [ + 'name' => 'InvoicingType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the invoice. Valid values:'."\n" + ."\n" + .'* 0: paper invoice'."\n" + .'* 1: electronic invoice'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProcessWay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The channel that is used to process the invoice. A value of 0 indicates that the invoice is processed by Alibaba Cloud. A value of 1 indicates that the invoice is processed by the tax platform. Set the value to 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ApplyUserNick', + 'in' => 'query', + 'schema' => [ + 'description' => 'The nickname of the applicant. The system does not verify the nickname.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'InvoiceByAmount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to invoice by amount. A value of true indicates that the user applies for the invoice based on the InvoiceAmount parameter. A value of false indicates that the user applies for the invoice based on the total amount of the invoicing items.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UserRemark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remarks made by the user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SelectedIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the selected invoicing items. Set the IDs to the IDs returned by calling the QueryEvaluateList operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '384752367', + ], + 'required' => true, + 'example' => '384752367', + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'emails', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'InvoiceApplyId' => [ + 'description' => 'The ID of the application.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1323125534', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InvoiceApplyId\\": 1323125534\\n }\\n}","errorExample":""},{"type":"xml","example":"<ApplyInvoiceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InvoiceApplyId>1323125534</InvoiceApplyId>\\n </Data>\\n</ApplyInvoiceResponse>","errorExample":""}]', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySkuPriceList' => [ + 'summary' => 'Queries the stock keeping units (SKUs) of a service. In most cases, a service has one or more SKUs. A service may even have tens of thousands of SKUs. You can call this operation to query the SKUs of a specific service and the prices of the SKUs. You can configure request parameters to query the specified SKUs based on the configurations of the SKUs.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'PriceEntityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the pricing object.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'instance_type', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to be returned on each page. Maximum value: 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token that is used to retrieve the next page. You do not need to set this parameter if you query coverage details for the first time. The response returns a token that you can use to query coverage details of the next page. If a null value is returned for the NextPageToken parameter, no more coverage details can be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', + ], + ], + [ + 'name' => 'PriceFactorConditionMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The conditions of the pricing factors.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '{"vm_region_no":"cn-shiwei-shenshu"}', + 'description' => 'The key-value pair of the pricing factor.'."\n", + ], + 'description' => 'The values of the pricing factors.'."\n", + ], + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message that is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'SkuPricePage' => [ + 'description' => 'The SKUs of the pricing object.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of SKUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18732', + ], + 'NextPageToken' => [ + 'description' => 'The token that is used to query the next page.'."\n", + 'type' => 'string', + 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', + ], + 'SkuPriceList' => [ + 'description' => 'The SKUs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The SKU.'."\n", + 'type' => 'object', + 'properties' => [ + 'SkuCode' => [ + 'description' => 'The code of the SKU.'."\n", + 'type' => 'string', + 'example' => '017c15a31507bc6de22aa93777461adc', + ], + 'CskuPriceList' => [ + 'description' => 'The prices of the SKUs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The price of the SKU.'."\n", + 'type' => 'object', + 'properties' => [ + 'CskuCode' => [ + 'description' => 'The unique code of the SKU price.'."\n", + 'type' => 'string', + 'example' => 'ac74dd7b52ae6389ddef099283fb8275', + ], + 'Currency' => [ + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'USD' => '', + 'CNY' => '', + ], + 'example' => 'CNY', + ], + 'UsageUnit' => [ + 'description' => 'The usage unit.'."\n", + 'type' => 'string', + 'example' => 'Count'."\n", + ], + 'PriceType' => [ + 'description' => 'The pricing type.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'usagePrice' => '', + 'monthPrice' => '', + 'dayPrice' => '', + 'hourPrice' => '', + 'weekPrice' => '', + 'yearPrice' => '', + 'fixedPrice' => '', + ], + 'example' => 'hourPrice', + ], + 'PriceMode' => [ + 'description' => 'The pricing mode.'."\n", + 'type' => 'string', + 'example' => 'STEP_ARRIVE', + ], + 'Price' => [ + 'description' => 'The price.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'STEP_ACCUMULATION' => '', + 'STEP_ARRIVE' => '', + 'NORMAL_PRICE' => '', + ], + 'example' => '100', + ], + 'PriceUnit' => [ + 'description' => 'The unit of the price.'."\n", + 'type' => 'string', + 'example' => 'USD (per unit)'."\n", + ], + 'RangeList' => [ + 'description' => 'If the PriceMode parameter is set to STEP_ACCUMULATION or STEP_ARRIVE, the value of this field exists and specifies the range. If the PriceMode parameter is set to NORMAL_PRICE, the value of this field is null.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Indicates a pricing object.'."\n", + 'type' => 'object', + 'properties' => [ + 'FactorCode' => [ + 'description' => 'The code of the pricing factor.'."\n", + 'type' => 'string', + 'example' => '212fbd27866307fc79ecf06934a88b2c', + ], + 'Min' => [ + 'description' => 'The minimum value.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Max' => [ + 'description' => 'The maximum value.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Type' => [ + 'description' => 'The closure type of the interval.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'LORC' => '', + 'LCRO' => '', + 'LCRC' => '', + 'LORL' => '', + ], + 'example' => 'LORC', + ], + ], + ], + ], + ], + ], + ], + 'SkuFactorMap' => [ + 'description' => 'The values of the pricing factors.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"vm_region_no","cn-qingdao-nebula"}', + 'description' => 'The key-value pair of the pricing factor.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SkuPricePage\\": {\\n \\"TotalCount\\": 18732,\\n \\"NextPageToken\\": \\"080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332\\",\\n \\"SkuPriceList\\": [\\n {\\n \\"SkuCode\\": \\"017c15a31507bc6de22aa93777461adc\\",\\n \\"CskuPriceList\\": [\\n {\\n \\"CskuCode\\": \\"ac74dd7b52ae6389ddef099283fb8275\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"UsageUnit\\": \\"个\\",\\n \\"PriceType\\": \\"hourPrice\\",\\n \\"PriceMode\\": \\"STEP_ARRIVE\\",\\n \\"Price\\": \\"100\\",\\n \\"PriceUnit\\": \\"美元/个\\",\\n \\"RangeList\\": [\\n {\\n \\"FactorCode\\": \\"212fbd27866307fc79ecf06934a88b2c\\",\\n \\"Min\\": \\"1\\",\\n \\"Max\\": \\"10\\",\\n \\"Type\\": \\"LORC\\"\\n }\\n ]\\n }\\n ],\\n \\"SkuFactorMap\\": {\\n \\"key\\": \\"{ \\\\\\"vm_region_no\\\\\\": \\\\\\"cn-zhangjiakou-na62-a01\\\\\\", \\\\\\"iooptimized\\\\\\": \\\\\\"optimized\\\\\\", \\\\\\"vm_os_kind\\\\\\": \\\\\\"windows\\\\\\", \\\\\\"instance_type\\\\\\": \\\\\\"ecs.i1.xlarge\\\\\\" }\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySkuPriceListResponse>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n <Success>true</Success>\\n <Data>\\n <SkuPricePage>\\n <TotalCount>18732</TotalCount>\\n <NextPageToken>080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332</NextPageToken>\\n <SkuPriceList>\\n <SkuCode>017c15a31507bc6de22aa93777461adc</SkuCode>\\n <CskuPriceList>\\n <CskuCode>ac74dd7b52ae6389ddef099283fb8275</CskuCode>\\n <Currency>CNY</Currency>\\n <UsageUnit>个</UsageUnit>\\n <PriceType>hourPrice</PriceType>\\n <PriceMode>STEP_ARRIVE</PriceMode>\\n <Price>100</Price>\\n <PriceUnit>美元/个</PriceUnit>\\n <RangeList>\\n <FactorCode>212fbd27866307fc79ecf06934a88b2c</FactorCode>\\n <Min>1</Min>\\n <Max>10</Max>\\n <Type>LORC</Type>\\n </RangeList>\\n </CskuPriceList>\\n <SkuFactorMap>\\n <key>{\\"vm_region_no\\",\\"cn-qingdao-nebula\\"}</key>\\n </SkuFactorMap>\\n </SkuPriceList>\\n </SkuPricePage>\\n </Data>\\n</QuerySkuPriceListResponse>","errorExample":""}]', + 'title' => 'QuerySkuPriceList', + ], + 'QueryCommodityList' => [ + 'summary' => 'Queries the information about a service based on the service code.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Success' => [ + 'description' => 'Indicates whether the information about the service was queried.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'NotApplicable', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommodityList' => [ + 'description' => 'The information about the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the service.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => 'The code of the service, which is the same as that on the Billing Management page.'."\n", + 'type' => 'string', + 'example' => 'ecs', + ], + 'CommodityName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'ECS (Pay-As-You-Go)'."\n", + ], + 'ChargeType' => [ + 'description' => 'The payment type. Valid values: POSTPAY (pay-as-you-go) and PREPAY (subscription).'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PREPAY' => '', + 'POSTPAY' => '', + ], + 'example' => 'POSTPAY', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC706AAC-75A6-55B5-9AB7-7D171C6C7655\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NotApplicable\\",\\n \\"Data\\": {\\n \\"CommodityList\\": [\\n {\\n \\"CommodityCode\\": \\"ecs\\",\\n \\"CommodityName\\": \\"云服务器（按量付费）\\",\\n \\"ChargeType\\": \\"POSTPAY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryCommodityList', + 'description' => 'You can call this operation to query the information about a service based on the service code.'."\n", + ], + 'QueryPriceEntityList' => [ + 'summary' => 'Queries the billable items of a service.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message that is returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PriceEntityInfoList' => [ + 'description' => 'The information about the billable items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The billable item.'."\n", + 'type' => 'object', + 'properties' => [ + 'PriceEntityCode' => [ + 'description' => 'The code of the billable item.'."\n", + 'type' => 'string', + 'example' => 'instance_type', + ], + 'PriceEntityName' => [ + 'description' => 'The name of the billable item.'."\n", + 'type' => 'string', + 'example' => 'Elastic Compute Service (ECS) instance'."\n", + ], + 'PriceFactorList' => [ + 'description' => 'The factors of the billable item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The factor of the billable item.'."\n", + 'type' => 'object', + 'properties' => [ + 'PriceFactorCode' => [ + 'description' => 'The code of the factor.'."\n", + 'type' => 'string', + 'example' => 'vm_region_no', + ], + 'PriceFactorName' => [ + 'description' => 'The name of the factor.'."\n", + 'type' => 'string', + 'example' => 'Region'."\n", + ], + 'PriceFactorValueList' => [ + 'description' => 'The values of the factor.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the factor.'."\n", + 'type' => 'string', + 'example' => 'cn-shiwei-shenshu', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PriceEntityInfoList\\": [\\n {\\n \\"PriceEntityCode\\": \\"instance_type\\",\\n \\"PriceEntityName\\": \\"云服务器实例\\",\\n \\"PriceFactorList\\": [\\n {\\n \\"PriceFactorCode\\": \\"vm_region_no\\",\\n \\"PriceFactorName\\": \\"地域\\",\\n \\"PriceFactorValueList\\": [\\n \\"cn-shiwei-shenshu\\"\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryPriceEntityList', + 'description' => 'You can call this operation to query the billable items of a service. A billable item is the minimum unit used to calculate costs.'."\n", + 'responseParamsDescription' => 'A service has one or more billable items, and each billable item has one or more factors.'."\n", + ], + 'DescribePricingModule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service code. You can query the service code by calling the **QueryProductList** operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service. You can query the service type by calling the **QueryProductList** operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C40A8EE0-8084-49FE-B66E-5E1C3B6AE025', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ModuleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Module' => [ + 'description' => 'The pricing information of modules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'description' => 'The name of the pricing module.'."\n", + 'type' => 'string', + 'example' => 'Instance'."\n", + ], + 'PriceType' => [ + 'description' => 'The price type. Valid values:'."\n" + ."\n" + .'* Usage: usage price'."\n" + .'* Hour: hourly price'."\n" + .'* Day: daily price'."\n" + .'* Week: weekly price'."\n" + .'* Month: monthly price'."\n" + .'* Year: annual price'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'Currency' => [ + 'description' => 'The currency. Default value: CNY.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'ModuleCode' => [ + 'description' => 'The code of the pricing module.'."\n", + 'type' => 'string', + 'example' => 'InstanceType', + ], + 'ConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigList' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The pricing attributes that the module depends on.'."\n", + 'type' => 'string', + 'example' => '[ "Region","InstanceType" ]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AttributeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Attribute' => [ + 'description' => 'The module attributes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the attribute.'."\n", + 'type' => 'string', + 'example' => 'DBInstanceStorage', + ], + 'Name' => [ + 'description' => 'The name of the attribute.'."\n", + 'type' => 'string', + 'example' => 'Capacity'."\n", + ], + 'Unit' => [ + 'description' => 'The unit of the attribute.'."\n", + 'type' => 'string', + 'example' => 'GB', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AttributeValue' => [ + 'description' => 'The attribute values.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the attribute value that corresponds to the module code. Valid values:'."\n" + ."\n" + .'* single_float: single value'."\n" + .'* range_float: range value'."\n", + 'type' => 'string', + 'example' => 'single_string', + ], + 'Value' => [ + 'description' => 'The attribute value that corresponds to the module code.'."\n" + ."\n" + .'> If the Type parameter is set to range_float, the valid values of this parameter range from 1024 to 1024000. A value of 1024 indicates that the step size is 1024.'."\n", + 'type' => 'string', + 'example' => 'mysql.n2.medium.1', + ], + 'Remark' => [ + 'description' => 'The description of the module values.'."\n", + 'type' => 'string', + 'example' => 'Connections: 4,000 IOPS is related to storage space'."\n", + ], + 'Name' => [ + 'description' => 'The attribute value that corresponds to the module code.'."\n", + 'type' => 'string', + 'example' => '2 Cores and 4 GB Memory (Basic Edition)'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"RequestId\\": \\"C40A8EE0-8084-49FE-B66E-5E1C3B6AE025\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ModuleList\\": {\\n \\"Module\\": [\\n {\\n \\"ModuleName\\": \\"实例\\",\\n \\"PriceType\\": \\"Month\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"ModuleCode\\": \\"InstanceType\\",\\n \\"ConfigList\\": {\\n \\"ConfigList\\": [\\n \\"[ \\\\\\"Region\\\\\\",\\\\\\"InstanceType\\\\\\" ]\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"AttributeList\\": {\\n \\"Attribute\\": [\\n {\\n \\"Code\\": \\"DBInstanceStorage\\",\\n \\"Name\\": \\"存储空间\\",\\n \\"Unit\\": \\"GB\\",\\n \\"Values\\": {\\n \\"AttributeValue\\": [\\n {\\n \\"Type\\": \\"single_string\\",\\n \\"Value\\": \\"mysql.n2.medium.1\\",\\n \\"Remark\\": \\"连接数：4000 IOPS与存储空间大小有关\\",\\n \\"Name\\": \\"2 核 4GB（单机基础版）\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePricingModuleResponse>\\n <Message>Successful!</Message>\\n <RequestId>C40A8EE0-8084-49FE-B66E-5E1C3B6AE025</RequestId>\\n <Data>\\n <AttributeList>\\n <Attribute>\\n <Values>\\n <AttributeValue>\\n <Type>single_string</Type>\\n <Value>cn-qingdao-cm5-a01</Value>\\n <Name>华北 1</Name>\\n </AttributeValue>\\n </Values>\\n <Code>Region</Code>\\n <Name>地域</Name>\\n </Attribute>\\n </AttributeList>\\n <ModuleList>\\n <Module>\\n <ModuleCode>DataDisk</ModuleCode>\\n <ModuleName>数据盘</ModuleName>\\n <Currency>CNY</Currency>\\n <PriceType>Month</PriceType>\\n <ConfigList>\\n <ConfigList>Region</ConfigList>\\n <ConfigList>DataDisk.Category</ConfigList>\\n </ConfigList>\\n </Module>\\n </ModuleList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribePricingModuleResponse>","errorExample":""}]', + 'summary' => 'Queries the pricing information about an Alibaba Cloud service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryProductList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'QueryTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the total number of services. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '94858229-2758-4663-A7D0-99490D541F15', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The information about all Alibaba Cloud services.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of services.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '449', + ], + 'ProductList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => 'The service definitions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => 'The name of the service.'."\n", + 'type' => 'string', + 'example' => 'CDN (Pay-as-you-go)'."\n", + ], + 'ProductType' => [ + 'description' => 'The type of the service.'."\n", + 'type' => 'string', + 'example' => 'CDN', + ], + 'SubscriptionType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'ProductCode' => [ + 'description' => 'The code of the service.'."\n", + 'type' => 'string', + 'example' => 'cdn', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"RequestId\\": \\"94858229-2758-4663-A7D0-99490D541F15\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 449,\\n \\"ProductList\\": {\\n \\"Product\\": [\\n {\\n \\"ProductName\\": \\"内容分发网络CDN（按量付费）\\",\\n \\"ProductType\\": \\"CDN\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"ProductCode\\": \\"cdn\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryProductListResponse>\\n <Message>Successful!</Message>\\n <RequestId>28D1C9AE-4B16-43AE-9E19-4D3CF36F2A1E</RequestId>\\n <Data>\\n <ProductList>\\n <Product>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <ProductName>NAT共享带宽包（按量付费）</ProductName>\\n <ProductCode>bwp</ProductCode>\\n <ProductType/>\\n </Product>\\n <Product>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <ProductName>内容分发网络CDN（按量付费）</ProductName>\\n <ProductCode>cdn</ProductCode>\\n <ProductType>CDN</ProductType>\\n </Product>\\n </ProductList>\\n <TotalCount>449</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNum>1</PageNum>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryProductListResponse>","errorExample":""}]', + 'summary' => 'Queries the information about all Alibaba Cloud services.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryUserOmsData' => [ + 'summary' => 'Queries the usage data of an Alibaba Cloud service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Table', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service whose usage data you want to query and the details of the usage data. The parameter value is usually set to the code of a service. Various usage models are provided for different services.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time type of the usage data. Set the parameter based on the description in the documentation of the specified service. Valid values:'."\n" + ."\n" + .'* Raw'."\n" + .'* Hour'."\n" + .'* Day'."\n" + .'* Month'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hour', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-20T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-21T12:00:00Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the record from which the usage data starts to return. The usage data records whose names are alphabetically after the value of the Marker parameter are returned. By default, the usage data starts to return from the earliest record.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NextToken', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 200. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The status code returned.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Marker' => [ + 'description' => 'Indicates that the returned usage data starts from the next page. If no value is returned for this parameter or this parameter is not returned, no data can be queried.'."\n", + 'type' => 'string', + 'example' => 'NextToken', + ], + 'HostId' => [ + 'description' => 'The ID of the host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + 'OmsData' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The usage data returned.'."\n", + 'type' => 'object', + 'example' => '[{ "SyncIn": "0", "Bucket": "quota_for_get_service_", "NetworkIn": "0", "PutRequest": "1", "NetworkOut": "0", "GetRequest": "0", "ProcessImgSize": "0", "SyncOut": "0", "Storage": "0", "Region": "ap-northeast-1", "ProviderId": "26842", "CdnIn": "0", "EndTime": "2019-09-03T16:00:00Z", "StartTime": "2019-09-02T16:00:00Z", "StorageType": "standard", "CdnOut": "0"}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotApplicable', + 'errorMessage' => 'This API is not applicable for caller.', + ], + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'This API is not authorized for caller.', + ], + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Marker\\": \\"NextToken\\",\\n \\"HostId\\": \\"cn\\",\\n \\"OmsData\\": [\\n [\\n {\\n \\"SyncIn\\": \\"0\\",\\n \\"Bucket\\": \\"quota_for_get_service_\\",\\n \\"NetworkIn\\": \\"0\\",\\n \\"PutRequest\\": \\"1\\",\\n \\"NetworkOut\\": \\"0\\",\\n \\"GetRequest\\": \\"0\\",\\n \\"ProcessImgSize\\": \\"0\\",\\n \\"SyncOut\\": \\"0\\",\\n \\"Storage\\": \\"0\\",\\n \\"Region\\": \\"ap-northeast-1\\",\\n \\"ProviderId\\": \\"26842\\",\\n \\"CdnIn\\": \\"0\\",\\n \\"EndTime\\": \\"2019-09-03T16:00:00Z\\",\\n \\"StartTime\\": \\"2019-09-02T16:00:00Z\\",\\n \\"StorageType\\": \\"standard\\",\\n \\"CdnOut\\": \\"0\\"\\n }\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryUserOmsDataResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OmsData>\\n <SyncIn>0</SyncIn>\\n <Bucket>quota_for_get_service_</Bucket>\\n <NetworkIn>0</NetworkIn>\\n <PutRequest>1</PutRequest>\\n <NetworkOut>0</NetworkOut>\\n <GetRequest>0</GetRequest>\\n <ProcessImgSize>0</ProcessImgSize>\\n <SyncOut>0</SyncOut>\\n <Storage>0</Storage>\\n <Region>ap-northeast-1</Region>\\n <ProviderId>26842</ProviderId>\\n <CdnIn>0</CdnIn>\\n <EndTime>2019-09-02T16:00:00Z</EndTime>\\n <StartTime>2019-09-01T16:00:00Z</StartTime>\\n <StorageType>standard</StorageType>\\n <CdnOut>0</CdnOut>\\n </OmsData>\\n <OmsData>\\n <SyncIn>0</SyncIn>\\n <Bucket>quota_for_get_service_</Bucket>\\n <NetworkIn>0</NetworkIn>\\n <PutRequest>1</PutRequest>\\n <NetworkOut>0</NetworkOut>\\n <GetRequest>0</GetRequest>\\n <ProcessImgSize>0</ProcessImgSize>\\n <SyncOut>0</SyncOut>\\n <Storage>0</Storage>\\n <Region>ap-northeast-1</Region>\\n <ProviderId>26842</ProviderId>\\n <CdnIn>0</CdnIn>\\n <EndTime>2019-09-03T16:00:00Z</EndTime>\\n <StartTime>2019-09-02T16:00:00Z</StartTime>\\n <StorageType>standard</StorageType>\\n <CdnOut>0</CdnOut>\\n </OmsData>\\n <HostId>cn</HostId>\\n </Data>\\n</QueryUserOmsDataResponse>","errorExample":""}]', + 'title' => 'QueryUserOmsData', + 'description' => 'You can call this operation to query the usage data of an Alibaba Cloud service. Take note of the following items:'."\n" + ."\n" + .'* The service code that you specify for querying the usage data of a specific Alibaba Cloud service must be valid. You can query the usage data by hour or by day.'."\n" + ."\n" + .'* The time that you specify must follow the ISO8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" + ."\n" + .' * Latency exists in data pushes. Therefore, if you set the DataType parameter to Hour, the integrity of usage data recorded in the last 24 hours can be ensured. If you set the DataType parameter to Day, the integrity of usage data recorded in the last two days can be ensured.'."\n" + .' * You can query the usage data that is recorded in the last quarter.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetAllExpirationDay' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'UnifyExpireDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration date. You can set an expiration date only for ECS instances that have not expired. The expiration date that you specify do not take effect on expired ECS instances. After the expiration date is set, the expiration date is used when you renew ECS instances.'."\n" + ."\n" + .'You can set the expiration date to a day from the 1st to the 28th of each month.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The message that is returned.'."\n", + 'type' => 'string', + 'example' => 'The message that is returned', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'The ID of the request', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"请求标识\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>返回信息</Message>\\n<RequestId>请求标识</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'SetAllExpirationDay', + 'summary' => 'Sets an expiration date for all Elastic Compute Service (ECS) instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCostBudgetsSummary' => [ + 'summary' => 'Query the summary information of the user "Cost Management-Budget".', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BudgetName', + 'in' => 'query', + 'schema' => [ + 'title' => '预算名称', + 'description' => 'The name of the budget. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Annual budget'."\n", + ], + ], + [ + 'name' => 'BudgetStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '预算状态', + 'description' => 'The status of the budget. Valid values: overdue and notOverdue. A value of overdue specifies to filter expired budgets. A value of notOverdue specifies to filter budgets that do not expire. By default, if you do not specify this parameter, information about all budgets is to be returned.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'notOverdue' => 'notOverdue', + 'overdue' => 'overdue', + ], + 'example' => 'notOverdue', + ], + ], + [ + 'name' => 'BudgetType', + 'in' => 'query', + 'schema' => [ + 'title' => '预算类型', + 'description' => 'The type of the budget. Valid values: cost, byquantity, and asset. A value of cost specifies to filter expense budgets. A value of byquantity specifies to filter budgets calculated based on the resource usage. A value of asset specifies to filter usage or coverage budgets. By default, information about all budgets is returned if you do not specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cost' => 'cost', + 'byquantity' => 'byquantity', + 'asset' => 'asset', + ], + 'example' => 'cost', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '开始读取的位置', + 'description' => 'The position in which the query starts. You must set this parameter to null or the token that is obtained from the previous query. Otherwise, an error is returned. If you set the NextToken parameter to null, the query starts from the beginning. The default value is null.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '读取的最大数据记录数量', + 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 10. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult<CostBudgetResponse>', + 'description' => 'The result of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下页token', + 'description' => 'The token that is used to retrieve the next page'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数。', + 'description' => 'The maximum number of entries that are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => 'The total number of entries that are returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Items' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BudgetName' => [ + 'description' => 'The name of the budget.'."\n", + 'type' => 'string', + 'example' => 'Annual budget'."\n", + ], + 'BudgetStatus' => [ + 'description' => 'The status of the budget.'."\n", + 'type' => 'string', + 'example' => 'overdue', + ], + 'BudgetType' => [ + 'description' => 'The type of the budget.'."\n", + 'type' => 'string', + 'example' => 'cost', + ], + 'Budget' => [ + 'description' => 'The information about the budget. The BudgetCycleType parameter indicates the cycle of the budget. Valid values: daily, monthly, quarterly, and yearly. The TotalBudgetAmount parameter indicates the total budget. The BudgetMemo parameter indicates the remarks of the budget.'."\n", + 'type' => 'object', + 'enumValueTitles' => [], + 'example' => '{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }', + ], + 'CalculatedValues' => [ + 'description' => 'The information about the estimate-to-actual analysis. The ActualConsumeSum parameter indicates the accumulated actual value. The ActualAddForecastedAmount parameter indicates the sum of accumulated actual value and predicted value. If the BudgetType parameter is set to cost, the sum of actual value and predicted value includes the actual cost incurred from the budget start date to the current date and the predicted cost from the current date to the budget end date. If the BudgetType parameter is set to asset, the sum of actual value and predicted value includes the actual usage or coverage from the budget start date to the budget end date. If the budget end date minus the current date is more than one year, the part that exceeds one year is not included. The ActualAndBudgetComparison parameter indicates the comparison between the actual value and the predicted value. The value of the ActualAndBudgetComparison parameter is calculated based on the following formula: Accumulated actual value/Total budget × 100%.'."\n", + 'type' => 'object', + 'example' => '{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }', + ], + 'ConsumePeriod' => [ + 'description' => 'The information about the billing cycle. The ConsumePeriodBegin parameter indicates the start date of the budget. The ConsumePeriodEnd parameter indicates the end date of the budget.'."\n", + 'type' => 'object', + 'example' => '{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }', + ], + ], + ], + ], + 'HostId' => [ + 'title' => '站点名称', + 'description' => 'The site of the host.'."\n", + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BFC23FE-A182-4D96-A1E4-7521B30B8E43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=\\",\\n \\"MaxResults\\": 5,\\n \\"TotalCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"BudgetName\\": \\"全年预算\\",\\n \\"BudgetStatus\\": \\"overdue\\",\\n \\"BudgetType\\": \\"cost\\",\\n \\"Budget\\": {\\n \\"budgetCycleType\\": \\"monthly\\",\\n \\"budgetMemo\\": \\"\\",\\n \\"totalBudgetAmount\\": 220\\n },\\n \\"CalculatedValues\\": {\\n \\"actualConsumeSum\\": 88.6,\\n \\"actualAddForecastedAmount\\": 89.6,\\n \\"actualAndBudgetComparison\\": \\"20.73%\\"\\n },\\n \\"ConsumePeriod\\": {\\n \\"consumePeriodBegin\\": \\"2022-10\\",\\n \\"consumePeriodEnd\\": \\"2022-11\\"\\n }\\n }\\n ],\\n \\"HostId\\": \\"cn\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCostBudgetsSummaryResponse>\\n <RequestId>3BFC2DDB-2BC5-1AC4-AE39-AA75A6FADE7C</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalCount>75</TotalCount>\\n <NextToken>eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MX0=</NextToken>\\n <MaxResults>1</MaxResults>\\n <Items>\\n <BudgetStatus>notOverdue</BudgetStatus>\\n <ConsumePeriod>\\n <consumePeriodBegin>2022-08</consumePeriodBegin>\\n <consumePeriodEnd>2023-07</consumePeriodEnd>\\n </ConsumePeriod>\\n <Budget>\\n <budgetCycleType>annually</budgetCycleType>\\n <budgetMemo/>\\n <totalBudgetAmount>51752.64</totalBudgetAmount>\\n </Budget>\\n <BudgetName>回归验证-费用预算-按年-当月起1年</BudgetName>\\n <BudgetType>cost</BudgetType>\\n <CalculatedValues>\\n <actualConsumeSum>1189.47</actualConsumeSum>\\n <actualAddForecastedAmount>61883.91</actualAddForecastedAmount>\\n <actualAndBudgetComparison>2.3%</actualAndBudgetComparison>\\n </CalculatedValues>\\n </Items>\\n <HostId>cn</HostId>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribeCostBudgetsSummaryResponse>","errorExample":""}]', + 'title' => 'DescribeCostBudgetsSummary', + 'description' => 'This operation is in beta testing and is only available for specific users in the whitelist. Excessive calls may result in performance issues. For example, the response times out.'."\n", + ], + 'RenewChangeInstance' => [ + 'summary' => '续费变配接口', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-skjdhaskjdh', + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'disk', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bandwidth', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'JASIOFKVNVIXXXXXX', + ], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202407022550621', + ], + 'HostId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100.100.64.1:8150', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotExists', + 'errorMessage' => 'The specific resource is not exists. ', + ], + [ + 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL ', + 'errorMessage' => 'Please complete your basic personal information first. ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError ', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202407022550621\\",\\n \\"HostId\\": \\"100.100.64.1:8150\\"\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'business.aliyuncs.com', + ], + ], +]; |