From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/bssopenapi/2017-12-14/api-docs.php | 22856 ++++++++++++++++++++++++ data/zh_cn/bssopenapi/2023-09-30/api-docs.php | 8681 +++++++++ 2 files changed, 31537 insertions(+) create mode 100644 data/zh_cn/bssopenapi/2017-12-14/api-docs.php create mode 100644 data/zh_cn/bssopenapi/2023-09-30/api-docs.php (limited to 'data/zh_cn/bssopenapi') diff --git a/data/zh_cn/bssopenapi/2017-12-14/api-docs.php b/data/zh_cn/bssopenapi/2017-12-14/api-docs.php new file mode 100644 index 0000000..13f38ef --- /dev/null +++ b/data/zh_cn/bssopenapi/2017-12-14/api-docs.php @@ -0,0 +1,22856 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'BssOpenApi', + 'version' => '2017-12-14', + ], + 'directories' => [ + [ + 'id' => 179160, + 'title' => '资金流水', + 'type' => 'directory', + 'children' => [ + 'QueryAccountBalance', + 'QueryAccountTransactionDetails', + 'QueryAccountTransactions', + ], + ], + [ + 'id' => 116853, + 'title' => '财务关联', + 'type' => 'directory', + 'children' => [ + 'QueryRelationList', + 'QueryPermissionList', + 'GetAccountRelation', + 'AddAccountRelation', + 'ModifyAccountRelation', + 'ConfirmRelation', + 'RelieveAccountRelation', + ], + ], + [ + 'id' => 116859, + 'title' => '资源标签', + 'type' => 'directory', + 'children' => [ + 'QueryInstanceByTag', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 116863, + 'title' => '卡券', + 'type' => 'directory', + 'children' => [ + 'QueryPrepaidCards', + 'QueryRedeem', + 'QueryCashCoupons', + ], + ], + [ + 'id' => 116874, + 'title' => '节省计划', + 'type' => 'directory', + 'children' => [ + 'QuerySavingsPlansInstance', + 'QuerySavingsPlansDeductLog', + 'DescribeSavingsPlansUsageTotal', + 'DescribeSavingsPlansUsageDetail', + 'DescribeSavingsPlansCoverageTotal', + 'DescribeSavingsPlansCoverageDetail', + 'QuerySavingsPlansDiscount', + ], + ], + [ + 'id' => 116881, + 'title' => '虚商配额', + 'type' => 'directory', + 'children' => [ + 'CreateResellerUserQuota', + 'SetResellerUserQuota', + 'ChangeResellerConsumeAmount', + 'QueryResellerAvailableQuota', + 'SetResellerUserAlarmThreshold', + 'QueryResellerUserAlarmThreshold', + 'SetResellerUserStatus', + ], + ], + [ + 'id' => 116886, + 'title' => '虚商账号', + 'type' => 'directory', + 'children' => [ + 'CreateAgAccount', + 'GetCustomerAccountInfo', + 'GetCustomerList', + ], + ], + [ + 'id' => 116890, + 'title' => '资源包', + 'type' => 'directory', + 'children' => [ + 'QueryResourcePackageInstances', + 'QueryDPUtilizationDetail', + 'QueryRIUtilizationDetail', + 'DescribeResourceUsageTotal', + 'DescribeResourceUsageDetail', + 'DescribeResourceCoverageTotal', + 'DescribeResourceCoverageDetail', + 'DescribeResourcePackageProduct', + 'GetResourcePackagePrice', + 'RenewResourcePackage', + 'UpgradeResourcePackage', + ], + ], + [ + 'id' => 116904, + 'title' => '财务账单', + 'type' => 'directory', + 'children' => [ + 'SubscribeBillToOSS', + 'UnsubscribeBillToOSS', + 'QueryBillToOSSSubscription', + 'QueryBillOverview', + 'QueryBill', + 'QueryAccountBill', + 'QuerySettleBill', + 'QueryInstanceBill', + 'DescribeInstanceBill', + 'QueryInstanceGaapCost', + 'DescribeInstanceAmortizedCostByAmortizationPeriod', + 'DescribeProductAmortizedCostByAmortizationPeriod', + 'DescribeInstanceAmortizedCostByConsumePeriod', + 'DescribeProductAmortizedCostByConsumePeriod', + 'DescribeSplitItemBill', + 'QuerySplitItemBill', + ], + ], + [ + 'id' => 116920, + 'title' => '询价', + 'type' => 'directory', + 'children' => [ + 'InquiryPriceRefundInstance', + 'GetPayAsYouGoPrice', + 'GetSubscriptionPrice', + ], + ], + [ + 'id' => 116924, + 'title' => '实例', + 'type' => 'directory', + 'children' => [ + 'QueryAvailableInstances', + 'ReleaseInstance', + 'CreateInstance', + 'ModifyInstance', + 'SetRenewal', + 'ConvertChargeType', + 'RenewInstance', + 'RefundInstance', + ], + ], + [ + 'id' => 116931, + 'title' => '订单', + 'type' => 'directory', + 'children' => [ + 'GetOrderDetail', + 'QueryOrders', + 'CancelOrder', + ], + ], + [ + 'id' => 116935, + 'title' => '财务单元', + 'type' => 'directory', + 'children' => [ + 'CreateCostUnit', + 'AllocateCostUnitResource', + 'DeleteCostUnit', + 'ModifyCostUnit', + 'QueryCostUnit', + 'QueryCostUnitResource', + 'QueryFinancialAccountInfo', + ], + ], + [ + 'id' => 116943, + 'title' => '发票', + 'type' => 'directory', + 'children' => [ + 'QueryEvaluateList', + 'QueryCustomerAddressList', + 'QueryInvoicingCustomerList', + 'ApplyInvoice', + ], + ], + [ + 'id' => 116949, + 'title' => '产品', + 'type' => 'directory', + 'children' => [ + 'QuerySkuPriceList', + 'QueryCommodityList', + 'QueryPriceEntityList', + 'DescribePricingModule', + 'QueryProductList', + ], + ], + [ + 'id' => 169993, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'QueryUserOmsData', + 'SetAllExpirationDay', + 'DescribeCostBudgetsSummary', + 'RenewChangeInstance', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'QueryAccountBalance' => [ + 'summary' => '查询用户账户余额信息。', + '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' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16176743-6DC7-4CB3-BB25-A13982D8DFAD', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AvailableAmount' => [ + 'description' => '可用额度。', + 'type' => 'string', + 'example' => '10000.00', + ], + 'CreditAmount' => [ + 'description' => '信控额度。', + 'type' => 'string', + 'example' => '0.00', + ], + 'MybankCreditAmount' => [ + 'description' => '网商银行信用额度。', + 'type' => 'string', + 'example' => '0.00', + ], + 'Currency' => [ + 'description' => '币种。取值范围：'."\n" + .'- CNY：人民币。'."\n" + .'- USD：美元。'."\n" + .'- JPY：日元。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'AvailableCashAmount' => [ + 'description' => '现金余额。', + 'type' => 'string', + 'example' => '10000.00', + ], + 'QuotaLimit' => [ + 'description' => '生态客户Quota限额', + 'type' => 'string', + 'example' => '10000.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 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":"\\n success\\n 16176743-6DC7-4CB3-BB25-A13982D8DFAD\\n \\n 0.00\\n 0.00\\n CNY\\n -11.19\\n 0.00\\n \\n 200\\n true\\n","errorExample":""}]', + 'title' => '查询用户账户余额信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAccountTransactionDetails' => [ + 'summary' => '查询用户收支明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TransactionNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '交易编号', + 'type' => 'string', + 'required' => false, + 'example' => '410874027490089', + ], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号/账单号', + 'type' => 'string', + 'required' => false, + 'example' => '2022120336190912', + ], + ], + [ + 'name' => 'TransactionChannelSN', + 'in' => 'query', + 'schema' => [ + 'description' => '交易渠道流水号', + 'type' => 'string', + 'required' => false, + 'example' => '2022112122001470591458665933', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间起始', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-20', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间终止', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-20', + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'query', + 'schema' => [ + 'description' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n\n" + .'充值：Payment。'."\n" + ."\n" + .'提现：Withdraw。'."\n" + ."\n" + .'退款：Refund。'."\n" + ."\n" + .'消费：Consumption。'."\n" + ."\n" + .'转账：Transfer。'."\n" + ."\n" + .'调账：Adjust。', + 'type' => 'string', + 'required' => false, + 'example' => 'Payment', + ], + ], + [ + 'name' => 'TransactionChannel', + 'in' => 'query', + 'schema' => [ + 'description' => '交易渠道。 传入以下交易渠道类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'用户余额：AccountBalance。'."\n" + ."\n" + .'银行转账： BankTransfer。'."\n" + ."\n" + .'支付宝：Alipay。'."\n" + ."\n" + .'支付宝花呗：AntCreditPay。'."\n" + ."\n" + .'线下汇款：OfflineRemittance。'."\n" + ."\n" + .'信控额度退款：RegularBankCreditRefund。'."\n" + ."\n" + .'信用卡：CreditCard。'."\n" + ."\n" + .'网商银行信任付：MyBankCredit。'."\n" + ."\n" + .'华夏银行分期付：HuaxiaBankCInstallment。'."\n" + ."\n" + .'苹果支付：ApplePay', + 'type' => 'string', + 'required' => false, + 'example' => 'AccountBalance', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询token', + 'type' => 'string', + 'required' => false, + 'example' => 'ABEDSDS124DASA', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '无效参数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回结果', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '响应状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '结果描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'asadadad-edafafafaasd', + ], + 'Success' => [ + 'description' => '是否成功标识', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '请求结果内容', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页标识', + 'type' => 'string', + 'example' => 'ASHDADS', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MaxResults' => [ + 'description' => '无效参数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AccountName' => [ + 'description' => '账户名', + 'type' => 'string', + 'example' => 'yidi', + ], + 'AccountTransactionsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountTransactionsList' => [ + 'description' => '明细列表', + 'type' => 'array', + 'items' => [ + 'description' => '结果', + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => '账期', + 'type' => 'string', + 'example' => '2022-10', + ], + 'TransactionChannel' => [ + 'description' => '交易渠道', + 'type' => 'string', + 'example' => 'Alipay', + ], + 'RecordID' => [ + 'description' => '订单号/账单号', + 'type' => 'string', + 'example' => '2022120336190912', + ], + 'Remarks' => [ + 'description' => '备注', + 'type' => 'string', + 'example' => '测试', + ], + 'Amount' => [ + 'description' => '金额', + 'type' => 'string', + 'example' => '1.00', + ], + 'TransactionAccount' => [ + 'description' => '对应交易账号', + 'type' => 'string', + 'example' => 'fortune_test@xxx.com', + ], + 'TransactionTime' => [ + 'description' => '交易时间', + 'type' => 'string', + 'example' => '2022-10-01', + ], + 'TransactionType' => [ + 'description' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：Payment。'."\n" + .'提现：Withdraw。'."\n" + .'退款：Refund。'."\n" + .'消费：Consumption。'."\n" + .'转账：Transfer。'."\n" + .'调账：Adjust。', + 'type' => 'string', + 'example' => 'Consumption', + ], + 'TransactionFlow' => [ + 'description' => '收支类型。 传入以下收支类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'收入：Income。'."\n" + .'支出：Expense', + 'type' => 'string', + 'example' => 'Income', + ], + 'FundType' => [ + 'description' => '资金形式。'."\n" + ."\n" + .'现金：Cash。'."\n" + .'保证金：Deposit。'."\n" + .'信控额度退款：RegularBankCreditRefund。'."\n" + .'订单直接支付：DirectPay。', + 'type' => 'string', + 'example' => 'Cash', + ], + 'TransactionChannelSN' => [ + 'description' => '交易渠道流水号', + 'type' => 'string', + 'example' => '123232434343532', + ], + 'TransactionNumber' => [ + 'description' => '交易编号', + 'type' => 'string', + 'example' => '43342334', + ], + 'Balance' => [ + 'description' => '余额', + '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\\": \\"fortune_test@xxx.com\\",\\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"}]', + 'title' => '查询账户交易明细', + ], + 'QueryAccountTransactions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TransactionNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '交易编号。', + 'type' => 'string', + 'required' => false, + 'example' => '133314076', + ], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => [ + 'description' => '订单/账单号。', + 'type' => 'string', + 'required' => false, + 'example' => '20200302', + ], + ], + [ + 'name' => 'TransactionChannelSN', + 'in' => 'query', + 'schema' => [ + 'description' => '交易渠道流水号。', + 'type' => 'string', + 'required' => false, + 'example' => '12342134', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段起，不传时默认是当前时间往前一个月。格式例：2018-01-01T00:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-05T01:46:09Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段止，不传时默认是当前时间。格式例：2018-01-01T00:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-06T01:55:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。不填默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。不填默认20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'query', + 'schema' => [ + 'description' => '交易类型。'."\n" + .'传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + .'- 充值：Payment。'."\n" + .'- 提现：Withdraw。'."\n" + .'- 退款：Refund。'."\n" + .'- 消费：Consumption。'."\n" + .'- 转账：Transfer。'."\n" + .'- 调账：Adjust。', + 'type' => 'string', + 'required' => false, + 'example' => 'Payment', + 'enum' => [ + 'Adjust', + 'Payment', + 'Refund', + 'Withdraw', + 'Consumption', + 'Pay_Fail_Refund', + 'Transfer', + ], + ], + ], + [ + 'name' => 'TransactionFlow', + 'in' => 'query', + 'schema' => [ + 'description' => '收支类型。'."\n" + .'传入以下收支类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + .'- 收入：Income。'."\n" + .'- 支出：Expense。', + 'type' => 'string', + 'required' => false, + 'example' => 'Income', + 'enum' => [ + 'Income', + 'Expense', + ], + ], + ], + [ + 'name' => 'TransactionChannel', + 'in' => 'query', + 'schema' => [ + 'description' => '交易渠道。'."\n" + .'传入以下交易渠道类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + .'- 用户余额：AccountBalance。'."\n" + .'- 银行转账： BankTransfer。'."\n" + .'- 支付宝：Alipay。'."\n" + .'- 支付宝花呗：AntCreditPay。'."\n" + .'- 线下汇款：OfflineRemittance。'."\n" + .'- 信控额度退款：RegularBankCreditRefund。'."\n" + .'- 信用卡：CreditCard。'."\n" + .'- 网商银行信任付：MyBankCredit。'."\n" + .'- 华夏银行分期付：HuaxiaBankCInstallment。'."\n" + .'- 苹果支付：ApplePay', + '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' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8634E02D-0942-4B1D-8295-5352FE9A1F39', + ], + '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' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'AccountTransactionsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountTransactionsList' => [ + 'description' => '流水信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => '账期，格式：YYYY-MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'TransactionChannel' => [ + 'description' => '交易渠道。'."\n" + .'- 用户余额：AccountBalance。'."\n" + .'- 银行转账： BankTransfer。'."\n" + .'- 支付宝：Alipay。'."\n" + .'- 支付宝花呗：AntCreditPay。'."\n" + .'- 线下汇款：OfflineRemittance。'."\n" + .'- 信控额度退款：RegularBankCreditRefund。'."\n" + .'- 信用卡：CreditCard。'."\n" + .'- 网商银行信任付：MyBankCredit。'."\n" + .'- 华夏银行分期付：HuaxiaBankCInstallment。'."\n" + .'- 苹果支付：ApplePay。', + 'type' => 'string', + 'example' => 'AccountBalance', + ], + 'RecordID' => [ + 'description' => '订单号/账单号。', + 'type' => 'string', + 'example' => '2020030242', + ], + 'Remarks' => [ + 'description' => '交易备注。', + 'type' => 'string', + 'example' => 'NAT_GW', + ], + 'Amount' => [ + 'description' => '金额。', + 'type' => 'string', + 'example' => '0', + ], + 'TransactionAccount' => [ + 'description' => '对应交易账号，比如支付宝充值账号或转账对端账号。', + 'type' => 'string', + 'example' => '213562146', + ], + 'TransactionTime' => [ + 'description' => '交易时间。', + 'type' => 'string', + 'example' => '2020-03-10T02:03:20Z', + ], + 'TransactionType' => [ + 'description' => '交易类型。'."\n" + .'- 充值：Payment。'."\n" + .'- 提现：Withdraw。'."\n" + .'- 退款：Refund。'."\n" + .'- 消费：Consumption。'."\n" + .'- 转账：Transfer。'."\n" + .'- 调账：Adjust。', + 'type' => 'string', + 'example' => 'Consumption', + ], + 'TransactionFlow' => [ + 'description' => '收支类型。'."\n" + .'- 收入：Income。'."\n" + .'- 支出：Expense。', + 'type' => 'string', + 'example' => 'Expense', + ], + 'FundType' => [ + 'description' => '资金形式。'."\n" + .'- 现金：Cash。'."\n" + .'- 保证金：Deposit。'."\n" + .'- 信控额度退款：RegularBankCreditRefund。'."\n" + .'- 订单直接支付：DirectPay。', + 'type' => 'string', + 'example' => 'Cash', + ], + 'TransactionChannelSN' => [ + 'description' => '交易渠道流水号。', + 'type' => 'string', + 'example' => '1234354325', + ], + 'TransactionNumber' => [ + 'description' => '交易编号。', + 'type' => 'string', + 'example' => '43342334', + ], + 'Balance' => [ + 'description' => '余额。', + '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\\": \\"test@test.aliyunid.com\\",\\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":"\\n Successful!\\n 8C451EDE-8F92-4896-B4E6-68159A27B0F5\\n \\n 1\\n 20\\n 1\\n \\n \\n Consumption\\n 2020-03\\n 133xxxxxx90112\\n 0.81\\n \\n 2020-03-10T02:03:20Z\\n \\n NAT_GW\\n Cash\\n Expense\\n 2020xxxxx706693\\n 0.00\\n AccountBalance\\n \\n \\n test@test.aliyunid.com\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '账户流水收支明细查询接口', + 'summary' => '查询用户账户流水信息。', + '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' => '阿里云账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1990699401005016', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页大小，默认20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '关系状态列表，状态是RelationshipStatusEnum的枚举值。默认不传值查询当前生效状态。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'RELATED', + ], + 'required' => false, + 'example' => 'RELATED', + 'maxItems' => 8, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '消息说明。'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '7FC5D662-37FD-40A6-85B1-33442D815184', + ], + 'Success' => [ + 'description' => '是否成功。'."\n", + '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' => '100', + ], + 'FinancialRelationInfoList' => [ + 'description' => '关系列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '关系失效时间。为空表示没有失效', + 'type' => 'string', + 'example' => '2021-03-08T15:12Z', + ], + 'RelationType' => [ + 'description' => '关系策略：FinancialManagement表示财务管理，FinancialTrusteeship表示财务托管', + 'type' => 'string', + 'example' => 'FinancialManagement', + ], + 'AccountNickName' => [ + 'description' => '用户显示名称', + 'type' => 'string', + 'example' => 'test4', + ], + 'StartTime' => [ + 'description' => '关系生效时间。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'State' => [ + 'description' => '关系状态。取值是RelationshipStatusEnum的枚举值。', + 'type' => 'string', + 'example' => 'RELATED', + ], + 'AccountId' => [ + 'description' => '阿里云账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1851253838840762', + ], + 'SetupTime' => [ + 'description' => '关系建立时间。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'AccountType' => [ + 'description' => '企业财务账号类型：MASTER和MEMBER。', + 'type' => 'string', + 'example' => 'MEMBER', + ], + 'AccountName' => [ + 'description' => '阿里云账号登录名', + 'type' => 'string', + 'example' => 'caiwuyun_test4', + ], + 'RelationId' => [ + 'description' => '关系ID', + '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":"Successful!\\n7FC5D662-37FD-40A6-85B1-33442D815184\\n\\n 100\\n 20\\n 1\\n \\n 1851253838840762\\n \\n RELATED\\n FinancialManagement\\n 2021-03-02T15:12Z\\n 2021-03-02T15:12Z\\n 51463\\n test4\\n MEMBER\\n caiwuyun_test4\\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '查询企业财务关系列表', + 'summary' => '查询有主子关系权限的账号的成员账号关系列表。', + 'requestParamsDescription' => 'RelationshipStatusEnum类型定义：'."\n" + ."\n" + .'|枚举值|描述|备注|'."\n" + .'|--|:--:|--:|'."\n" + .'|INITIAL|初始化状态|关系未生效|'."\n" + .'|CONFIRMING|邀约状态|关系未生效 |'."\n" + .'|REJECTED|被拒绝状态|关系未生效|'."\n" + .'|CONNECTION_CANCELED|关系解除状态|关系未生效|'."\n" + .'|RELATED|已关联状态|关系已生效|'."\n" + .'|CHANGE_CONFIRMING|生效后变更待确认状态|关系已生效|'."\n" + .'|CONNECTION_MASTER_CANCEL|取消确认状态|关系未生效|'."\n" + ."\n\n" + ."\n\n", + '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' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '消息说明。'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'F6E29451-A3CD-4705-806D-0112D08F5C49', + ], + 'Success' => [ + 'description' => '是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '消息体。'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '关系生效时间。为空表示还没有失效，故没有失效时间。', + 'type' => 'string', + 'example' => '2021-03-06T15:12Z', + ], + 'RelationType' => [ + 'description' => '关系策略：FinancialManagement表示财务管理，FinancialTrusteeship表示财务托管', + 'type' => 'string', + 'example' => 'FinancialManagement', + ], + 'StartTime' => [ + 'description' => '关系生效时间。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'State' => [ + 'description' => '关系状态。取值是RelationshipStatusEnum的枚举值。', + 'type' => 'string', + 'example' => 'RELATED', + ], + 'MasterId' => [ + 'description' => '主账号Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'MemberId' => [ + 'description' => '成员账号Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1851253838840762', + ], + 'SetupTime' => [ + 'description' => '关系建立时间。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'PermissionList' => [ + 'description' => '权限列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '权限失效时间。为空表示权限目前还是生效的。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-05T15:12Z', + ], + 'StartTime' => [ + 'description' => '权限生效时间。符合ISO8601标准的utc时间格式，如2016-05-23T12:00:00Z（为北京时间2016年5月23日20点0分0秒）', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'PermissionCode' => [ + 'description' => '权限Code', + 'type' => 'string', + 'example' => 'allow_synchronize_finance_identity', + ], + 'PermissionName' => [ + 'description' => '权限名', + 'type' => 'string', + 'example' => '主账号 子账号共享主账号信控身份', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"Successful!\\nF6E29451-A3CD-4705-806D-0112D08F5C49\\n\\n 1851253838840762\\n \\n RELATED\\n FinancialManagement\\n 2021-03-02T15:12Z\\n 2021-03-02T15:12Z\\n 1990699401005016\\n \\n \\n 主账号允许子账号共享主账号信控身份\\n 2021-03-02T15:12Z\\n allow_synchronize_finance_identity\\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '查询权限详情', + 'summary' => '根据关系ID查询有主子关系权限的关系的权限列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'RelationshipStatusEnum类型定义：'."\n" + ."\n" + .'|枚举值|描述|备注|'."\n" + .'|--|:--:|--:|'."\n" + .'|INITIAL|初始化状态|关系未生效|'."\n" + .'|CONFIRMING|邀约状态|关系未生效 |'."\n" + .'|REJECTED|被拒绝状态|关系未生效|'."\n" + .'|CONNECTION_CANCELED|关系解除状态|关系未生效|'."\n" + .'|RELATED|已关联状态|关系已生效|'."\n" + .'|CHANGE_CONFIRMING|生效后变更待确认状态|关系已生效|'."\n" + .'|CONNECTION_MASTER_CANCEL|取消确认状态|关系未生效|'."\n", + 'extraInfo' => ' ', + ], + 'GetAccountRelation' => [ + 'summary' => '查询财务关联详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'title' => 'relationId', + 'description' => '账号关联id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'title' => 'requestId', + 'description' => '请求唯一标识，用于标记一次请求，便于定位问题', + 'type' => 'string', + 'required' => false, + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '提示信息', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求标识', + 'type' => 'string', + 'example' => 'RequestId', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'id', + 'description' => '关联id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '关联id', + ], + 'ParentUserId' => [ + 'title' => 'parentUserId', + 'description' => '父账号uid', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '主账号的阿里云UID', + ], + 'ChildUserId' => [ + 'description' => '子账号uid', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '子账号的阿里云账号UID', + ], + 'StartTime' => [ + 'description' => '账号关联开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-11-01', + ], + 'EndTime' => [ + 'description' => '账号关联结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-01', + ], + 'Type' => [ + 'title' => 'type', + 'description' => '关联关系类型', + 'type' => 'string', + 'example' => 'enterprise_group', + ], + 'Status' => [ + 'description' => '账号关联状态：'."\n" + .'RELATED 【已建立关联】'."\n" + .'CONFIRMING 【待对方确认】'."\n" + .'REJECTED 【对方拒绝】'."\n" + .'CONNECTION_CANCELED 【财务子账号取消申请】'."\n" + .'CONNECTION_MASTER_CANCEL【财务主账号取消邀请】'."\n" + .'CHANGE_CONFIRMING 【关系变更待确认中】'."\n" + .'INITIAL 【初始新建关联状态】', + 'type' => 'string', + 'example' => 'RELATED 【已建立关联】', + ], + 'GmtModified' => [ + 'description' => '账号关联更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-01', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '请求状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '请求是否成功标识', + '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' => '查询财务关联', + ], + 'AddAccountRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => '关系类型，目前仅支持enterprise_group', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '主账号的阿里云UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildNick', + 'in' => 'query', + 'schema' => [ + 'description' => '显示名称，用于页面显示，便于明确账号使用场景', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'xxx项目', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号的阿里云账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求唯一标识，用于标记一次请求，便于定位问题', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '32324242444', + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '授予子账号的权限数据，权限点如下：'."\n" + ."\n" + .'- 允许同步信控身份给关联账号:SYNCHRONIZE\\_FINANCE\\_IDENTITY'."\n" + .'- 允许同步优惠给关联账号:SYNCHRONIZE\\_FINANCE\\_DISCOUNT\\_POLICY\\_TO\\_TARGET'."\n" + .'- 禁止关联账户余额提现:FORBID\\_WITHDRAW\\_CASH'."\n" + .'- 禁止关联账户管理发票:FORBID\\_MANAGE\\_INVOICE'."\n" + .'- 请求查看财务关联信息:CHECK\\_FINANCE\\_INFO'."\n" + .'- 允许管理目标发票:MANAGE\\_TARGET\\_INVOICE'."\n" + .'- 允许查看关联账户消费信息:CHECK\\_TARGET\\_CONSUMPTION', + 'type' => 'array', + 'items' => [ + 'description' => '权限点。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + ], + 'required' => false, + 'example' => 'CHECK_TARGET_CONSUMPTION', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '授予子账号角色，目前仅支持财务托管角色(trusteeship)', + 'type' => 'array', + 'items' => [ + 'description' => '财务托管角色。', + 'type' => 'string', + 'required' => false, + 'example' => 'trusteeship', + ], + 'required' => false, + 'example' => 'trusteeship', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '返回信息', + ], + 'RequestId' => [ + 'description' => '请求标识', + 'type' => 'string', + 'example' => '请求标识', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => '请求来源ip', + 'type' => 'string', + 'example' => 'HostId', + ], + 'RelationId' => [ + 'description' => '关联关系id', + '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":"\\n\\n\\n \\n\\n\\ntrue","errorExample":""}]', + 'title' => '创建财务关联', + 'summary' => '创建一个财务关联关系。', + 'description' => '1、具体财务关联业务规则参见[邀请关联账号]( https://help.aliyun.com/document_detail/100376.html)[财务托管协议]( https://www.alibabacloud.com/help/doc-detail/116383.html)。'."\n" + .'2、如果邀约主、子账号实名认证一致，则不需要子账号通过OpenAPI再次确认，否则需要调用ConfirmRelation确认。', + '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' => '关系类型，目前仅支持enterprise_group', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'RelationOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '修改动作'."\n" + .'- 添加：ADD'."\n" + .'- 删除：DELETE', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ADD', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '主账号的阿里云UID'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildNick', + 'in' => 'query', + 'schema' => [ + 'description' => '显示名称，用于页面显示，便于明确账号使用场景', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '用户昵称', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号的阿里云账号UID'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求唯一标识，用于标记一次请求，便于定位问题'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '暂时不支持角色修改', + 'type' => 'array', + 'items' => [ + 'description' => '角色 Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'trusteeship', + ], + 'required' => false, + 'example' => 'trusteeship', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '支持修改的权限点如下：'."\n" + ."\n" + .'- 允许同步信控身份给关联账号：SYNCHRONIZE\\_FINANCE\\_IDENTITY'."\n" + .'- 允许同步优惠给关联账号：SYNCHRONIZE\\_FINANCE\\_DISCOUNT\\_POLICY\\_TO\\_TARGET'."\n" + .'- 禁止关联账户余额提现：FORBID\\_WITHDRAW\\_CASH'."\n" + .'- 禁止关联账户管理发票：FORBID\\_MANAGE\\_INVOICE'."\n" + .'- 请求查看财务关联信息：CHECK\\_FINANCE\\_INFO'."\n" + .'- 允许管理目标发票：MANAGE\\_TARGET\\_INVOICE'."\n" + .'- 允许查看关联账户消费信息：CHECK\\_TARGET\\_CONSUMPTION', + 'type' => 'array', + 'items' => [ + 'description' => '权限点。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + ], + 'required' => false, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '业务状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息', + 'type' => 'string', + 'example' => '返回消息', + ], + 'RequestId' => [ + 'description' => '唯一请求标识', + 'type' => 'string', + 'example' => '48602faf-abbe-4d46-8029-654cc5aead5d', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => '请求来源IP', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + ], + ], + ], + ], + ], + ], + '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":"\\n\\n\\n \\n\\n\\n","errorExample":""}]', + 'title' => '修改财务关联权限点', + 'summary' => '支持添加、删除财务关联权限点。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConfirmRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => '关系类型，目前仅支持enterprise_group', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '主账号阿里云UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ConfirmCode', + 'in' => 'query', + 'schema' => [ + 'description' => '确认动作：'."\n" + ."\n" + .'- 子账号同意：child_agree'."\n" + .'- 子账号拒绝：child_disagree'."\n" + .'- 主账号取消确认：主账号取消确认', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'child_agree', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号阿里云UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '调用请求唯一标识', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '授予子账号的权限数据，权限点如下：'."\n" + .'- 允许同步信控身份给关联账号：SYNCHRONIZE_FINANCE_IDENTITY'."\n" + .'- 允许同步优惠给关联账号：SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET'."\n" + .'- 禁止关联账户余额提现：FORBID_WITHDRAW_CASH'."\n" + .'- 禁止关联账户管理发票：FORBID_MANAGE_INVOICE'."\n" + .'- 请求查看财务关联信息：CHECK_FINANCE_INFO'."\n" + .'- 允许管理目标发票：MANAGE_TARGET_INVOICE'."\n" + .'- 允许查看关联账户消费信息：CHECK_TARGET_CONSUMPTION', + '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' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '51463', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '业务后台状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '返回信息', + ], + 'RequestId' => [ + 'description' => '调用请求唯一标识', + 'type' => 'string', + 'example' => 'request_id', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => '主机ID', + '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":""}]', + 'title' => '确认财务关联', + 'summary' => '子账号确认主账号发起的邀约。', + 'description' => '1、目前只有财务管理关联，在主、子实名认证不一致的情形下，才需要子账号确认'."\n" + .'2、确认的权限点，必须与主账号发起邀约权限点一致才可以确认成功', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RelieveAccountRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => '关系类型，目前仅支持enterprise_group', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'enterprise_group', + ], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '主账号的阿里云UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1738376485192612', + ], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号的阿里云账号UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1512996702208737', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求唯一标识，用于标记一次请求，便于定位问题', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'request_id', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => [ + 'description' => '账号关联id，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'RelationId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息', + 'type' => 'string', + 'example' => '返回消息', + ], + 'RequestId' => [ + 'description' => '唯一请求业务标识', + 'type' => 'string', + 'example' => 'request_id', + ], + 'Success' => [ + 'description' => '请求处理是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => 'hostid', + '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"}]', + 'title' => '解除账号关联', + 'summary' => '解除主、子账号关联。', + ], + 'QueryInstanceByTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型'."\n" + .'instance 节省计划实例', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源id列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'spn-XXXXXX', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => '001', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'param is null', + ], + 'NextToken' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCm', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9EC6C0B7-3397-5FAE-9915-8972CDDB1211', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagResource' => [ + 'description' => '实例信息的列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'spn-xxxxx', + ], + 'ResourceType' => [ + 'description' => '资源类型'."\n" + .'instance 节省计划实例', + 'type' => 'string', + 'example' => 'instance', + ], + 'Tag' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签键值对', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值', + '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"}]', + 'title' => '按标签查询实例', + 'summary' => '根据标签信息查询实例列表。', + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型'."\n" + .'instance 节省计划实例', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源id列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'spn-XXXXXX', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键对应的标签值。可以同时创建n个标签值，n的取值范围：1~20。允许传入空字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值，n的取值范围：1~20。', + 'type' => 'string', + 'required' => true, + 'example' => '001', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', + ], + 'Success' => [ + 'description' => '是否成功', + '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"}]', + 'title' => '为资源添加标签', + 'summary' => '支持添加资源上配置的标签。', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型'."\n" + .'instance 节省计划实例', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'instance', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全部删除，仅当未传入tagkey.n时有效。取值范围：-true-false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源id列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'spn-xxxxxx', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。N的取值范围为1~20。', + 'type' => 'string', + 'required' => false, + 'example' => 'codename', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值信息', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'Data' => [ + 'description' => '返回数据'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', + ], + 'Success' => [ + 'description' => '是否成功', + '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"}]', + 'title' => '取消资源的标签', + 'summary' => '取消资源上配置的标签。', + ], + 'QueryPrepaidCards' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '卡包过期结束时间止，格式：yyyy-mm-ddhh:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01 00:00:00', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '卡包过期时间起，格式：yyyy-mm-dd。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01 00:00:00', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => '卡包是否生效。取值范围：-true。-false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '7EA6C02D-06D0-4213-9C3B-E67910F7D1EB', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PrepaidCard' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '取值：'."\n" + .'- Available：有效'."\n" + .'- Expired：过期'."\n" + .'- Cancelled：作废', + 'type' => 'string', + 'example' => 'Available', + ], + 'ExpiryTime' => [ + 'description' => '卡包失效时间。', + 'type' => 'string', + 'example' => '2019-08-04 01:39:11', + ], + 'GrantedTime' => [ + 'description' => '卡包发放时间。', + 'type' => 'string', + 'example' => '2019-08-04 01:39:11', + ], + 'NominalValue' => [ + 'description' => '面额。', + 'type' => 'string', + 'example' => '100.00', + ], + 'EffectiveTime' => [ + 'description' => '卡包生效时间。', + 'type' => 'string', + 'example' => '2019-08-04 01:39:11', + ], + 'PrepaidCardNo' => [ + 'description' => '卡包编码。', + 'type' => 'string', + 'example' => 'Q-7edaab979fc9', + ], + 'ApplicableScenarios' => [ + 'description' => '适用场景描述。', + 'type' => 'string', + 'example' => '阿里云按量付费账单,阿里云新购', + ], + 'PrepaidCardId' => [ + 'description' => '卡包id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '213432432', + ], + 'ApplicableProducts' => [ + 'description' => '适用产品描述。', + 'type' => 'string', + 'example' => '通用', + ], + 'Balance' => [ + 'description' => '剩余金额。', + '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"}]', + 'title' => '账户卡包查询', + 'summary' => '查询用户卡包信息。', + ], + 'QueryRedeem' => [ + 'summary' => '查询用户提货券信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '失效开始时间。格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '失效结束时间。格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => '提货券是否生效：'."\n" + .'- true。'."\n" + .'- false。'."\n" + ."\n" + .'默认false。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。每页条数不允许超过300', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Redeem' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Redeem' => [ + 'description' => '提货券详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiryTime' => [ + 'description' => '提货券失效时间。', + 'type' => 'string', + 'example' => '2018-06-13 20:25:00', + ], + 'GrantedTime' => [ + 'description' => '提货券发行时间。', + 'type' => 'string', + 'example' => '2018-05-14 20:25:00', + ], + 'Status' => [ + 'description' => '提货券状态，取值：'."\n" + .'- Generated：已生成。'."\n" + .'- CallBack：已回调。'."\n" + .'- RefundPending：提货券退款中。'."\n" + .'- Canceled：提货券已作废。'."\n" + .'- Order_Canceled：订单已作废。'."\n" + .'- ActivePending：激活中，请稍后。'."\n" + .'- ActiveSuccess：激活成功。'."\n" + .'- ExchangePending：兑换中。'."\n" + .'- ExchangeSuccess：兑换成功。'."\n" + .'- Expired：已过期。'."\n" + .'- Invalid：已作废。', + 'type' => 'string', + 'example' => 'Generated', + ], + 'Specification' => [ + 'description' => '提货券规格。', + 'type' => 'string', + 'example' => '无', + ], + 'NominalValue' => [ + 'description' => '面额。', + 'type' => 'string', + 'example' => '0', + ], + 'EffectiveTime' => [ + 'description' => '提货券生效时间。', + 'type' => 'string', + 'example' => '2018-05-14 20:25:00', + ], + 'RedeemId' => [ + 'description' => '提货券ID。', + 'type' => 'string', + 'example' => '1342', + ], + 'RedeemNo' => [ + 'description' => '提货券Number。', + 'type' => 'string', + 'example' => '4889*****1610', + ], + 'ApplicableProducts' => [ + 'description' => '适用产品。', + 'type' => 'string', + 'example' => '云服务器', + ], + 'Balance' => [ + 'description' => '余额。', + '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":"\\n Successful!\\n E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B\\n \\n 0\\n 10\\n 1\\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '查询提货券服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCashCoupons' => [ + 'summary' => '查询用户代金券信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '代金券终止过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', + 'type' => 'string', + 'required' => false, + 'example' => '2018-08-01T00:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '代金券起始过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', + 'type' => 'string', + 'required' => false, + 'example' => '2018-09-01T00:00:00Z', + ], + ], + [ + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => [ + 'description' => '代金券是否生效。取值范围：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '执行结果说明', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '147B566E-DB4C-4E43-BDBB-5DB1D9D268DB', + ], + 'Success' => [ + 'description' => '是否调用成功。true：调用成功，false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CashCoupon' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '取值：'."\n" + .'- Available：有效'."\n" + .'- Expired：过期'."\n" + .'- Cancelled：作废', + 'type' => 'string', + 'example' => 'Available', + ], + 'ExpiryTime' => [ + 'description' => '代金券过期时间', + 'type' => 'string', + 'example' => '2018-08-10T00:00:00Z', + ], + 'GrantedTime' => [ + 'description' => '代金券发放时间', + 'type' => 'string', + 'example' => '2018-08-02T15:15:50Z', + ], + 'NominalValue' => [ + 'description' => '面额', + 'type' => 'string', + 'example' => '100.00', + ], + 'EffectiveTime' => [ + 'description' => '代金券生效时间', + 'type' => 'string', + 'example' => '2018-08-02T15:15:50Z', + ], + 'ApplicableScenarios' => [ + 'description' => '适用场景描述', + 'type' => 'string', + 'example' => '阿里云按量付费账单,阿里云新购', + ], + 'CashCouponId' => [ + 'description' => '代金券ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34534253254325', + ], + 'ApplicableProducts' => [ + 'description' => '适用产品描述', + 'type' => 'string', + 'example' => '通用', + ], + 'CashCouponNo' => [ + 'description' => '代金券编码', + 'type' => 'string', + 'example' => 'Q-b1485def8f04a', + ], + 'Balance' => [ + 'description' => '余额', + 'type' => 'string', + 'example' => '100.00', + ], + 'Description' => [ + 'description' => '备注', + 'type' => 'string', + 'example' => '该代金券用于产品功能验证的测试', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询用户代金券信息', + ], + 'QuerySavingsPlansInstance' => [ + 'summary' => '查询当前用户保有的节省计划实例信息。', + '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' => '每页个数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => '多语言信息'."\n" + ."\n" + .'- ZH 中文'."\n" + .'- EN 英文', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ZH', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '节省计划实例ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn-xxxxxxx', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2020-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签元素列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签元素', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签查询键', + 'type' => 'string', + 'required' => false, + 'example' => '测试标签', + ], + 'Value' => [ + 'description' => '标签查询值', + 'type' => 'string', + 'required' => false, + 'example' => '测试标签', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态：'."\n" + .'NORMAL:有效'."\n" + .'RELEASE 失效', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品Code', + 'type' => 'string', + 'required' => false, + 'example' => 'savingplan_common_public_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值对象', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + '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' => '100', + ], + 'Items' => [ + 'description' => '实例信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前状态'."\n" + ."\n" + .'- NORMAL 正常状态'."\n" + ."\n" + .'- LIMIT 欠费停机'."\n" + ."\n" + .'- RELEASE 释放', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Cycle' => [ + 'description' => '购买年限', + 'type' => 'string', + 'example' => '1:Year', + ], + 'StartTimestamp' => [ + 'description' => '开始时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663135741039', + ], + 'SavingsType' => [ + 'description' => '节省计划类型：'."\n" + ."\n" + .'- unversal 通用型'."\n" + .'- ecs 计算型', + 'type' => 'string', + 'example' => 'ECS', + ], + 'Utilization' => [ + 'description' => '总使用率', + 'type' => 'string', + 'example' => '1.0', + ], + 'PrepayFee' => [ + 'description' => '预付金额,单位:元', + 'type' => 'string', + 'example' => '8760.00', + ], + 'InstanceId' => [ + 'description' => '节省计划实例ID', + 'type' => 'string', + 'example' => 'spn-xxxxxxxx', + ], + 'Currency' => [ + 'description' => '货币单位：CNY人民币 USD美元', + 'type' => 'string', + 'example' => 'CNY', + ], + 'EndTimestamp' => [ + 'description' => '结束时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663135741039', + ], + 'EndTime' => [ + 'description' => '实例失效时间，格式 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2021-01-01 00:00:00', + ], + 'StartTime' => [ + 'description' => '实例生效时间，格式 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'example' => '2020-01-01 00:00:00', + ], + 'AllocationStatus' => [ + 'description' => '分配状态：'."\n" + .'- unallocated 未分配'."\n" + .'- allocated 分配中'."\n" + .'- beAllocated 被分配中'."\n", + 'type' => 'string', + 'example' => 'unallocated', + ], + 'InstanceFamily' => [ + 'description' => '如果是ECS型实例，表示对应的规格族信息或者规格族套餐信息', + 'type' => 'string', + 'example' => 'ecs.g6', + ], + 'Region' => [ + 'description' => '地域信息', + 'type' => 'string', + 'example' => 'cn-zhangjiakou-na62-a01', + ], + 'LastBillTotalUsage' => [ + 'description' => '上一周期抵扣总金额，单位:元', + 'type' => 'string', + 'example' => '100.0', + ], + 'LastBillUtilization' => [ + 'description' => '上一周期使用率', + 'type' => 'string', + 'example' => '0.8', + ], + 'TotalSave' => [ + 'description' => '总节省金额，单位:元', + 'type' => 'string', + 'example' => '20.00', + ], + 'PoolValue' => [ + 'description' => '承付款，单位:元', + 'type' => 'string', + 'example' => '1.00', + ], + 'PayMode' => [ + 'description' => '付款类型：'."\n" + ."\n" + .'- total 全预付'."\n" + .'- half 半预付'."\n" + .'- zero 0预付', + 'type' => 'string', + 'example' => 'total', + ], + 'Tags' => [ + 'description' => '标签信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签元素', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => '标签1', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => '标签1', + ], + ], + ], + ], + 'DeductCycleType' => [ + 'description' => '抵扣周期类型：'."\n" + .'HOUR：小时'."\n" + .'DAY：天'."\n" + .'ONCE：一次性（总量递减）', + 'type' => 'string', + 'example' => 'HOUR', + ], + 'RestPoolValue' => [ + 'description' => '弹性版，按月，按天保底当前周期剩余金额，单位:元', + 'type' => 'string', + 'example' => '100.0', + ], + 'CommodityCode' => [ + 'description' => '商品Code', + '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":"Successful\\n61293E7A-3406-4447-8620-EC88B0AA66AD\\n\\n 100\\n 20\\n 1\\n \\n NORMAL\\n unallocated\\n 2021-01-01 00:00:00\\n ecs.g6\\n spn-xxxxxxxx\\n 2020-01-01 00:00:00\\n 20.00\\n 8760.00\\n total\\n 1.0\\n CNY\\n 1.00\\n cn-zhangjiakou-na62-a01\\n ECS\\n \\n 标签1\\n 标签1\\n \\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '节省计划实例查询', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySavingsPlansDeductLog' => [ + 'summary' => '查询节省计划抵扣的明细数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型：'."\n" + ."\n" + .'- spn 节省计划实例'."\n" + ."\n" + .'- product 抵扣云产品实例', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => '多语言选项，默认返回中文'."\n" + .'ZH 中文'."\n" + .'EN 英文', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ZH', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'spn-XXXXXXX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-01-05 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => '请校验入参正确性', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + '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', + ], + 'Items' => [ + 'description' => '抵扣明细列表', + 'type' => 'array', + 'items' => [ + 'description' => '抵扣明细数据', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2020-12-01 01:00:00', + ], + 'StartTime' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2020-12-01 00:00:00', + ], + 'SavingsType' => [ + 'description' => '节省计划类型：'."\n" + ."\n" + .'- universal 通用型 '."\n" + .'- ecs 计算型', + 'type' => 'string', + 'example' => 'ecs', + ], + 'UserId' => [ + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'DiscountRate' => [ + 'description' => '当前抵扣使用的折扣率', + 'type' => 'string', + 'example' => '0.069', + ], + 'BillModule' => [ + 'description' => '抵扣计费项', + 'type' => 'string', + 'example' => '云服务器配置', + ], + 'InstanceId' => [ + 'description' => '节省计划实例ID', + 'type' => 'string', + 'example' => 'spn-xxxxxxx', + ], + 'DeductInstanceId' => [ + 'description' => '被抵扣云产品实例ID', + 'type' => 'string', + 'example' => 'i-XXXXXXXXX', + ], + 'DeductCommodity' => [ + 'description' => '抵扣商品', + 'type' => 'string', + 'example' => '云服务器ECS-按量付费', + ], + 'DeductRate' => [ + 'description' => '抵扣率', + 'type' => 'string', + 'example' => '1.0', + ], + 'DeductFee' => [ + 'description' => '抵扣费用，单位:元', + 'type' => 'string', + 'example' => '0.52', + ], + 'OwnerId' => [ + 'description' => '所有者ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'BillingCycle' => [ + 'title' => '账期', + 'description' => '账期', + 'type' => 'string', + 'example' => '202312', + ], + 'Region' => [ + 'title' => '被抵扣实例地域', + 'description' => '被抵扣实例地域', + 'type' => 'string', + 'example' => 'cn-shanghai-eu13-a01', + ], + 'InstanceSpec' => [ + 'title' => '被抵扣实例规格', + 'description' => '被抵扣实例规格', + 'type' => 'string', + 'example' => 'ecs.g7.xlarge', + ], + 'InstanceTypeFamily' => [ + 'title' => '被抵扣实例规格族', + 'description' => '被抵扣实例规格族', + 'type' => 'string', + 'example' => 'ecs.g7', + ], + 'BillingOfficialPrice' => [ + 'title' => '被抵扣账单的官网价', + 'description' => '被抵扣账单的官网价，单位:元', + 'type' => 'string', + 'example' => '375.35', + ], + 'DeductedOfficialPrice' => [ + 'title' => '被抵扣部分官网价', + 'description' => '被抵扣部分官网价，单位:元', + 'type' => 'string', + 'example' => '375.37', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '节省计划抵扣明细查询', + ], + 'DescribeSavingsPlansUsageTotal' => [ + 'summary' => '节省计划使用率汇总查询', + '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' => '要查询的时间范围的开始。开始时间包含在时​​间范围内。时间格式 yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的时间范围的结束时间。不包含结束时间。如果不设置该参数，则结束时间为当前时间。时间格式 yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询使用情况摘要的时间粒度。有效值枚举：MONTH、DAY、HOUR。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + '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', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '接口调用信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的查询数据', + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => '每个时间端的使用率数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Period' => [ + 'description' => '数据所属时间段，格式 yyyyMMddHH.', + 'type' => 'string', + 'example' => '2021041500', + ], + ], + ], + ], + 'TotalUsage' => [ + 'description' => '总使用率概览', + 'type' => 'object', + 'properties' => [ + 'PostpaidCost' => [ + 'description' => '后付费价格', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'SavedCost' => [ + 'description' => '节省的金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UsagePercentage' => [ + 'description' => '总使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PoolValue' => [ + 'description' => '节省计划的总量', + '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":"\\n success\\n Successful!\\n 79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\n true\\n \\n \\n 1\\n 2021041500\\n \\n \\n 200\\n 100\\n 1\\n 100\\n \\n \\n","errorExample":""}]', + 'title' => '节省计划使用率汇总', + ], + 'DescribeSavingsPlansUsageDetail' => [ + 'summary' => '节省计划使用率明细查询', + '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' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询使用情况摘要的时间粒度。枚举值：MONTH：月维度； DAY：天维度； HOUR：小时维度。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '如果为空查询当前账号及其托管子账号的数据，可传入托管子账号ID，明确查询该子账号数据。', + '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', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求标识', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数据个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'NextToken' => [ + 'description' => '下一页token', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9', + ], + 'Items' => [ + 'description' => '数据项', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前状态'."\n" + ."\n" + .'-1: 欠费、1: 生效', + 'type' => 'string', + 'example' => '-1', + ], + 'Type' => [ + 'description' => '类型：通用型、ECS计算型', + 'type' => 'string', + 'example' => '通用型', + ], + 'UsagePercentage' => [ + 'description' => '使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'UserId' => [ + 'description' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123745698925000', + ], + 'InstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'spn-a1fhs54c243hP22', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'PostpaidCost' => [ + 'description' => '按量标准费用', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.2', + ], + 'DeductValue' => [ + 'description' => '节省计划已支出，即已使用承付款', + 'type' => 'number', + 'format' => 'float', + 'example' => '3.94', + ], + 'StartPeriod' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2021-08-01 00:00:00', + ], + 'SavedCost' => [ + 'description' => '节省净额', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.08', + ], + 'PoolValue' => [ + 'description' => '节省计划总金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '29.84', + ], + 'UserName' => [ + 'description' => '账号名称', + 'type' => 'string', + 'example' => 'test13@test.aliyun.com', + ], + 'EndPeriod' => [ + 'description' => '结束时间', + '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\\": \\"test13@test.aliyun.com\\",\\n \\"EndPeriod\\": \\"2021-08-09 00:00:00\\"\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => '节省计划使用率明细', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSavingsPlansCoverageTotal' => [ + 'summary' => '节省计划覆盖率汇总查询。', + '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' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-07-15 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-20 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + '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', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求标识', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => '时段覆盖率', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Period' => [ + 'description' => '时段'."\n" + .'yyyyMMddHH', + 'type' => 'string', + 'example' => '2021071500', + ], + ], + ], + ], + 'TotalCoverage' => [ + 'description' => '总覆盖率', + 'type' => 'object', + 'properties' => [ + 'CoveragePercentage' => [ + 'description' => '总覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductAmount' => [ + 'description' => '总抵扣金额', + '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' => '节省计划覆盖率汇总', + ], + 'DescribeSavingsPlansCoverageDetail' => [ + 'summary' => '节省计划覆盖率明细查询。', + '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' => '要查询的时间范围的开始。开始时间包含在时​​间范围内。时间格式 yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的时间范围的结束时间。不包含结束时间。如果不设置该参数，则结束时间为当前时间。时间格式 yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询使用情况摘要的时间粒度。有效值枚举：MONTH、DAY、HOUR。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的最大个数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + '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', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + 'required' => false, + ], + 'SelectType' => [ + 'type' => 'string', + 'required' => false, + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '接口调用信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的查询数据', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数据个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NextToken' => [ + 'description' => '下一页的token', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'Items' => [ + 'description' => '数据项', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '用户id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'OwnerId' => [ + 'description' => '被抵扣商品所有者ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1906589291020438', + ], + 'InstanceId' => [ + 'description' => '实例id', + 'type' => 'string', + 'example' => 'i-bp1d9x623987rlj0dx4xx', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'InstanceSpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'PostpaidCost' => [ + 'description' => '按量成本', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'CoveragePercentage' => [ + 'description' => '覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'Region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'DeductAmount' => [ + 'description' => '抵扣金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '5.5', + ], + 'StartPeriod' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2023-04-01 00:00:00', + ], + 'TotalAmount' => [ + 'description' => '总支出', + 'type' => 'number', + 'format' => 'float', + 'example' => '6.11', + ], + 'UserName' => [ + 'description' => '用户账号名', + 'type' => 'string', + 'example' => 'xxx@test.aliyunid.com', + ], + 'EndPeriod' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2023-05-01 00: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\\": \\"xxx@test.aliyunid.com\\",\\n \\"EndPeriod\\": \\"2023-05-01 00:00:00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '节省计划覆盖率明细', + ], + 'QuerySavingsPlansDiscount' => [ + 'summary' => '查询节省计划折扣信息列表。', + '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' => '模块CODE', + 'type' => 'string', + 'required' => false, + 'example' => 'instance_type', + ], + ], + [ + 'name' => 'PayMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'payMode', + 'description' => '付费类型:'."\n" + .'total 全预付'."\n" + .'half 半预付'."\n" + .'zero 0预付', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'zero' => '0预付', + 'total' => '全预付', + 'half' => '半预付', + ], + 'example' => 'total', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'pageSize', + 'description' => '每页个数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SpnType', + 'in' => 'query', + 'schema' => [ + 'title' => 'spnType', + 'description' => '节省计划类型:'."\n" + .'ecs 计算型'."\n" + .'universal 通用型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ecs' => '计算型', + 'universal' => '通用型', + ], + 'example' => 'universal', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'title' => 'locale', + 'description' => '多语言标识', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EN' => '英文', + 'ZH' => '中文', + ], + 'example' => 'ZH', + ], + ], + [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => [ + 'title' => 'cycle', + 'description' => '查询周期', + 'type' => 'string', + 'required' => true, + 'example' => '1:Year', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'title' => 'pageNum', + 'description' => '查询页数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'title' => 'spec', + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'commodityCode', + 'description' => '商品CODE', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => '地域信息', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SpnCommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '节省计划商品Code', + 'type' => 'string', + 'required' => false, + 'example' => 'savingplan_common_public_cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => '结果', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => '请求IP', + 'type' => 'string', + 'example' => '100.104.180.109', + ], + 'Items' => [ + 'description' => '折扣信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '折扣明细', + 'type' => 'object', + 'properties' => [ + 'CommodityName' => [ + 'description' => '产品明细'."\n", + 'type' => 'string', + 'example' => '云服务器ECS-按量付费', + ], + 'ModuleName' => [ + 'description' => '计价模块名称。', + 'type' => 'string', + 'example' => '实例', + ], + 'SpnType' => [ + 'description' => '节省计划类型', + 'type' => 'string', + 'example' => 'universal', + ], + 'PayMode' => [ + 'description' => '付款类型：'."\n" + ."\n" + .'- total 全预付'."\n" + .'- half 半预付'."\n" + .'- zero 0预付', + 'type' => 'string', + 'example' => 'total', + ], + 'Cycle' => [ + 'description' => '查询周期', + 'type' => 'string', + 'example' => '1:Year', + ], + 'Region' => [ + 'description' => '地域信息', + 'type' => 'string', + 'example' => '张家口', + ], + 'RegionCode' => [ + 'description' => '实例所在地域ID，您可以调用[DescribeDBInstanceAttribute](~~26231~~)查询。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Spec' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ecs.g6', + ], + 'DiscountRate' => [ + 'description' => '官网折扣率', + 'type' => 'string', + 'example' => '0.85', + ], + 'ContractDiscountRate' => [ + 'description' => '合同折扣率', + 'type' => 'string', + 'example' => '0.85', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '错误码', + 'type' => 'string', + 'example' => 'PARAM_ERROR', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '调用是否成功', + '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' => '查询节省计划折扣明细', + ], + 'CreateResellerUserQuota' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '金额，单位元[Quota开户必填]', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => '币种名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CNY：人民币。USD：美元。JPY：日元。', + ], + ], + [ + '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' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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"}]', + 'title' => '创建配额账本和消费账本', + 'summary' => '创建用户 Quota 配额账本和 Quota 消费账本。', + ], + 'SetResellerUserQuota' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '金额，单位元', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '750', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => '币种类型', + 'type' => 'string', + 'required' => false, + 'example' => ' CNY：人民币。 USD：美元', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务id', + 'type' => 'string', + 'required' => false, + 'example' => 'OD2022040818295234777795624764689', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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' => '设置用户配额账本的Quota额度', + 'summary' => '创建用户quota配额账本和quota消费账本', + 'description' => '设置用户配额账本的Quota额度', + ], + 'ChangeResellerConsumeAmount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AdjustType', + 'in' => 'query', + 'schema' => [ + 'description' => '消费金额调整方向 increase:增加,用户消费增加金额 decrease:减少,用户充值减少金额 [必填]', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'increase/decrease', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '调整金额,单位为元,金额必须大于0。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10.00', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => [ + 'description' => '币种', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CNY', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'quota_amount_adjust', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源，填写系统名称即可', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'system', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部业务主键ID，用于做幂等性校验使用', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1647396865', + ], + ], + [ + 'name' => 'ExtendMap', + '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', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '修改后对应的quota账本消费额度', + 'type' => 'string', + 'example' => '300.00', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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"}]', + 'title' => '进行用户 Quota 消费抵扣', + 'description' => '进行用户 Quota 消费抵扣。', + ], + 'QueryResellerAvailableQuota' => [ + 'summary' => '查询用户（代付场景下设置消费配额）的当前可用配额余额信息。', + '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' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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"}]', + 'title' => '查询当前可用配额余额信息', + ], + 'SetResellerUserAlarmThreshold' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AlarmType', + 'in' => 'query', + 'schema' => [ + 'description' => '预警类型：quota_low_balance（代表Quota低额预警）', + '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' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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"}]', + 'title' => '设置Quota额度低额预警规则', + 'description' => '设置Quota额度低额预警规则。', + ], + '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' => '预警类型[必填,quota_low_balance:Quota低额预警]', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'quota_low_balance' => 'quota_low_balance', + ], + 'example' => 'quota_low_balance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ThresholdType' => [ + 'title' => '报警类型 0 数值 1比例 其他默认为 数值', + 'description' => '报警类型：0（数值）、1（比例）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ThresholdAmount' => [ + 'title' => '预警额度 为0有效', + 'description' => '预警额度（预警类型为0时有效）', + 'type' => 'string', + 'example' => '100', + ], + 'Numerator' => [ + 'title' => '预警百分比_分子 为1有效', + 'description' => '预警百分比，代表分子数值（预警类型为1时有效）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Denominator' => [ + 'title' => '预警百分比_分母 为1有效', + 'description' => '预警百分比，代表分母数值（预警类型为1时有效）', + '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' => '本次调用返回code，一般为错误代码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '本次调用返回的消息，一般为错误消息', + 'description' => '本次调用返回的消息，一般为错误消息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + '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"}]', + 'title' => '查询Quota额度低额预警规则', + 'description' => '查询 Quota 额度低额预警规则', + ], + 'SetResellerUserStatus' => [ + 'summary' => '开启或关闭用户sql审计功能', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '需要设置的用户状态'."\n" + .'取值：'."\n" + .' Freeze：用户冻结状态'."\n" + .' Thaw：用户解冻状态'."\n" + .' Trusteeship：用户托管状态'."\n" + .' TrusteeshipCancel：用户非托管状态', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Freeze', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型'."\n" + .'取值：'."\n" + .' FREEZE：用户冻结业务'."\n" + .' TRUSTEESHIP：用户托管业务', + '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' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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"}]', + 'title' => '设置托管、冻结状态', + 'description' => '根据上传参数设置托管、冻结状态。', + ], + 'CreateAgAccount' => [ + 'summary' => '创建一个财务关联关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'LoginEmail', + 'in' => 'query', + 'schema' => [ + 'description' => '登录邮箱', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'email', + ], + ], + [ + 'name' => 'AccountAttr', + 'in' => 'query', + 'schema' => [ + 'description' => '新增账号属性，需要在控制台的顶部菜单栏，单击账号属性，跳转至**安全设置**页面查看。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'EnterpriseName', + 'in' => 'query', + 'schema' => [ + 'description' => '企业名称（统一社会信用代码对应的企业名）。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云测试有限公司', + ], + ], + [ + 'name' => 'FirstName', + 'in' => 'query', + 'schema' => [ + 'description' => '一级分类名称。', + 'type' => 'string', + 'required' => false, + 'example' => '志成', + ], + ], + [ + 'name' => 'LastName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的姓。'."\n" + ."\n" + .'长度：最大64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '吴', + ], + ], + [ + 'name' => 'NationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '国家码', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'ProvinceName', + 'in' => 'query', + 'schema' => [ + 'description' => '省份名称（非必填）。', + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + ], + [ + 'name' => 'CityName', + 'in' => 'query', + 'schema' => [ + 'description' => '城市名称（英文）。', + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + ], + [ + 'name' => 'Postcode', + 'in' => 'query', + 'schema' => [ + 'description' => '邮编', + 'type' => 'string', + 'required' => false, + 'example' => '350000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'LOGIN_EMAIL_HAS_BEEN_USED', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'loginEmail=685741089H@chinaunicom.cn,has used', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AgRelationDto' => [ + 'description' => 'MPK与PK的二级关系', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '关联关系类型', + 'type' => 'string', + 'example' => 'FINACE_CLOUD', + ], + 'Pk' => [ + 'description' => 'MPK下PK(UID)', + 'type' => 'string', + 'example' => '1728240534507590', + ], + 'RamAdminRoleName' => [ + 'description' => 'ram角色名称', + 'type' => 'string', + 'example' => 'admin-role', + ], + 'Mpk' => [ + 'description' => 'MPK（UID）', + 'type' => 'string', + 'example' => '1785287436011964', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"LOGIN_EMAIL_HAS_BEEN_USED\\",\\n \\"Message\\": \\"loginEmail=685741089H@chinaunicom.cn,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"}]', + 'title' => '创建平行账号', + 'description' => '创建一个财务云主子关系。', + ], + 'GetCustomerAccountInfo' => [ + 'summary' => '查询虚商下终端客户账号信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '94017C56-1725-5DD9-AB41-B3BAE791D600', + ], + 'Success' => [ + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Mpk' => [ + 'description' => '父账号mpk', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1051360339779133', + ], + 'LoginEmail' => [ + 'description' => '终端客户的邮箱地址', + 'type' => 'string', + 'example' => 'xxxx@aliyun.com', + ], + 'HostingStatus' => [ + 'description' => '托管状态.信控提供，实例是否托管由阿里云管理，如果托管，阿里云会负责欠费停机操作'."\n" + ."\n" + .'1、用户冻结业务-"FREEZE",'."\n" + ."\n" + .'2、用户托管业务-"TRUSTEESHIP"', + 'type' => 'string', + 'example' => 'FREEZE', + ], + 'AccountType' => [ + 'description' => '账号类型 1 为企业， 0 个人', + 'type' => 'string', + 'example' => '1', + ], + 'CreditLimitStatus' => [ + 'description' => 'enduser业务类型'."\n" + ."\n" + .'1、用户冻结状态-"Freeze"'."\n" + ."\n" + .'2、用户解冻状态-"Thaw"'."\n" + .' '."\n" + .'3、用户托管状态-"Trusteeship"'."\n" + .' '."\n" + .'4、用户非托管状态-"TrusteeshipCancel"', + 'type' => 'string', + 'example' => 'Freeze', + ], + 'IsCertified' => [ + 'description' => '实名认证状态', + '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\\": \\"xxxx@aliyun.com\\",\\n \\"HostingStatus\\": \\"FREEZE\\",\\n \\"AccountType\\": \\"1\\",\\n \\"CreditLimitStatus\\": \\"Freeze\\",\\n \\"IsCertified\\": true\\n }\\n}","type":"json"}]', + 'title' => '查找虚商客户账号信息', + ], + 'GetCustomerList' => [ + 'summary' => '查询虚商下的终端客户uid列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'UidList' => [ + 'description' => '用户uid列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户uid列表。', + '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' => '查询子账号列表', + 'description' => '系统会根据请求的aksk查询其下的关联的终端客户uid列表', + ], + 'QueryResourcePackageInstances' => [ + 'summary' => '查询用户某个资源包的实例，仅支持查询有效的资源包。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '失效起始时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '失效结束时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T13:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数，默认值20，最大300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IncludePartner', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含合作伙伴。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Page' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'string', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '12', + ], + 'HostId' => [ + 'description' => '主机ID。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => '实例详情数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiryTime' => [ + 'description' => '失效时间。', + 'type' => 'string', + 'example' => '2019-03-12T16:00:00Z', + ], + 'Status' => [ + 'description' => '资源包状态，取值：'."\n" + .'- Available（有效）。'."\n" + .'- Expired（失效）。', + 'type' => 'string', + 'example' => 'Available', + ], + 'Remark' => [ + 'description' => '资源包商品的备注说明，只提供中文说明', + 'type' => 'string', + 'example' => '标准存储包(华东2)', + ], + 'RemainingAmountUnit' => [ + 'description' => '剩余量单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma01', + ], + 'PackageType' => [ + 'description' => '资源包类型。', + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_sh', + ], + 'EffectiveTime' => [ + 'description' => '生效时间。', + 'type' => 'string', + 'example' => '2018-09-12T09:51:56Z', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TotalAmount' => [ + 'description' => '总量。', + 'type' => 'string', + 'example' => '40.000', + ], + 'DeductType' => [ + 'description' => '扣费类型：Absolute。', + 'type' => 'string', + 'example' => 'Absolute', + ], + 'TotalAmountUnit' => [ + 'description' => '总量单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'RemainingAmount' => [ + 'description' => '剩余量。', + 'type' => 'string', + 'example' => '40.000', + ], + 'ApplicableProducts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => '适用产品列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源包适用产品。', + 'type' => 'string', + 'example' => '{"Product": ["oss"] }', + ], + ], + ], + ], + 'CommodityCode' => [ + 'description' => '商品code', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n 1\\n 20\\n \\n \\n GB\\n \\n oss\\n \\n OSSBAG-cn-v0h1s4hma018\\n Absolute\\n 40.000\\n Available\\n cn-shanghai\\n GB\\n FPT_ossbag_absolute_Storage_sh\\n 40.000\\n 标准存储包(华东2)\\n 2018-09-12T09:51:56Z\\n 2019-03-12T16:00:00Z\\n \\n \\n cn\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询资源包实例服务', + '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' => '筛选查询的实例ID，为空时返回所有的使用的实例明细。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-123123', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '实例对应的规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instancetyp', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品code，如ecsRi、scu_bag等。如果填写该字段，则prodCode字段不生效', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecsRi', + ], + ], + [ + 'name' => 'DeductedInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '被抵扣实例的ID，为空时返回所有实例的明细数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-123123', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式：YYYY-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式：YYYY-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'LastToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询从LastToken之后开始返回。第一次查询填null，之后的从结果NextToken获取', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESF***zNTAw', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询条数，默认为20，最大值为300。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IncludeShare', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含财务云子账号的资源包用量'."\n" + .'- true：包含'."\n" + .'- false：不包含', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code，如：ecs', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'oss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下次请求查询开始标识，填充到request的LastToken字段中。如果返回为null，则标识查询结束', + 'type' => 'string', + 'example' => 'CAESF***zNTAw', + ], + 'DetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailList' => [ + 'description' => '明细数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeductedInstanceId' => [ + 'description' => '被抵扣实例ID。', + 'type' => 'string', + 'example' => 'oss-123123', + ], + 'InstanceId' => [ + 'description' => '预留实例ID。', + 'type' => 'string', + 'example' => 'oss-123123', + ], + 'DeductHours' => [ + 'description' => '抵扣系数。 仅当CommodityCode为ecsRi有效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '24', + ], + 'ShareUid' => [ + 'description' => '抵扣实例所属uid'."\n" + .'- 共享抵扣：抵扣实例所属uid'."\n" + .'- 非共享抵扣：等于uid字段', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + 'DeductDate' => [ + 'description' => '抵扣日期。', + 'type' => 'string', + 'example' => '2019/5/23 12:00', + ], + 'InstanceSpec' => [ + 'description' => '被抵扣实例的规格。', + 'type' => 'string', + 'example' => 'rds.mysql.s3.large', + ], + 'DeductedCommodityCode' => [ + 'description' => '被抵扣商品code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedProductDetail' => [ + 'description' => '被抵商品（产品明细）名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'DeductMeasure' => [ + 'description' => '原始计量量。表示用户在某段时间内实际使用的资源量，未经任何规则调整。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Region' => [ + 'description' => '计量中region,可以是空', + 'type' => 'string', + 'example' => 'cn-hangzhou ', + ], + 'DeductQuantity' => [ + 'description' => '实际抵扣对应按量实例的算力或容量。'."\n" + .'> 实际抵扣量（DeductQuantity）是基于原始计量量（DeductMeasure）并结合具体抵扣规则计算得出的。'."\n" + .'> -', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductFactorTotal' => [ + 'description' => 'RI或SCU在该时间段的算力或容量总量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'ResCode' => [ + 'description' => '计费项', + 'type' => 'string', + 'example' => 'PutRequest', + ], + 'Uid' => [ + 'description' => '被抵扣实例的uid', + '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":"Successful！\\nDF58589C-A06C-4224-8615-7797E6474FA3\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '资源包用量查询', + 'summary' => '查询资源包(包含RI、scu)的使用量情况。', + 'description' => '限制：'."\n" + .'- 仅支持查询最近1年的用量记录', + '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' => '筛选查询的预留实例ID，为空时返回所有的使用的预留实例明细。', + 'type' => 'string', + 'required' => false, + 'example' => 'dsudfgdsjh', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '预留实例对应的规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instancetyp', + ], + ], + [ + 'name' => 'RICommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '取值：'."\n" + .'- ecsRi（默认值）：ECS的预留实例。'."\n" + .'- scu_bag：存储容量单位包。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecsRi', + ], + ], + [ + 'name' => 'DeductedInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '被抵扣实例的ID，为空时返回所有实例的明细数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'jsdgfsdhgsdjh', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式：YYYY-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式：YYYY-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-05-23 12:00:00', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数，默认为20，最大值为300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailList' => [ + 'description' => '明细数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeductedCommodityCode' => [ + 'description' => '被抵扣商品code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedProductDetail' => [ + 'description' => '被抵商品（产品明细）名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'DeductedInstanceId' => [ + 'description' => '被抵扣实例ID。', + 'type' => 'string', + 'example' => 'safdffghfgh', + ], + 'DeductFactorTotal' => [ + 'description' => 'RI或SCU在该时间段的算力或容量总量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductQuantity' => [ + 'description' => '实际抵扣对应按量实例的算力或容量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'DeductHours' => [ + 'description' => '抵扣系数。 仅当RICommodityCode为ecsRi有效。', + 'type' => 'string', + 'example' => '24', + ], + 'DeductDate' => [ + 'description' => '抵扣日期。', + 'type' => 'string', + 'example' => '2019-05-23 12:00:00', + ], + 'RIInstanceId' => [ + 'description' => '预留实例ID。', + 'type' => 'string', + 'example' => '324253645', + ], + 'InstanceSpec' => [ + 'description' => '被抵扣实例的规格。', + '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":"\\n DF58589C-A06C-4224-8615-7797E6474FA3\\n Successful!\\n \\n 0\\n 1\\n 20\\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '预留实例用量查询', + 'summary' => '查询RI的使用量情况。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceUsageTotal' => [ + 'summary' => '预留实例、SCU使用率汇总查询。', + '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' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间，查询对应的时间为开始时间', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间，查询对应的时间为结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'MONTH' => 'MONTH', + 'HOUR' => 'HOUR', + 'DAY' => 'DAY', + ], + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号；只支持传入1个账号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包类型，枚举值包括RI/SCU；RI：预留实例； SCU：存储容量单位包', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'SCU' => 'SCU', + 'RI' => 'RI', + ], + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '（根节点）', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '364C7C81-5E5E-51A0-B738-1969D2671B05', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Data' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => '时段使用率', + 'type' => 'array', + 'items' => [ + 'description' => '（时段使用率）', + 'type' => 'object', + 'properties' => [ + 'UsagePercentage' => [ + 'description' => '使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Period' => [ + 'description' => '时段', + 'type' => 'string', + 'example' => '2021071500', + ], + ], + ], + ], + 'TotalUsage' => [ + 'description' => '总使用率', + 'type' => 'object', + 'properties' => [ + 'PostpaidCost' => [ + 'description' => '总按量实例成本', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'SavedCost' => [ + 'description' => '总节省金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UsagePercentage' => [ + 'description' => '总使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'PotentialSavedCost' => [ + 'description' => '潜在总节省金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'ReservationCost' => [ + 'description' => '总资源购买费用', + '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":"\\n BD1DC347-905C-1D6E-8BA1-D724266842D2\\n Successful!\\n \\n \\n 0\\n 0\\n 0\\n 0\\n \\n \\n 2021050100\\n 0\\n \\n \\n 2021050200\\n 0\\n \\n \\n 2021050300\\n 0\\n \\n \\n 2021050400\\n 0\\n \\n \\n 2021050500\\n 0\\n \\n \\n 2021050600\\n 0\\n \\n \\n 2021050700\\n 0\\n \\n \\n 2021050800\\n 0\\n \\n \\n 2021050900\\n 0\\n \\n \\n 2021051000\\n 0\\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '资源使用率汇总', + ], + 'DescribeResourceUsageDetail' => [ + 'summary' => '预留实例、SCU使用率明细查询。', + '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' => '格式：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' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '如果为空查询当前账号及其托管子账号的数据，可传入托管子账号ID，明确查询该子账号数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包类型。枚举值：RI：预留实例；SCU：存储容量单位包。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求标识'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页的token'."\n", + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'TotalCount' => [ + 'description' => '总条数'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Items' => [ + 'description' => '数据条目', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'Valid', + ], + 'UsagePercentage' => [ + 'description' => '使用率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'ResourceInstanceId' => [ + 'description' => '资源实例ID'."\n", + 'type' => 'string', + 'example' => 'ecsri-bp147nnfz21225k9mpix00', + ], + 'TotalQuantity' => [ + 'description' => '资源总量'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'ReservationCost' => [ + 'description' => '资源购买费用', + 'type' => 'string', + 'example' => '0', + ], + 'RegionNo' => [ + 'description' => '地域Code', + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'UserId' => [ + 'description' => '账号ID', + 'type' => 'string', + 'example' => '123745698925000', + ], + 'StatusName' => [ + 'description' => '状态名称', + 'type' => 'string', + 'example' => '生效', + ], + 'CapacityUnit' => [ + 'description' => '抵扣单位', + 'type' => 'string', + 'example' => '算力*小时', + ], + 'PotentialSavedCost' => [ + 'description' => '潜在节省净值', + 'type' => 'string', + 'example' => '0.13', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ZoneName' => [ + 'description' => '可用区Code', + 'type' => 'string', + 'example' => '杭州 可用区I', + ], + 'InstanceSpec' => [ + 'description' => '规格'."\n", + 'type' => 'string', + 'example' => 'ecs.t5-lc2m1.nano', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-04-01 01:00:00', + ], + 'PostpaidCost' => [ + 'description' => '按量成本等效值', + 'type' => 'string', + 'example' => '0.06', + ], + 'ImageType' => [ + 'description' => '操作系统'."\n", + 'type' => 'string', + 'example' => 'linux', + ], + 'StartTime' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2021-04-01 00:00:00', + ], + 'Region' => [ + 'description' => '地域'."\n", + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'DeductQuantity' => [ + 'description' => '抵扣量'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'SavedCost' => [ + 'description' => '节省净值', + 'type' => 'string', + 'example' => '0.06', + ], + 'Zone' => [ + 'description' => '可用区', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'UserName' => [ + 'description' => '账号名称', + 'type' => 'string', + 'example' => 'test@aliyun.com', + ], + 'Quantity' => [ + 'description' => '资源数量'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@aliyun.com\\",\\n \\"Quantity\\": 2\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => '资源使用率明细', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceCoverageTotal' => [ + 'summary' => '预留实例、SCU覆盖率汇总查询。', + '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' => '格式：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' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'RI：预留实例；SCU：存储容量单位包'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求标识'."\n", + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据'."\n", + 'type' => 'object', + 'properties' => [ + 'PeriodCoverage' => [ + 'description' => '时段覆盖率', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CoveragePercentage' => [ + 'description' => '覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Period' => [ + 'description' => '时段'."\n" + .'yyyyMMddHH', + 'type' => 'string', + 'example' => '2020110100', + ], + ], + ], + ], + 'TotalCoverage' => [ + 'description' => '总覆盖率', + 'type' => 'object', + 'properties' => [ + 'CapacityUnit' => [ + 'description' => '抵扣单位', + 'type' => 'string', + 'example' => '算力*小时', + ], + 'DeductQuantity' => [ + 'description' => '总抵扣量', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'CoveragePercentage' => [ + 'description' => '总覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'TotalQuantity' => [ + 'description' => '总使用量', + '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' => '资源覆盖率汇总', + 'description' => '与费用中心“资源实例管理”菜单中的“覆盖率概况”的汇总数据一致。'."\n" + .'当前支持RI和SCU两种资源的覆盖率查询。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourceCoverageDetail' => [ + 'summary' => '预留实例、SCU覆盖率明细查询。', + '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' => '格式：yyyy-MM-dd HH:mm:ss；'."\n" + .'查询逻辑为包括该时间'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-02 00:00:00', + ], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => 'MONTH：月维度；'."\n" + .'DAY：天维度；'."\n" + .'HOUR：小时维度；', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HOUR', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123745698925000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'RI：预留实例；SCU：存储容量单位包', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求标识', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页的token', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'MaxResults' => [ + 'description' => '本页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Items' => [ + 'description' => '数据项', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '产品明细Code', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ProductName' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => '云服务器 ECS', + ], + 'TotalQuantity' => [ + 'description' => '总用量', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'RegionNo' => [ + 'description' => '地域Code', + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'UserId' => [ + 'description' => '账号ID', + 'type' => 'string', + 'example' => '123745698925000', + ], + 'CommodityName' => [ + 'description' => '产品明细'."\n", + 'type' => 'string', + 'example' => '云服务器ECS-按量付费', + ], + 'CapacityUnit' => [ + 'description' => '抵扣单位', + 'type' => 'string', + 'example' => '算力*小时', + ], + 'InstanceId' => [ + 'description' => '按量实例ID'."\n", + 'type' => 'string', + 'example' => 'i-bp1d9x623987rlj0dx4xx', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ZoneName' => [ + 'description' => '可用区', + 'type' => 'string', + 'example' => '杭州 可用区I', + ], + 'InstanceSpec' => [ + 'description' => '规格'."\n", + 'type' => 'string', + 'example' => 'ecs.t5-lc2m1.nano', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-04-01 01:00:00', + ], + 'StartTime' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2021-04-01 00:00:00', + ], + 'PaymentAmount' => [ + 'description' => '账单金额', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CoveragePercentage' => [ + 'description' => '覆盖率', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Region' => [ + 'description' => '地域'."\n", + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'DeductQuantity' => [ + 'description' => '抵扣量'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Zone' => [ + 'description' => '可用区Code', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'UserName' => [ + 'description' => '账号名称', + 'type' => 'string', + 'example' => 'test13@test.aliyun.com', + ], + 'ProductCode' => [ + 'description' => '产品Code', + '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\\": \\"test13@test.aliyun.com\\",\\n \\"ProductCode\\": \\"ecs\\"\\n }\\n ]\\n }\\n}","errorExample":""}]', + 'title' => '资源覆盖率明细', + 'description' => '1. 与费用中心“资源实例管理”菜单中的“覆盖率概况”的列表数据一致。'."\n" + .'2. 当前支持RI和SCU两种资源的覆盖率查询。'."\n" + .'3. 提供“小时”、“天”，“月”三种维度的覆盖率查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeResourcePackageProduct' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ossbag', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72353765387', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ResourcePackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourcePackage' => [ + 'description' => '资源包详情数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'ossbag', + ], + 'Name' => [ + 'description' => '资源包名称。', + 'type' => 'string', + 'example' => '对象存储OSS资源包(包月)', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'ossbag', + ], + 'PackageTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PackageType' => [ + 'description' => '资源包类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '资源包代码。', + 'type' => 'string', + 'example' => 'FPT_ossbag_deadlineAcc_CdnOut_common_sz', + ], + 'Name' => [ + 'description' => '资源包类型名称。', + 'type' => 'string', + 'example' => '回源流量包(华南1)', + ], + 'Properties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Property' => [ + 'description' => '属性详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => 'region', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + ], + ], + ], + ], + ], + 'Specifications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Specification' => [ + 'description' => '规格详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '规格名称。', + 'type' => 'string', + 'example' => '1TB', + ], + 'Value' => [ + 'description' => '规格值。', + 'type' => 'string', + 'example' => '1024', + ], + 'AvailableDurations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableDuration' => [ + 'description' => '可选时间长度详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '时长值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Name' => [ + 'description' => '时长名称。', + 'type' => 'string', + 'example' => '6 Month', + ], + 'Unit' => [ + 'description' => '资源包时长单位。取值范围：'."\n" + .'- Month：月。'."\n" + .'- Year：年。'."\n" + ."\n" + .'默认Month。', + '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":">\\n Successful!\\n BBEF51A3-E933-4F40-A534-C673CBDB9C80\\n true\\n Success\\n \\n \\n \\n 对象存储OSS资源包(包月)\\n ossbag\\n \\n \\n 回源流量包(华南1)\\n \\n \\n 1TB\\n 1024\\n \\n \\n 6 Month\\n 6\\n Month\\n \\n \\n \\n \\n FPT_ossbag_deadlineAcc_CdnOut_common_sz\\n \\n \\n region\\n cn-shenzhen\\n \\n \\n ossbag_type\\n cdn2oss_flow_out\\n \\n \\n \\n \\n 标准存储包(华北2)\\n \\n \\n 40GB\\n 40\\n \\n \\n 6 Month\\n 6\\n Month\\n \\n \\n \\n \\n FPT_ossbag_absolute_Storage_bj\\n \\n \\n region\\n cn-beijing\\n \\n \\n ossbag_type\\n storage\\n \\n \\n \\n \\n \\n \\n \\n","errorExample":""}]', + 'title' => '描述资源包产品服务', + 'summary' => '查询某个资源包产品的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetResourcePackagePrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', + 'type' => 'string', + 'required' => true, + 'example' => 'ossbag', + ], + ], + [ + 'name' => 'PackageType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包类型。值与**描述资源包接口**返回的**ResourcePackage**的Code值相等。', + 'type' => 'string', + 'required' => true, + 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包生效时间，不填默认立即生效。'."\n" + .'订单类型为**购买**时，不支持询价**生效时间大于当前时间六个月**的资源包。'."\n" + .'订单类型为**升级**时，生效时间**必须小于等于**升级的资源包实际到期时间。'."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-10T12:00:00Z', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包规格大小。', + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包时长。值与规格大小的可用时长相符。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包时长单位。取值：'."\n" + .'- Month：月。'."\n" + .'- Year：年。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值：'."\n" + .'- BUY：新购。'."\n" + .'- UPGRADE：升级。'."\n" + .'- RENEW：续费。'."\n" + ."\n" + .'默认值BUY。', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户实例ID。**订单类型为续费、升级时，必填。**', + 'type' => 'string', + 'required' => false, + 'example' => 'OSSBAG-cn-0xl0002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => '原始价格，单位元。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1290240', + ], + 'DiscountPrice' => [ + 'description' => '折扣价格，单位元。', + 'type' => 'number', + 'format' => 'float', + 'example' => '215040', + ], + 'Currency' => [ + 'description' => '币种。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'TradePrice' => [ + 'description' => '交易价格，单位元。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1075200', + ], + 'Promotions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Promotion' => [ + 'description' => '优惠详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '优惠描述。', + 'type' => 'string', + 'example' => '购买半年，立享8.3折优惠', + ], + 'Id' => [ + 'description' => '优惠ID。', + '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":"\\n Successful!\\n BBEF51A3-E933-4F40-A534-C673CBDB9C80\\n true\\n Success\\n \\n 215040\\n \\n \\n 购买半年，立享8.3折优惠\\n 1000680914\\n \\n \\n 1290240\\n 1075200\\n CNY\\n \\n","errorExample":""}]', + 'title' => '资源包产品询价服务', + 'summary' => '查询用户某个资源包的价格。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewResourcePackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lskd****sljhsdj', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包生效时间，不填默认立即生效。'."\n" + ."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包续费时长。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包时长单位，取值：'."\n" + .'- Month'."\n" + .'- Year'."\n" + ."\n" + .'默认为Month。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204322301110333', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204322560333', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n OSSBAG-cn-0xl0****d003\\n 204322301110333\\n \\n","errorExample":""}]', + 'title' => '资源包续费服务', + 'summary' => '为用户某个资源包实例续费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeResourcePackage' => [ + 'summary' => '升级用户某个资源包的实例。如本周期已升级，则无法继续升级，待次周期生效后再操作升级。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSSBAG-cn-0xl*****x002', + ], + ], + [ + 'name' => 'EffectiveDate', + 'in' => 'query', + 'schema' => [ + 'description' => '资源包生效时间，不填默认次周期生效。'."\n" + ."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02T12:00:00Z', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => '升级资源包规格大小。', + 'type' => 'string', + 'required' => false, + 'example' => '51200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73387246238746', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73387246238746', + ], + 'InstanceId' => [ + 'description' => '实例ID。'."\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":"\\r\\n Successful!\\r\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\r\\n true\\r\\n Success\\r\\n \\r\\n OSSBAG-cn-0xl*****d003\\r\\n 204322301110333\\r\\n \\r\\n","errorExample":""}]', + 'title' => '升级资源包服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubscribeBillToOSS' => [ + 'summary' => '使用OSS订阅账单文件，支持将账单数据存储到指定的OSS bucket中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeBucket', + 'in' => 'query', + 'schema' => [ + 'description' => '存储订阅账单文件的OSS Bucket名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xxxxxx-bucket', + ], + ], + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的账单类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。'."\n" + .'- InstanceDetailMonthly：实例消费账期汇总。'."\n" + .'- SplitItemDetailDaily: 分账账单按天汇总。'."\n" + .'- MonthBill：月账单PDF。仅支持订阅MA。', + 'type' => 'string', + 'required' => false, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'MultAccountRelSubscribe', + 'in' => 'query', + 'schema' => [ + 'description' => '对于多级账号，可指定推送账单的类型。可选值为：'."\n" + .'- MA：推送主账号及财务云非托管子账号账单。'."\n" + .'- ACP1：推送虚商子账号账单。'."\n" + ."\n" + .'默认：MA。', + 'type' => 'string', + 'required' => false, + 'example' => 'MA', + ], + ], + [ + 'name' => 'BucketOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。'."\n" + .'普通用户则无需指定，默认为调用账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12341324', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-03', + ], + ], + [ + 'name' => 'BucketPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'OSS Bucket存储路径', + 'description' => '订阅至Bucket下的指定目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'testpath', + ], + ], + [ + 'name' => 'RowLimitPerFile', + 'in' => 'query', + 'schema' => [ + 'description' => '单文件行数上限。当账单文件超过上限后，会拆成多个文件，并合并成一个压缩包。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300000', + ], + ], + [ + 'name' => 'UsingSsl', + 'in' => 'query', + 'schema' => [ + 'description' => '是否通过SSL（Secure Sockets Layer）加密协议来保护网络通信。取值：'."\n" + ."\n" + .'- true：启用SSL加密，可以确保数据传输的安全性和完整性。'."\n" + ."\n" + .'- false（默认值）：不启用SSL加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F61FCE4B-9B56-4FD9-A17E-******', + ], + 'Success' => [ + 'description' => '是否成功。', + '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":"\\n Successful!\\n F61FCE4B-9B56-4FD9-A17E-******\\n true\\n Success\\n","errorExample":""}]', + 'title' => '设置OSS订阅账单文件', + 'description' => '在调用该接口时，请注意：'."\n" + ."\n" + .'- 用户一次订阅一个类型的账单文件。'."\n" + ."\n" + .'- 订阅后次日开始每日推送上一日生成的账单文件，每月4号推送上月整账期的全量账单文件。月账单PDF每月4号推送上月账单文件。'."\n" + ."\n" + .'- 按天生成的账单文件可能存在时延，延迟生成的账单会在生成次日推送，也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。'."\n" + ."\n" + .'> 首次使用OSS订阅，需要给订阅用户授予[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)权限。若授权取消，系统将不再推送文件，需要用户重新授权。'."\n" + ."\n" + .'- 本订阅与费用与成本控制台的“账单数据存储”为同一功能，订阅互通。'."\n" + ."\n" + .'- 订阅至Bucket下的目录时，请注意符合目录命名规范：'."\n" + ."\n" + .' - 不允许使用表情符，请使用符合要求的 UTF-8 字符。'."\n" + .' - / 用于分割路径，可快速创建子目录，但不要以 / 或 \\ 开头，不要出现连续的 /。'."\n" + .' - 不允许出现名为 .. 的子目录。'."\n" + .' - 总长度控制在 1~254 个字符。'."\n" + ."\n\n" + .'- 文件名：'."\n" + ."\n" + .' - **BillingItemDetailForBillingPeriod**（计费项账单明细）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_BillingItemDetail_YYYYMMDD`，例如：`169**_BillingItemDetail_20190310`。'."\n" + .' '."\n" + .' - 下月初完整文件名格式：`UID_BillingItemDetail_YYYYMM`，例如：`169**_BillingItemDetail_201903`。'."\n" + .' '."\n" + .' - **InstanceDetailForBillingPeriod**（实例账单明细）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_InstanceDetail_YYYYMMDD`，例如：`169**_InstanceDetail_20190310`。'."\n" + .' '."\n" + .' - 下月初完整文件名格式：`UID_InstanceDetail_YYYYMM`，例如：`169**_InstanceDetail_201903`。'."\n" + ."\n" + .' - **InstanceDetailMonthly**（实例账单账期汇总）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_InstanceDetailMonthly_YYYYMM`，例如：`169**_InstanceDetailMonthly_201903`。此文件每日更新月初至当日的全量数据，直至次月4号。'."\n" + ."\n" + .' - **BillingItemDetailMonthly**（计费项账单账期汇总）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_BillingItemDetailMonthly_YYYYMM`，例如：`169**_BillingItemDetailMonthly_201903`。此文件每日更新月初至当日的全量数据，直至次月4号。'."\n" + ."\n" + .' - **SplitItemDetailDaily**（分账账单按天汇总）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_SplitItemDetailDaily_YYYYMM`，例如：`169**_SplitItemDetailDaily_201903`。此文件每日更新月初至当日的全量数据，直至次月4号。'."\n" + ."\n" + .' - **MonthBill**（月账单PDF）'."\n" + .' '."\n" + .' - 每月推送文件名格式：`UID_MonthBill_YYYYMM`，例如：`169**_MonthBill_201903`。每月4号推送上月账单文件。'."\n" + ."\n" + .'- 除MonthBill为PDF文件外，其余文件类型为csv文件。但如果账单数据行数超过一定阈值，会自动拆分成多个csv文件，并合并压缩成一个zip文件，zip文件名格式相同。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnsubscribeBillToOSS' => [ + 'summary' => '取消详单导出订阅。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。'."\n" + .'- InstanceDetailMonthly：实例消费账期汇总。'."\n" + .'- SplitItemDetailDaily: 分账账单按天汇总。'."\n" + .'- MonthBill：月账单PDF。仅支持订阅MA。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'MultAccountRelSubscribe', + 'in' => 'query', + 'schema' => [ + 'description' => '对于多级账号，可指定推送账单的类型。可选值为：'."\n" + ."\n\n" + .'- MA：推送主账号账单。'."\n" + .'- ACP1：推送虚商子账号账单。'."\n" + ."\n" + .'默认值：MA。', + 'type' => 'string', + 'required' => false, + 'example' => 'MA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D23FE74C-742F-4624-A82B-******', + ], + 'Success' => [ + 'description' => '是否成功。', + '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":"\\n Successful!\\n D23FE74C-742F-4624-A82B-******\\n true\\n Success\\n","errorExample":""}]', + 'title' => '取消详单订阅服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBillToOSSSubscription' => [ + 'summary' => '查询账单订阅到OSS储存桶的记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9EEAE43F-1E4D-4734-AE93-5049878AC103', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccountName' => [ + 'description' => '当前查询账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'AccountID' => [ + 'description' => '当前查询账号ID。', + 'type' => 'string', + 'example' => '185xxxxx03489', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '订阅详情。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅详情。', + 'type' => 'object', + 'properties' => [ + 'BucketOwnerId' => [ + 'description' => '储存桶所有者用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1369168081849304', + ], + 'SubscribeType' => [ + 'description' => '订阅账单类型。'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。', + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'SubscribeBucket' => [ + 'description' => '订阅的储存桶ID。', + 'type' => 'string', + 'example' => 'billingtestbucket', + ], + 'SubscribeTime' => [ + 'description' => '订阅时间，格式’YYYY-MM-DD hh:mm:ss’。', + 'type' => 'string', + 'example' => '2019-10-30 15:40:11', + ], + 'SubscribeLanguage' => [ + 'description' => '订阅语言简码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + 'BucketPath' => [ + 'description' => 'OSS存储目录。', + 'type' => 'string', + 'example' => 'Billing/BillingItemDetailMonthly/', + ], + 'RowLimitPerFile' => [ + 'description' => '单文件行数上限。当账单文件超过上限后，会拆成多个文件，并合并成一个压缩包。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"9EEAE43F-1E4D-4734-AE93-5049878AC103\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AccountName\\": \\"test@test.aliyunid.com\\",\\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":"\\n Successful!\\n 9EEAE43F-1E4D-4734-AE93-5049878AC103\\n \\n 185xxxxx03489\\n \\n \\n test@test.aliyunid.com\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '详单订阅查询', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBillOverview' => [ + 'summary' => '查询用户某个账期内的账单总览信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，YYYY-MM。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + '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' => '订阅类型：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BCB1E1BC-05BF-4217-80EE-BF09A29407BA', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => [ + 'description' => '账期，格式：YYYY-MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => '账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoundDownDiscount' => [ + 'description' => '抹零优惠。', + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => '账单类型，取值：'."\n" + .'- SubscriptionOrder。预付费账单'."\n" + .'- PayAsYouGoBill。后付费账单'."\n" + .'- Refund。退款'."\n" + .'- Adjustment。调账', + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额或信用结算金额（普通用户的欠费， 或者信用客户信用额度消耗）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => 'Nat网关', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => 'NAT Gateway (Pay-As-You-Go)', + ], + 'OwnerID' => [ + 'description' => '账单OwnerID。', + 'type' => 'string', + 'example' => '1222', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentAmount' => [ + 'description' => '现金支付（含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + '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\\": \\"test@test.aliyunid.com\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"RoundDownDiscount\\": \\"0\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\",\\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":"BCB1E1BC-05BF-4217-80EE-BF09A29407BA\\nSuccessful!\\n\\n 2020-03\\n 185766xxxx\\n test@test.aliyunid.com\\n \\n \\n 0\\n Nat网关\\n 185766xxxx\\n 0\\n USD\\n 0\\n 100\\n 0\\n 0\\n Subscription\\n PayAsYouGoBill\\n 100\\n CNY\\n rds\\n 0\\n 0\\n 0\\n NAT Gateway (Pay-As-You-Go)\\n rds\\n rds\\n 0\\n trusteeship\\n rds\\n 1222\\n 100\\n test@test.aliyunid.com\\n 0\\n 0\\n \\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '账单总览查询服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryBill' => [ + 'summary' => '查询用户某个账期内的结算账单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账期，YYYY-MM。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + .'- SubscriptionOrder'."\n" + .'- PayAsYouGoBill'."\n" + .'- Refund'."\n" + .'- Adjustment', + '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' => '订阅类型。取值：'."\n" + .'- Subscription'."\n" + .'- PayAsYouGo'."\n" + ."\n" + .'> 必须和ProductCode参数一起使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '根据原价（PretaxGrossAmount）是否为0做过滤，默认为否（兼容现有逻辑）。'."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => '账期，YYYY－MM。', + 'type' => 'string', + 'example' => '2020-02', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185xxxxx489', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => '账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '支付状态。取值：'."\n" + .'- PayFinish：已支付'."\n" + .'- PayUnclear：未结清'."\n" + .'- PayUnsettle：未结算'."\n" + .'- NoSettle：免结算', + 'type' => 'string', + 'example' => 'PayFinish', + ], + 'RoundDownDiscount' => [ + 'description' => '抹零优惠。', + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'- SubscriptionOrder'."\n" + .'- PayAsYouGoBill'."\n" + .'- Refund'."\n" + .'- Adjustment', + 'type' => 'string', + 'example' => 'SubscriptionOrder', + ], + 'Currency' => [ + 'description' => '币种。'."\n" + .'- CNY'."\n" + .'- USD'."\n" + .'- JPY', + 'type' => 'string', + 'example' => 'CNY', + ], + 'UsageStartTime' => [ + 'description' => '账单开始时间。', + 'type' => 'string', + 'example' => '2020-03-11 07:00:00', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription'."\n" + .'- PayAsYouGo', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'UsageEndTime' => [ + 'description' => '账单结束时间。', + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SubOrderId' => [ + 'description' => '该条账单对应的订单明细ID。', + 'type' => 'string', + 'example' => '325345254353', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => '订单支付时间。', + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'PipCode' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CommodityCode' => [ + 'description' => '商品Code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'RecordID' => [ + 'description' => '订单号、账单号。', + 'type' => 'string', + 'example' => '2020xxxx5912', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '关系型数据库RDS（包月）', + ], + 'OwnerID' => [ + 'description' => '子账号**AccountID**（多账号代付场景）。', + 'type' => 'string', + 'example' => '3532535235', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentAmount' => [ + 'description' => '现金支付（含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + '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\\": \\"test@test.aliyunid.com\\",\\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":"\\n Successful!\\n 347A769E-CA83-4213-964D-41A974DE0F3D\\n \\n 2020-03\\n 47\\n 185xxxxx489\\n 20\\n 1\\n \\n \\n PayFinish\\n 0\\n 0\\n 云数据库RDS\\n 关系型数据库RDS(包月)\\n rds\\n \\n rds\\n 0\\n 0\\n \\n 0\\n 0\\n 0\\n 2020-03-11 08:00:00\\n PayAsYouGoBill\\n PayAsYouGo\\n 0\\n \\n 0\\n CNY\\n 2020-03-11 07:00:00\\n 2020xxxx5912\\n \\n \\n test@test.aliyunid.com\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '账单查询服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryAccountBill' => [ + 'summary' => '查询用户某个账期内的消费，并以资源所有者的维度进行汇总', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，YYYY-MM。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认值20，最大值：300。', + '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' => '是否增加产品Code汇总。'."\n" + .'- true。'."\n" + .'- false。'."\n" + ."\n" + .'默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '查询账单的颗粒度。取值：'."\n" + .'- MONTHLY：月。与费用中心-费用账单-账单明细-账期账单一致。'."\n" + .'- DAILY：日。与费用中心-费用账单-账单明细-按天账单一致。'."\n" + ."\n" + .'> 选择DAILY需指定BillingDate。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'MONTHLY', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-06-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => '账期，格式：YYYY-MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '1857xxxxx489', + ], + 'PageSize' => [ + 'description' => '每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccountName' => [ + 'description' => '账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillingDate' => [ + 'description' => '账单日期。', + 'type' => 'string', + 'example' => '2021-03-01', + ], + 'ProductName' => [ + 'description' => '产品名称。'."\n" + .'> 仅当**IsGroupByProduct**为true时返回。', + 'type' => 'string', + 'example' => 'rds', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OwnerName' => [ + 'description' => '资源 Owner 账号 AccountName（多账号代付场景）。', + 'type' => 'string', + 'example' => 'aligzncloudtest2', + ], + 'Currency' => [ + 'description' => '币种。取值：'."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'SubscriptionType' => [ + 'description' => '产品订阅类型：'."\n" + .'- 预付费：Subscription。'."\n" + .'- 后付费：PayAsYouGo。'."\n" + ."\n" + .'> 仅当IsGroupByProduct为true时返回。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'OwnerID' => [ + 'description' => '资源Owner账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '325434254', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'string', + 'example' => '1857xxxxx489', + ], + 'PaymentAmount' => [ + 'description' => '现金支付（含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额或信用结算金额。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CostUnit' => [ + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '产品code。'."\n" + .'> 仅当**IsGroupByProduct**为true时返回。', + 'type' => 'string', + 'example' => 'rds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\",\\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\\": \\"test@test.aliyunid.com\\",\\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":"3BFC23FE-A182-4D96-A1E4-7521B30B8E43\\nSuccessful!\\n\\n 1\\n 2020-03\\n 1857xxxxx489\\n 20\\n 1\\n test@test.aliyunid.com\\n \\n \\n 0\\n aligzncloudtest2\\n rds\\n rds\\n 1857xxxxx489\\n 0\\n 0\\n trusteeship\\n 2021-03-01\\n 0\\n 0\\n rds\\n 0\\n PayAsYouGo\\n 0\\n 325434254\\n 0\\n CNY\\n test@test.aliyunid.com\\n 未分配\\n 0\\n 0\\n \\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '账号账单查询服务', + 'description' => '- 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月3日12点后支持查看/导出（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。'."\n" + .'- 支持近18个月数据。 '."\n" + .'- 账单数据相对于实际费用消耗延迟24小时更新，其中实例ID相关的信息（ 实例配置，实例规格，实例昵称，资源组，公网IP，私网IP，可用区）延迟48小时更新。 '."\n" + .'- 账单数据不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用（如需统计含分拆项数据，请前往分账账单）。'."\n" + .'- 对于云通信产品，仅支持查询2020年6月及以后的明细数据，万网产品（包括域名、商标等）仅支持查询2020年11月及以后的明细数据。'."\n" + .'- 单用户限流10笔/秒，如遇超时，请重试。', + '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' => '账期，YYYY-MM。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-07', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + .'- SubscriptionOrder 预付费订单'."\n" + .'- PayAsYouGoBill 后付费账单'."\n" + .'- Refund 退款账单'."\n" + .'- Adjustment 调账账单', + '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' => '订阅类型。取值：'."\n" + .'- Subscription 预付费'."\n" + .'- PayAsYouGo 后付费'."\n" + .'> 必须和ProductCode参数一起使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '根据原价（PretaxGrossAmount）是否为0做过滤，默认为否（兼容现有逻辑）。'."\n" + .'- true：是。'."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + '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' => '请求ID。', + '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' => '账期，YYYY－MM。', + 'type' => 'string', + 'example' => '2020-02', + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185xxxxx489', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AccountName' => [ + 'description' => '账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '支付状态。取值：'."\n" + .'- PayFinish：已支付'."\n" + .'- PayUnclear：未结清'."\n" + .'- PayUnsettle：未结算'."\n" + .'- NoSettle：免结算', + 'type' => 'string', + 'example' => 'PayFinish', + ], + 'RoundDownDiscount' => [ + 'description' => '抹零优惠。', + 'type' => 'string', + 'example' => '0', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'- Subscription'."\n" + .'- OrderPayAsYouGoBill'."\n" + .'- Refund'."\n" + .'- Adjustment', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'Currency' => [ + 'description' => '币种。'."\n" + .'- CNY'."\n" + .'- USD'."\n" + .'- JPY', + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription'."\n" + .'- PayAsYouGo', + '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' => '该条账单对应的订单明细ID。', + 'type' => 'string', + 'example' => '325345254353', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => '订单支付时间。', + 'type' => 'string', + 'example' => '2020-03-11 08:00:00', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'RecordID' => [ + 'description' => '订单号、账单号。', + 'type' => 'string', + 'example' => '2020xxxx5912', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '关系型数据库RDS（包月）', + ], + 'OwnerID' => [ + 'description' => '子账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '3532535235', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + '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\\": \\"test@test.aliyunid.com\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"Status\\": \\"PayFinish\\",\\n \\"RoundDownDiscount\\": \\"0\\",\\n \\"Item\\": \\"Subscription\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\",\\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":"AE3F4057-DFC9-4B81-8858-F620651010C9\\nSuccessful!\\n\\n 200\\n 2020-02\\n 185xxxxx489\\n CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\n 20\\n test@test.aliyunid.com\\n \\n \\n 0\\n 云数据库RDS\\n 185xxxxx489\\n 325345254353\\n 0\\n USD\\n 0\\n 2020-03-11 08:00:00\\n 0\\n 0\\n 0\\n 2020-03-11 08:00:00\\n PayAsYouGo\\n SubscriptionOrder\\n 0\\n CNY\\n rds\\n 2020-03-11 07:00:00\\n 0\\n 2O3AADJFEAF2PDKSFAMFCB11918\\n PayFinish\\n 0\\n 0\\n 关系型数据库RDS(包月)\\n rds\\n rds\\n 0\\n trusteeship\\n rds\\n 3532535235\\n 100\\n test@test.aliyunid.com\\n 2020xxxx5912\\n 0\\n 0\\n \\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '结算账单查询服务', + 'summary' => '查询用户某个账期内的结算账单。支持账单条目超过50000条的国内账号。', + 'description' => '- 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月2日12点后支持查看/导出（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。'."\n" + .'- 账单数据相对于实际费用消耗延迟5小时更新。'."\n" + .'- 账单数据中对于历史账期“未结清”状态的账单，还款后延迟5个小时更新为已结清；对于当月“未结清”状态的账单，还款后于次月2日12点出账时更新为已结清。'."\n" + .'- 当前API支持优雅退避，请求速率为600/60(s)。'."\n" + .'- 单用户限流10笔/秒，如遇超时，请重试。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInstanceBill' => [ + 'summary' => '查询用户某个账期内所有商品实例或计费项的消费汇总。API 已升级为 DescribeInstanceBill，此API不再提供50000行以后数据的查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账期YYYY－MM。仅支持最近18个月账期。', + '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' => '产品类型。当ProductCode为云市场产品code时，此参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'>必须和**ProductCode**参数一起使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'IsBillingItem', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按照计费项维度拉取数据。'."\n" + .'- false。与“费用中心-费用账单-账单明细-实例”账单一致。'."\n" + .'- true。与“费用中心-费用账单-账单明细-计费项”账单一致。'."\n" + ."\n" + .'默认 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '根据原价（**PretaxGrossAmount**）和应付（**PretaxAmount**）是否都为0做过滤。取值：'."\n" + .'- false。'."\n" + .'- true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，仅当**Granularity**为DAILY时必填，格式为YYYY-MM-DD。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-03', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '查询账单的颗粒度。取值：'."\n" + .'- MONTHLY：月。与“费用中心-费用账单-账单明细-账期”账单一致。'."\n" + .'- DAILY：日。与“费用中心-费用账单-账单明细-按天”账单一致。'."\n" + ."\n" + .'选择DAILY需指定**BillingDate**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MONTHLY', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => '账单日期，格式：YYYY－MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingDate' => [ + 'description' => '账单日期，仅当Granularity为DAILY时有值，格式为YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'InstanceConfig' => [ + 'description' => '实例详细配置。', + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'- SubscriptionOrder （预付订单）。'."\n" + .'- PayAsYouGoBill （后付账单）。'."\n" + .'- Refund （退款）。'."\n" + .'- Adjustment （调账）。', + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'> 必须和ProductCode参数一起使用。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillingItem' => [ + 'description' => '计费项。仅当IsBillingItem=true有值。', + 'type' => 'string', + 'example' => '其他', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '杭州', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CostUnit' => [ + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配', + ], + 'ListPriceUnit' => [ + 'description' => '单价单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '元', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriodUnit' => [ + 'description' => '服务周期单位', + 'type' => 'string', + 'example' => '秒', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'NickName' => [ + 'description' => '实例昵称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'Usage' => [ + 'description' => '用量, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'OwnerID' => [ + 'description' => '子账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '169***013', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'UsageUnit' => [ + 'description' => '用量单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => 'GB', + ], + 'PaymentAmount' => [ + 'description' => '现金支付。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'DeductedByResourcePackage' => [ + 'description' => '资源包抵扣。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriod' => [ + 'description' => '服务周期。', + 'type' => 'string', + 'example' => '10', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ListPrice' => [ + 'description' => '单价, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '100', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'BillingType' => [ + 'description' => '计费方式。', + 'type' => 'string', + 'example' => '其它', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\",\\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":"\\n Successful!\\n 79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\n \\n 2020-03\\n 2\\n 18xxxxx3489\\n 20\\n 1\\n \\n \\n rds.mysql.s3.large\\n 云数据库RDS\\n rm-bp1xxxxxxxe\\n 0\\n \\n \\n \\n 0.01\\n 0\\n 11447.99\\n Subscription\\n SubscriptionOrder\\n 11448\\n 数据库类型:MySQL;实例规格:rds.mysql.s3.large;存储:5;内存:8192\\n CNY\\n 未分配\\n 默认资源组\\n 其它\\n \\n 0\\n 关系型数据库RDS(包月)\\n rds\\n cn-hangzhou-b\\n rds\\n 0\\n \\n \\n \\n 31583763\\n 秒 \\n \\n \\n 18576xxxxx489\\n 0.01\\n \\n 华东1（杭州）\\n \\n \\n \\n test@test.aliyunid.com\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '实例账单查询服务', + 'description' => '## API描述'."\n" + ."\n" + .'在调用本接口时，请注意：'."\n" + .'- 实例账单API已升级，请使用新版API：[DescribeInstanceBill](~~209402~~)。此API不再提供50000行以后数据的查询。'."\n" + .'- 实例账单是根据账单数据拆分生成，一般会有一天延迟。'."\n" + .'- 实例信息在账期内会变化，月汇总的实例Config和Spec对应记录生成时间信息，如需详情可参考对应明细账单。'."\n" + .'- 云通信产品可查询从2020年6月以后的数据; 万网产品可查询从2020年11月以后的数据。'."\n" + .''."\n" + .'- 国际站服务地址请选择新加坡。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceBill' => [ + 'summary' => '查询用户某个账期内所有商品实例或计费项的消费汇总。', + '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' => '账期YYYY－MM。仅支持最近18个月账期。', + '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' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'IsBillingItem', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按照计费项维度拉取数据。'."\n" + ."\n" + .'- false（默认值）：与费用与成本-费用账单-账单明细-实例账单一致。'."\n" + .'- true：与费用与成本-费用账单-账单明细-计费项账单一致。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCm', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '根据原价（PretaxGrossAmount）和应付（PretaxAmount）是否都为0做过滤。取值：'."\n" + .'- false。'."\n" + .'- true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。'."\n" + ."\n" + .'> BillingDate参数值需和BillingCycle参数月份保持一致，例如BillingCycle设置为2020-03，BillingDate需设置为2020-03-DD。若月份设置不一致，查询的结果按BillingCycle设置的时间返回。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-02', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '查询账单的颗粒度。取值如下：'."\n" + ."\n" + .'- MONTHLY：月。与费用与成本-费用账单-账单明细-账期账单一致。'."\n" + .'- DAILY：日。与费用与成本-费用账单-账单明细-按天账单一致。'."\n" + ."\n" + .'> 选择DAILY需指定BillingDate。', + 'type' => 'string', + 'required' => false, + 'example' => 'MONTHLY', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '122', + ], + ], + [ + 'name' => 'InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。下次调用时，需要将此设置到入参NextToken中。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCm', + ], + 'BillingCycle' => [ + 'description' => '账单日期，格式：YYYY－MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '122', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingDate' => [ + 'description' => '账单日期，仅当Granularity为DAILY时有值，格式为YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2020-03-20', + ], + 'InstanceConfig' => [ + 'description' => '实例详细配置。', + 'type' => 'string', + 'example' => 'CPU：12', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x ', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'- SubscriptionOrder （预付订单）。'."\n" + .'- PayAsYouGoBill （后付账单）。'."\n" + .'- Refund （退款）。'."\n" + .'- Adjustment （调账）。', + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'Tag' => [ + 'description' => '资源标签。', + 'type' => 'string', + 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-dadada', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + ."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'InstanceSpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge ', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'BillingItem' => [ + 'description' => '计费项。仅当IsBillingItem=true有值。', + 'type' => 'string', + 'example' => '带宽', + ], + 'BillingItemCode' => [ + 'description' => '计费项代码。', + 'type' => 'string', + 'example' => 'disk', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '杭州', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'CostUnit' => [ + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配 ', + ], + 'ListPriceUnit' => [ + 'description' => '单价单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '元', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组 ', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriodUnit' => [ + 'description' => '服务时长单位。', + 'type' => 'string', + 'example' => '秒', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS ', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'NickName' => [ + 'description' => '实例昵称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS ', + ], + 'Usage' => [ + 'description' => '用量。'."\n" + ."\n" + .'> 仅当isBillingItem为true时有效。用量数据为该周期内所有账单的用量总和并非客户的实际购买量。如使用了1G的存储，每小时出账，则每小时用量为1G，按天汇总的账单用量为1G*24=24G。', + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'OwnerID' => [ + 'description' => '资源Owner账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '123', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'UsageUnit' => [ + 'description' => '用量单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => 'GB', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'string', + 'example' => '122', + ], + 'PaymentAmount' => [ + 'description' => '现金支付（含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'DeductedByResourcePackage' => [ + 'description' => '资源包抵扣, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '0.1', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ServicePeriod' => [ + 'description' => '服务时长。', + 'type' => 'string', + 'example' => '3600', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => '杭州1', + ], + 'ListPrice' => [ + 'description' => '单价, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '100', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'BillingType' => [ + 'description' => '计费方式。', + 'type' => 'string', + 'example' => '其它', + ], + 'ItemName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'AfterDiscountAmount' => [ + 'description' => '优惠后金额（包含券抵扣的应付金额数据。计算规则为：优惠后金额=官网目录价-优惠金额）', + '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\\": \\"test@test.aliyunid.com\\",\\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\\": \\"test@test.aliyunid.com\\",\\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":"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\nSuccessful!\\n\\n 20\\n 2020-03\\n 122\\n CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U\\n 20\\n test@test.aliyunid.com\\n \\n ecs.sn1ne.3xlarge\\t\\n 云数据库RDS\\t\\n i-dadada\\n 122\\n 0.1\\n 元\\n 2020-03-20\\n 100\\n 0.1\\n 0.1\\n 0.1\\n PayAsYouGo\\n PayAsYouGoBill\\n 0.1\\n CPU：12\\n CNY\\n rds\\n 未分配\\t\\n 0\\n 默认资源组\\t\\n 其它\\n 100\\n 0.1\\n 云数据库RDS\\t\\n rds\\n 杭州1\\n rds\\n 0.1\\n trusteeship\\n 带宽\\n test\\n 192.xx.xx.xx\\n rds\\n 秒\\n 3600\\n 0.1\\n GB\\n 123\\n 0.1\\n 34.xx.x.x\\t\\n 杭州\\n test@test.aliyunid.com\\n key:testKey value:testValue; key:testKey1 value:testValues1\\n 0\\n \\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '查询实例账单服务', + 'description' => '- 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月3日12点后支持查看/导出（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。'."\n" + .'- 当月账单数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 支持近18个月数据。 '."\n" + .'- 账单数据相对于实际费用消耗延迟24小时更新，其中实例ID相关的信息（ 实例配置，实例规格，实例昵称，资源组，公网IP，私网IP，可用区）延迟48小时更新。 '."\n" + .'- 账单数据不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用（如需统计含分拆项数据，请前往分账账单）。'."\n" + .'- 对于云通信产品，仅支持查询2020年6月及以后的明细数据，万网产品（包括域名、商标等）仅支持查询2020年11月及以后的明细数据。'."\n" + .'- 单用户限流10笔/秒，如遇超时，请重试。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryInstanceGaapCost' => [ + 'summary' => '该 API 不再更新。请前往使用如下API获取对应分摊成本：DescribeInstanceAmortizedCostByAmortizationPeriod - 查询实例摊销月摊销成本；DescribeProductAmortizedCostByAmortizationPeriod- 查询产品摊销月摊销成本；DescribeInstanceAmortizedCostByConsumePeriod- 查询实例账期月摊销成本；DescribeProductAmortizedCostByConsumePeriod- 查询产品账期月摊销成本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认值：20，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，YYYY－MM。', + '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' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + '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' => '主机ID。', + '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' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + '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' => '订单类型：'."\n" + .'- New（新购）。'."\n" + .'- Renewal（续费）。'."\n" + .'- Upgrade（升级）。'."\n" + .'- Degrade（降级）。'."\n", + 'type' => 'string', + 'example' => 'New', + ], + 'MonthGaapDeductedByPrepaidCard' => [ + 'description' => '本月分摊储值卡抵扣。', + 'type' => 'string', + 'example' => '0', + ], + 'UnallocatedDeductedByCashCoupons' => [ + 'description' => '未分摊代金券抵扣。', + 'type' => 'string', + 'example' => '0', + ], + 'PretaxAmountLocal' => [ + 'description' => '本币币种已分摊优惠后金额（国际）。', + 'type' => 'string', + 'example' => '0', + ], + 'BillingCycle' => [ + 'description' => '账期YYYY－MM。', + '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' => '账单类型：'."\n" + .'- SubscriptionOrder （预付订单）。'."\n" + .'- PayAsYouGoBill （后付账单）。'."\n" + .'- Refund （退款）。'."\n" + .'- Adjustment （调账）。', + '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' => '实例ID。', + 'type' => 'string', + 'example' => 'OSSBAG-cn-0xl0xxxxxx', + ], + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag', + ], + 'Currency' => [ + 'description' => '币种。取值：'."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + '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' => '所有者ID。', + '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":"\\n \\n 2\\n \\n \\n null\\n 0\\n 0\\n 0.74\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2018-06-15 14:06:53\\n CNY\\n ossbag\\n 0\\n Renewal\\n 0\\n 0\\n CNY\\n 0\\n 0\\n Subscription\\n 2019-04\\n flowpack\\n OSSBAG-cn-0xl0njdtx002\\n 0\\n 0\\n 0\\n 202143356070333\\n 0\\n 0\\n 0\\n 202143356070333\\n 0\\n 0\\n 2019-05-01 00:00:00\\n 0\\n 0\\n 2019-04-01 00:00:00\\n 0.99\\n 0\\n 0.25\\n 0\\n 1028728862215453\\n 0.74\\n 0\\n 0.74\\n 0\\n SubscriptionOrder\\n \\n \\n 20\\n cn\\n 1\\n \\n Successful!\\n AEAA504C-FCCA-4FB9-9E05-162CABC6EB40\\n true\\n Success\\n","errorExample":""}]', + 'title' => '查询月费用分摊服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ + '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' => [ + 'title' => '账期月、摊销月', + 'description' => '摊销月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '账期月筛选条件', + 'description' => '账期月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账期月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '订阅类型', + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '产品。'."\n" + .'参考取值来源：'."\n" + .'查QueryProductList 查询产品信息，'."\n" + .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', + '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' => [ + 'title' => '财务单元code', + 'description' => '财务单元code。', + 'type' => 'string', + 'required' => false, + 'example' => '123#', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账单购买者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源归属账号筛选条件。'."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '资源归属账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID筛选条件。'."\n" + .'支持查询多个实例，不传默认查所有实例。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '消息说明。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'Data' => [ + 'description' => '返回数据'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + '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' => [ + 'CostUnit' => [ + 'title' => '财务单元', + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配', + ], + 'CostUnitCode' => [ + 'title' => '财务单元code', + 'description' => '财务单元code。', + 'type' => 'string', + 'example' => '1234', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组 ', + ], + 'Tag' => [ + 'description' => '实例标签。', + 'type' => 'string', + 'example' => 'tag', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '杭州', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => '杭州1', + ], + 'SplitAccountName' => [ + 'description' => '分拆项所属账号名称。', + 'type' => 'string', + 'example' => 'test**1122', + ], + 'SplitProductDetail' => [ + 'description' => '分拆项产品明细名称。', + 'type' => 'string', + 'example' => 'rds', + ], + 'SplitItemID' => [ + 'description' => '分拆项ID。', + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'SplitItemName' => [ + 'description' => '分拆项名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ConsumePeriod' => [ + 'title' => '账期', + 'description' => '账期。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'title' => '摊销状态', + 'description' => '摊销状态，取值：'."\n" + .'- amortized 已摊销'."\n" + .'- unAmortized 未摊销', + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'title' => '摊销月', + 'description' => '摊销月。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'BillOwnerID' => [ + 'description' => '资源归属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => '资源所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'ProductDetailCode' => [ + 'description' => '产品明细code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS ', + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PretaxGrossAmount' => [ + 'title' => '官网价', + 'description' => '官网价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'title' => '优惠金额', + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RoundDownDiscount' => [ + 'title' => '抹零金额', + 'description' => '抹零金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'title' => '应付金额', + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'title' => '代金券抵扣', + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'title' => '优惠券抵扣', + 'description' => '优惠券抵扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByPrepaidCard' => [ + 'title' => '储值卡支付金额', + 'description' => '储值卡支付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExpenditureAmount' => [ + 'title' => '消费金额（可开票）', + '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' => [ + 'description' => '优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'description' => '期初已摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'description' => '本期摊销-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'description' => '期末未摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\",\\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\\": \\"test@test.aliyunid.com\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"test@test.aliyunid.com\\",\\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"}]', + 'title' => '查询实例摊销月摊销成本', + 'description' => '- 摊销成本不作为结算及对账依据。摊销成本提供费用分摊能力，将您在云上产生的费用（含预付费和后付费）按照指定的分摊规则进行分摊。'."\n" + .'- 当月最终数据在次月6日12点后支持使用（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。当月数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 摊销成本数据支持近12个月数据。'."\n" + .'- 摊销成本中分拆项相关数据在分账账单数据出具后延迟48小时更新（若需使用分拆费用请提前开通[分账账单](https://usercenter2.aliyun.com/finance/split-bill)）；非分拆项相关数据在明细账单出具后延迟48小时更新。'."\n" + .'- 2021年8月（不含）之前的摊销成本月中不更新，仅于摊销次月6日12点后统一更新，也不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用。'."\n" + .'- 摊销成本数据需要用户开通[摊销成本](https://usercenter2.aliyun.com/finance/amortized-costs)后才可提供，自开通后延迟48小时可使用。', + ], + 'DescribeProductAmortizedCostByAmortizationPeriod' => [ + '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' => '摊销月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '账期月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账期月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '产品。'."\n" + .'参考取值来源：'."\n" + .'查QueryProductList 查询产品信息，'."\n" + .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', + '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' => '财务单元code。', + 'type' => 'string', + 'required' => false, + 'example' => '123#'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账单购买者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源归属账号筛选条件。'."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '资源归属账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult>', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200'."\n", + ], + 'Message' => [ + 'description' => '消息说明。', + 'type' => 'string', + 'example' => 'Successful！'."\n", + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\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' => '账期。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'description' => '摊销状态，取值：'."\n" + .'- amortized 已摊销'."\n" + .'- unAmortized 未摊销', + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'description' => '摊销月。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'BillOwnerID' => [ + 'description' => '资源归属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => '资源所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS'."\n", + ], + 'ProductDetailCode' => [ + 'description' => '产品明细code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS'."\n", + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship'."\n", + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + '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' => [ + 'description' => '优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'description' => '期初已摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'description' => '本期摊销-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'description' => '期末未摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\\\n\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"test@test.aliyunid.com\\\\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"}]', + 'title' => '查询产品摊销月摊销成本', + 'description' => '- 摊销成本不作为结算及对账依据。摊销成本提供费用分摊能力，将您在云上产生的费用（含预付费和后付费）按照指定的分摊规则进行分摊。'."\n" + .'- 当月最终数据在次月6日12点后支持使用（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。当月数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 摊销成本数据支持近12个月数据。'."\n" + .'- 摊销成本中分拆项相关数据在分账账单数据出具后延迟48小时更新（若需使用分拆费用请提前开通[分账账单](https://usercenter2.aliyun.com/finance/split-bill)）；非分拆项相关数据在明细账单出具后延迟48小时更新。'."\n" + .'- 2021年8月（不含）之前的摊销成本月中不更新，仅于摊销次月6日12点后统一更新，也不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用。'."\n" + .'- 摊销成本数据需要用户开通[摊销成本](https://usercenter2.aliyun.com/finance/amortized-costs)后才可提供，自开通后延迟48小时可使用。', + ], + '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' => [ + 'title' => '账期月、摊销月', + 'description' => '账期月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '摊销月筛选条件', + 'description' => '摊销月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '摊销月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09'."\n", + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '订阅类型', + 'description' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '产品。'."\n" + .'参考取值来源：'."\n" + .'查QueryProductList 查询产品信息，'."\n" + .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', + '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' => [ + 'title' => '财务单元code', + 'description' => '财务单元code。', + 'type' => 'string', + 'required' => false, + 'example' => '123#'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账单购买者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源归属账号筛选条件。 '."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。 '."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '资源归属账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID筛选条件。'."\n" + .'支持查询多个实例，不传默认查所有实例。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185766xxxx'."\n", + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\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' => [ + 'CostUnit' => [ + 'title' => '财务单元', + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配'."\n", + ], + 'CostUnitCode' => [ + 'title' => '财务单元code', + 'description' => '财务单元code。', + 'type' => 'string', + 'example' => '1234', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh'."\n", + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组 '."\n", + ], + 'Tag' => [ + 'description' => '实例标签。', + 'type' => 'string', + 'example' => 'tag', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x'."\n", + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx'."\n", + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '杭州', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => '杭州1'."\n", + ], + 'SplitAccountName' => [ + 'description' => '分拆项所属账号名称。', + 'type' => 'string', + 'example' => 'test**1122'."\n", + ], + 'SplitProductDetail' => [ + 'description' => '分拆项产品明细名称。', + 'type' => 'string', + 'example' => 'rds', + ], + 'SplitItemID' => [ + 'description' => '分拆项ID。', + 'type' => 'string', + 'example' => 'i-28bycvyb4'."\n", + ], + 'SplitItemName' => [ + 'description' => '分拆项名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z'."\n", + ], + 'ConsumePeriod' => [ + 'title' => '账期', + 'description' => '账期。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'title' => '摊销状态', + 'description' => '摊销状态，取值：'."\n" + ."\n" + .'- amortized 已摊销'."\n" + .'- unAmortized 未摊销', + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'title' => '摊销月', + 'description' => '摊销月。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'BillOwnerID' => [ + 'description' => '资源归属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => '资源所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS'."\n", + ], + 'ProductDetailCode' => [ + 'description' => '产品明细code。', + 'type' => 'string', + 'example' => 'rds'."\n", + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS '."\n", + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PretaxGrossAmount' => [ + 'title' => '官网价', + 'description' => '官网价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'title' => '优惠金额', + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RoundDownDiscount' => [ + 'title' => '抹零金额', + 'description' => '抹零金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PretaxAmount' => [ + 'title' => '应付金额', + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCashCoupons' => [ + 'title' => '代金券抵扣', + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByCoupons' => [ + 'title' => '优惠券抵扣', + 'description' => '优惠券抵扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'DeductedByPrepaidCard' => [ + 'title' => '储值卡支付金额', + 'description' => '储值卡支付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'ExpenditureAmount' => [ + 'title' => '消费金额（可开票）', + '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' => [ + 'description' => '优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'description' => '期初已摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'description' => '本期摊销-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'description' => '期末未摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\\\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\\": \\"test@test.aliyunid.com\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"test@test.aliyunid.com\\\\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"}]', + 'title' => '查询实例账期月摊销成本', + 'description' => '- 摊销成本不作为结算及对账依据。摊销成本提供费用分摊能力，将您在云上产生的费用（含预付费和后付费）按照指定的分摊规则进行分摊。'."\n" + .'- 当月最终数据在次月6日12点后支持使用（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。当月数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 摊销成本数据支持近12个月数据。'."\n" + .'- 摊销成本中分拆项相关数据在分账账单数据出具后延迟48小时更新（若需使用分拆费用请提前开通[分账账单](https://usercenter2.aliyun.com/finance/split-bill)）；非分拆项相关数据在明细账单出具后延迟48小时更新。'."\n" + .'- 2021年8月（不含）之前的摊销成本月中不更新，仅于摊销次月6日12点后统一更新，也不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用。'."\n" + .'- 摊销成本数据需要用户开通[摊销成本](https://usercenter2.aliyun.com/finance/amortized-costs)后才可提供，自开通后延迟48小时可使用。', + ], + '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' => '账期月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '摊销月筛选条件', + 'description' => '摊销月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '摊销月'."\n" + .'格式：YYYY－MM。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09'."\n", + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '产品。'."\n" + .'参考取值来源：'."\n" + .'查QueryProductList 查询产品信息，'."\n" + .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', + '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' => '财务单元code。', + 'type' => 'string', + 'required' => false, + 'example' => '123#'."\n", + 'maxLength' => 256, + ], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '账单购买者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源归属账号筛选条件。 '."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。 '."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => [ + 'description' => '资源归属账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 256, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", + 'maxLength' => 2560, + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult>', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185766xxxx', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\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' => '账期。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'AmortizationStatus' => [ + 'description' => '摊销状态，取值：'."\n" + ."\n" + .'- amortized 已摊销'."\n" + .'- unAmortized 未摊销', + 'type' => 'string', + 'example' => 'amortized', + ], + 'AmortizationPeriod' => [ + 'description' => '摊销月。'."\n" + .'格式：YYYYMM。', + 'type' => 'string', + 'example' => '202210', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'BillOwnerID' => [ + 'description' => '资源归属账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185xxxxx489', + ], + 'BillOwnerName' => [ + 'description' => '资源所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS'."\n", + ], + 'ProductDetailCode' => [ + 'description' => '产品明细code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS'."\n", + ], + 'BizType' => [ + 'description' => '业务类型。', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + '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' => [ + 'description' => '优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'PreviouslyAmortizedAfterDiscountAmount' => [ + 'description' => '期初已摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CurrentAmortizationAfterDiscountAmount' => [ + 'description' => '本期摊销-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'RemainingAmortizationAfterDiscountAmount' => [ + 'description' => '期末未摊-优惠后金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"test@test.aliyunid.com\\\\n\\",\\n \\"MaxResults\\": 100,\\n \\"TotalCount\\": 100,\\n \\"Items\\": [\\n {\\n \\"ConsumePeriod\\": \\"202210\\",\\n \\"AmortizationStatus\\": \\"amortized\\",\\n \\"AmortizationPeriod\\": \\"202210\\",\\n \\"BillAccountID\\": 0,\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\\\n\\",\\n \\"BillOwnerID\\": 0,\\n \\"BillOwnerName\\": \\"test@test.aliyunid.com\\\\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"}]', + 'title' => '查询产品账期月摊销成本', + 'description' => '- 摊销成本不作为结算及对账依据。摊销成本提供费用分摊能力，将您在云上产生的费用（含预付费和后付费）按照指定的分摊规则进行分摊。'."\n" + .'- 当月最终数据在次月6日12点后支持使用（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。当月数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 摊销成本数据支持近12个月数据。'."\n" + .'- 摊销成本中分拆项相关数据在分账账单数据出具后延迟48小时更新（若需使用分拆费用请提前开通[分账账单](https://usercenter2.aliyun.com/finance/split-bill)）；非分拆项相关数据在明细账单出具后延迟48小时更新。'."\n" + .'- 2021年8月（不含）之前的摊销成本月中不更新，仅于摊销次月6日12点后统一更新，也不支持提供分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用。'."\n" + .'- 摊销成本数据需要用户开通[摊销成本](https://usercenter2.aliyun.com/finance/amortized-costs)后才可提供，自开通后延迟48小时可使用。', + ], + 'DescribeSplitItemBill' => [ + 'summary' => '查询分账账单。', + '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' => '账单日期，YYYY－MM。', + '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' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'> 必须和ProductCode参数一起使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmd', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + [ + 'name' => 'InstanceID', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + ], + [ + 'name' => 'SplitItemID', + 'in' => 'query', + 'schema' => [ + 'description' => '分拆项ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '查询账单的颗粒度。取值：'."\n" + .'- MONTHLY：月。与用户中心-分账账单-账期账单一致。'."\n" + .'- DAILY：日。与用户中心-分账账单-按天账单一致。'."\n" + ."\n" + .'> 选择DAILY需指定BillingDate。', + 'type' => 'string', + 'required' => false, + 'example' => 'Monthly', + ], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => [ + 'description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-03-02', + ], + ], + [ + 'name' => 'TagFilter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签过滤条件，支持多组标签查询条件TagValues。多组TagValues条件之间为或关系。', + 'type' => 'array', + 'items' => [ + 'description' => '标签过滤条件。', + 'type' => 'object', + 'properties' => [ + 'TagValues' => [ + 'description' => 'TagValues.N用于查找符合指定标签值的账单，由字符串列表组成。标签值长度的取值范围：1~128。N的取值范围：1~20。'."\n" + .'- 指定TagValues.N时，需同时指定TagFilter.N.TagKey，否则报错InvalidParameter.TagValues。'."\n" + .'- 指定多个标签值时，则满足任一标签值的账单都会被查询到。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'required' => false, + 'example' => 'TestValue', + 'maxItems' => 20, + ], + 'TagKey' => [ + 'description' => 'TagFilter.N用于查找符合指定标签的账单，由一个键值对组成。标签键长度的取值范围：1~128。N的取值范围：1~20'."\n" + ."\n" + .'- 仅指定TagFilter.N.TagKey时，则返回关联该标签键的所有账单。'."\n" + .'- 同时指定多个标签键值对时，满足任一标签键值对的账单被查找到。'."\n" + .'- 如果资源上的标签发生变动，仅能查询标签存续期间的账单。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => [ + 'description' => '根据原价（PretaxGrossAmount）和应付（PretaxAmount）是否都为0做过滤。取值：'."\n" + ."\n" + .'- false。'."\n" + .'- true。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。下次调用时，需要将此设置到入参NextToken中。', + 'type' => 'string', + 'example' => 'CAESEgoQCg4K', + ], + 'BillingCycle' => [ + 'description' => '账单日期，格式：YYYY－MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => [ + 'description' => '分拆项所属账号AccountID', + 'type' => 'string', + 'example' => '12**122', + ], + 'BillAccountName' => [ + 'description' => '账单所属账号名称。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '杭州', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致。', + 'type' => 'string', + 'example' => 'rds', + ], + 'NickName' => [ + 'description' => '实例昵称。', + 'type' => 'string', + 'example' => 'nick', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'Usage' => [ + 'description' => '用量。', + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'UsageUnit' => [ + 'description' => '用量单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'SplitCommodityCode' => [ + 'description' => '分拆项商品code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'BillAccountID' => [ + 'description' => '账单所属账号ID。', + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedByResourcePackage' => [ + 'description' => '资源包抵扣。', + 'type' => 'string', + 'example' => '0', + ], + 'PaymentAmount' => [ + 'description' => '现金支付（含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitBillingCycle' => [ + 'description' => '分账月。', + 'type' => 'string', + 'example' => '2021-06', + ], + 'ServicePeriod' => [ + 'description' => '服务时长。', + 'type' => 'string', + 'example' => '20', + ], + 'SplitItemName' => [ + 'description' => '分拆项名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ListPrice' => [ + 'description' => '单价。', + 'type' => 'string', + 'example' => '0.12', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => '华北1', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InstanceConfig' => [ + 'description' => '实例详细配置。', + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'BillingDate' => [ + 'description' => '账单日期，格式YYYY-MM-DD。暂未支持。', + 'type' => 'string', + 'example' => '2020-01-20', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'SubscriptionOrder（预付订单）。'."\n" + .'PayAsYouGoBill （后付账单）。'."\n" + .'Refund （退款）。'."\n" + .'Adjustment （调账）。', + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'SplitItemID' => [ + 'description' => '分拆项ID。', + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Tag' => [ + 'description' => '资源标签。资源上标签变更时，则存续期间产生的账单会有此标签。', + 'type' => 'string', + 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + .'CNY。'."\n" + .'USD。'."\n" + .'JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BizType' => [ + 'description' => '业务类型', + 'type' => 'string', + 'example' => 'trusteeship', + ], + 'BillingItem' => [ + 'description' => '计费项。', + 'type' => 'string', + 'example' => '带宽', + ], + 'BillingItemCode' => [ + 'description' => '计费项代码。', + 'type' => 'string', + 'example' => 'disk', + ], + 'CostUnit' => [ + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配', + ], + 'ListPriceUnit' => [ + 'description' => '单价单位。', + 'type' => 'string', + 'example' => '元/GB', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ServicePeriodUnit' => [ + 'description' => '服务时长单位。', + 'type' => 'string', + 'example' => '小时', + ], + 'SplitBillingDate' => [ + 'description' => '分账天。', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'SplitProductDetail' => [ + 'description' => '分拆项产品明细名称。', + 'type' => 'string', + 'example' => '云数据库', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OwnerID' => [ + 'description' => '资源Owner账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '169***013', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitAccountName' => [ + 'description' => '分拆项所属账号名称。', + 'type' => 'string', + 'example' => 'test**1122', + ], + 'BillingType' => [ + 'description' => '计费方式。', + 'type' => 'string', + 'example' => '其它', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ItemName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'AfterDiscountAmount' => [ + 'description' => '优惠后金额（包含券抵扣的应付金额数据。计算规则为：优惠后金额=官网目录价-优惠金额）', + '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\\": \\"CAESEgoQCg4K\\",\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"MaxResults\\": 20,\\n \\"AccountID\\": \\"185xxxx3489\\",\\n \\"TotalCount\\": 20,\\n \\"AccountName\\": \\"test@test.aliyunid.com\\",\\n \\"Items\\": [\\n {\\n \\"SplitAccountID\\": \\"12**122\\",\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\",\\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":"\\n Success\\n Successful!\\n 79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\n true\\n \\n CAESEgoQCg4K\\n 2020-03\\n 20\\n 185xxxx3489\\n 20\\n test@test.aliyunid.com\\n \\n 12**122\\n test@test.aliyunid.com\\n PayAsYouGo\\n ecs.sn1ne.3xlarge\\n 0\\n 杭州\\n 0.1\\n rds\\n rds\\n nick\\n 云数据库RDS\\n 100\\n 192.xx.xx.xx\\n GB\\n rds\\n 185xxxx3489\\n rds\\n 0\\n 0\\n 2021-06\\n 20\\n iZ28bycvyb4Z\\n 0.12\\n 华北1\\n 0\\n 0\\n CPU:12\\n 2020-01-20\\n 34.xx.x.x\\n PayAsYouGoBill\\n i-28bycvyb4\\n i-kjhdskjgshfdlkjfdh\\n key:testKey value:testValue; key:testKey1 value:testValues1\\n CNY\\n 0\\n trusteeship\\n 带宽\\n disk\\n 未分配\\n 元/GB\\n 默认资源组\\n 0\\n 小时\\n 2021-06-01\\n 云数据库RDS\\n 云数据库\\n 0\\n 169***013\\n 0\\n 0\\n test**1122\\n 其它\\n rds\\n iZ28bycvyb4Z\\n \\n \\n","errorExample":""}]', + 'title' => '分账账单服务', + 'description' => '- 分账账单当月数据查询结果仅供参考，不作为对账依据。当月最终账单在次月4日12点后查询，当月分账账单数据中不包含未结算（未出账，累账中）的后付费数据。'."\n" + .'- 分账账单数据支持最近12个月数据。'."\n" + .'- 分账账单数据相对于实际费用消耗延迟48小时更新，其中分拆型云产品（例如：CDN、OSS、共享带宽等）各个分拆项（例如：域名、Bucket、EIP等）的具体费用延迟72小时更新。'."\n" + .'- 分账账单数据需要用户在控制台[分账账单](https://usercenter2.aliyun.com/finance/split-bill)[分账账单](https://usercenter2-intl.aliyun.com/finance/split-bill)页面开通后才可提供，自开通后延迟24小时可使用。'."\n" + .'- 单用户限流10笔/秒，如遇超时，请重试。', + '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' => '账单日期，YYYY－MM。', + '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' => '订阅类型。取值：'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：后付费。'."\n" + .'说明：必须和ProductCode参数一起使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'description' => '账单日期，格式：YYYY－MM。', + 'type' => 'string', + 'example' => '2020-03', + ], + 'AccountID' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '185xxxx3489', + ], + 'PageSize' => [ + 'description' => '每页数量，默认值：20，最大值：300。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccountName' => [ + 'description' => '用户账号。', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '账单详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => [ + 'description' => '分拆项所属账号AccountID。', + 'type' => 'string', + 'example' => '122', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：后付费。'."\n" + .'说明：必须和ProductCode参数一起使用。'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'InstanceSpec' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.3xlarge', + ], + 'DeductedByCoupons' => [ + 'description' => '优惠券优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OutstandingAmount' => [ + 'description' => '未结清金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'CommodityCode' => [ + 'description' => '商品Code，与费用中心产品明细Code一致', + 'type' => 'string', + 'example' => 'rds', + ], + 'NickName' => [ + 'description' => '实例昵称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProductDetail' => [ + 'description' => '产品明细。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'Usage' => [ + 'description' => '用量, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '100', + ], + 'IntranetIP' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.xx.xx.xx', + ], + 'UsageUnit' => [ + 'description' => '用量单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => 'GB', + ], + 'SplitCommodityCode' => [ + 'description' => '分拆项商品Code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'DeductedByResourcePackage' => [ + 'description' => '资源包抵扣。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'PaymentAmount' => [ + 'description' => '现金支付。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitBillingCycle' => [ + 'description' => '分账月。', + 'type' => 'string', + 'example' => '2020-06', + ], + 'ServicePeriod' => [ + 'description' => '服务周期。', + 'type' => 'string', + 'example' => '10', + ], + 'SplitItemName' => [ + 'description' => '分拆项名称。', + 'type' => 'string', + 'example' => 'iZ28bycvyb4Z', + ], + 'ListPrice' => [ + 'description' => '单价, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '100', + ], + 'Zone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CashAmount' => [ + 'description' => '现金支付（不包含信用额度退款抵扣）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InstanceConfig' => [ + 'description' => '实例详细配置。', + 'type' => 'string', + 'example' => 'CPU:12', + ], + 'BillingDate' => [ + 'description' => '账单日期，格式YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2020-01-20', + ], + 'InternetIP' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '34.xx.x.x', + ], + 'Item' => [ + 'description' => '账单类型：'."\n" + .'SubscriptionOrder （预付订单）。'."\n" + .'PayAsYouGoBill （后付账单）。'."\n" + .'Refund （退款）。'."\n" + .'Adjustment （调账）。', + 'type' => 'string', + 'example' => 'PayAsYouGoBill', + ], + 'SplitItemID' => [ + 'description' => '分拆项ID。', + 'type' => 'string', + 'example' => 'i-28bycvyb4', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-kjhdskjgshfdlkjfdh', + ], + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + .'CNY。'."\n" + .'USD。'."\n" + .'JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'DeductedByCashCoupons' => [ + 'description' => '代金券抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'BillingItem' => [ + 'description' => '计费项。', + 'type' => 'string', + 'example' => '其他', + ], + 'CostUnit' => [ + 'description' => '财务单元。', + 'type' => 'string', + 'example' => '未分配', + ], + 'ListPriceUnit' => [ + 'description' => '单价单位, 仅当isBillingItem为true时有效。', + 'type' => 'string', + 'example' => '元', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'PretaxAmount' => [ + 'description' => '应付金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ServicePeriodUnit' => [ + 'description' => '服务时长单位。', + 'type' => 'string', + 'example' => '秒', + ], + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '云数据库RDS', + ], + 'SplitProductDetail' => [ + 'description' => '分拆项产品明细名称。', + 'type' => 'string', + 'example' => 'rds', + ], + 'AdjustAmount' => [ + 'description' => '信用额度退款抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OwnerID' => [ + 'description' => '子账号AccountID（多账号代付场景）。', + 'type' => 'string', + 'example' => '169***013', + ], + 'DeductedByPrepaidCard' => [ + 'description' => '储值卡抵扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'SplitAccountName' => [ + 'description' => '分拆项所属账号名称。', + 'type' => 'string', + 'example' => '12@test.com', + ], + 'BillingType' => [ + 'description' => '计费方式。', + 'type' => 'string', + 'example' => '其它', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + '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\\": \\"test@test.aliyunid.com\\",\\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\\": \\"12@test.com\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\nSuccessful!\\n\\n 2020-03\\n 2\\n 185xxxx3489\\n 1\\n 20\\n \\n \\n ecs.sn1ne.3xlarge\\n 云数据库RDS\\n i-kjhdskjgshfdlkjfdh\\n 0\\n 元\\n \\n 100\\n 0\\n 0\\n 0\\n iZ28bycvyb4Z\\n PayAsYouGo\\n PayAsYouGoBill\\n 0\\n CPU:12\\n CNY\\n 未分配\\n 默认资源组\\n 其它\\n 100\\n 0\\n 云数据库RDS\\n rds\\n cn-hangzhou-h\\n rds\\n 0\\n 其他\\n test\\n 192.xx.xx.xx\\n 10\\n i-28bycvyb4\\n NULL\\n GB\\n 169***013\\n 0\\n 34.xx.x.x\\n cn-hangzhou\\n tag\\n \\n \\n test@test.aliyunid.com\\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '查询分账账单', + 'summary' => '查询分账账单。分账账单 API 已升级，请使用新版API：DescribeSplitItemBill。', + 'description' => '- 分账账单API已升级，请使用新版API：[DescribeSplitItemBill](~~208169~~)。此API不再提供50000行以后数据的查询。'."\n" + .'- 与费用中心-分账账单账期数据一致'."\n" + .'- 分账账单提供12月内账期数据查询'."\n" + .'- 本数据需要用户在控制台[分账账单](https://usercenter2.aliyun.com/finance/split-bill)页面开通后才可提供', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InquiryPriceRefundInstance' => [ + 'summary' => 'InquiryPriceRefundInstance：调用本接口对需要退订的实例进行询价。', + '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' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。', + 'type' => 'string', + 'required' => false, + 'example' => '793F021C-B589-1225-82A9-99232AEBE494', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => '退订场景必填，产品code', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceId', + 'description' => '退订场景必填，实例id', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1etb69sqxgl4*******', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => '退订场景必填，产品类型，无特殊说明传入“” 空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '”“', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '执行结果说明', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台。', + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => '执行主机所在站点', + 'type' => 'string', + 'example' => 'cn', + ], + 'InstanceId' => [ + 'title' => 'instanceId', + 'description' => '实例id', + 'type' => 'string', + 'example' => 'i-bp1etb69sqxgl4*******', + ], + 'Currency' => [ + 'title' => 'currency', + 'description' => '币种', + 'type' => 'string', + 'example' => '退款金额本币币种： CNY：人民币。 USD：美元。 JPY：日元。', + ], + 'RefundAmount' => [ + 'title' => 'refundAmount', + 'description' => '金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '12.34', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '响应码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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' => '退订实例询价', + 'description' => '1. **请仔细核对退订资源的信息，并确认退订条款和退订金额，资源一经退订无法恢复。**'."\n" + .'2. 退订只退还实付金额的部分，已使用的代金券不退还。'."\n" + .'3. 其他问题请参照：[退订规则](https://help.aliyun.com/knowledge_detail/116043.html?spm=a2c81.e1d666e.app.2.62ae11271Kd6iM)[国际站退订规则说明](https://www.alibabacloud.com/help/zh/user-center/user-guide/refund-rules)', + 'extraInfo' => "\n" + .'**针对部分业务规则拦截返回的错误码的解释**'."\n" + ."\n" + .'- ResourceNotExists：实例不存在'."\n" + .'- ResourceStatusError：实例状态不对'."\n" + .'- BindMirrorInstanceError：ecs有关联的收费镜像'."\n" + .'- ExceedRefundQuotaError：退订次数超过quota配额上限'."\n" + .'- ExistUnPaidOrderError：实例下存在未支付订单'."\n" + .'- ExistRefundingOrderError：无效实例ID(实例已到期或已退款或已释放)'."\n" + .'- NoRestValueError：退款金额为0'."\n" + .'- AmbassadorOrderLimitError：实例下有云大使订单'."\n" + .'- ActivityForbiddenError：活动订单禁止退款'."\n" + .'- ProductCheckError：云产品规则预校验未通过', + ], + 'GetPayAsYouGoPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值类型：PayAsYouGo（后付费）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的 Region ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '计价模块列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计价模块。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '第n个计价模块的模块标识。'."\n" + ."\n\n" + .'> 可通过[DescribePricingModule](~~96469~~)接口获取Module参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType', + ], + 'PriceType' => [ + 'description' => '第n个计价模块的价格类型，取值范围：'."\n" + .'- Hour：小时价。'."\n" + .'- Usage：使用量。'."\n" + .'- Month：月价。'."\n" + .'- Year：年价。'."\n" + ."\n" + .'> 可通过[DescribePricingModule](~~96469~~)接口获取Module参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'Hour', + ], + 'Config' => [ + 'description' => '第n个计价模块的配置，n的取值范围为（1~50），格式：“AA:aa,BB:bb”，其中AA,BB分别为计价模块属性标识，aa,bb分别为计价模块属性的属性值。'."\n" + ."\n" + .'> 可通过[DescribePricingModule](~~96469~~)接口获取Module参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'description' => '币种。取值范围：'."\n" + .'- CNY：人民币。'."\n" + .'- USD：美元。'."\n" + .'- JPY：日元。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => '计价模块价格详情。', + 'type' => 'array', + 'items' => [ + 'description' => '计价模块价格详情。', + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => [ + 'description' => '优惠价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'InvoiceDiscount' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'UnitPrice' => [ + 'description' => '单价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OriginalCost' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.77', + ], + 'ModuleCode' => [ + 'description' => '计价模块标识。', + 'type' => 'string', + 'example' => 'InstanceType', + ], + ], + ], + ], + ], + ], + 'PromotionDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionDetail' => [ + 'description' => '优惠详情。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠详情。', + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => [ + 'description' => '优惠描述。', + 'type' => 'string', + 'example' => '仅提供测试使用的1分钱活动', + ], + 'PromotionId' => [ + 'description' => '优惠标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10200210', + ], + 'PromotionName' => [ + 'description' => '优惠名称。', + 'type' => 'string', + 'example' => '仅提供测试使用的1分钱活动', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"\\n Successful!\\n 1537A007-72D7-4165-8A26-8694A38E219A\\n \\n CNY\\n \\n \\n 0\\n InstanceType\\n 0.01\\n 1.77\\n 1.76\\n \\n \\n \\n \\n 仅提供测试使用的1分钱活动\\n 10200210\\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '后付费产品询价服务', + 'summary' => '查询后付费产品价格。', + 'description' => '### API描述'."\n" + .'1. 调用QueryProductList获取产品code,参见[查询产品信息](~~95984~~)。'."\n" + .'2. 调用DescribePricingModule接口获取产品的配置参数，参见[查询产品模块信息](~~96469~~)。'."\n" + .'3. 根据查询到的产品配置参数调用本接口获取后付费产品的价格。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSubscriptionPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ServicePeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '服务时长单位。取值范围：'."\n" + .'- Year：年。'."\n" + .'- Month：月。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值类型：Subscription（预付费）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。取值范围：'."\n" + .'- NewOrder：新购。'."\n" + .'- Renewal：续费。'."\n" + .'- Upgrade：升级。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NewOrder', + ], + ], + [ + 'name' => 'ServicePeriodQuantity', + 'in' => 'query', + 'schema' => [ + 'description' => '服务时长。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，是否必输以具体产品的询价文档为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的Region ID（地域ID）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定询价的实例 ID，升级场景必须设置，用于获取实例升级前配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-khkjhxxxxxxxxx', + ], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '计价模块列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleStatus' => [ + 'description' => '仅在订单类型为Upgrade（升级）时需要，表示此次询价模块变更状态。'."\n" + .'取值范围：'."\n" + .'- 1：新增。'."\n" + .'- 2：变更，升级场景如果计价模块的配置发生变化需要显示指定此状态值。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ModuleCode' => [ + 'description' => '第n个计价模块的模块标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'PackageCode', + ], + 'Tag' => [ + 'description' => '仅在某些产品的升级变配中需要，代表指定资源的标识。例如：对于磁盘的变配，用Tag标识具体磁盘对应的Id。', + 'type' => 'string', + 'required' => false, + 'example' => '213213123', + ], + 'Config' => [ + 'description' => '第n个计价模块的配置，n的取值范围为（1~50），格式：“AA:aa,BB:bb”，其中AA,BB分别为计价模块属性标识，aa,bb分别为计价模块属性的属性值。', + 'type' => 'string', + 'required' => true, + 'example' => 'PackageCode:version_1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'InvalidConfigCod', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30E7066E-AE6F-4E59-AFE6-11386CE3AFA7', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '产品价格信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '900', + ], + 'DiscountPrice' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Currency' => [ + 'description' => '币种。取值范围：'."\n" + .'- CNY：人民币。'."\n" + .'- USD：美元。'."\n" + .'- JPY：日元。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'Quantity' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TradePrice' => [ + 'description' => '优惠价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => '计价模块价格详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => [ + 'description' => '优惠价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'InvoiceDiscount' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'UnitPrice' => [ + 'description' => '单价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'OriginalCost' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'ModuleCode' => [ + 'description' => '计价模块标识。', + 'type' => 'string', + 'example' => 'PackageCode', + ], + ], + ], + ], + ], + ], + 'PromotionDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromotionDetail' => [ + 'description' => '优惠详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => [ + 'description' => '优惠描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'PromotionId' => [ + 'description' => '优惠标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1021199213', + ], + 'PromotionName' => [ + 'description' => '优惠名称。', + '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":"\\n \\n 1\\n 900\\n \\n \\n ExtBandwidth\\n 0\\n 0\\n 800\\n 800\\n \\n \\n PackageCode\\n 0\\n 0\\n 100\\n 100\\n \\n \\n \\n \\n 1021199213\\n \\n \\n \\n 900\\n 0\\n CNY\\n \\n D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\n true\\n Success\\n Successful!\\n","errorExample":""}]', + 'title' => '预付费产品询价服务', + 'summary' => '查询预付费产品价格。', + 'description' => '1. 调用QueryProductList获取产品code,参见[查询产品信息](~~95984~~)。'."\n" + .'2. 调用DescribePricingModule接口获取产品的配置参数，参见[查询产品模块信息](~~96469~~)。'."\n" + .'3. 根据查询到的产品配置参数调用本接口获取预付费产品的价格。', + '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' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数，默认值为20，最大不超过300个。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。可通过接口**QueryProductList**查询产品代码。'."\n" + ."\n" + .'> 当设置了region时，不为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'InstanceIDs', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。多个ID用英文逗号分隔，最大不超过100个。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'EndTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间段起，符合ISO8601标准的utc时间格式，例如2016-05-23T12:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'EndTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间段止，符合ISO8601标准的utc时间格式，例如2016-05-23T12:00:00Z。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段起，符合ISO8601标准的utc时间格式。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段止，符合ISO8601标准的utc时间格式。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '续费状态，取值：'."\n" + .'- AutoRenewal：自动续费。'."\n" + .'- ManualRenewal：手动续费。'."\n" + .'- NotRenewal：不续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', + ], + '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' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'InstanceList' => [ + 'description' => '实例信息的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubStatus' => [ + 'description' => '子状态。', + 'type' => 'string', + 'example' => 'Normal-后付费模块正常'."\n" + .'WaitForLimit-后付费模块即将欠费受限'."\n" + .'BandwidthLimited-后付费模块欠费受限', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'Creating-资源创建中'."\n" + .'WaitForExpire-即将停服'."\n" + .'Normal-正常'."\n" + .'Expired-停服', + ], + 'ExpectedReleaseTime' => [ + 'description' => '期望释放时间。', + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewStatus' => [ + 'description' => '续费状态，取值：'."\n" + .'- AutoRenewal：自动续费。'."\n" + .'- ManualRenewal：手动续费。'."\n" + .'- NotRenewal：不续费。', + 'type' => 'string', + 'example' => 'ManualRenewal', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'SellerId' => [ + 'description' => '卖方ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123123', + ], + 'InstanceID' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => '1049056', + ], + 'Seller' => [ + 'description' => '卖方。', + 'type' => 'string', + 'example' => '123123123', + ], + 'StopTime' => [ + 'description' => '停止时间。', + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewalDurationUnit' => [ + 'description' => '自动续费周期单位，取值：'."\n" + .'- M：月。'."\n" + .'- Y：年。', + 'type' => 'string', + 'example' => 'M', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'OwnerId' => [ + 'description' => '所有者ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '325352345', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ReleaseTime' => [ + 'description' => '释放时间。', + 'type' => 'string', + 'example' => '2019-09-08T16:00:00Z', + ], + 'RenewalDuration' => [ + 'description' => '自动续费周期数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + '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":"\\n \\n 51\\n 20\\n 1\\n \\n Creating\\n Normal\\n Subscription\\n ManualRenewal\\n IFP-ji2gz****\\n flowpack\\n 2999-09-08T16:00:00Z\\n 181****\\n 2016-11-07T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n Subscription\\n ManualRenewal\\n IFP-6dyrc****\\n flowpack\\n 2999-09-08T16:00:00Z\\n 181****\\n 2016-11-07T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n Subscription\\n ManualRenewal\\n IFP-ne1nt5uw1\\n flowpack\\n 2999-09-08T16:00:00Z\\n 181****\\n 2016-11-07T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n Subscription\\n ManualRenewal\\n IFP-vj5ry82x1\\n flowpack\\n 2999-09-08T16:00:00Z\\n 181****\\n 2016-11-07T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n Subscription\\n ManualRenewal\\n IFP-e6oupf251\\n flowpack\\n 2999-09-08T16:00:00Z\\n 181****\\n 2016-11-10T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 988643\\n cmjj011731\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 988647\\n cmjj011731\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 988648\\n cmjj011731\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 988649\\n cmjj011731\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 988651\\n cmjj011731\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 1049056\\n cmjj011399\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Creating\\n Normal\\n PayAsYouGo\\n 1049052\\n cmjj011399\\n 2999-09-08T16:00:00Z\\n 181****\\n 2999-09-08T16:00:00Z\\n 26888\\n \\n \\n Successful!\\n C7C15585-8349-4C62-BEE4-5A391841B9BE\\n true\\n Success\\n","errorExample":""}]', + 'title' => '实例查询服务', + 'summary' => '查询用户可用实例列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReleaseInstance' => [ + 'summary' => '国家云虚商侧主动释放实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => '产品代码', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'title' => 'subscriptionType', + 'description' => '付费类型'."\n" + ."\n" + .'Subscription：预付费'."\n" + ."\n" + .'PayAsYouGo：后付费', + 'type' => 'string', + 'required' => true, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceIds', + 'description' => '实例ID。多个ID用英文逗号分隔，最大不超过100个。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'renewStatus', + 'description' => '续费状态，取值：'."\n" + ."\n" + .'AutoRenewal：自动续费'."\n" + ."\n" + .'ManualRenewal：手动续费'."\n" + ."\n" + .'NotRenewal：不续费', + 'type' => 'string', + 'required' => false, + 'example' => 'AutoRenewal', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region', + 'description' => '地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => '产品类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '执行结果说明', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台', + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'ReleaseResult' => [ + 'title' => 'releaseResult', + 'description' => '释放是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HostId' => [ + 'title' => 'hostId', + 'description' => '执行主机所在站点', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '响应码', + 'type' => 'string', + 'example' => 'Invalid_Product_Code', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success=true代表调用执行完成'."\n" + ."\n" + .'success=false代表执行出现错误', + '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' => '释放实例', + 'description' => '本接口仅提供虚商伙伴使用，用于主动释放终端用户账下实例'."\n" + .'非指定虚商伙伴调用此接口，会被校验拦截。', + ], + 'CreateInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。可通过接口**QueryProductList**查询产品代码', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Cdn', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cdn', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费周期。单位为月，按年付费产品请输入12的整数倍。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费状态，取值：'."\n" + .'- AutoRenewal：自动续费。'."\n" + .'- ManualRenewal：手动续费。'."\n" + ."\n" + .'默认ManualRenewal。', + 'type' => 'string', + 'required' => false, + 'example' => 'ManualRenewal', + ], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期， 单位为月。'."\n" + .'> 当设置**RenewalStatus**为**AutoRenewal**时，必须设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端幂等参数，服务端会查询是否有相同ClientToken的请求，如果有，直接返回上次调用结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'JASIOFKVNVIXXXXXX', + ], + ], + [ + 'name' => 'Logistics', + 'in' => 'query', + 'schema' => [ + 'description' => '本次订单的物流信息地址，一般对实物类订单有效', + 'type' => 'string', + 'required' => false, + 'example' => '{"cityCode":"330100","cityName":"杭州","contactName":"测试","countryCode":"","districtName":"浦沿街道","email":"**@example.com","mobilePhone":"153564848844","phone":"1234567","provCode":"330000","provName":"浙江省","streetCode":"33010610","streetName":"转塘","zipCode":"0000"}', + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '模块列表', + 'type' => 'array', + 'items' => [ + 'description' => '模块信息', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '第n个模块属性value配置，n的取值范围为（1~100）。', + 'type' => 'string', + 'required' => true, + 'example' => 'disk', + ], + 'Code' => [ + 'description' => '第n个模块属性code配置，n的取值范围为（1~100），如有多个模块属性参数，按照n=1,2,3…n的形式拼接多个参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceType', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '预付费周期的周期类型'."\n" + ."\n" + .'- PricingCycle=1-表示预付费周期的单位是年；'."\n" + ."\n" + .'- PricingCycle=2-表示预付费周期的单位是月；'."\n" + ."\n" + .'- PricingCycle=3-表示预付费周期的单位是天；'."\n" + ."\n" + .'默认值：PricingCycle=2'."\n" + ."\n" + .'仅限于部分产品类型使用（ProductType为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' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '创建成功的订单ID。', + 'type' => 'string', + 'example' => '20240xxxx21', + ], + 'InstanceId' => [ + 'description' => '订单对应的实例ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n OSSBAG-cn-v1hxxxxx23\\n 20240xxxx21\\n \\n","errorExample":""}]', + 'title' => '实例创建服务', + 'summary' => '创建一个实例资源，会创建一个新购实例资源的订单，并自动支付。不支持ECS和RDS系列产品的创建。', + 'requestParamsDescription' => '假设想要通过本API创建音视频通信产品应用，完整参数示例如下：'."\n" + ."\n" + .'> ProductCode=rtc&SubscriptionType=PayAsYouGo&ProductType=&Parameter.1.Code=ServiceType&Parameter.1.Value=universal&Parameter.2.Code=BillType&Parameter.2.Value=PayByCR&Parameter.3.Code=ServiceAreaCn&Parameter.3.Value=true&Parameter.4.Code=ServiceAreaUs&Parameter.4.Value=false', + 'responseParamsDescription' => ' ', + 'extraInfo' => '创建成功后，可以使用实例[查询服务](https://www.alibabacloud.com/help/zh/boa/latest/api-bssopenapi-2017-12-14-queryavailableinstances?spm=a2c63.p38356.0.0.53aa436fJ6R68k)，查询已创建的实例', + ], + 'ModifyInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'ModifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型，取值'."\n" + .'- Upgrade：升级。'."\n" + .'- Downgrade：降级。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Upgrade', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '变更配置的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-akjhkdsjhfskjfhd', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止请求重复提交。', + 'type' => 'string', + 'required' => false, + 'example' => 'JAKSJFHFAKJSF', + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '第n个模块属性value配置，n的取值范围为（1~100）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'Code' => [ + 'description' => '第n个模块属性code配置，n的取值范围为（1~100），如有多个模块属性参数，按照n=1,2,3…n的形式拼接多个参数。'."\n" + ."\n" + .'> 只设置需要变更配置的模块属性信息，如A,B两个属性中，只有A需要变更配置，则只传A属性相关即可。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '创建成功的订单ID。', + 'type' => 'string', + 'example' => '202653252354351', + ], + 'HostId' => [ + 'description' => '主机ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n 202653252354351\\n \\n","errorExample":""}]', + 'title' => '实例变更服务', + 'summary' => '对实例资源配置进行变更。调用接口会创建一个变配实例资源的订单，并自动支付。该接口不支持ECS和RDS 系列产品的变更，请查找对应产品的专有API执行变配。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetRenewal' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RenewalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '设置实例自动续费时长，取值：'."\n" + .'- 1。'."\n" + .'- 2。'."\n" + .'- 3。'."\n" + .'- 6。'."\n" + .'- 12。'."\n" + ."\n" + .'> 当RenewalStatus= AutoRenewal时，必须设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceIDs', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，支持批量设置最多100个包年包月实例，多个实例ID以英文逗号分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-askjdhaskfjh', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'RenewalPeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期单位，取值：'."\n" + .'- M：月。'."\n" + .'- Y：年。'."\n" + ."\n" + .'> 当RenewalStatus= AutoRenewal时，必须设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'M', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '续费状态，取值：'."\n" + .'- AutoRenewal：自动续费。'."\n" + .'- ManualRenewal：手动续费。'."\n" + .'- NotRenewal：不续费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AutoRenewal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n","errorExample":""}]', + 'title' => '设置实例自动续费服务', + 'summary' => '调用SetRenewal为一个实例设置自动续费服务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConvertChargeType' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例当前的付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'> 调用成功后资源将被更变为相反的类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费周期（月），如果转换为预付费类型，需要设置购买的预付费的周期时长。取值：'."\n" + .'- 1~9。'."\n" + .'- 12。'."\n" + .'- 24。'."\n" + .'- 36。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-kasjgfjshgf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n 202657601410661\\n \\n","errorExample":""}]', + 'title' => '切换实例付费模式', + 'summary' => '为一个实例变更订阅类型。目前支持SLB、EIP和NAT网关后付费实例转预付费实例，和SLB、EIP产品预付费转后付费实例操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rm-skjdhaskjdh', + ], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费续费时长，单位：月。取值：'."\n" + .'- 1~9。'."\n" + .'- 12。'."\n" + .'- 24。'."\n" + .'- 36。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASKJHKLASJHAFSLKJH', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n 202657601410661\\n \\n","errorExample":""}]', + 'title' => '实例续费服务', + 'summary' => '对相关实例进行续费。不支持ECS、RDS、REDIS产品类实例的续费，请查找对应产品的专用续费API执行续费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefundInstance' => [ + 'summary' => '调用本接口退订不再需要的实例。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'description' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。调用后如果返回了结果，可以解析到退款订单编号，代表调用成功。', + 'type' => 'string', + 'required' => false, + 'example' => '793F021C-B589-1225-82A9-99232AEBE494', + ], + ], + [ + 'name' => 'ImmediatelyRelease', + 'in' => 'query', + 'schema' => [ + 'title' => 'immediatelyRelease', + 'description' => '退订场景必填。1：标识立即释放。0：标识先停机，根据停机策略停机。仅部分商品支持。默认都是立即释放。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productCode', + 'description' => '退订场景必填，产品code。如果调用后错误码提示产品不支持，可提交工单申请云产品允许开通此功能。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'instanceId', + 'description' => '退订场景必填，实例id，非自定义名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1etb69sqxgl4*******', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'description' => '退订场景必填，产品类型，无特殊说明传入空字符串。在调试工具上，无需手动输入，鼠标放到输入框上，会弹出"输入空字符串"的按钮，点击此按钮即可。通过代码发起退订时，传入英文字符下的空字符串 ""。', + 'type' => 'string', + 'required' => false, + 'example' => '空字符串', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '执行结果说明', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台。', + 'type' => 'string', + 'example' => 'UUID', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'title' => 'hostId', + 'description' => '执行主机所在站点', + 'type' => 'string', + 'example' => 'cn', + ], + 'OrderId' => [ + 'title' => 'orderId', + 'description' => '退订成功的情况下，返回退款订单id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2100000000***', + ], + ], + ], + 'Code' => [ + 'title' => 'code', + 'description' => '响应码', + 'type' => 'string', + 'example' => 'ResourceNotExists', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + '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' => '退订实例', + 'description' => '1. 退订只退还实付金额的部分，已使用的代金券不退还。'."\n" + ."\n" + .'2. 请仔细核对退订资源的信息，并确认退订条款和退订金额，资源一经退订无法恢复。'."\n" + ."\n" + .'1. 该接口仅支持直销客户调用，分销客户无法使用。'."\n" + ."\n" + .'4. 其他问题请参照：[退订规则](https://help.aliyun.com/knowledge_detail/116043.html?spm=a2c81.e1d666e.app.2.62ae11271Kd6iM)[国际站退订规则说明](https://www.alibabacloud.com/help/zh/user-center/user-guide/refund-rules)', + 'extraInfo' => '**针对部分业务规则拦截返回的错误码的解释**'."\n" + ."\n" + .'- ResourceNotExists：实例不存在'."\n" + .'- ResourceStatusError：实例状态不对'."\n" + .'- BindMirrorInstanceError：ecs有关联的收费镜像'."\n" + .'- ExceedRefundQuotaError：退订次数超过quota配额上限'."\n" + .'- ExistUnPaidOrderError：实例下存在未支付订单'."\n" + .'- ExistRefundingOrderError：无效实例ID(实例已到期或已退款或已释放)'."\n" + .'- NoRestValueError：退款金额为0'."\n" + .'- AmbassadorOrderLimitError：实例下有云大使订单'."\n" + .'- ActivityForbiddenError：活动订单禁止退款'."\n" + .'- ProductCheckError：云产品规则预校验未通过', + ], + 'GetOrderDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '32453453', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '订单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订单详情。', + 'type' => 'object', + 'properties' => [ + 'OrderSubType' => [ + 'description' => '子订单类型：-productsuborder：产品子订单类型。-refundsuborder：退款子订单类型', + 'type' => 'string', + 'example' => '子订单类型', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Currency' => [ + 'description' => '币种，CNY：人民币。 USD：美元。 JPY：日元', + 'type' => 'string', + 'example' => ' CNY', + ], + 'Config' => [ + 'description' => '主产品的配置。', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'SubscriptionType' => [ + 'title' => '', + 'description' => '订阅类型，'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：按量付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'UsageStartTime' => [ + 'description' => '服务开始时间。', + 'type' => 'string', + 'example' => '2017-06-08T16:00:00Z', + ], + 'UsageEndTime' => [ + 'description' => '服务结束时间。', + 'type' => 'string', + 'example' => '2117-06-08T16:00:00Z', + ], + 'SubOrderId' => [ + 'description' => '子订单id。', + 'type' => 'string', + 'example' => '234343', + ], + 'Region' => [ + 'description' => '地域'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AfterTaxAmount' => [ + 'description' => '税后金额。', + 'type' => 'string', + 'example' => '0', + ], + 'PaymentTime' => [ + 'description' => '支付时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Operator' => [ + 'description' => '订单操作RAM用户对应ID，如无则留空。', + 'type' => 'string', + 'example' => '23424243432', + ], + 'OrderType' => [ + 'description' => '订单类型，取值范围：-new：新购。-renew：续费。-upgrade：升级。-refund：退款。', + 'type' => 'string', + 'example' => 'new', + ], + 'PaymentStatus' => [ + 'description' => '支付状态，取值范围：-unpaid：未支付。-paid：已支付。-cancelled：已作废。', + 'type' => 'string', + 'example' => 'paid', + ], + 'Quantity' => [ + 'description' => '主产品数量。', + 'type' => 'string', + 'example' => '1', + ], + 'PretaxAmountLocal' => [ + 'description' => '本币金额。', + 'type' => 'string', + 'example' => '0', + ], + 'Tax' => [ + 'description' => '税费。', + 'type' => 'string', + 'example' => '1', + ], + 'OriginalConfig' => [ + 'description' => '未经标准化的模块信息。', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'PretaxAmount' => [ + 'description' => '订单应付金额。', + 'type' => 'string', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => '商品code', + 'type' => 'string', + 'example' => 'rds', + ], + 'RelatedOrderId' => [ + 'description' => '关联订单id。', + 'type' => 'string', + 'example' => '4353453534543', + ], + 'PaymentCurrency' => [ + 'description' => '支付币种。 CNY：人民币。 USD：美元。 JPY：日元', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ProductType' => [ + 'description' => '主产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'InstanceIDs' => [ + 'description' => '实例id列表。', + 'type' => 'string', + 'example' => '["rm-bp1a2vsr018313t6o"]', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'string', + 'example' => '0', + ], + 'OrderId' => [ + 'description' => '订单号。', + 'type' => 'string', + 'example' => '3453425324', + ], + 'ProductCode' => [ + 'description' => '主产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ExtendInfos' => [ + 'description' => '订单扩展信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '订单扩展信息'."\n" + .'- IsAutoRenew=true表示自动续费订单，非自动续费订单不返回该参数；'."\n" + .'- CouponNo为优惠券编号；'."\n" + .'- DeductedByCoupons为优惠券抵扣金额，单位为元；'."\n" + .'- DiscountAmount为优惠金额，单位为元。', + 'example' => '{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}', + ], + ], + 'BillModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleConfig' => [ + 'description' => '计费配置信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '配件名', + 'type' => 'string', + 'example' => '数据盘', + ], + 'Code' => [ + 'description' => '配置code', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'ApiCode' => [ + 'description' => 'apiCode', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'BillModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleProperties' => [ + 'description' => '配置下的值', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleApiCode' => [ + 'description' => '配置apiCode', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'AttrApiCode' => [ + 'description' => '配置的属性code', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'Value' => [ + 'description' => '配置的属性值', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'OriginalModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'originalModuleConfig' => [ + 'description' => '具体配置信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '配置名', + 'type' => 'string', + 'example' => '系统盘', + ], + 'Code' => [ + 'description' => '配置code', + 'type' => 'string', + 'example' => 'systemdisk', + ], + 'ModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleProperties' => [ + 'description' => '配置的属性列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '配置属性code', + 'type' => 'string', + 'example' => '高效云盘', + ], + 'Name' => [ + 'description' => '配置属性名', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Value' => [ + 'description' => '配置属性的值', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '订单详情查询服务', + 'summary' => '查询用户或分销客户某个订单详情信息。', + ], + 'QueryOrders' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段止（缺省查询当前时间最近1小时内订单），格式：YYYY-MM-ddTHH:mm:ssZ，时区： UTC', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + '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' => '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' => '订阅类型。取值类型：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值范围'."\n" + .'- New 新购'."\n" + .'- Renew 续费'."\n" + .'- Upgrade 升级'."\n" + .'- TempUpgrade 短时升级'."\n" + .'- Downgrade 降级'."\n" + .'- Refund 退款'."\n" + .'- Convert 付费类型转换'."\n" + .'- ResizeDisk 调整磁盘大小'."\n" + .'- CompensatoryRenew 补偿续费'."\n" + .'- IncreaseUpgrade 带宽升级'."\n" + .'- Exchange 换购'."\n" + .'- ChangeOperatingSystem 更换操作系统', + 'type' => 'string', + 'required' => false, + 'example' => 'New', + ], + ], + [ + 'name' => 'PaymentStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '支付状态。非退款订单，取值范围：'."\n" + .'- Unpaid：未支付。'."\n" + .'- Paid：已支付。'."\n" + .'- Cancelled：已作废。'."\n" + ."\n" + .'> 对于退款订单可置NULL。', + 'type' => 'string', + 'required' => false, + 'example' => 'Paid', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段起（缺省查询当前时间最近1小时内订单），格式：YYYY-MM-ddTHH:mm:ssZ，时区： UTC', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T13:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '分页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。建议每页最大20条，条数过多会导致超时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '订单列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PretaxAmount' => [ + 'description' => '订单应付金额。', + 'type' => 'string', + 'example' => '0', + ], + 'CommodityCode' => [ + 'description' => '商品Code', + 'type' => 'string', + 'example' => 'ecs', + ], + 'RelatedOrderId' => [ + 'description' => '关联订单ID。', + 'type' => 'string', + 'example' => '234535345345342', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Currency' => [ + 'description' => '币种。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'PaymentCurrency' => [ + 'description' => '支付币种。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ProductType' => [ + 'description' => '主产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'AfterTaxAmount' => [ + 'description' => '税后金额。', + 'type' => 'string', + 'example' => '66', + ], + 'PaymentTime' => [ + 'description' => '支付时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => '订单类型，取值范围'."\n" + .'- New 新购'."\n" + .'- Renew 续费'."\n" + .'- Upgrade 升级'."\n" + .'- TempUpgrade 短时升级'."\n" + .'- Downgrade 降级'."\n" + .'- Refund 退款'."\n" + .'- Convert 付费类型转换'."\n" + .'- ResizeDisk 调整磁盘大小'."\n" + .'- CompensatoryRenew 补偿续费'."\n" + .'- IncreaseUpgrade 带宽升级'."\n" + .'- Exchange 换购'."\n" + .'- ChangeOperatingSystem 更换操作系统', + 'type' => 'string', + 'example' => 'New', + ], + 'PaymentStatus' => [ + 'description' => '支付状态。非退款订单，取值范围：'."\n" + .'- Unpaid：未支付。'."\n" + .'- Paid：已支付。'."\n" + .'- Cancelled：已作废。'."\n" + ."\n" + .'> 对于退款订单可置NULL。', + 'type' => 'string', + 'example' => 'Paid', + ], + 'OrderId' => [ + 'description' => '订单号。', + 'type' => 'string', + 'example' => '34532532', + ], + 'Tax' => [ + 'description' => '税费。', + 'type' => 'string', + 'example' => '1', + ], + 'PretaxAmountLocal' => [ + 'description' => '本币金额。', + 'type' => 'string', + 'example' => '0', + ], + 'ProductCode' => [ + 'description' => '主产品代码。', + '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":"\\n Successful!\\n 61293E7A-3406-4447-8620-EC88B0AA66AD\\n \\n 0\\n 20\\n 1\\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '订单列表查询服务', + 'summary' => '查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单，如需查询更长时间范围的订单数据，请设CreateTimeStart和CreateTimeEnd参数。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelOrder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '73465432785', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30D2285E-A848-4ECB-AA74-4954C60858A1', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'HostId' => [ + 'description' => '主机ID。', + '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":"\\n \\n cn\\n \\n Successful!\\n 30D2285E-A848-4ECB-AA74-4954C60858A1\\n true\\n Success\\n","errorExample":""}]', + 'title' => '取消未支付订单服务', + 'summary' => '调用CancelOrder取消未支付订单服务。', + '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' => '财务单元列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => '父财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + 'OwnerUid' => [ + 'description' => '新财务单元的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '982375623', + ], + 'UnitName' => [ + 'description' => '财务单元名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CostUnitDtoList' => [ + 'description' => '财务单元实体列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => '父财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'UnitName' => [ + 'description' => '财务单元名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => '财务单元ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '84327659328', + ], + 'OwnerUid' => [ + 'description' => '新财务单元的属主用户ID。', + '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":"\\n \\n \\n dd\\n 12***********45\\n 16************86\\n \\n \\n Successful\\n F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\n true\\n success\\n","errorExample":""}]', + 'title' => '创建财务单元', + 'summary' => '创建财务单元，支持批量创建。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateCostUnitResource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FromUnitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '源财务单元的属主用户ID（必传）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '273394581313325532', + ], + ], + [ + 'name' => 'FromUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => '源财务单元ID（必传）。'."\n" + .'- 0表示未分配财务单元ID'."\n" + .'- 大于0表示已分配的财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ToUnitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标财务单元属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '241021678450941490', + ], + ], + [ + 'name' => 'ToUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标财务单元ID，取值：'."\n" + .'- -1表示已分配资源移除到未分配。'."\n" + .'- 大于0表示分配到指定财务单元。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '186419', + ], + ], + [ + 'name' => 'ResourceInstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApportionCode' => [ + 'description' => '分拆型实例的分拆型，只有分拆型产品实例才需要传这个参数。'."\n" + .'- 目前分拆项产品有八种商品，其商品code分别是oss、dcdn、snapshot、vod、cdn、live、cbwp。'."\n" + .'- 这个分拆项字段一般是通过QueryCostUnitResource获取用户的某一个财务单元（包含未分配）下的所有账单实例（包括分拆型实例会带分拆项）。', + 'type' => 'string', + 'required' => false, + 'example' => 'qwer1-cn-beijing', + ], + 'CommodityCode' => [ + 'description' => '账单实例的商品code（必传）。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + ], + 'ResourceUserId' => [ + 'description' => '账单实例的属主用户ID（必传）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '273394581313325532', + ], + 'ResourceId' => [ + 'description' => '账单的实例ID（必传）。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou;standard', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '消息码，例如：success。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '845C629F-47A7-4F46-A470-ED5047C4C250', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ToUnitUserId' => [ + 'description' => '目标财务单元属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34857693874', + ], + 'IsSuccess' => [ + 'description' => '财务单元资源分配是否分配成功'."\n" + .'- true表示分配成功'."\n" + .'- false表示分配失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ToUnitId' => [ + 'description' => '目标财务单元ID。', + '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":"\\r\\n \\r\\n \\r\\n true\\r\\n 1245\\r\\n 1686\\r\\n \\r\\n \\r\\n Successful!\\r\\n F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\r\\n true\\r\\n success\\r\\n","errorExample":""}]', + 'title' => '资源分配到财务单元', + 'summary' => '资源实例（实例型和分拆型）从源财务单元分配到目标财务单元。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCostUnit' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2135342', + ], + ], + [ + 'name' => 'UnitId', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '376348', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '是否完成。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitId' => [ + 'description' => '新财务单元的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123412343', + ], + 'OwnerUid' => [ + 'description' => '财务单元的属主用户ID。', + '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":"\\n \\n \\n true\\n 1245\\n 1686\\n \\n \\n Successful!\\n F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\n true\\n success\\n","errorExample":""}]', + 'title' => '删除财务单元', + 'summary' => '删除财务单元。', + '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' => '财务单元列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UnitId' => [ + 'description' => '财务单元的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2524352', + ], + 'NewUnitName' => [ + 'description' => '财务单元的新名字。', + 'type' => 'string', + 'required' => true, + 'example' => 'newTest', + ], + 'OwnerUid' => [ + 'description' => '财务单元的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1321312312', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码.', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnitId' => [ + 'description' => '新财务单元的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '356349875', + ], + 'OwnerUid' => [ + 'description' => '财务单元的属主用户ID。', + '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":"\\n \\n \\n true\\n 1245\\n 1686\\n \\n \\n Successful!\\n F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\n true\\n success\\n","errorExample":""}]', + 'title' => '修改财务单元', + 'summary' => '修改财务单元，支持批量修改。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCostUnit' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的属主用户。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '28394563429587', + ], + ], + [ + 'name' => 'ParentUnitId', + 'in' => 'query', + 'schema' => [ + 'description' => '父财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数，最大不超过300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + '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' => '1', + ], + 'CostUnitDtoList' => [ + 'description' => '财务单元列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => '父财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'UnitName' => [ + 'description' => '财务单元名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => '财务单元ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23534', + ], + 'OwnerUid' => [ + 'description' => '财务单元的属主用户。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n \\n 1\\n 20\\n \\n","errorExample":""}]', + 'title' => '查询财务单元', + 'summary' => '查询财务单元树当前节点下的所有财务单元节点。当 ParentUnitId 为 -1，表示查所有财务单元。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCostUnitResource' => [ + 'summary' => '查询用户的财务单元所属的资源实例列表。当 UnitId 为 0，表示查未分配的主子资源实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23453245', + ], + ], + [ + 'name' => 'UnitId', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '235325', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04332CB7-9A57-4461-97E0-02821D044414', + ], + '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' => '12', + ], + 'ResourceInstanceDtoList' => [ + 'description' => '资源实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '资源的商品code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ResourceUserName' => [ + 'description' => '资源属主的用户名。', + 'type' => 'string', + 'example' => 'test@test.aliyun.com', + ], + 'CommodityName' => [ + 'description' => '资源的商品名。', + 'type' => 'string', + 'example' => '云数据库', + ], + 'ResourceUserId' => [ + 'description' => '资源的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2424242134', + ], + 'ApportionName' => [ + 'description' => '资源分拆名。', + 'type' => 'string', + 'example' => 'test', + ], + 'ApportionCode' => [ + 'description' => '资源分拆code。', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_bj', + ], + 'ResourceNick' => [ + 'description' => '资源的自定义昵称。', + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceTag' => [ + 'description' => '资源的Tag标签。', + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceId' => [ + 'description' => '资源的实例ID。', + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma018', + ], + 'ResourceGroup' => [ + 'description' => '资源所属的资源组。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'RelatedResources' => [ + 'description' => '资源实例相关的资源。', + 'type' => 'string', + 'example' => 'oss', + ], + 'ResourceStatus' => [ + 'description' => '资源状态。', + 'type' => 'string', + 'example' => 'Available', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'example' => 'rds', + ], + 'ResourceSource' => [ + 'description' => '资源来源。取值：'."\n" + .'- AUTO_ALLOCATE：自动分配。'."\n" + .'- MANUAL_ALLOCATE：手动分配。', + 'type' => 'string', + 'example' => 'MANUAL_ALLOCATE', + ], + ], + ], + ], + 'CostUnit' => [ + 'description' => '财务单元信息。', + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => [ + 'description' => '父财务单元ID，-1表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23421', + ], + 'UnitName' => [ + 'description' => '财务单元的名字。', + 'type' => 'string', + 'example' => 'test', + ], + 'UnitId' => [ + 'description' => '财务单元的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123412', + ], + 'OwnerUid' => [ + 'description' => '财务单元的属主用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '321432', + ], + ], + ], + 'CostUnitStatisInfo' => [ + 'description' => '财务单元的统计信息。', + 'type' => 'object', + 'properties' => [ + 'TotalResourceCount' => [ + 'description' => '当前财务单元下的所有资源实例数（包含子财务单元）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ResourceCount' => [ + 'description' => '当前财务单元下的资源实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalUserCount' => [ + 'description' => '当前财务单元下的所有关联账号数（包含子财务单元）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SubUnitCount' => [ + 'description' => '当前财务单元下的子单元数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ResourceGroupCount' => [ + 'description' => '当前财务单元下的资源组数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalResourceGroupCount' => [ + 'description' => '当前财务单元下的所有资源组数（包含子财务单元）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UserCount' => [ + 'description' => '当前财务单元下的子单元数。', + '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\\": \\"test@test.aliyun.com\\",\\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":"\\n Success\\n Successful！\\n 04332CB7-9A57-4461-97E0-02821D044414\\n true\\n \\n 1\\n 20\\n 12\\n \\n rds\\n test@test.aliyun.com\\n 云数据库\\n 2424242134\\n test\\n test\\n FPT_ossbag_absolute_Storage_bj\\n testResource\\n testResource\\n OSSBAG-cn-v0h1s4hma018\\n 默认资源组\\n oss\\n Available\\n rds\\n MANUAL_ALLOCATE\\n \\n \\n 23421\\n test\\n 123412\\n 321432\\n \\n \\n 3\\n 1\\n 2\\n 2\\n 1\\n 2\\n 0\\n \\n \\n","errorExample":""}]', + 'title' => '查询财务单元的资源', + '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' => '阿里云账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1990699401005016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '消息说明。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97426BC2-792E-41F5-92B8-73C710DA7779', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '数据消息体。', + 'type' => 'object', + 'properties' => [ + 'MemberNickName' => [ + 'description' => '成员账号的显示名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'IsFinancialAccount' => [ + 'description' => '是否是企业财务账号：true表示是，false表示否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MemberGroupName' => [ + 'description' => '成员账号所在的组名。', + 'type' => 'string', + 'example' => '测试组', + ], + 'UserName' => [ + 'description' => '账号登录名。', + 'type' => 'string', + 'example' => 'killortop3', + ], + 'AccountType' => [ + 'description' => '企业财务账号类型：MASTER表示主账号，MEMBER表示成员账号。', + 'type' => 'string', + 'example' => 'MEMBER', + ], + 'MemberGroupId' => [ + 'description' => '成员账号所在的组ID。', + '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":"Successful!\\n97426BC2-792E-41F5-92B8-73C710DA7779\\n\\n killortop3\\n 测试组\\n 测试\\n true\\n 124\\n MEMBER\\n\\nSuccess\\ntrue","errorExample":""}]', + 'title' => '查看企业财务账号信息', + 'summary' => '查询有主子关系权限的账号的企业财务账号信息。', + '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' => '类型，取值：'."\n" + .'- 1：搜索可开票金额负值。'."\n" + .'- 2：搜索可开票金额为正值。'."\n" + .'- 3：搜索所有不为0代开票信息。'."\n" + .'- 4：已开金额>0。'."\n" + ."\n" + .'> 默认为空则搜索全部。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单/账单/合同编号', + 'type' => 'string', + 'required' => false, + 'example' => '2387432832696', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数，默认是20，不能超过300', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'StartAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始金额', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'EndAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '查询终止金额', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'StartBizTime', + 'in' => 'query', + 'schema' => [ + 'description' => '支付成功时间开始区间。格式：yyyy-mm-dd hh:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2025-02-01 00:00:00', + ], + ], + [ + 'name' => 'EndBizTime', + 'in' => 'query', + 'schema' => [ + 'description' => '支付成功时间结束区间。格式：yyyy-mm-dd hh:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2025-03-01 00:00:00', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序类型，取值：'."\n" + .'- 1：按ID进行倒排。'."\n" + .'- 2：按代开票类型倒排，id倒序二排序。'."\n" + .'- 3：按代开票类型顺排，id倒序二排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartSearchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-02-01 00:00:00', + ], + ], + [ + 'name' => 'EndSearchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-03-01 00:00:00', + ], + ], + [ + 'name' => 'BillCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '账期', + 'type' => 'string', + 'required' => false, + 'example' => '202502', + ], + ], + [ + 'name' => 'BizTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待开票对象归属的开票主体列表', + 'type' => 'array', + 'items' => [ + 'description' => '待开票对象归属的开票主体。取值示例：'."\n" + .'- ALIYUN_SERVICE：阿里云计算有限公司（服务）'."\n" + .'- ALICOM_SERVICE：阿里巴巴云计算（北京）有限公司（服务）', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN_SERVICE', + ], + 'required' => false, + 'example' => 'ALIYUN', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D35FF10E-1B2E-4ABA-8401-0AE17725F50B', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalUnAppliedInvoiceAmount' => [ + 'description' => '查询条件内可开票金额，单位分', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12344', + ], + 'PageSize' => [ + 'description' => '每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalInvoiceAmount' => [ + 'description' => '查询条件内总开票金额，单位分', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'HostId' => [ + 'type' => 'string', + ], + 'EvaluateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Evaluate' => [ + 'description' => '返回数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '类型，取值：'."\n" + .'- 1：搜索可开票金额负值。'."\n" + .'- 2：搜索可开票金额为正值。'."\n" + .'- 3：搜索所有不为0代开票信息。'."\n" + .'- 4：已开金额>0。'."\n" + ."\n" + .'> 默认为空则搜索全部。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '开票对象状态。'."\n" + .'- 0：已开'."\n" + .'- 1：未开（可开）'."\n" + .'- 2：部分开票'."\n" + .'- 3：开票申请处理中，被锁定', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2738543', + ], + 'BillCycle' => [ + 'description' => '账期', + 'type' => 'string', + 'example' => '202502', + ], + 'CanInvoiceAmount' => [ + 'description' => '剩余可开票金额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'OffsetAcceptAmount' => [ + 'description' => '接受冲抵金额。由于存在其他退订，降配等类型订单带来的退款行为，退订金额抵扣到本次开票记录的金额。与退款数据的**OffsetCostAmount**对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-5000', + ], + 'ItemId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'OutBizId' => [ + 'description' => '订单/账单/合同编号', + 'type' => 'string', + 'example' => '124324213421', + ], + 'UserNick' => [ + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'HelloWorld', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-01-01 00:00:00', + ], + 'OpId' => [ + 'type' => 'string', + ], + 'BizType' => [ + 'description' => '待开票对象归属的开票主体。取值示例：'."\n" + ."\n" + .'- ALIYUN_SERVICE：阿里云计算有限公司（服务）'."\n" + .'- ALICOM_SERVICE：阿里巴巴云计算（北京）有限公司（服务）', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'OriginalAmount' => [ + 'description' => '总可开票金额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'InvoicedAmount' => [ + 'description' => '已开票金额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-02-01 00:00:00', + ], + 'PresentAmount' => [ + 'description' => '总可开票金额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'BizTime' => [ + 'description' => '消费时间', + 'type' => 'string', + 'example' => '2025-02-01 00:00:00', + ], + 'Name' => [ + 'description' => '待开票对象名称', + 'type' => 'string', + 'example' => '云服务器ECS(包月)', + ], + 'OffsetCostAmount' => [ + 'description' => '冲抵金额。由于存在其他退订，降配等类型订单带来的退款行为，退订金额抵扣到本次开票记录的金额。与退款数据的**OffsetAcceptAmount**对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'Id' => [ + 'description' => '待开票对象id', + '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":"\\n Successful!\\n D35FF10E-1B2E-4ABA-8401-0AE17725F50B\\n \\n 8532\\n 23\\n 20\\n 1\\n 8532\\n cn\\n \\n \\n 1\\n 0\\n 2020-03-09 10:43:57\\n 2020-03-09 10:45:02\\n 202003\\n ALIYUN_SERVICE\\n 1\\n 1\\n 关系型数据库RDS(包月)\\n 2020-03-09 10:45:02\\n 1\\n 1857xxxxxx3489\\n 0\\n 23345345553\\n 20xxxxxxx112\\n 0\\n 1\\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '待开票对象查询服务', + 'summary' => '查询待开票对象信息。', + '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' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CustomerInvoiceAddressList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomerInvoiceAddress' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Addressee' => [ + 'type' => 'string', + ], + 'PostalCode' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'City' => [ + 'type' => 'string', + ], + 'UserNick' => [ + 'type' => 'string', + ], + 'Street' => [ + 'type' => 'string', + ], + 'Phone' => [ + 'type' => 'string', + ], + 'County' => [ + 'type' => 'string', + ], + 'BizType' => [ + 'type' => 'string', + ], + 'DeliveryAddress' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Province' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"\\n Successful!\\n BBEF51A3-E933-4F40-A534-C673CBDB9C80\\n true\\n Success\\n \\n \\n \\n 186********\\n 测试街道\\n 000000\\n 测试区\\n 浙江省杭州市**********\\n 311601051\\n test\\n 169***********\\n 浙江*\\n 杭州*\\n \\n \\n \\n","errorExample":""}]', + 'title' => '查询发票邮寄地址服务', + 'summary' => '查询阿里云发票邮寄地址信息服务。', + ], + 'QueryInvoicingCustomerList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CustomerInvoiceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomerInvoice' => [ + 'description' => '发票信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '默认发票类型，取值示例：'."\n" + .'- 0：增值税普通发票。'."\n" + .'- 1：增值税专用发票。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '发票抬头状态，取值示例：'."\n" + .'- 1：申请中'."\n" + .'- 2：通过'."\n" + .'- 3：拒绝'."\n" + .'- 4：失效'."\n" + .'- 5：撤回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'AdjustType' => [ + 'description' => '抬头变更方式。取值示例：'."\n" + .'- 1：非抬头名称信息修改'."\n" + .'- 4：其他类型抬头修改'."\n" + .'- 5：实名认证抬头修改', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Bank' => [ + 'description' => '开户银行名称', + 'type' => 'string', + 'example' => '测试银行', + ], + 'StartCycle' => [ + 'description' => '有效开始月份。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202002', + ], + 'TitleChangeInstructions' => [ + 'description' => '发票抬头变更情况说明书。', + 'type' => 'string', + 'example' => 'instruction.doc', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34565465675', + ], + 'OperatingLicenseAddress' => [ + 'description' => '注册场所地址。', + 'type' => 'string', + 'example' => '某某省某某市某某区某地址', + ], + 'InvoiceTitle' => [ + 'description' => '发票抬头。', + 'type' => 'string', + 'example' => '测试公司', + ], + 'UserNick' => [ + 'description' => '用户昵称。', + 'type' => 'string', + 'example' => 'testNick', + ], + 'OperatingLicensePhone' => [ + 'description' => '注册固定电话。', + 'type' => 'string', + 'example' => '138xxxxxxxx', + ], + 'EndCycle' => [ + 'description' => '有效结束月份。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202003', + ], + 'DefaultRemark' => [ + 'description' => '开票默认备注。选择此抬头开票时，会将改备注添加到发票上。', + 'type' => 'string', + 'example' => 'PO代码：12984554', + ], + 'TaxationLicense' => [ + 'description' => '税务登记证扫描件路径和文件名。', + 'type' => 'string', + 'example' => 'taxationLicense.jpg', + ], + 'RegisterNo' => [ + 'description' => '统一社会信用代码。', + 'type' => 'string', + 'example' => '21343245342534', + ], + 'GmtCreate' => [ + 'description' => '创建时间，格式：yyyy-mm-dd hh:mm:ss。', + 'type' => 'string', + 'example' => '2025-02-01 00:00:00', + ], + 'TaxpayerType' => [ + 'description' => '纳税人类型。取值示例：'."\n" + .'- 1：一般纳税人'."\n" + .'- 2：小规模纳税人', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomerType' => [ + 'description' => '客户支付宝认证类型。取值示例：'."\n" + .'- 1：个人。'."\n" + .'- 2：公司。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IssueType' => [ + 'description' => '抬头类型。取值示例：'."\n" + ."\n" + .'- 0：个人'."\n" + .'- 1：企业'."\n" + .'- 2：事业单位', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Id' => [ + 'description' => '发票抬头记录id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '239875502738', + ], + 'BankNo' => [ + 'description' => '基本开户账号。', + '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":"\\n Successful!\\n BBEF51A3-E933-4F40-A534-C673CBDB9C80\\n true\\n Success\\n \\n \\n \\n 2\\n 2\\n 50000************\\n 个人\\n 169***********\\n 2018-09-07 15:26:20\\n 2\\n \\n \\n \\n","errorExample":""}]', + 'title' => '发票抬头查询服务', + 'summary' => '查询阿里云用户发票抬头信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApplyInvoice' => [ + 'summary' => '提交开票申请服务。', + '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' => '申请开票金额（单位：分）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => [ + 'description' => '发票抬头信息ID，对应QueryInvoicingCustomerList接口返回的ID参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '124132423', + ], + ], + [ + 'name' => 'AddressId', + 'in' => 'query', + 'schema' => [ + 'description' => '邮寄地址ID，对应QueryCustomerAddressList接口返回的ID参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '237958367', + ], + ], + [ + 'name' => 'InvoicingType', + 'in' => 'query', + 'schema' => [ + 'description' => '发票类型，取值：'."\n" + .'- 0：专票'."\n" + .'- 1：普票', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProcessWay', + 'in' => 'query', + 'schema' => [ + 'description' => '开票渠道，要求为1。取值示例：'."\n" + .'- 0：阿里云处理'."\n" + .'- 1：税务平台处理', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ApplyUserNick', + 'in' => 'query', + 'schema' => [ + 'description' => '申请人昵称，系统不做校验。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'InvoiceByAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按金额开票，若为true则按照用户指定InvoiceAmount申请发票，否则以所选待开票对象的总金额申请发票。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UserRemark', + 'in' => 'query', + 'schema' => [ + 'description' => '用户备注', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SelectedIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '选择开票的待开票对象ID列表，对应QueryEvaluateList接口返回的ID参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '384752367', + ], + 'required' => true, + 'example' => '384752367', + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'emails', + 'in' => 'query', + 'schema' => [ + 'description' => '发票接收邮箱。字段长度最长200，多个邮箱可用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'aaa@aa.com,bbb@bb.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'InvoiceApplyId' => [ + 'description' => '发票申请记录ID。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n 1323125534\\n \\n","errorExample":""}]', + 'title' => '发票申请服务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySkuPriceList' => [ + 'summary' => '通常一个产品功能会有1到多个SKU，有的产品会多达数万级别的SKU。'."\n" + .'本API是用来查询一个指定的产品功能下的SKU列表及其目录价。接口入参支持按照某种SKU配置的条件来进行过滤查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品code，可通过**QueryCommodityList**接口查询商品code。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'PriceEntityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '定价对象code，可通过**QueryPriceEntityList**接口查询定价对象code。', + 'type' => 'string', + 'required' => true, + 'example' => 'instance_type', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的数量，最大不能超过50', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。可通过查询结果中的**NextPageToken**字段获取下一页token。', + 'type' => 'string', + 'required' => false, + 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', + ], + ], + [ + 'name' => 'PriceFactorConditionMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '定价因子条件集合，可通过**QueryPriceEntityList**接口查询定价因子code和定价因子值。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '{"vm_region_no":"cn-shiwei-shenshu"}', + 'description' => '定价因子值对', + ], + 'description' => '定价对象因值集合', + ], + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言，不填时默认为zh(中文)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'en', + ], + ], + ], + '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' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回消息', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SkuPricePage' => [ + 'description' => '定价对象sku信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'sku总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18732', + ], + 'NextPageToken' => [ + 'description' => '下一页的token', + 'type' => 'string', + 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', + ], + 'SkuPriceList' => [ + 'description' => 'sku列表', + 'type' => 'array', + 'items' => [ + 'description' => 'sku对象', + 'type' => 'object', + 'properties' => [ + 'SkuCode' => [ + 'description' => 'sku code', + 'type' => 'string', + 'example' => '017c15a31507bc6de22aa93777461adc', + ], + 'CskuPriceList' => [ + 'description' => 'sku价格列表', + 'type' => 'array', + 'items' => [ + 'description' => 'sku价格对象', + 'type' => 'object', + 'properties' => [ + 'CskuCode' => [ + 'description' => 'csku code，价格唯一编码', + 'type' => 'string', + 'example' => 'ac74dd7b52ae6389ddef099283fb8275', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'enumValueTitles' => [ + 'JPY' => '日元', + 'SAR' => '沙特币', + 'USD' => '美元', + 'CNY' => '人民币', + ], + 'example' => 'CNY', + ], + 'UsageUnit' => [ + 'description' => '用量单位', + 'type' => 'string', + 'example' => '个', + ], + 'PriceType' => [ + 'description' => '价格类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'usagePrice' => '使用量价', + 'monthPrice' => '月价', + 'dayPrice' => '天价', + 'hourPrice' => '小时价', + 'weekPrice' => '周价', + 'yearPrice' => '年价', + 'fixedPrice' => '一口价', + ], + 'example' => 'hourPrice', + ], + 'PriceMode' => [ + 'description' => '定价模式', + 'type' => 'string', + 'enumValueTitles' => [ + 'STEP_ACCUMULATION' => '阶梯累计', + 'STEP_ARRIVE' => '阶梯到达', + 'NORMAL_PRICE' => '非阶梯价', + ], + 'example' => 'STEP_ARRIVE', + ], + 'Price' => [ + 'description' => '价格', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '100', + ], + 'PriceUnit' => [ + 'description' => '价格单位', + 'type' => 'string', + 'example' => '美元/个', + ], + 'RangeList' => [ + 'description' => '当PriceMode是STEP_ACCUMULATION 、STEP_ARRIVE时，本字段有值，指定Range范围；'."\n" + .'当PriceMode是'."\n" + .'NORMAL_PRICE时，本字段值是NULL', + 'type' => 'array', + 'items' => [ + 'description' => '区分对象', + 'type' => 'object', + 'properties' => [ + 'FactorCode' => [ + 'description' => '因子code', + 'type' => 'string', + 'example' => '212fbd27866307fc79ecf06934a88b2c', + ], + 'Min' => [ + 'description' => '最小值', + 'type' => 'string', + 'example' => '1', + ], + 'Max' => [ + 'description' => '最大值', + 'type' => 'string', + 'example' => '10', + ], + 'Type' => [ + 'description' => '区间闭合类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'LORC' => '左开右闭', + 'LCRO' => '左闭右开', + 'LCRC' => '左闭右闭', + 'LORL' => '左开右开', + ], + 'example' => 'LORC', + ], + ], + ], + ], + ], + ], + ], + 'SkuFactorMap' => [ + 'description' => '因子值集合', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{ "vm_region_no": "cn-zhangjiakou-na62-a01", "iooptimized": "optimized", "vm_os_kind": "windows", "instance_type": "ecs.i1.xlarge" }', + 'description' => '因子值对'."\n" + ."\n" + .'不同的商品的定价对象下有各自的因子，比如ecs商品的instance_type的因子有`vm_region_no，iooptimized，vm_os_kind，instance_type`', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"\\n F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\n Success\\n Successful!\\n true\\n \\n \\n 18732\\n 080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332\\n \\n 017c15a31507bc6de22aa93777461adc\\n \\n ac74dd7b52ae6389ddef099283fb8275\\n CNY\\n 个\\n hourPrice\\n STEP_ARRIVE\\n 100\\n 美元/个\\n \\n 212fbd27866307fc79ecf06934a88b2c\\n 1\\n 10\\n LORC\\n \\n \\n \\n {\\"vm_region_no\\",\\"cn-qingdao-nebula\\"}\\n \\n \\n \\n \\n","errorExample":""}]', + 'title' => '查询商品定价对象下sku列表', + ], + 'QueryCommodityList' => [ + 'summary' => '该接口提供根据产品code获取商品信息列表的能力。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言，不填时默认为zh(中文)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'en', + ], + ], + ], + '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' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', + ], + 'Message' => [ + 'description' => '调用结果的附加信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Success' => [ + 'description' => '是否成功'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '状态码'."\n", + 'type' => 'string', + 'example' => 'NotApplicable', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CommodityList' => [ + 'description' => '商品列表。', + 'type' => 'array', + 'items' => [ + 'description' => '商品列表。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品code，与费用中心产品明细code一致', + 'type' => 'string', + 'example' => 'ecs', + ], + 'CommodityName' => [ + 'description' => '商品名称。', + 'type' => 'string', + 'example' => '云服务器（按量付费）', + ], + 'ChargeType' => [ + 'description' => '付款类型：-POSTPAY：按量付款-PREPAY：包年包月', + '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' => '根据产品code查询商品信息列表', + 'description' => '该接口提供根据产品code获取商品信息列表的能力。', + ], + 'QueryPriceEntityList' => [ + 'summary' => '本API是用来查询一个商品下有哪些定价对象。'."\n" + .'定价对象是用来计量和计算费用的最小产品能力。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品code，可通过**QueryCommodityList**接口查询商品code。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言，不填时默认为zh(中文)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'en', + ], + ], + ], + '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' => [ + 'PriceEntityInfoList' => [ + 'description' => '定价对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '定价对象', + 'type' => 'object', + 'properties' => [ + 'PriceEntityCode' => [ + 'description' => '定价对象code', + 'type' => 'string', + 'example' => 'instance_type', + ], + 'PriceEntityName' => [ + 'description' => '定价对象名称', + 'type' => 'string', + 'example' => '云服务器实例', + ], + 'PriceFactorList' => [ + 'description' => '定价对象因子列表', + 'type' => 'array', + 'items' => [ + 'description' => '定价对象因子', + 'type' => 'object', + 'properties' => [ + 'PriceFactorCode' => [ + 'description' => '定价对象因子code', + 'type' => 'string', + 'example' => 'vm_region_no', + ], + 'PriceFactorName' => [ + 'description' => '定价对象因子名称', + 'type' => 'string', + 'example' => '地域', + ], + 'PriceFactorValueList' => [ + 'description' => '定价对象因子值列表', + 'type' => 'array', + 'items' => [ + 'description' => '定价对象因子值', + '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' => '商品定价对象列表查询', + 'description' => '本API是用来查询一个商品下有哪些定价对象。'."\n" + .'定价对象是用来计量和计算费用的最小产品能力。', + 'responseParamsDescription' => '一个商品会有一到多个定价对象，每个定价对象下有一到多个定价因子', + ], + 'DescribePricingModule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，可通过接口**QueryProductList**查询产品类型。'."\n" + .'>需要和**QueryProductList**接口返回的产品类型保持一致>', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Subscription', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C40A8EE0-8084-49FE-B66E-5E1C3B6AE025', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ModuleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Module' => [ + 'description' => '模块及定价属性信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'description' => '计价模块名称。', + 'type' => 'string', + 'example' => '实例', + ], + 'PriceType' => [ + 'description' => '价格类型：'."\n" + .'- Usage：使用量。'."\n" + .'- Hour：小时价。'."\n" + .'- Day：天价。'."\n" + .'- Week：星期价。'."\n" + .'- Month：月价。'."\n" + .'- Year：年价。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Currency' => [ + 'description' => '币种：CNY：人民币。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'ModuleCode' => [ + 'description' => '计价模块标识。', + 'type' => 'string', + 'example' => 'InstanceType', + ], + 'ConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigList' => [ + 'type' => 'array', + 'items' => [ + 'description' => '模块依赖的定价属性Code集合。', + 'type' => 'string', + 'example' => '[ "Region","InstanceType" ]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AttributeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Attribute' => [ + 'description' => '模块定价属性值。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '属性Code。', + 'type' => 'string', + 'example' => 'DBInstanceStorage', + ], + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => '存储空间', + ], + 'Unit' => [ + 'description' => '属性单位。', + 'type' => 'string', + 'example' => 'GB', + ], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AttributeValue' => [ + 'description' => '属性。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '模块Code对应属性值类型。取值：'."\n" + .'- single_float：单一数值类型。'."\n" + .'- single_string：单一字符串类型。'."\n" + .'- range_float：范围取值类型。', + 'type' => 'string', + 'example' => 'single_string', + ], + 'Value' => [ + 'description' => '模块Code对应属性值。'."\n" + .'> 在Type = range_float时格式1024-1024000:1024表示从1024至1024000，步长1024。', + 'type' => 'string', + 'example' => 'mysql.n2.medium.1', + ], + 'Remark' => [ + 'description' => '模块取值描述信息。', + 'type' => 'string', + 'example' => '连接数：4000 IOPS与存储空间大小有关', + ], + 'Name' => [ + 'description' => '模块Code对应属性值。', + 'type' => 'string', + 'example' => '2 核 4GB（单机基础版）', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"\\n Successful!\\n C40A8EE0-8084-49FE-B66E-5E1C3B6AE025\\n \\n \\n \\n \\n \\n single_string\\n cn-qingdao-cm5-a01\\n 华北 1\\n \\n \\n Region\\n 地域\\n \\n \\n \\n \\n DataDisk\\n 数据盘\\n CNY\\n Month\\n \\n Region\\n DataDisk.Category\\n \\n \\n \\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '查询产品模块信息', + 'summary' => '查询阿里云某个产品对应模块信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryProductList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'QueryTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回产品总数目，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，最大300，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'This API is not applicable for caller.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94858229-2758-4663-A7D0-99490D541F15', + ], + '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' => '10', + ], + 'TotalCount' => [ + 'description' => '产品记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '449', + ], + 'ProductList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => '产品定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '内容分发网络CDN（按量付费）', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'CDN', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'ProductCode' => [ + 'description' => '产品代码。', + '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":"\\n Successful!\\n 28D1C9AE-4B16-43AE-9E19-4D3CF36F2A1E\\n \\n \\n \\n PayAsYouGo\\n NAT共享带宽包（按量付费）\\n bwp\\n \\n \\n \\n PayAsYouGo\\n 内容分发网络CDN（按量付费）\\n cdn\\n CDN\\n \\n \\n 449\\n 10\\n 1\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '查询产品信息', + 'summary' => '查询阿里云产品信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryUserOmsData' => [ + 'summary' => '根据传入的云产品查询相应的计量记录。', + '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' => '用量数据产品和明细信息，一般为ProductCode，不同产品存在多种计量模型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'description' => '计量数据时间类型，参考具体产品文档描述选用。'."\n" + .'- Raw：小时。'."\n" + .'- Hour：小时。'."\n" + .'- Day：天。'."\n" + .'- Month：月。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hour', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的开始时间。'."\n" + ."\n" + .'日期格式按照ISO8601标准标示，并需要使用UTC时间。格式：yyyy-mm-ddThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-20T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601标准标示，并需要使用UTC时间。格式：yyyy-mm-ddThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-02-21T12:00:00Z', + ], + ], + [ + 'name' => 'Marker', + 'in' => 'query', + 'schema' => [ + 'description' => '设定结果从NextToken之后按字母排序的第一个开始返回。默认从头返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'NextToken', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询每页行数，1~200，默认值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Marker' => [ + 'description' => '下页开始NextToken字段，如为空或无此项表示已无数据。', + 'type' => 'string', + 'example' => 'NextToken', + ], + 'HostId' => [ + 'description' => '主机ID。', + 'type' => 'string', + 'example' => 'cn', + ], + 'OmsData' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'OMS数据列表。', + '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":"\\n Successful!\\n 6000EE23-274B-4E07-A697-FF2E999520A4\\n true\\n Success\\n \\n \\n 0\\n quota_for_get_service_\\n 0\\n 1\\n 0\\n 0\\n 0\\n 0\\n 0\\n ap-northeast-1\\n 26842\\n 0\\n 2019-09-02T16:00:00Z\\n 2019-09-01T16:00:00Z\\n standard\\n 0\\n \\n \\n 0\\n quota_for_get_service_\\n 0\\n 1\\n 0\\n 0\\n 0\\n 0\\n 0\\n ap-northeast-1\\n 26842\\n 0\\n 2019-09-03T16:00:00Z\\n 2019-09-02T16:00:00Z\\n standard\\n 0\\n \\n cn\\n \\n","errorExample":""}]', + 'title' => '根据传入的云产品查询相应的计量记录', + 'description' => '## API描述'."\n" + .'- 传入云产品参数必须在以下云产品code中，计量数据类型有小时、天类型。'."\n" + .'- 传入时间格式按照ISO8601标准，时间规范约束：'."\n" + .' - 由于数据推送存在一定延时，按小时类型能保证24小时前计量数据完整性，按天类型能保证2天前计量数据完整性。'."\n" + .' - 时间跨度上，可取最近一个季度的计量数据。', + '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' => '当前统一到期日设置只支持未过期云服务器ECS实例，已过期实例无法对齐统一到期日。设置完成后，可在续费时对齐设置的统一到期时间'."\n" + ."\n" + .'日期范围：每月1号至28号', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '返回信息', + ], + 'RequestId' => [ + 'description' => '请求标识', + 'type' => 'string', + 'example' => '请求标识', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"请求标识\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"返回信息\\n请求标识\\n200\\ntrue","errorExample":""}]', + 'title' => '设置ECS统一到期日', + 'summary' => '为ECS实例的续费设置统一到期日。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCostBudgetsSummary' => [ + 'summary' => '查询用户 “成本管理-预算”的概要信息。', + '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' => '预算名称。模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => '全年预算', + ], + ], + [ + 'name' => 'BudgetStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '预算状态', + 'description' => '预算状态，枚举值：overdue（已过期）,notOverdue（未过期）。不填写则默认取全部', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'notOverdue' => 'notOverdue', + 'overdue' => 'overdue', + ], + 'example' => 'notOverdue', + ], + ], + [ + 'name' => 'BudgetType', + 'in' => 'query', + 'schema' => [ + 'title' => '预算类型', + 'description' => '预算类型。枚举值：cost(费用预算), byquantity（按量编制预算）, asset（使用率及覆盖率预算）。'."\n" + .'不填写则默认取全部', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cost' => 'cost', + 'byquantity' => 'byquantity', + 'asset' => 'asset', + ], + 'example' => 'cost', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '开始读取的位置', + 'description' => '当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错，空则代表从头开始读取。默认：空', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '读取的最大数据记录数量', + 'description' => '读取的最大数据记录数量。默认值：10，最大值：10，最小值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssResult', + 'description' => 'BssResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下页token', + 'description' => '下页token', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数。', + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Items' => [ + 'description' => '列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '预算列表', + 'type' => 'object', + 'properties' => [ + 'BudgetName' => [ + 'description' => '预算名称。', + 'type' => 'string', + 'example' => '全年预算', + ], + 'BudgetStatus' => [ + 'description' => '预算状态', + 'type' => 'string', + 'example' => 'overdue', + ], + 'BudgetType' => [ + 'description' => '预算类型。', + 'type' => 'string', + 'example' => 'cost', + ], + 'Budget' => [ + 'description' => '预算相关信息，其中：'."\n" + ."\n" + .'- BudgetCycleType是滚动周期，枚举值：daily（日），monthly（月），quarterly（季），yearly(年)；'."\n" + ."\n" + .'- TotalBudgetAmount是预算总额；'."\n" + ."\n" + .'- BudgetMemo是预算备注。', + 'type' => 'object', + 'enumValueTitles' => [], + 'example' => '{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }', + ], + 'CalculatedValues' => [ + 'description' => '预实分析相关信息，其中：'."\n" + ."\n" + .'- ActualConsumeSum是累计实际值；'."\n" + ."\n" + .'- ActualAddForecastedAmount是累计实际与预测之和。当预算类型为费用预算时，累计实际与预测之和为从预算开始日期至当前日期的实际发生额加上从当前日期至预算截止日期的预测值。若当前日期至预算截止日期超过一年，则不会包含超过一年的预测金额部分；当预算类型为使用率及覆盖率预算时，累计实际与预测之和为从预算开始日期至预算截止日期的使用率或覆盖率，不含超过一年的预测部分。'."\n" + ."\n" + .'- ActualAndBudgetComparison是预实对比，累计实际值/预算总额*100%；', + 'type' => 'object', + 'example' => '{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }', + ], + 'ConsumePeriod' => [ + 'description' => '账期相关信息。其中：'."\n" + ."\n" + .'- ConsumePeriodBegin是预算起始日期；'."\n" + ."\n" + .'- ConsumePeriodEnd是预算截止日期。', + 'type' => 'object', + 'example' => '{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }', + ], + ], + ], + ], + 'HostId' => [ + 'title' => '站点名称', + 'description' => '站点名称', + '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":"\\n 3BFC2DDB-2BC5-1AC4-AE39-AA75A6FADE7C\\n Successful!\\n \\n 75\\n eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MX0=\\n 1\\n \\n notOverdue\\n \\n 2022-08\\n 2023-07\\n \\n \\n annually\\n \\n 51752.64\\n \\n 回归验证-费用预算-按年-当月起1年\\n cost\\n \\n 1189.47\\n 61883.91\\n 2.3%\\n \\n \\n cn\\n \\n Success\\n true\\n","errorExample":""}]', + 'title' => '查询成本管理预算概要信息', + 'description' => '本OpenAPI灰度中，仅对部分白名单用户开放，调用过多时不排除出现响应超时等性能问题。', + ], + 'RenewChangeInstance' => [ + 'summary' => '对一个实例续费的同时进行变配操作，实际变配时间，是续费订单生效的时间，并自动支付。不支持ECS和RDS系列产品的创建。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', + 'type' => 'string', + 'required' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rm-skjdhaskjdh', + ], + ], + [ + 'name' => 'Parameter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '模块列表', + 'type' => 'array', + 'items' => [ + 'description' => '模块信息', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '第n个模块属性value配置，n的取值范围为（1~100）。', + 'type' => 'string', + 'required' => true, + 'example' => 'disk', + ], + 'Code' => [ + 'description' => '第n个模块属性code配置，n的取值范围为（1~100），如有多个模块属性参数，按照n=1,2,3…n的形式拼接多个参数。', + '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' => '预付费续费时长，单位：月。取值：'."\n" + .'- 1~9。'."\n" + .'- 12。'."\n" + .'- 24。'."\n" + .'- 36。', + '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' => 'success=true代表调用执行完成。success=false代表执行出现错误。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '创建成功的订单ID。', + '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"}]', + 'title' => '续费变配服务', + ], + ], + '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', + ], + ], +]; diff --git a/data/zh_cn/bssopenapi/2023-09-30/api-docs.php b/data/zh_cn/bssopenapi/2023-09-30/api-docs.php new file mode 100644 index 0000000..2903330 --- /dev/null +++ b/data/zh_cn/bssopenapi/2023-09-30/api-docs.php @@ -0,0 +1,8681 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'BssOpenApi', + 'version' => '2023-09-30', + ], + 'directories' => [ + [ + 'id' => 223311, + 'title' => '订单', + 'type' => 'directory', + 'children' => [ + 'GetOrders', + 'GetOrderDetail', + ], + ], + [ + 'id' => 208736, + 'title' => '发票', + 'type' => 'directory', + 'children' => [ + 'ListInvoiceTitle', + 'ListInvoiceCandidate', + 'CreateInvoice', + ], + ], + [ + 'id' => 203314, + 'title' => '资金账户', + 'type' => 'directory', + 'children' => [ + 'CreateFundAccountPayRelation', + 'SetFundAccountLowAvailableAmountAlarm', + 'GetFundAccountCanWithdrawAmount', + 'GetFundAccountAvailableAmount', + 'GetFundAccountLowAvailableAmountAlarm', + 'ListFundAccount', + 'CancelFundAccountLowAvailableAmountAlarm', + 'GetFundAccountCanAllocateCreditAmount', + 'ListFundAccountPayRelation', + 'GetFundAccountCanRecycleAmount', + 'CreateFundAccountTransfer', + 'GetFundAccountTransactionDetails', + 'SetFundAccountCreditAmount', + 'GetFundAccountCanTransferAmount', + ], + ], + [ + 'id' => 204580, + 'title' => '优惠券', + 'type' => 'directory', + 'children' => [ + 'DescribeCoupon', + 'DescribeCouponItemList', + ], + ], + [ + 'id' => 208201, + 'title' => '账单', + 'type' => 'directory', + 'children' => [ + 'CreateReportDefinition', + 'ListReportDefinitions', + 'DeleteReportDefinition', + ], + ], + [ + 'id' => 208683, + 'title' => '财务单元', + 'type' => 'directory', + 'children' => [ + 'SaveCostCenterShareRule', + 'QueryCostCenterShareRule', + 'CreateCostCenter', + 'ModifyCostCenter', + 'DeleteCostCenter', + 'QueryCostCenter', + 'QueryCostCenterResource', + 'CreateCostCenterRule', + 'ModifyCostCenterRule', + 'DeleteCostCenterRule', + 'QueryCostCenterRule', + 'AllocateCostCenterResource', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'DimItem' => [ + 'type' => 'object', + 'properties' => [ + 'PageInfo' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CurrentPage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'Values' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/ItemValues', + ], + ], + 'Code' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + 'EcIdAccountId' => [ + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'EcId' => [ + 'type' => 'string', + ], + ], + ], + 'FieldOption' => [ + 'type' => 'object', + 'properties' => [ + 'IsDefault' => [ + 'type' => 'boolean', + ], + 'Value' => [ + 'type' => 'string', + ], + 'FunctionCode' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + 'ItemValues' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'apis' => [ + 'GetOrders' => [ + 'summary' => '查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单，如需查询更长时间范围的订单数据，请设CreateTimeStart和CreateTimeEnd参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段止（缺省查询当前时间最近1小时内订单），格式：YYYY-MM-ddTHH:mm:ssZ，时区： UTC', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T12:00:00Z', + ], + ], + [ + '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' => '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' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Subscription', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值范围'."\n" + .'- New 新购'."\n" + .'- Renew 续费'."\n" + .'- Upgrade 升级'."\n" + .'- TempUpgrade 短时升级'."\n" + .'- Downgrade 降级'."\n" + .'- Refund 退款'."\n" + .'- Convert 付费类型转换'."\n" + .'- ResizeDisk 调整磁盘大小'."\n" + .'- CompensatoryRenew 补偿续费'."\n" + .'- IncreaseUpgrade 带宽升级'."\n" + .'- Exchange 换购'."\n" + .'- ChangeOperatingSystem 更换操作系统', + 'type' => 'string', + 'required' => false, + 'example' => 'New', + ], + ], + [ + 'name' => 'PaymentStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '支付状态。非退款订单，取值范围：'."\n" + .'- Unpaid：未支付。'."\n" + .'- Paid：已支付。'."\n" + .'- Cancelled：已作废。'."\n" + ."\n" + .'> 对于退款订单可置NULL。', + 'type' => 'string', + 'required' => false, + 'example' => 'Paid', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间段起（缺省查询当前时间最近1小时内订单），格式：YYYY-MM-ddTHH:mm:ssZ，时区： UTC', + 'type' => 'string', + 'required' => false, + 'example' => '2016-05-23T13:00:00Z', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '企业多账号中成员账号UID。无此场景，不用填写。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1779628988149763', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '分页数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。建议每页最大20条，条数过多会导致超时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '订单列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AfterTaxAmount' => [ + 'description' => '税后金额。', + 'type' => 'string', + 'example' => '66', + ], + 'ProductCode' => [ + 'description' => '主产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'ProductType' => [ + 'description' => '主产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'RelatedOrderId' => [ + 'description' => '关联订单ID。', + 'type' => 'string', + 'example' => '234535345345342', + ], + 'PaymentCurrency' => [ + 'description' => '支付币种。 CNY：人民币。 USD：美元。 JPY：日元', + 'type' => 'string', + 'example' => 'CNY', + ], + 'PaymentTime' => [ + 'description' => '支付时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Tax' => [ + 'description' => '税。仅在国际站点使用', + 'type' => 'string', + 'example' => '1', + ], + 'OrderId' => [ + 'description' => '订单号', + 'type' => 'string', + 'example' => '237258627070169', + ], + 'SubscriptionType' => [ + 'description' => '订阅类型，'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：按量付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => '订单类型，取值范围'."\n" + .'- New 新购'."\n" + .'- Renew 续费'."\n" + .'- Upgrade 升级'."\n" + .'- TempUpgrade 短时升级'."\n" + .'- Downgrade 降级'."\n" + .'- Refund 退款'."\n" + .'- Convert 付费类型转换'."\n" + .'- ResizeDisk 调整磁盘大小'."\n" + .'- CompensatoryRenew 补偿续费'."\n" + .'- IncreaseUpgrade 带宽升级'."\n" + .'- Exchange 换购'."\n" + .'- ChangeOperatingSystem 更换操作系统', + 'type' => 'string', + 'example' => 'New', + ], + 'PretaxAmount' => [ + 'description' => '订单应付金额。', + 'type' => 'string', + 'example' => '0', + ], + 'Currency' => [ + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'CommodityCode' => [ + 'description' => '商品Code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'PaymentStatus' => [ + 'description' => '支付状态。非退款订单，取值范围：'."\n" + .'- Unpaid：未支付。'."\n" + .'- Paid：已支付。'."\n" + .'- Cancelled：已作废。'."\n" + ."\n" + .'> 对于退款订单可置NULL。', + 'type' => 'string', + 'example' => 'Paid', + ], + 'PretaxAmountLocal' => [ + 'description' => '本币金额。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaller', + 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', + ], + ], + 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\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"1\\",\\n \\"OrderId\\": \\"237258627070169\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '订单列表查询服务', + ], + 'GetOrderDetail' => [ + 'summary' => '查询用户或分销客户某个订单详情信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '233501558440169', + ], + ], + [ + 'name' => 'MemberUid', + 'in' => 'query', + 'schema' => [ + 'description' => '当前账户管理的企业多账号成员UID。如不涉及该场景，请留空。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1715322405372273', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Successful!', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HostName' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'test', + ], + 'PageNum' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => '订单列表', + 'type' => 'array', + 'items' => [ + 'description' => '订单详情', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '订单操作RAM用户对应ID，如无则留空。', + 'type' => 'string', + 'example' => '322315', + ], + 'AfterTaxAmount' => [ + 'description' => '税后金额。', + 'type' => 'string', + 'example' => '0', + ], + 'Config' => [ + 'description' => '主产品的配置。', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'SubOrderId' => [ + 'description' => '子订单号。', + 'type' => 'string', + 'example' => '234343', + ], + 'PaymentTime' => [ + 'description' => '订单支付时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'Tax' => [ + 'description' => '税费。', + 'type' => 'string', + 'example' => '0', + ], + 'PaymentCurrency' => [ + 'description' => '支付币种。 CNY：人民币。 USD：美元。 JPY：日元', + 'type' => 'string', + 'example' => 'CNY', + ], + 'UsageEndTime' => [ + 'description' => '服务结束时间。', + 'type' => 'string', + 'example' => '2117-06-08T16:00:00Z', + ], + 'SubscriptionType' => [ + 'title' => '', + 'description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', + 'type' => 'string', + 'example' => 'Subscription', + ], + 'PretaxGrossAmount' => [ + 'description' => '原始金额。', + 'type' => 'string', + 'example' => '0', + ], + 'OrderType' => [ + 'description' => '订单类型，取值范围'."\n" + .'- New 新购'."\n" + .'- Renew 续费'."\n" + .'- Upgrade 升级'."\n" + .'- TempUpgrade 短时升级'."\n" + .'- Downgrade 降级'."\n" + .'- Refund 退款'."\n" + .'- Convert 付费类型转换'."\n" + .'- ResizeDisk 调整磁盘大小'."\n" + .'- CompensatoryRenew 补偿续费'."\n" + .'- IncreaseUpgrade 带宽升级'."\n" + .'- Exchange 换购'."\n" + .'- ChangeOperatingSystem 更换操作系统', + 'type' => 'string', + 'example' => 'new', + ], + 'Currency' => [ + 'description' => '币种，取值：'."\n" + .'- CNY。'."\n" + .'- USD。'."\n" + .'- JPY。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'CommodityCode' => [ + 'description' => '商品Code。', + 'type' => 'string', + 'example' => 'rds', + ], + 'UsageStartTime' => [ + 'description' => '服务开始时间。', + 'type' => 'string', + 'example' => '2017-06-08T16:00:00Z', + ], + 'OriginalConfig' => [ + 'description' => '未经标准化的模块信息。', + 'type' => 'string', + 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', + ], + 'InstanceIds' => [ + 'description' => '实例id列表。', + 'type' => 'string', + 'example' => '["rm-bp1a2vsr018313t6o"]', + ], + 'PaymentStatus' => [ + 'description' => '支付状态。非退款订单，取值范围：'."\n" + .'- Unpaid：未支付。'."\n" + .'- Paid：已支付。'."\n" + .'- Cancelled：已作废。', + 'type' => 'string', + 'example' => 'paid', + ], + 'ExtendInfos' => [ + 'description' => '订单扩展信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '订单扩展信息'."\n" + .'- IsAutoRenew=true 表示自动续费订单，非自动续费订单不返回该参数；'."\n" + .'- CouponNo 为优惠券编号；'."\n" + .'- DeductedByCoupons 为优惠券抵扣金额，单位为元；'."\n" + .'- DiscountAmount 为优惠金额，单位为元。', + 'example' => '{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}', + ], + ], + 'ProductCode' => [ + 'description' => '产品代码。', + 'type' => 'string', + 'example' => 'rds', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2017-06-08T09:41:30Z', + ], + 'ProductType' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'rds', + ], + 'Quantity' => [ + 'description' => '数量。', + 'type' => 'string', + 'example' => '3', + ], + 'RelatedOrderId' => [ + 'description' => '关联订单ID。', + 'type' => 'string', + 'example' => '241559391310332', + ], + 'OrderId' => [ + 'description' => '订单号', + 'type' => 'string', + 'example' => '241559391310333', + ], + 'BillModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleConfig' => [ + 'description' => '计费配置信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleProperties' => [ + 'description' => '配置下的值', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '配置的属性值', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'AttrApiCode' => [ + 'description' => '配置的属性 code', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'ModuleApiCode' => [ + 'description' => '配置apicode', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + ], + ], + ], + ], + ], + 'ApiCode' => [ + 'description' => 'apiCode', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'Code' => [ + 'description' => '配置 code', + 'type' => 'string', + 'example' => 'datadisk', + ], + 'Name' => [ + 'description' => '配件名', + 'type' => 'string', + 'example' => '数据盘', + ], + ], + ], + ], + ], + ], + 'OriginalModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'originalModuleConfig' => [ + 'description' => '具体配置信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleProperties' => [ + 'description' => '配置的属性列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '配置属性值', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Code' => [ + 'description' => '配置属性 code', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'Name' => [ + 'description' => '配置属性名称', + 'type' => 'string', + 'example' => '高效云盘', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '配置code', + 'type' => 'string', + 'example' => 'systemdisk', + ], + 'Name' => [ + 'description' => '配置名称', + 'type' => 'string', + 'example' => '系统盘', + ], + ], + ], + ], + ], + ], + 'OrderSubType' => [ + 'description' => '子订单类型：'."\n" + .'- productsuborder：产品子订单类型。'."\n" + .'- refundsuborder：退款子订单类型', + 'type' => 'string', + 'example' => 'productsuborder', + ], + 'PretaxAmount' => [ + 'description' => '订单应付金额。', + 'type' => 'string', + 'example' => '0', + ], + 'Region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PretaxAmountLocal' => [ + 'description' => '本币金额。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOwner', + 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaller', + 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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\\": 400,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"Operator\\": \\"322315\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"0\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"new\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"InstanceIds\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Quantity\\": \\"3\\",\\n \\"RelatedOrderId\\": \\"241559391310332\\",\\n \\"OrderId\\": \\"241559391310333\\",\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"ModuleApiCode\\": \\"cloud_ssd\\"\\n }\\n ]\\n },\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"Name\\": \\"数据盘\\"\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_efficiency\\",\\n \\"Code\\": \\"cloud_efficiency\\",\\n \\"Name\\": \\"高效云盘\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"systemdisk\\",\\n \\"Name\\": \\"系统盘\\"\\n }\\n ]\\n },\\n \\"OrderSubType\\": \\"productsuborder\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '订单详情查询服务', + ], + 'ListInvoiceTitle' => [ + 'summary' => '查询可用的发票抬头列表', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '抬头列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UnifiedSocialCreditCode' => [ + 'title' => '统一社会信用代码', + 'description' => '统一社会信用代码。15、17、18、20位字符。', + 'type' => 'string', + 'example' => '111111111111111', + ], + 'AccountId' => [ + 'title' => '用户ID', + 'description' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'RegisteredAddress' => [ + 'title' => '注册场所地址', + 'description' => '注册场所地址', + 'type' => 'string', + 'example' => '北京市朝阳区', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '发票抬头创建时间', + 'type' => 'string', + 'example' => '2025-06-01 00:00:00', + ], + 'InvoiceTitle' => [ + 'title' => '发票抬头', + 'description' => '发票抬头', + 'type' => 'string', + 'example' => 'xx公司', + ], + 'Id' => [ + 'title' => '发票抬头id', + 'description' => '发票抬头ID', + 'type' => 'string', + 'example' => '123456', + ], + 'BankAccountNumber' => [ + 'title' => '基本开户账号', + 'description' => '基本开户账号', + 'type' => 'string', + 'example' => '1234567890', + ], + 'RegisteredLandline' => [ + 'title' => '注册固定电话', + 'description' => '注册固定电话', + 'type' => 'string', + 'example' => '010-12345678', + ], + 'AccountBankName' => [ + 'title' => '开户银行名称', + 'description' => '开户银行名称', + 'type' => 'string', + 'example' => '招商银行', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"UnifiedSocialCreditCode\\": \\"111111111111111\\",\\n \\"AccountId\\": 1990699401005016,\\n \\"RegisteredAddress\\": \\"北京市朝阳区\\",\\n \\"CreateTime\\": \\"2025-06-01 00:00:00\\",\\n \\"InvoiceTitle\\": \\"xx公司\\",\\n \\"Id\\": \\"123456\\",\\n \\"BankAccountNumber\\": \\"1234567890\\",\\n \\"RegisteredLandline\\": \\"010-12345678\\",\\n \\"AccountBankName\\": \\"招商银行\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + 'title' => '发票抬头查询服务', + 'requestParamsDescription' => '无需传入参数，接口会直接查询当前登录UID可用的发票抬头列表', + ], + 'ListInvoiceCandidate' => [ + 'summary' => '查询开票对象数据，可根据该数据进行开票', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '状态', + 'description' => '开票对象状态列表', + 'type' => 'array', + 'items' => [ + 'description' => '开票对象状态', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '已开票', + '未开票（可开票）', + '部分开票', + '开票处理中，被锁定', + ], + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '类型', + 'description' => '开票对象类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '开票对象类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '订单', + '账单', + '合同', + '调账账单', + '退款订单', + 7 => '调账订单', + '佣金账单', + ], + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + ], + ], + 'required' => false, + 'enumValueTitles' => [], + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + ], + ], + ], + [ + 'name' => 'BusinessIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '业务单据号', + 'description' => '业务单据号列表', + 'type' => 'array', + 'items' => [ + 'description' => '业务单据号。如订单号等。', + 'type' => 'string', + 'required' => false, + 'example' => '202506', + ], + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间。格式：yyyy-mm-dd hh:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-06-01 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间。格式：yyyy-mm-dd hh:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-07-01 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'BillingCycles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '账期', + 'description' => '账期列表', + 'type' => 'array', + 'items' => [ + 'description' => '账期', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '202506', + ], + 'required' => false, + ], + ], + [ + 'name' => 'InvoiceIssuers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '开票主体', + 'description' => '开票主体列表', + 'type' => 'array', + 'items' => [ + 'description' => '开票主体', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN_SERVICE', + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + 'required' => false, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '开票对象状态', + 'description' => '开票对象状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BillingCycle' => [ + 'title' => '账期', + 'description' => '账期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '202506', + ], + 'AccountId' => [ + 'title' => '账号ID', + 'description' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'AcceptedOffsetAmount' => [ + 'title' => '接受冲抵金额', + 'description' => '接受冲抵金额', + 'type' => 'string', + 'example' => '0.01', + ], + 'ProductName' => [ + 'title' => '产品名称', + 'description' => '产品名称', + 'type' => 'string', + 'example' => '性能测试', + ], + 'ProductCode' => [ + 'title' => '产品Code', + 'description' => '产品Code', + 'type' => 'string', + 'example' => 'pts', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-06-91 00:00:00', + ], + 'TotalAmount' => [ + 'title' => '总金额', + 'description' => '总金额', + 'type' => 'string', + 'example' => '0.01', + ], + 'ResourceOwnerAccountName' => [ + 'title' => '资源归属账号名称', + 'description' => '资源归属账号名称', + 'type' => 'string', + 'example' => '测试账号', + ], + 'InvoiceIssuer' => [ + 'title' => '开票主体', + 'description' => '开票主体', + 'type' => 'string', + 'example' => 'ALIYUN_SERVICE', + ], + 'InvoiceableAmount' => [ + 'title' => '可开票金额', + 'description' => '可开票金额', + 'type' => 'string', + 'example' => '0.01', + ], + 'OffsetAmount' => [ + 'title' => '冲抵金额', + 'description' => '冲抵金额', + 'type' => 'string', + 'example' => '0', + ], + 'Type' => [ + 'title' => '开票对象类型', + 'description' => '开票对象类型', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResourceOwnerAccountId' => [ + 'title' => '资源归属账号ID', + 'description' => '资源归属账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'CommodityCode' => [ + 'title' => '商品Code', + 'description' => '商品Code', + 'type' => 'string', + 'example' => 'pts', + ], + 'Id' => [ + 'title' => '开票对象id', + 'description' => '开票对象id', + 'type' => 'string', + 'example' => '12345', + ], + 'BusinessTime' => [ + 'title' => '业务发生时间', + 'description' => '业务发生时间', + 'type' => 'string', + 'example' => '2025-06-01 00:00:00'."\n", + ], + 'InvoicedAmount' => [ + 'title' => '已开票金额', + 'description' => '已开票金额', + 'type' => 'string', + 'example' => '0', + ], + 'BusinessId' => [ + 'title' => '业务单据号', + 'description' => '业务单据号', + 'type' => 'string', + 'example' => '202506', + ], + 'CommodityName' => [ + 'title' => '商品名称', + 'description' => '商品名称', + 'type' => 'string', + 'example' => '性能测试', + ], + 'AccountName' => [ + 'title' => '账号名称', + 'description' => '账号名称', + 'type' => 'string', + 'example' => '测试账号', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'InvoiceCandidateSearchTimeInvalid', + 'errorMessage' => 'Invoicing Candidate query time is illegal.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"BillingCycle\\": 202506,\\n \\"AccountId\\": 1990699401005016,\\n \\"AcceptedOffsetAmount\\": \\"0.01\\",\\n \\"ProductName\\": \\"性能测试\\",\\n \\"ProductCode\\": \\"pts\\",\\n \\"CreateTime\\": \\"2025-06-91 00:00:00\\",\\n \\"TotalAmount\\": \\"0.01\\",\\n \\"ResourceOwnerAccountName\\": \\"测试账号\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\",\\n \\"InvoiceableAmount\\": \\"0.01\\",\\n \\"OffsetAmount\\": \\"0\\",\\n \\"Type\\": 1,\\n \\"ResourceOwnerAccountId\\": 1990699401005016,\\n \\"CommodityCode\\": \\"pts\\",\\n \\"Id\\": \\"12345\\",\\n \\"BusinessTime\\": \\"2025-06-01 00:00:00\\\\n\\",\\n \\"InvoicedAmount\\": \\"0\\",\\n \\"BusinessId\\": \\"202506\\",\\n \\"CommodityName\\": \\"性能测试\\",\\n \\"AccountName\\": \\"测试账号\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + 'title' => '开票对象查询服务', + ], + 'CreateInvoice' => [ + 'summary' => '申请发票', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '自动化测试平台配置的统一测试UID=1948392007548064不支持开票操作', + ], + 'parameters' => [ + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'title' => '开票信息', + 'description' => '指定开票金额。支持两位小数。'."\n" + .'- 若不填，则按照invoiceCandidateIds的全部总可开票金额开票。'."\n" + .'- 若填写，则按照填写的金额开票。填写金额不可超过invoiceCandidateIds的全部总可开票金额。', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + 'pattern' => '^[\\d._-]+$', + ], + ], + [ + 'name' => 'InvoiceTitleId', + 'in' => 'query', + 'schema' => [ + 'title' => '发票抬头信息Id', + 'description' => '发票抬头ID。'."\n" + ."\n" + .'- 当前登录账号通过 ListInvoiceTitle 接口返回的 ID 参数。', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'RecipientEmails', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '接收邮箱', + 'description' => '发票接收邮箱列表。最多可传入3个。', + 'type' => 'array', + 'items' => [ + 'description' => '发票接收邮箱。', + 'type' => 'string', + 'required' => true, + 'example' => '1@1.com', + ], + 'required' => true, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + [ + 'name' => 'InvoiceRemark', + 'in' => 'query', + 'schema' => [ + 'title' => '发票备注', + 'description' => '发票备注', + 'type' => 'string', + 'required' => false, + 'example' => '备注信息', + 'maxLength' => 200, + ], + ], + [ + 'name' => 'InvoiceCandidateIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '开票对象列表', + 'description' => '开票对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '开票对象ID', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + 'pattern' => '^\\d+$', + ], + 'required' => true, + 'pattern' => '^\\d+$', + 'minItems' => 1, + ], + ], + [ + 'name' => 'InvoiceType', + 'in' => 'query', + 'schema' => [ + 'title' => '开票类型', + 'description' => '开票类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '数字化电子普票', + '数字化电子专票', + ], + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'InvoiceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '开票方式', + 'description' => '开票方式'."\n" + .'- 0：独立开票，企业下多个账号的消费按照各自账号分别独立开具'."\n" + .'- 1：合并开票，企业下多个账号的消费按照开票主体合并开具'."\n" + .'如果AccountIds入参仅传入一个账号，则按照独立开票开具。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [ + '独立开票', + '合并开票', + ], + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'title' => '账号ID', + 'description' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1990699401005016', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '不可开票', + ], + 'Amount' => [ + 'title' => '开票金额', + 'description' => '开票金额', + 'type' => 'string', + 'example' => '0.01', + ], + 'ErrorCode' => [ + 'title' => '错误码', + 'description' => '错误码', + 'type' => 'string', + 'example' => '1001', + ], + 'InvoiceIssuer' => [ + 'title' => '开票主体', + 'description' => '开票主体', + 'type' => 'string', + 'example' => 'ALIYUN_SERVICE', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'InvoiceManualAmountNotAllowed', + 'errorMessage' => 'Cross-account independent invoicing, amount cannot be specified.', + ], + [ + 'errorCode' => 'InvoiceRecipientEmailsMoreThanThree', + 'errorMessage' => 'Maximum 3 email addresses allowed for invoice application.', + ], + [ + 'errorCode' => 'InvoiceCandidateNotFound', + 'errorMessage' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.', + ], + [ + 'errorCode' => 'InvoiceTitleNotExist', + 'errorMessage' => 'Invoice title does not exist.', + ], + [ + 'errorCode' => 'InvoiceRemarkTooLong', + 'errorMessage' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.', + ], + [ + 'errorCode' => 'InvoiceAmountInValid', + 'errorMessage' => 'Illegal amount requested for invoicing.', + ], + [ + 'errorCode' => 'InvoiceAmountFormatInvalid', + 'errorMessage' => 'Illegal format of invoiced amount.', + ], + [ + 'errorCode' => 'InvoiceModeInvalid', + 'errorMessage' => 'InvoiceMode field is illegal.', + ], + [ + 'errorCode' => 'InvoiceTypeInvalid', + 'errorMessage' => 'InvoiceType field is illegal.', + ], + [ + 'errorCode' => 'InvoiceSpecialOnlyForEnterprises', + 'errorMessage' => 'Special invoices can only be issued by enterprise accounts.', + ], + [ + 'errorCode' => 'InvoiceAmountNegativeInvalid', + 'errorMessage' => 'The sum of the selected amounts is negative and cannot be invoiced.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": 1990699401005016,\\n \\"Message\\": \\"不可开票\\",\\n \\"Amount\\": \\"0.01\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '发票申请', + ], + 'CreateFundAccountPayRelation' => [ + 'summary' => '创建资金账户的付款关系', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户Id', + 'description' => '资金账户Id', + 'type' => 'string', + 'required' => true, + 'example' => '12332112', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表', + 'description' => '企业与账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '企业与账号列表', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '被代付的阿里云账号列表', + 'description' => '被代付的阿里云账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => true, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => false, + 'example' => '1501603440974415', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'title' => '使用账户付款的用户AccountId', + 'description' => '使用账户付款的用户AccountId', + 'type' => 'string', + 'example' => '1501603440974415', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'string', + 'example' => '12332112', + ], + 'ResultMessage' => [ + 'title' => '结果信息', + 'description' => '结果信息', + 'type' => 'string', + 'example' => 'Successful', + ], + 'ResultCode' => [ + 'title' => '结果编码', + 'description' => '结果编码', + 'type' => 'string', + 'example' => 'Success', + ], + 'AccountName' => [ + 'title' => '使用账户付款的用户名称', + 'description' => '使用账户付款的用户名称', + 'type' => 'string', + 'example' => 'test@test.aliyunid.com'."\n", + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBillingAccount', + 'errorMessage' => 'The caller does not have permission for the specified billing account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": \\"1501603440974415\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"ResultMessage\\": \\"Successful\\",\\n \\"ResultCode\\": \\"Success\\",\\n \\"AccountName\\": \\"test@test.aliyunid.com\\\\n\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999\\"\\n}","type":"json"}]', + 'title' => '创建资金账户的付款关系', + ], + 'SetFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '设置资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ThresholdAmount', + 'in' => 'formData', + 'schema' => [ + 'title' => '低额预警阈值', + 'description' => '低额预警阈值', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12321213', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '08108BF5-1AA3-518E-9986-95A3616E8DA9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"08108BF5-1AA3-518E-9986-95A3616E8DA9\\"\\n}","type":"json"}]', + 'title' => '设置资金账户低额预警', + ], + 'GetFundAccountCanWithdrawAmount' => [ + 'summary' => '查询资金账户可提现金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123212232', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', + ], + 'CashAmount' => [ + 'title' => '现金余额', + 'description' => '现金余额', + 'type' => 'string', + 'example' => '1000', + ], + 'CanWithdrawAmount' => [ + 'title' => '可提现金额 = 现金余额 - 转账账本金额 - (欠票金额 + 历史月未结清金额 + 当前月未结清金额 - 转账账本金额) - 按量付费业务预留金额', + 'description' => '可提现金额 = 现金余额 - 转账账本金额 - (欠票金额 + 历史月未结清金额 + 当前月未结清金额 - 转账账本金额) - 按量付费业务预留金额', + 'type' => 'string', + 'example' => '500', + ], + 'CanOriginalWithdrawAmount' => [ + 'title' => '可原路提现金额', + 'description' => '可原路提现金额', + 'type' => 'string', + 'example' => '400', + ], + 'CannotOriginalWithdrawAmount' => [ + 'title' => '不可原路提现金额', + 'description' => '不可原路提现金额', + 'type' => 'string', + 'example' => '100', + ], + 'PayAsYouGoReversedAmount' => [ + 'title' => '按量业务预留金额', + 'description' => '按量业务预留金额', + 'type' => 'string', + 'example' => '100', + ], + 'TransferAmount' => [ + 'title' => '转账金额', + 'description' => '转账金额', + 'type' => 'string', + 'example' => '0', + ], + 'CreditMemoAmount' => [ + 'title' => '欠票金额', + 'description' => '欠票金额', + 'type' => 'string', + 'example' => '100', + ], + 'CurrentMonthUnclearedAmount' => [ + 'title' => '当前月未结清金额', + 'description' => '当前月未结清金额', + 'type' => 'string', + 'example' => '200', + ], + 'HistoryMonthUnclearedAmount' => [ + 'title' => '历史月未结清金额', + 'description' => '历史月未结清金额', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"CashAmount\\": \\"1000\\",\\n \\"CanWithdrawAmount\\": \\"500\\",\\n \\"CanOriginalWithdrawAmount\\": \\"400\\",\\n \\"CannotOriginalWithdrawAmount\\": \\"100\\",\\n \\"PayAsYouGoReversedAmount\\": \\"100\\",\\n \\"TransferAmount\\": \\"0\\",\\n \\"CreditMemoAmount\\": \\"100\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"200\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"100\\"\\n}","type":"json"}]', + 'title' => '查询资金账户可提现金额', + ], + 'GetFundAccountAvailableAmount' => [ + 'summary' => '查询资金账户可用金', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '账户Id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '账户Id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'string', + 'required' => false, + 'example' => '12332112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'string', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的账号accountId', + 'description' => '账户归属人的账号accountId', + 'type' => 'string', + 'example' => '1344312434', + ], + 'FundAccountStatus' => [ + 'title' => '账户状态', + 'description' => '账户状态', + 'type' => 'string', + 'example' => 'valid', + ], + 'FundAccountType' => [ + 'title' => '资金账户类型'."\n" + .'DIRECT_USER-阿里云直客账户;'."\n" + .' RESELLER_QUOTA-生态账户', + 'description' => '资金账户类型'."\n" + .'DIRECT_USER-阿里云直客账户;'."\n" + .' RESELLER_QUOTA-生态账户', + 'type' => 'string', + 'example' => 'REDIRECT_USER', + ], + 'AvailableAmount' => [ + 'title' => '可用额度', + 'description' => '可用额度', + 'type' => 'string', + 'example' => '100', + ], + 'CashAmount' => [ + 'title' => '现金余额', + 'description' => '现金余额', + 'type' => 'string', + 'example' => '50', + ], + 'NegativeBillAmount' => [ + 'title' => '负账单金额', + 'description' => '负账单金额', + 'type' => 'string', + 'example' => '0', + ], + 'CreditAmount' => [ + 'title' => '信控配额', + 'description' => '信控配额', + 'type' => 'string', + 'example' => '100', + ], + 'AvailableCreditAmount' => [ + 'title' => '信控余额', + 'description' => '信控余额', + 'type' => 'string', + 'example' => '50', + ], + 'CreditRefundAmount' => [ + 'title' => '信控退款余额', + 'description' => '信控退款余额', + 'type' => 'string', + 'example' => '0', + ], + 'UnclearedAmount' => [ + 'title' => '未结清金额 (当前月未结清 + 历史月未结清)', + 'description' => '未结清金额 (当前月未结清 + 历史月未结清)', + 'type' => 'string', + 'example' => '50', + ], + 'CurrentMonthUnclearedAmount' => [ + 'title' => '当月未结清金额', + 'description' => '当月未结清金额', + 'type' => 'string', + 'example' => '20', + ], + 'HistoryMonthUnclearedAmount' => [ + 'title' => '历史月未结清金额', + 'description' => '历史月未结清金额', + 'type' => 'string', + 'example' => '30', + ], + 'BankAcceptanceAmount' => [ + 'title' => '银承汇票额度', + 'description' => '银承汇票额度', + 'type' => 'string', + 'example' => '0', + ], + 'ExtendLedgerList' => [ + 'title' => '扩展的账本列表', + 'description' => '扩展的账本列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'title' => '账本金额币种，比如：CNY/USD等', + 'description' => '账本金额币种，比如：CNY/USD等', + 'type' => 'string', + 'example' => 'CNY', + ], + 'LedgerName' => [ + 'title' => '账本名称', + 'description' => '账本名称', + 'type' => 'string', + 'example' => '应付对冲账本', + ], + 'OriginalAmount' => [ + 'title' => '账本余额', + 'description' => '账本余额', + 'type' => 'string', + 'example' => '50', + ], + ], + ], + ], + 'QuotaAmount' => [ + 'title' => '生态终端客户配额', + 'description' => '生态终端客户配额', + 'type' => 'string', + 'example' => '20', + ], + 'QuotaConsumedAmount' => [ + 'title' => '生态终端客户已消费额度', + 'description' => '生态终端客户已消费额度', + 'type' => 'string', + 'example' => '10', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'OriginalCashAmountList' => [ + 'title' => '原始现金账本列表（国际站用户可能存在多个币种的现金账本）', + 'description' => '原始现金账本列表（国际站用户可能存在多个币种的现金账本）', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'title' => '金额', + 'description' => '金额', + 'type' => 'string', + 'example' => '10', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'example' => 'USD', + ], + ], + ], + ], + 'CreditUser' => [ + 'title' => '是否开通信控', + 'description' => '是否开通信控', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'InnerAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', + ], + [ + 'errorCode' => 'InnerSubAccountNoQueryPricePermission', + 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"FundAccountOwnerAccountId\\": \\"1344312434\\",\\n \\"FundAccountStatus\\": \\"valid\\",\\n \\"FundAccountType\\": \\"REDIRECT_USER\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"50\\",\\n \\"NegativeBillAmount\\": \\"0\\",\\n \\"CreditAmount\\": \\"100\\",\\n \\"AvailableCreditAmount\\": \\"50\\",\\n \\"CreditRefundAmount\\": \\"0\\",\\n \\"UnclearedAmount\\": \\"50\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"20\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"30\\",\\n \\"BankAcceptanceAmount\\": \\"0\\",\\n \\"ExtendLedgerList\\": [\\n {\\n \\"Currency\\": \\"CNY\\",\\n \\"LedgerName\\": \\"应付对冲账本\\",\\n \\"OriginalAmount\\": \\"50\\"\\n }\\n ],\\n \\"QuotaAmount\\": \\"20\\",\\n \\"QuotaConsumedAmount\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalCashAmountList\\": [\\n {\\n \\"Amount\\": \\"10\\",\\n \\"Currency\\": \\"USD\\"\\n }\\n ],\\n \\"CreditUser\\": true\\n}","type":"json"}]', + 'title' => '查询资金账户可用金', + ], + 'GetFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '查询资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12332112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'ThresholdAmount' => [ + 'title' => '预警阈值', + 'description' => '预警阈值', + 'type' => 'string', + 'example' => '100', + ], + 'AlarmEnabled' => [ + 'title' => '是否开启预警', + 'description' => '是否开启预警', + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"ThresholdAmount\\": \\"100\\",\\n \\"AlarmEnabled\\": true\\n}","type":"json"}]', + 'title' => '查询资金账户低额预警', + ], + 'ListFundAccount' => [ + 'summary' => '查询资金账户列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'QueryOnlyManage', + 'in' => 'formData', + 'schema' => [ + 'title' => '只查询管理的账户列表，默认false', + 'description' => '只查询管理的账户列表，默认false', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'QueryOnlyInUse', + 'in' => 'formData', + 'schema' => [ + 'title' => '只查询在用的账户列表，默认为false', + 'description' => '只查询在用的账户列表，默认为false', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => '26842', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的账号accountId', + 'description' => '账户归属人的账号accountId', + 'type' => 'string', + 'example' => '132123211', + ], + 'FundAccountType' => [ + 'title' => '账户类型'."\n" + .'DIRECT_USER-阿里云直客账户; '."\n" + .'RESELLER_QUOTA-生态账户', + 'description' => '账户类型'."\n" + .'DIRECT_USER-阿里云直客账户; '."\n" + .'RESELLER_QUOTA-生态账户', + 'type' => 'string', + 'example' => 'DIRECT_USER', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'string', + 'example' => '1022231', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '账户名称', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'Permissions' => [ + 'title' => '用户拥有的账户权限集合'."\n" + .'using - 使用；'."\n" + .'manage - 管理；'."\n" + .'owner - 拥有；', + 'description' => '用户拥有的账户权限集合'."\n" + .'using - 使用；'."\n" + .'manage - 管理；'."\n" + .'owner - 拥有；', + 'type' => 'array', + 'items' => [ + 'description' => '权限点', + 'type' => 'string', + 'example' => 'owner', + ], + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '一级售卖场', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountAdminAccountName' => [ + 'title' => '账户对应的MA用户名称', + 'description' => '账户对应的MA用户名称', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'CreateDate' => [ + 'title' => '账户创建时间', + 'description' => '账户创建时间', + 'type' => 'string', + 'example' => '2024-12-30 12:00:00', + ], + 'FundAccountAdminAccountId' => [ + 'title' => '账户对应的MA用户accountId', + 'description' => '账户对应的MA用户accountId', + 'type' => 'string', + 'example' => '1232121', + ], + 'FundAccountStatus' => [ + 'title' => '账户状态'."\n" + .'VALID-有效;'."\n" + .'FROZEN-冻结; '."\n" + .'CLOSED-注销', + 'description' => '账户状态'."\n" + .'VALID-有效;'."\n" + .'FROZEN-冻结; '."\n" + .'CLOSED-注销', + 'type' => 'string', + 'example' => 'VALID', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"FundAccountOwnerAccountId\\": \\"132123211\\",\\n \\"FundAccountType\\": \\"DIRECT_USER\\",\\n \\"FundAccountId\\": \\"1022231\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"Permissions\\": [\\n \\"owner\\"\\n ],\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountAdminAccountName\\": \\"云某的账户\\",\\n \\"CreateDate\\": \\"2024-12-30 12:00:00\\",\\n \\"FundAccountAdminAccountId\\": \\"1232121\\",\\n \\"FundAccountStatus\\": \\"VALID\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + 'title' => '查询资金账户列表', + ], + 'CancelFundAccountLowAvailableAmountAlarm' => [ + 'summary' => '取消资金账户低额预警', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123321123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'DFC1F7F9-3BA9-BA4D-2F2E653', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DFC1F7F9-3BA9-BA4D-2F2E653\\"\\n}","type":"json"}]', + 'title' => '取消资金账户低额预警', + 'description' => '取消资金账户低额预警', + ], + 'GetFundAccountCanAllocateCreditAmount' => [ + 'summary' => '查询资金账户可分配信控额度', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不设置时默认使用当前账号拥有（owner）的账户', + 'description' => '资金账户id，不设置时默认使用当前账号拥有（owner）的账户', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1233231', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', + ], + 'Ecid' => [ + 'title' => '企业实体id', + 'description' => '企业实体id', + 'type' => 'string', + 'example' => '2032123221', + ], + 'EcidCreditAmount' => [ + 'title' => '企业信控配额', + 'description' => '企业信控配额', + 'type' => 'string', + 'example' => '1000', + ], + 'EcidAllocatedCreditAmount' => [ + 'title' => '企业已分配信控额度', + 'description' => '企业已分配信控额度', + 'type' => 'string', + 'example' => '300', + ], + 'MaxCanAllocateCreditAmount' => [ + 'title' => '当前账户最大可分配信控额度', + 'description' => '当前账户最大可分配信控额度', + 'type' => 'string', + 'example' => '1500', + ], + 'MinCanAllocateCreditAmount' => [ + 'title' => '当前账户最小可分配信控额度', + 'description' => '当前账户最小可分配信控额度', + 'type' => 'string', + 'example' => '200', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '一级售卖场', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '账户归属人的阿里云accountId', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123433121', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '账户名称', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'FundAccountEcid' => [ + 'title' => '账户ecid', + 'description' => '账户ecid', + 'type' => 'string', + 'example' => '202321232', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"CC706AAC-75A6-55B5-9AB7-7D171C6C7655\\",\\n \\"Ecid\\": \\"2032123221\\",\\n \\"EcidCreditAmount\\": \\"1000\\",\\n \\"EcidAllocatedCreditAmount\\": \\"300\\",\\n \\"MaxCanAllocateCreditAmount\\": \\"1500\\",\\n \\"MinCanAllocateCreditAmount\\": \\"200\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 123433121,\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"FundAccountEcid\\": \\"202321232\\"\\n}","type":"json"}]', + 'title' => '查询资金账户可分配信控额度', + ], + 'ListFundAccountPayRelation' => [ + 'summary' => '查询账户的付款关系', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户Id', + 'description' => '资金账户Id', + 'type' => 'string', + 'required' => true, + 'example' => '12323123', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '关系状态'."\n" + .'valid - 有效'."\n" + .'expired - 无效', + 'description' => '关系状态'."\n" + .'valid - 有效'."\n" + .'expired - 无效', + 'type' => 'string', + 'required' => false, + 'example' => 'valid', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'default' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'string', + 'example' => '123231213', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '账户归属人的阿里云accountId', + 'type' => 'string', + 'example' => '312328912', + ], + 'AccountId' => [ + 'title' => '付款关系关联的用户accountId，即使用该账户付款的账号', + 'description' => '付款关系关联的用户accountId，即使用该账户付款的账号', + 'type' => 'string', + 'example' => '32812132121', + ], + 'AccountName' => [ + 'title' => '用户名称', + 'description' => '用户名称', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'EffectiveTime' => [ + 'title' => '付款关系生效时间', + 'description' => '付款关系生效时间', + 'type' => 'string', + 'example' => '2024-12-01 12:00:10', + ], + 'IneffectiveTime' => [ + 'title' => '付款关系失效时间', + 'description' => '付款关系失效时间', + 'type' => 'string', + 'example' => '2025-01-01 12:12:12', + ], + 'Status' => [ + 'title' => '关系状态'."\n" + .'valid - 有效；'."\n" + .'expired - 无效', + 'description' => '关系状态'."\n" + .'valid - 有效；'."\n" + .'expired - 无效', + 'type' => 'string', + 'example' => 'valid', + ], + 'RelationType' => [ + 'title' => '关系类型，收款关系/付款关系', + 'description' => '关系类型，收款关系/付款关系', + 'type' => 'string', + 'example' => 'PAYMENT', + ], + 'OperatorType' => [ + 'title' => '授权操作人类型'."\n" + .'aliyun_pk - 用户；'."\n" + .'system - 阿里云系统；', + 'description' => '授权操作人类型'."\n" + .'aliyun_pk - 用户；'."\n" + .'system - 阿里云系统；', + 'type' => 'string', + 'example' => 'aliyun_pk', + ], + 'OperatorNo' => [ + 'title' => '授权操作人'."\n" + .'操作人类型为aliyun_pk时，operatorNo为阿里云accountId', + 'description' => '授权操作人'."\n" + .'操作人类型为aliyun_pk时，operatorNo为阿里云accountId', + 'type' => 'string', + 'example' => '1232343423', + ], + 'OperatorName' => [ + 'title' => '操作人名称'."\n" + .'操作人类型为aliyun_pk时， 操作人名称为阿里云昵称'."\n" + .'操作人类型为system时， 操作人名称为"阿里云小二"', + 'description' => '操作人名称'."\n" + .'操作人类型为aliyun_pk时， 操作人名称为阿里云昵称'."\n" + .'操作人类型为system时， 操作人名称为"阿里云小二"', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '一级售卖场', + 'type' => 'string', + 'example' => '2684210001', + ], + 'Ecid' => [ + 'title' => '付款关系关联的用户的企业实体id', + 'description' => '付款关系关联的用户的企业实体id', + 'type' => 'string', + 'example' => '213231232', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Data\\": [\\n {\\n \\"FundAccountId\\": \\"123231213\\",\\n \\"FundAccountOwnerAccountId\\": \\"312328912\\",\\n \\"AccountId\\": \\"32812132121\\",\\n \\"AccountName\\": \\"云某的名称\\",\\n \\"EffectiveTime\\": \\"2024-12-01 12:00:10\\",\\n \\"IneffectiveTime\\": \\"2025-01-01 12:12:12\\",\\n \\"Status\\": \\"valid\\",\\n \\"RelationType\\": \\"PAYMENT\\",\\n \\"OperatorType\\": \\"aliyun_pk\\",\\n \\"OperatorNo\\": \\"1232343423\\",\\n \\"OperatorName\\": \\"云某的名称\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"Ecid\\": \\"213231232\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '查询账户的付款关系', + ], + 'GetFundAccountCanRecycleAmount' => [ + 'summary' => '查询资金账户可回收金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RecycleFromFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '回收源账户ID (出款方账户id)，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '回收源账户ID (出款方账户id)，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'string', + 'required' => false, + 'example' => '122321223', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'RecycleFromFundAccountId' => [ + 'title' => '回收源账户ID', + 'description' => '回收源账户ID', + 'type' => 'string', + 'example' => '1232122132', + ], + 'TransferAmount' => [ + 'title' => '转账账本余额', + 'description' => '转账账本余额', + 'type' => 'string', + 'example' => '200', + ], + 'AvailableAmount' => [ + 'title' => '被回收账户的可用金', + 'description' => '被回收账户的可用金', + 'type' => 'string', + 'example' => '300', + ], + 'RecycleToFundAccountList' => [ + 'title' => '可回收到的账户列表', + 'description' => '可回收到的账户列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FundAccountOwnerAccountId' => [ + 'title' => '可回收到的账户归属的accountId', + 'description' => '可回收到的账户归属的accountId', + 'type' => 'string', + 'example' => '183221321', + ], + 'MaxRecyclableAmount' => [ + 'title' => '最大可回收金额', + 'description' => '最大可回收金额', + 'type' => 'string', + 'example' => '120', + ], + 'FundAccountId' => [ + 'title' => '可回收到的账户ID', + 'description' => '可回收到的账户ID', + 'type' => 'string', + 'example' => '122323121', + ], + 'FundAccountName' => [ + 'title' => '可回收到的账户名称', + 'description' => '可回收到的账户名称', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'OriginalTransferRemainAmount' => [ + 'title' => '可原路回收的转账金额', + 'description' => '可原路回收的转账金额', + 'type' => 'string', + 'example' => '120', + ], + ], + ], + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"RecycleFromFundAccountId\\": \\"1232122132\\",\\n \\"TransferAmount\\": \\"200\\",\\n \\"AvailableAmount\\": \\"300\\",\\n \\"RecycleToFundAccountList\\": [\\n {\\n \\"FundAccountOwnerAccountId\\": \\"183221321\\",\\n \\"MaxRecyclableAmount\\": \\"120\\",\\n \\"FundAccountId\\": \\"122323121\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"OriginalTransferRemainAmount\\": \\"120\\"\\n }\\n ],\\n \\"Currency\\": \\"CNY\\"\\n}","type":"json"}]', + 'title' => '查询资金账户可回收金额', + ], + 'CreateFundAccountTransfer' => [ + 'summary' => '创建账户划拨/回收', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FromFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转出账户id (出款方账户id)', + 'description' => '转出账户id (出款方账户id)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123212323', + ], + ], + [ + 'name' => 'ToFundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转入账户id (收款方账户id)', + 'description' => '转入账户id (收款方账户id)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11112231', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账金额', + 'description' => '转账金额', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + [ + 'name' => 'FinanceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资产类型(当前仅支持现金)'."\n" + .'cash-现金;', + 'description' => '资产类型(当前仅支持现金)'."\n" + .'cash-现金;', + 'type' => 'string', + 'required' => true, + 'example' => 'cash', + ], + ], + [ + 'name' => 'TransferType', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账类型'."\n" + .'grant-划拨;'."\n" + .'recycle;回收', + 'description' => '转账类型'."\n" + .'grant-划拨;'."\n" + .'recycle;回收', + 'type' => 'string', + 'required' => true, + 'example' => 'grant', + 'enum' => [ + 'grant', + 'recycle', + ], + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + 'required' => true, + 'example' => '转账的备注', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '1BB79-5B23-3EA-BB4F-352F93E'."\n" + ."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'AccountNotExist', + 'errorMessage' => 'Account does not exist.', + ], + [ + 'errorCode' => 'AvailableTransferAmountNotEnough', + 'errorMessage' => 'The available amount for granting or recycling is insufficient.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"1BB79-5B23-3EA-BB4F-352F93E\\\\n\\\\n\\"\\n}","type":"json"}]', + 'title' => '创建账户划拨/回收', + ], + 'GetFundAccountTransactionDetails' => [ + 'summary' => '查询资金账户收支明细', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '资金账户id，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123221232', + ], + ], + [ + 'name' => 'TransactionNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '流水号', + 'description' => '流水号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '543231231', + ], + ], + [ + 'name' => 'BillNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易单号', + 'description' => '交易单号', + 'type' => 'string', + 'required' => false, + 'example' => '2023212312321', + ], + ], + [ + 'name' => 'ChannelTransactionNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易渠道流水号', + 'description' => '交易渠道流水号', + 'type' => 'string', + 'required' => false, + 'example' => '20250312334312322', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询开始时间戳（毫秒）', + 'description' => '查询开始时间戳（毫秒）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1735664461000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询结束时间戳（毫秒）', + 'description' => '查询结束时间戳（毫秒）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1735664561000', + ], + ], + [ + 'name' => 'TransactionDirection', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易方向 in/out(资金流入流出)', + 'description' => '交易方向 in/out(资金流入流出)', + 'type' => 'string', + 'required' => false, + 'example' => 'IN', + 'enum' => [ + 'IN', + 'OUT', + ], + ], + ], + [ + 'name' => 'TransactionType', + 'in' => 'formData', + 'schema' => [ + 'title' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。', + 'description' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。', + 'type' => 'string', + 'required' => false, + 'example' => 'CHARGE', + ], + ], + [ + 'name' => 'TransactionTypeList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '交易类型列表，支持多个参数查询', + 'description' => '交易类型列表，支持多个参数查询', + 'type' => 'array', + 'items' => [ + 'description' => '交易类型', + 'type' => 'string', + 'required' => false, + 'example' => 'CHARGE', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransactionChannelList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'description' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'type' => 'array', + 'items' => [ + 'description' => '资金类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ACCT_CASH', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小(最大200)', + 'description' => '每页大小(最大200)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'default' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => '26842', + ], + 'TransactionType' => [ + 'title' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。'."\n", + 'description' => '交易类型。 传入以下交易类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + ."\n" + .'充值：CHARGE。'."\n" + ."\n" + .'提现：WITHDRAW。'."\n" + ."\n" + .'退款：REFUND。'."\n" + ."\n" + .'消费：PAY。'."\n" + ."\n" + .'转账：TRANSFER。'."\n" + ."\n" + .'调账：ADJUST。'."\n" + ."\n" + .'订单失效退款: PAY_FAILED。'."\n", + 'type' => 'string', + 'example' => 'CHARGE', + ], + 'ChannelTransactionNumber' => [ + 'title' => '外部交易流水号', + 'description' => '外部交易流水号', + 'type' => 'string', + 'example' => '20244389232', + ], + 'TransactionNumber' => [ + 'title' => '流水号', + 'description' => '流水号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5423121', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1232121', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '一级售卖场', + 'type' => 'string', + 'example' => '2684210001', + ], + 'TransactionAccount' => [ + 'title' => '对应交易账号，比如支付宝充值账号或转账对端账号。', + 'description' => '对应交易账号，比如支付宝充值账号或转账对端账号。', + 'type' => 'string', + 'example' => '186****3975', + ], + 'BillNumber' => [ + 'title' => '订单号或者账单号', + 'description' => '订单号或者账单号', + 'type' => 'string', + 'example' => '2323203243', + ], + 'Remark' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + 'example' => '订单备注', + ], + 'TransactionDirection' => [ + 'title' => '交易方向 in/out(收入/支出)', + 'description' => '交易方向 in/out(收入/支出)', + 'type' => 'string', + 'example' => 'IN', + ], + 'FundType' => [ + 'title' => '资金形式', + 'description' => '资金形式', + 'type' => 'string', + 'example' => 'ACCT_BOOK', + ], + 'Currency' => [ + 'title' => '交易金额币种', + 'description' => '交易金额币种', + 'type' => 'string', + 'example' => 'USD', + ], + 'TransactionChannel' => [ + 'title' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'description' => '交易渠道，传入时按交易渠道查询，不传时默认查所有。'."\n" + ."\n" + .'用户余额：ACCT_CASH。'."\n" + ."\n" + .'支付宝：ALIPAY。'."\n" + ."\n" + .'支付宝支付通：ALIPAY_ZHIFUTONG。'."\n" + ."\n" + .'对公汇款：OFFLINE_REMIT。'."\n" + ."\n" + .'信控额度退款：REFUND。'."\n" + ."\n" + .'网银：UNION_PAY_BANK。'."\n" + ."\n" + .'信用卡：CREDIT_CARD。（国际站才有）'."\n" + ."\n" + .'AYPAL：PAYPAL 。（国际站才有）'."\n" + ."\n\n", + 'type' => 'string', + 'example' => 'ALIPAY', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '账户名称', + 'type' => 'string', + 'example' => '云某的名称', + ], + 'TransactionAmount' => [ + 'title' => '交易金额', + 'description' => '交易金额', + 'type' => 'string', + 'example' => '10', + ], + 'TransactionTime' => [ + 'title' => '交易时间格式化字符串', + 'description' => '交易时间格式化字符串', + 'type' => 'string', + 'example' => '2024-12-01 12:00:00', + ], + 'FundAccountEcid' => [ + 'title' => '企业实体id', + 'description' => '企业实体id', + 'type' => 'string', + 'example' => '23473943', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '账户归属人的阿里云accountId', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32343231', + ], + 'Balance' => [ + 'title' => '操作后余额', + 'description' => '操作后余额', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MaxOffsetLimit', + 'errorMessage' => 'Exceeded maximum page turning limit.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"TransactionType\\": \\"CHARGE\\",\\n \\"ChannelTransactionNumber\\": \\"20244389232\\",\\n \\"TransactionNumber\\": 5423121,\\n \\"FundAccountId\\": 1232121,\\n \\"Nbid\\": \\"2684210001\\",\\n \\"TransactionAccount\\": \\"186****3975\\",\\n \\"BillNumber\\": \\"2323203243\\",\\n \\"Remark\\": \\"订单备注\\",\\n \\"TransactionDirection\\": \\"IN\\",\\n \\"FundType\\": \\"ACCT_BOOK\\",\\n \\"Currency\\": \\"USD\\",\\n \\"TransactionChannel\\": \\"ALIPAY\\",\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"TransactionAmount\\": \\"10\\",\\n \\"TransactionTime\\": \\"2024-12-01 12:00:00\\",\\n \\"FundAccountEcid\\": \\"23473943\\",\\n \\"FundAccountOwnerAccountId\\": 32343231,\\n \\"Balance\\": \\"5\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\"\\n}","type":"json"}]', + 'title' => '查询资金账户收支明细', + ], + 'SetFundAccountCreditAmount' => [ + 'summary' => '设置资金账户的信控限额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资金账户id, 不设置时默认使用当前账号拥有（owner）的账户', + 'description' => '资金账户id, 不设置时默认使用当前账号拥有（owner）的账户', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232312', + ], + ], + [ + 'name' => 'CreditAmount', + 'in' => 'formData', + 'schema' => [ + 'title' => '授信额度', + 'description' => '授信额度', + 'type' => 'string', + 'required' => true, + 'example' => '500', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '信控额度币种。目前国内仅支持CNY，国际仅支持USD', + 'description' => '信控额度币种。目前国内仅支持CNY，国际仅支持USD', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this action.', + ], + [ + 'errorCode' => 'ExistApprovingProcess', + 'errorMessage' => 'There is a credit control setting process in the approval process, please contact the business manager.', + ], + [ + 'errorCode' => 'ExistUnconfirmedContract', + 'errorMessage' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', + ], + [ + 'errorCode' => 'NotSupportAllocateCredit', + 'errorMessage' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]', + 'title' => '设置资金账户的信控限额', + ], + 'GetFundAccountCanTransferAmount' => [ + 'summary' => '查询资金账户的可转出金额', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FundAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '转账源账户ID，不传时默认使用当前账号拥有（owner）的账户id。', + 'description' => '转账源账户ID，不传时默认使用当前账号拥有（owner）的账户id。', + 'type' => 'string', + 'required' => false, + 'example' => '123212', + ], + ], + [ + 'name' => 'Currency', + 'in' => 'formData', + 'schema' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'MaxTransferableAmount' => [ + 'title' => '可转账金额', + 'description' => '可转账金额', + 'type' => 'string', + 'example' => '100', + ], + 'CashAmount' => [ + 'title' => '现金账本余额', + 'description' => '现金账本余额', + 'type' => 'string', + 'example' => '500', + ], + 'TransferAmount' => [ + 'title' => '转账账本余额', + 'description' => '转账账本余额', + 'type' => 'string', + 'example' => '100', + ], + 'AvailableAmount' => [ + 'title' => '可用金', + 'description' => '可用金', + 'type' => 'string', + 'example' => '100', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => '26842', + ], + 'Nbid' => [ + 'title' => '一级售卖场', + 'description' => '一级售卖场', + 'type' => 'string', + 'example' => '2684210001', + ], + 'FundAccountId' => [ + 'title' => '账户Id', + 'description' => '账户Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12332112', + ], + 'FundAccountOwnerAccountId' => [ + 'title' => '账户归属人的阿里云accountId', + 'description' => '账户归属人的阿里云accountId', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '154738212323', + ], + 'FundAccountName' => [ + 'title' => '账户名称', + 'description' => '账户名称', + 'type' => 'string', + 'example' => '云某的账户', + ], + 'FundAccountEcid' => [ + 'title' => '账户归属的企业实体id', + 'description' => '账户归属的企业实体id', + 'type' => 'string', + 'example' => '2032121324', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'Request timed out. Please try again later.', + ], + [ + 'errorCode' => 'NoFundAccountPermission', + 'errorMessage' => 'The caller does not have permission for the specified fund account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"MaxTransferableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"500\\",\\n \\"TransferAmount\\": \\"100\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 154738212323,\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"FundAccountEcid\\": \\"2032121324\\"\\n}","type":"json"}]', + 'title' => '查询资金账户的可转出金额', + ], + 'DescribeCoupon' => [ + 'summary' => '查询优惠券列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EffectiveStartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '生效开始时间', + 'description' => '生效开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684750028000', + ], + ], + [ + 'name' => 'EffectiveEndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '生效结束时间', + 'description' => '生效结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1708423156000', + ], + ], + [ + 'name' => 'ExpireStartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '失效开始时间', + 'description' => '失效开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684750028000', + ], + ], + [ + 'name' => 'ExpireEndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '失效结束时间', + 'description' => '失效结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1708423156000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'required' => false, + 'example' => 'AVAILABLE', + ], + ], + [ + 'name' => 'CouponType', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券类型', + 'description' => '优惠券类型', + 'type' => 'string', + 'required' => false, + 'example' => 'CERTAIN', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级场信息', + 'description' => '一级场信息', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + [ + 'name' => 'CouponId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券id', + 'description' => '优惠券id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '351430260343', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'title' => '券编码', + 'description' => '券编码', + 'type' => 'string', + 'required' => false, + 'example' => '554863270150', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1501603440974415', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CouponId' => [ + 'title' => '优惠券id', + 'description' => '优惠券ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59243658', + ], + 'CouponNo' => [ + 'title' => '券编码', + 'description' => '券编码', + 'type' => 'string', + 'example' => '731074910070', + ], + 'CouponType' => [ + 'title' => '优惠券类型', + 'description' => '优惠券类型', + 'type' => 'string', + 'example' => 'CERTAIN', + ], + 'CouponTypeName' => [ + 'title' => '优惠券类型名称', + 'description' => '优惠券类型名称', + 'type' => 'string', + 'example' => '满减券', + ], + 'Amount' => [ + 'title' => '面值', + 'description' => '面值', + 'type' => 'string', + 'example' => '9929.750000', + ], + 'RemainAmount' => [ + 'title' => '剩余金额', + 'description' => '剩余金额', + 'type' => 'string', + 'example' => '100.00', + ], + 'ItemNames' => [ + 'title' => '产品code列表', + 'description' => '产品code列表', + 'type' => 'array', + 'items' => [ + 'description' => '适用商品名称', + 'type' => 'string', + 'example' => '全产品适用', + ], + ], + 'UniversalType' => [ + 'title' => '优惠券适用范围', + 'description' => '优惠券适用范围', + 'type' => 'string', + 'example' => 'UNIVERSAL', + ], + 'YhOrderTypes' => [ + 'title' => '优惠券适用订单类型列表', + 'description' => '优惠券适用订单类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '适用订单类型', + 'type' => 'string', + 'example' => '新购', + ], + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'GmtCreate' => [ + 'description' => '发券时间', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z'."\n", + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2021-03-02T15:12Z', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-03-06T15:12Z', + ], + 'Site' => [ + 'title' => '站点', + 'description' => '站点', + 'type' => 'string', + 'example' => 'CHINA', + ], + 'SiteName' => [ + 'title' => '站点名称', + 'description' => '站点名称', + 'type' => 'string', + 'example' => '官网自营', + ], + 'Remark' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + 'example' => '新买28号', + ], + 'MoneyLimit' => [ + 'title' => '金额限制', + 'description' => '金额限制', + 'type' => 'string', + 'example' => '无订单金额限制', + ], + 'Currency' => [ + 'title' => '币种', + 'description' => '币种', + 'type' => 'string', + 'example' => 'CNY', + ], + 'SuitAccount' => [ + 'title' => '适用帐号', + 'description' => '适用账号', + 'type' => 'string', + 'example' => '1902671110151254', + ], + 'OrderTimeRule' => [ + 'title' => '订单时长限制规则', + 'description' => '订单时长限制规则', + 'type' => 'string', + 'example' => '预付费规则：购买订单时长大于3600s才能使用', + ], + 'ShareUidList' => [ + 'title' => '共享帐号列表', + 'description' => '共享账号列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'title' => '阿里云uid', + 'description' => '阿里云uid', + 'type' => 'string', + 'example' => '1902671110151254', + ], + 'UserNick' => [ + 'title' => '阿里云帐号', + 'description' => '阿里云账号', + 'type' => 'string', + 'example' => '阿里云计算有限公司', + ], + ], + ], + ], + 'SuitItemType' => [ + 'title' => '适用产品类型：all 全产品通用 white 指定产品适用 black 指定产品不适用', + 'description' => '适用产品类型：all 全产品通用 white 指定产品适用 black 指定产品不适用', + 'type' => 'string', + 'example' => 'all', + ], + 'ShowSetDeductTagButton' => [ + 'description' => '是否展示标签抵扣按钮', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CertainAmount' => [ + 'type' => 'string', + ], + 'FirstBuy' => [ + 'title' => '是否有首购限制', + 'description' => '是否有首购限制', + 'type' => 'boolean', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', + ], + [ + 'errorCode' => 'SubAccountNoQueryPricePermission', + 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Data\\": [\\n {\\n \\"CouponId\\": 59243658,\\n \\"CouponNo\\": \\"731074910070\\",\\n \\"CouponType\\": \\"CERTAIN\\",\\n \\"CouponTypeName\\": \\"满减券\\",\\n \\"Amount\\": \\"9929.750000\\",\\n \\"RemainAmount\\": \\"100.00\\",\\n \\"ItemNames\\": [\\n \\"全产品适用\\"\\n ],\\n \\"UniversalType\\": \\"UNIVERSAL\\",\\n \\"YhOrderTypes\\": [\\n \\"新购\\"\\n ],\\n \\"Status\\": \\"Available\\",\\n \\"GmtCreate\\": \\"2021-03-02T15:12Z\\\\n\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"Site\\": \\"CHINA\\",\\n \\"SiteName\\": \\"官网自营\\",\\n \\"Remark\\": \\"新买28号\\",\\n \\"MoneyLimit\\": \\"无订单金额限制\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SuitAccount\\": \\"1902671110151254\\",\\n \\"OrderTimeRule\\": \\"预付费规则：购买订单时长大于3600s才能使用\\",\\n \\"ShareUidList\\": [\\n {\\n \\"Uid\\": \\"1902671110151254\\",\\n \\"UserNick\\": \\"阿里云计算有限公司\\"\\n }\\n ],\\n \\"SuitItemType\\": \\"all\\",\\n \\"ShowSetDeductTagButton\\": true,\\n \\"CertainAmount\\": \\"\\",\\n \\"FirstBuy\\": true\\n }\\n ],\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\"\\n}","type":"json"}]', + 'title' => '查询优惠券列表', + ], + 'DescribeCouponItemList' => [ + 'summary' => '查询优惠券可用商品列表', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券id', + 'description' => '优惠券id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '59104570', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '商品名称(支持模糊匹配)', + 'description' => '商品名称(支持模糊匹配)', + 'type' => 'string', + 'required' => false, + 'example' => '云服务器ECS', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1004064243473974', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '商品code', + 'description' => '商品code', + 'type' => 'string', + 'example' => 'vm', + ], + 'Name' => [ + 'title' => '商品名称', + 'description' => '商品名称', + 'type' => 'string', + 'example' => '云服务器ECS', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"vm\\",\\n \\"Name\\": \\"云服务器ECS\\"\\n }\\n ],\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\"\\n}","type":"json"}]', + 'title' => '查询优惠券可用商品列表', + ], + 'CreateReportDefinition' => [ + 'summary' => '创建账单报告订阅。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ReportSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅来源 OSS/MC', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'title' => '账单存储类型，类型来源参考API：ListReportTypesForReportDefinition', + 'description' => '订阅类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。', + 'type' => 'string', + 'required' => true, + 'example' => 'BillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + 'schema' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05', + ], + ], + [ + 'name' => 'OssBucketOwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。 普通用户则无需指定，默认为调用账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket存储文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sh-bill', + ], + ], + [ + 'name' => 'OssBucketPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS Bucket存储路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'bill/', + ], + ], + [ + 'name' => 'McProject', + 'in' => 'formData', + 'schema' => [ + 'description' => 'MC 项目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'project', + ], + ], + [ + 'name' => 'McTableName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'MC 订阅表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'table', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + [ + 'name' => 'SplitFileOnUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NotSendOnNoData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SendWithAttach', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IncludeMembers', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '340CAB45-0637-5875-9BE4-EFD5750F6BA5', + ], + 'ReportTaskId' => [ + 'description' => '账单订阅任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'ReportSourceType' => [ + 'description' => '订阅来源 OSS/MC', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportSourceName' => [ + 'description' => '订阅来源名称。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportType' => [ + 'title' => '账单存储类型', + 'description' => '订阅类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。', + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'BeginBillingCycle' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'type' => 'string', + 'example' => '2025-05', + ], + 'SubscribeCreateTime' => [ + 'description' => '订阅创建时间。', + 'type' => 'string', + 'example' => '2025-05-21 10:36:31', + ], + 'OssBucketOwnerAccountId' => [ + 'description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。 普通用户则无需指定，默认为调用账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'OssBucketName' => [ + 'description' => 'OSS Bucket存储文件名称。', + 'type' => 'string', + 'example' => 'sh-bill', + ], + 'OssBucketPath' => [ + 'description' => 'OSS Bucket存储路径。', + 'type' => 'string', + 'example' => 'bill/', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TASK_EXIST', + 'errorMessage' => 'task has already exist.', + ], + [ + 'errorCode' => 'InvalidBucket', + 'errorMessage' => 'The bucket is invalid or the bucket does not belong to you.', + ], + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"340CAB45-0637-5875-9BE4-EFD5750F6BA5\\",\\n \\"ReportTaskId\\": 123123,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"sh-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n}","type":"json"}]', + 'title' => '创建报告订阅', + 'description' => '在调用该接口时，请注意：'."\n" + ."\n" + .'- 用户一次订阅一个类型的账单文件。'."\n" + ."\n" + .'- 订阅后次日开始每日推送上一日生成的账单文件，每月4号推送上月整账期的全量账单文件。月账单PDF每月4号推送上月账单文件。'."\n" + ."\n" + .'- 按天生成的账单文件可能存在时延，延迟生成的账单会在生成次日推送，也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。'."\n" + ."\n" + .'> 请按文档流程说明申请权限[账单订阅](https://help.aliyun.com/zh/user-center/user-guide/billing-subscription?spm=5176.21213303.J_v8LsmxMG6alneH-O7TCPa.1.3ef82f3d5ZIf08&scm=20140722.S_help@@%E6%96%87%E6%A1%A3@@2861820._.ID_help@@%E6%96%87%E6%A1%A3@@2861820-RL_%E8%B4%A6%E5%8D%95%E8%AE%A2%E9%98%85-LOC_2024SPHelpResult-OR_ser-PAR1_2150419517478292121114501eaee8-V_4-RE_new5-P0_0-P1_0)'."\n" + ."\n" + .'- 本订阅与费用中心首页的“账单数据存储”为同一功能，订阅互通。'."\n" + ."\n" + .'- 订阅至Bucket下的目录时，请注意符合目录命名规范：'."\n" + ."\n" + .' - 不允许使用表情符，请使用符合要求的 UTF-8 字符。'."\n" + .' - / 用于分割路径，可快速创建子目录，但不要以 / 或 \\ 开头，不要出现连续的 /。'."\n" + .' - 不允许出现名为 .. 的子目录。'."\n" + .' - 总长度控制在 1~254 个字符。'."\n" + ."\n\n" + .'- 文件名：'."\n" + ."\n" + .' - **BillingItemDetailForBillingPeriod**（计费项账单明细）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_BillingItemDetail_YYYYMMDD`，例如：`169**_BillingItemDetail_20190310`。'."\n" + .' '."\n" + .' - 下月初完整文件名格式：`UID_BillingItemDetail_YYYYMM`，例如：`169**_BillingItemDetail_201903`。'."\n" + .' '."\n" + .' - **InstanceDetailForBillingPeriod**（实例账单明细）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_InstanceDetail_YYYYMMDD`，例如：`169**_InstanceDetail_20190310`。'."\n" + .' '."\n" + .' - 下月初完整文件名格式：`UID_InstanceDetail_YYYYMM`，例如：`169**_InstanceDetail_201903`。'."\n" + ."\n" + .' - **InstanceDetailMonthly**（实例账单账期汇总）'."\n" + .' '."\n" + .' - 每日推送文件名格式：`UID_InstanceDetailMonthly_YYYYMM`，例如：`169**_InstanceDetailMonthly_201903`。此文件每日更新月初至当日的全量数据，直至次月4号。'."\n" + ."\n" + .'- 文件类型为csv文件。但如果账单数据行数超过一定阈值，会自动拆分成多个csv文件，并合并压缩成一个zip文件，zip文件名格式相同。', + ], + 'ListReportDefinitions' => [ + 'summary' => '查看已订阅的报告列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReportDefinitions' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReportTaskId' => [ + 'description' => '账单订阅任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123321', + ], + 'ReportSourceType' => [ + 'description' => '订阅来源 OSS/MC', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportSourceName' => [ + 'description' => '订阅来源名称。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'ReportType' => [ + 'title' => '账单存储类型', + 'description' => '订阅类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。', + 'type' => 'string', + 'example' => 'BillingItemDetailForBillingPeriod', + ], + 'BeginBillingCycle' => [ + 'title' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'description' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', + 'type' => 'string', + 'example' => '2025-05', + ], + 'SubscribeCreateTime' => [ + 'description' => '订阅创建时间。', + 'type' => 'string', + 'example' => '2025-05-21 10:36:31', + ], + 'OssBucketOwnerAccountId' => [ + 'description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。 普通用户则无需指定，默认为调用账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'OssBucketName' => [ + 'description' => 'OSS Bucket存储文件名称。', + 'type' => 'string', + 'example' => 'oss-bill', + ], + 'OssBucketPath' => [ + 'description' => 'OSS Bucket存储路径。', + 'type' => 'string', + 'example' => 'bill/', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportDefinitions\\": [\\n {\\n \\"ReportTaskId\\": 123321,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"oss-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n }\\n ],\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '查看订阅报告', + ], + 'DeleteReportDefinition' => [ + 'summary' => '删除账单报告导出订阅。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReportTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '账单订阅任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123123', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '删除订阅是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidHistoricalNbid', + 'errorMessage' => 'Historical field does not support subscription bill.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]', + 'title' => '删除报告订阅', + ], + 'SaveCostCenterShareRule' => [ + 'summary' => '修改财务单元分摊规则，包括对分摊规则的创建、修改、删除', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1977800748053695', + ], + ], + [ + 'name' => 'CreateShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '创建分摊规则信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息', + 'type' => 'object', + 'properties' => [ + 'ToCostCenterList' => [ + 'description' => '目标财务单元列表', + 'type' => 'array', + 'items' => [ + 'description' => '目标财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583055', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'FromCostCenterList' => [ + 'description' => '源财务单元列表', + 'type' => 'array', + 'items' => [ + 'description' => '源财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583053', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRatioList' => [ + 'description' => '分摊比例列表', + 'type' => 'array', + 'items' => [ + 'description' => '分摊比例', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.5', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRuleName' => [ + 'description' => '分摊规则名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'ShareType' => [ + 'description' => '分摊规则类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AVERAGE' => '按平均拆分', + 'CUSTOM' => '自定义拆分比例', + 'RATIO' => '按比例拆分', + ], + 'example' => 'RATIO', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModifyShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '修改分摊规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息', + 'type' => 'object', + 'properties' => [ + 'ShareRuleId' => [ + 'description' => '分摊规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1828', + ], + 'ToCostCenterList' => [ + 'description' => '目标财务单元列表', + 'type' => 'array', + 'items' => [ + 'description' => '目标财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583056', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'FromCostCenterList' => [ + 'description' => '源财务单元列表', + 'type' => 'array', + 'items' => [ + 'description' => '源财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '583052', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRatioList' => [ + 'description' => '分摊比例列表', + 'type' => 'array', + 'items' => [ + 'description' => '分摊比例', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.2', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ShareRuleName' => [ + 'description' => '分摊规则名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'ShareType' => [ + 'description' => '分摊规则类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'AVERAGE' => '按平均拆分', + 'CUSTOM' => '自定义拆分比例', + 'RATIO' => '按比例拆分', + ], + 'example' => 'CUSTOM', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RemoveShareRuleList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '删除分摊规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '分摊规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1827', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改财务单元分摊规则', + ], + 'QueryCostCenterShareRule' => [ + 'summary' => '查询财务单元分摊规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1529600453335198', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '预留字段', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nYCisJwqt18pP5E9yb47iu', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '单次查询的最大记录数', + 'description' => '预留字段', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'description' => '列表信息', + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiTokenResult', + 'description' => 'BssApiTokenResult', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '预留字段', + 'type' => 'string', + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + 'MaxResults' => [ + 'title' => '单次查询的最大记录数', + 'description' => '预留字段', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Data' => [ + 'title' => '数据列表', + 'description' => '返回数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'ShareRuleId' => [ + 'description' => '分摊规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1826', + ], + 'ShareRuleName' => [ + 'description' => '分摊规则名称', + 'type' => 'string', + 'example' => 'test', + ], + 'ShareRuleType' => [ + 'description' => '分摊规则类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'AVERAGE' => '按平均拆分', + 'CUSTOM' => '自定义拆分比例', + 'RATIO' => '按比例拆分', + ], + 'example' => 'AVERAGE', + ], + 'FromCostCenterShareRuleDetails' => [ + 'description' => '源财务单元规则信息', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'RootCostCenterId' => [ + 'description' => '根财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583050', + ], + 'CostCenterId' => [ + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637127', + ], + 'ParentCostCenterId' => [ + 'description' => '父财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637537', + ], + 'PrevCostCenterId' => [ + 'description' => '前序财务单元 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583059', + ], + 'CostCenterCode' => [ + 'description' => '财务单元CODE', + 'type' => 'string', + 'example' => '970354711219#', + ], + 'CostCenterName' => [ + 'description' => '财务单元名称', + 'type' => 'string', + 'example' => '成本计划', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + 'GmtModified' => [ + 'title' => '', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + ], + ], + ], + 'ToCostCenterShareRuleDetails' => [ + 'description' => '目标财务单元规则信息', + 'type' => 'array', + 'items' => [ + 'description' => '对象信息', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'RootCostCenterId' => [ + 'description' => '根财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583050', + ], + 'CostCenterId' => [ + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637127', + ], + 'ParentCostCenterId' => [ + 'description' => '父财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '637537', + ], + 'PrevCostCenterId' => [ + 'description' => '前序财务单元 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '583055', + ], + 'CostCenterCode' => [ + 'description' => '财务单元CODE', + 'type' => 'string', + 'example' => '970354711215#', + ], + 'CostCenterName' => [ + 'description' => '财务单元名称', + 'type' => 'string', + 'example' => '成本分摊', + ], + 'ShareRatio' => [ + 'description' => '分摊比例', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-07-16 13:49:59', + ], + ], + ], + ], + 'GmtModified' => [ + 'title' => '最近修改时间', + 'description' => '最近修改时间', + 'type' => 'string', + 'example' => '2026-01-01 00:00:00', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Data\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"ShareRuleId\\": 1826,\\n \\"ShareRuleName\\": \\"test\\",\\n \\"ShareRuleType\\": \\"AVERAGE\\",\\n \\"FromCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583059,\\n \\"CostCenterCode\\": \\"970354711219#\\",\\n \\"CostCenterName\\": \\"成本计划\\",\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"ToCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583055,\\n \\"CostCenterCode\\": \\"970354711215#\\",\\n \\"CostCenterName\\": \\"成本分摊\\",\\n \\"ShareRatio\\": 0.2,\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2026-01-01 00:00:00\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '查询财务单元分摊规则', + 'description' => '用于查询用户财务单元的分摊规则', + ], + 'CreateCostCenter' => [ + 'summary' => '创建财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterEntityList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '财务单元实体列表', + 'description' => '财务单元实体列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元名称（同一个账号必须唯一）', + 'description' => '财务单元名称（同一个账号必须唯一）', + 'type' => 'string', + 'required' => true, + 'example' => '资源组', + ], + 'OwnerAccountId' => [ + 'title' => '新财务单元的属主用户 ID', + 'description' => '新财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + 'ParentCostCenterId' => [ + 'title' => '父财务单元 ID，-1 表示财务单元根。', + 'description' => '父财务单元 ID，-1 表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CostCenterDtoList' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元名字（同一个账号必须唯一）', + 'description' => '财务单元名字（同一个账号必须唯一）', + 'type' => 'string', + 'example' => '资源组', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'ParentCostCenterId' => [ + 'title' => '父级财务单元ID', + 'description' => '父级财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameLengthExceed', + 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotBelongToUser', + 'errorMessage' => 'Cost unit is not belong to this user.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameExist', + 'errorMessage' => 'The financial unit name already exists.', + ], + [ + 'errorCode' => 'CostCenter.UnitNumberExceed', + 'errorMessage' => 'The maximum number of financial units has been exceeded.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + [ + 'errorCode' => 'CostCenter.UnitLevelExceed', + 'errorMessage' => 'The depth of the financial unit exceeds the maximum hierarchy level.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterDtoList\\": [\\n {\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\"\\n}","type":"json"}]', + 'title' => '创建财务单元', + 'description' => '创建一个或多个财务单元。', + ], + 'ModifyCostCenter' => [ + 'summary' => '修改财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'CostCenterEntityList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '财务单元实体列表', + 'description' => '财务单元实体列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostCenterName' => [ + 'title' => '财务单元的新名字（同一个账号必须唯一）', + 'description' => '财务单元的新名字（同一个账号必须唯一）', + 'type' => 'string', + 'required' => true, + 'example' => '资源组', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '485938', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiListResult', + 'description' => 'BssApiListResult', + 'type' => 'object', + 'properties' => [ + 'CostCenterOperateDto' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified request lacks essential parameters.', + ], + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotBelongToUser', + 'errorMessage' => 'Cost unit is not belong to this user.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameLengthExceed', + 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', + ], + [ + 'errorCode' => 'CostCenter.UnitNameExist', + 'errorMessage' => 'The financial unit name already exists.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterOperateDto\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + 'title' => '修改财务单元', + 'description' => '修改一个或多个财务单元', + ], + 'DeleteCostCenter' => [ + 'summary' => '删除财务单元', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '485938', + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.DeleteWithShareRule', + 'errorMessage' => 'This financial unit involves splitting expense rules. Please adjust relevant rules before deleting the financial unit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + [ + 'errorCode' => 'CostCenter.DeleteWithSubUnitOrResource', + 'errorMessage' => 'Financial units with sub-units, allocated resources, or auto-allocation rules cannot be deleted.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"IsSuccess\\": true\\n}","type":"json"}]', + 'title' => '删除财务单元', + 'description' => '本OpenAPI灰度中，仅对部分白名单用户开放，调用过多时不排除出现响应超时等性能问题。', + ], + 'QueryCostCenter' => [ + 'summary' => '查询财务单元', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'query', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1314839403940987', + ], + ], + [ + 'name' => 'ParentCostCenterId', + 'in' => 'query', + 'schema' => [ + 'title' => '父财务单元 ID，-1 表示财务单元根。', + 'description' => '父财务单元 ID，-1 表示财务单元根。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '-1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPageResult', + 'description' => 'BssApiPageResult', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'CostCenterDtoList' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrevCostCenterId' => [ + 'title' => '前序财务单元 ID', + 'description' => '前序财务单元 ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485996', + ], + 'CostCenterName' => [ + 'title' => '财务单元名字（同一个账号必须唯一）', + 'description' => '财务单元名字（同一个账号必须唯一）', + 'type' => 'string', + 'example' => '资源组', + ], + 'CostCenterCode' => [ + 'title' => '财务单元CODE', + 'description' => '财务单元CODE', + 'type' => 'string', + 'example' => '15945703968#', + ], + 'Level' => [ + 'title' => '财务单元节点级数', + 'description' => '财务单元节点级数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'loose', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的归属用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1314839403940987', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '485938', + ], + 'ParentCostCenterId' => [ + 'title' => '父级财务单元ID', + 'description' => '父级财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"CostCenterDtoList\\": [\\n {\\n \\"PrevCostCenterId\\": 485996,\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"CostCenterCode\\": \\"15945703968#\\",\\n \\"Level\\": 0,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '查询财务单元', + 'description' => '查询父财务单元及其子财务单元', + ], + 'QueryCostCenterResource' => [ + 'summary' => '查询用户的财务单元所属的资源实例列表。当 CostCenterId 为 0，表示查未分配的主子资源实例。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '账号ID', + 'description' => '财务单元的属主用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '成本中心ID', + 'description' => '财务单元的ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESEgoQCg4KCmd', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '单次查询的最大记录数', + 'description' => '单次查询的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'title' => '账号信息', + 'description' => '企业与账号列表', + 'type' => 'object', + 'properties' => [ + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1501603440974415', + ], + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'title' => '账号id', + 'description' => '成员账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1501603440974415', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'BssApiTokenResult', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'type' => 'string', + 'required' => true, + 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + ], + 'MaxResults' => [ + 'title' => '单次查询的最大记录数', + 'description' => '单次查询的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'CostCenterResourceDtoList' => [ + 'title' => '数据列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '明细数据', + 'type' => 'object', + 'properties' => [ + 'OwnerAccountId' => [ + 'title' => '资源归属账号id', + 'description' => '财务单元归属客户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'OwnerAccountName' => [ + 'title' => '资源归属账号名称', + 'description' => '财务单元归属客户名称', + 'type' => 'string', + 'example' => '客户A', + ], + 'ResourceUserId' => [ + 'title' => '分配资源账号id', + 'description' => '资源的属主用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567812345678', + ], + 'ResourceUserName' => [ + 'title' => '分配资源账号名称', + 'description' => '资源的属主用户名称', + 'type' => 'string', + 'example' => 'test@test.aliyun.com'."\n", + ], + 'RootCostCenterId' => [ + 'title' => '财务单元根节点id', + 'description' => '根财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CostCenterId' => [ + 'title' => '财务单元id', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'ParentCostCenterId' => [ + 'title' => '财务单元上级节点id', + 'description' => '父财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'CostCenterCode' => [ + 'title' => '财务单元code', + 'description' => '财务单元code', + 'type' => 'string', + 'example' => 'code', + ], + 'CostCenterName' => [ + 'title' => '财务单元名称', + 'description' => '财务单元名称', + 'type' => 'string', + 'example' => 'test', + ], + 'CostCenterCreateTime' => [ + 'title' => '财务单元创建时间', + 'description' => '财务单元创建时间', + 'type' => 'string', + 'example' => '2025-05-18 12:12:25', + ], + 'CostCenterUpdateTime' => [ + 'title' => '财务单元修改时间', + 'description' => '财务单元最后更新时间', + 'type' => 'string', + 'example' => '2025-05-18 16:12:25', + ], + 'ResourceUpdateTime' => [ + 'description' => '财务单元最后更新时间（预留字段，当前不可用）', + 'type' => 'string', + 'example' => '2025-05-18 16:12:25'."\n", + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'example' => 'rds', + ], + 'PipName' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => '云数据库', + ], + 'CommodityCode' => [ + 'description' => '资源的商品code', + 'type' => 'string', + 'example' => 'otsbag', + ], + 'CommodityName' => [ + 'description' => '资源的商品名', + 'type' => 'string', + 'example' => '云数据库', + ], + 'ApportionItemCode' => [ + 'description' => '资源分拆code', + 'type' => 'string', + 'example' => 'test', + ], + 'ApportionItemName' => [ + 'description' => '资源分拆名', + 'type' => 'string', + 'example' => 'test', + ], + 'ResourceId' => [ + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'OSSBAG-cn-v0h1s4hma018'."\n", + ], + 'InstanceId' => [ + 'description' => '出账粒度ID', + 'type' => 'string', + 'example' => 'cn-hangzhou;standard', + ], + 'ResourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'FPT_ossbag_absolute_Storage_bj', + ], + 'ResourceTag' => [ + 'description' => '资源的Tag标签', + 'type' => 'string', + 'example' => 'tag', + ], + 'ResourceNick' => [ + 'description' => '资源的自定义昵称。', + 'type' => 'string', + 'example' => 'testResource', + ], + 'ResourceGroup' => [ + 'description' => '资源所属的资源组', + 'type' => 'string', + 'example' => '默认资源组'."\n", + ], + 'ResourceSource' => [ + 'title' => '资源来源', + 'description' => '资源来源。取值：'."\n" + .'- AUTO_ALLOCATE：自动分配。'."\n" + .'- MANUAL_ALLOCATE：手动分配。', + 'type' => 'string', + 'example' => 'MANUAL_ALLOCATE', + ], + 'RegionNo' => [ + 'title' => '地域', + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'RegionName' => [ + 'title' => '地域名称', + 'description' => '地域名称', + 'type' => 'string', + 'example' => '上海', + ], + 'RecentBillingMonth' => [ + 'title' => '最近出账账期', + 'description' => '最近出账账期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202509', + ], + 'FinanceUnitRuleVersion' => [ + 'title' => '规则版本', + 'description' => '规则版本', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'StartBillingMonth' => [ + 'title' => '规则生效账期', + 'description' => '规则生效账期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202509', + ], + 'ApplicablePeriodNum' => [ + 'title' => '刷新账期数量', + 'description' => '刷新账期数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'AddStrategy' => [ + 'title' => '添加策略', + 'description' => '添加策略', + 'type' => 'string', + 'example' => 'AUTO_ALLOCATE', + ], + 'AddStrategyName' => [ + 'title' => '添加策略名称', + 'description' => '添加策略名称', + 'type' => 'string', + 'example' => '自动分配', + ], + 'MasterCommodityCode' => [ + 'title' => '关联商品code', + 'description' => '关联商品code', + 'type' => 'string', + 'example' => 'ecs', + ], + 'MasterInstanceId' => [ + 'title' => '关联实例ID', + 'description' => '关联实例ID', + 'type' => 'string', + 'example' => 'i-xxxxx', + ], + ], + ], + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"MaxResults\\": 200,\\n \\"TotalCount\\": 2000,\\n \\"CostCenterResourceDtoList\\": [\\n {\\n \\"OwnerAccountId\\": 1234567812345678,\\n \\"OwnerAccountName\\": \\"客户A\\",\\n \\"ResourceUserId\\": 1234567812345678,\\n \\"ResourceUserName\\": \\"test@test.aliyun.com\\\\n\\",\\n \\"RootCostCenterId\\": -1,\\n \\"CostCenterId\\": 123456,\\n \\"ParentCostCenterId\\": 123456,\\n \\"CostCenterCode\\": \\"code\\",\\n \\"CostCenterName\\": \\"test\\",\\n \\"CostCenterCreateTime\\": \\"2025-05-18 12:12:25\\",\\n \\"CostCenterUpdateTime\\": \\"2025-05-18 16:12:25\\",\\n \\"ResourceUpdateTime\\": \\"2025-05-18 16:12:25\\\\n\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PipName\\": \\"云数据库\\",\\n \\"CommodityCode\\": \\"otsbag\\",\\n \\"CommodityName\\": \\"云数据库\\",\\n \\"ApportionItemCode\\": \\"test\\",\\n \\"ApportionItemName\\": \\"test\\",\\n \\"ResourceId\\": \\"OSSBAG-cn-v0h1s4hma018\\\\n\\",\\n \\"InstanceId\\": \\"cn-hangzhou;standard\\",\\n \\"ResourceType\\": \\"FPT_ossbag_absolute_Storage_bj\\",\\n \\"ResourceTag\\": \\"tag\\",\\n \\"ResourceNick\\": \\"testResource\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\n\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"RegionName\\": \\"上海\\",\\n \\"RecentBillingMonth\\": 202509,\\n \\"FinanceUnitRuleVersion\\": 3,\\n \\"StartBillingMonth\\": 202509,\\n \\"ApplicablePeriodNum\\": 3,\\n \\"AddStrategy\\": \\"AUTO_ALLOCATE\\",\\n \\"AddStrategyName\\": \\"自动分配\\",\\n \\"MasterCommodityCode\\": \\"ecs\\",\\n \\"MasterInstanceId\\": \\"i-xxxxx\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '查询财务单元的资源', + ], + 'CreateCostCenterRule' => [ + 'summary' => '创建财务单元自动分配规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '485938', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '规则表达式', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '操作类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '叶子结点过滤类型（code非标签使用）', + 'TAG' => '叶子结点过滤类型（code是标签时使用）', + 'NARY' => '子条件关系（非叶子条件时使用）', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '关系表达式', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '条件表达式', + 'type' => 'array', + 'items' => [ + 'description' => '条件表达式'."\n" + .'**整体结构见示例(可以多层嵌套），下面的字段只是字段说明**', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '筛选条件（废弃）', + 'type' => 'any', + 'required' => false, + 'example' => '无', + ], + 'FilterValues' => [ + 'description' => '子条件过滤', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '条件过滤KEY', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '账号', + 'ARTICLE' => '产品明细', + 'RESOURCE_GROUP' => '资源组', + 'xxx（用户自定义标签key）' => '业务标签，基于用户实际配置值', + 'PRODUCT' => '产品', + 'INSTANCE_NICK' => '实例名称', + 'INSTANCE_ID' => '实例ID(出账粒度)', + ], + 'example' => 'TAG-test-xxx-key', + ], + 'CodeName' => [ + 'description' => '条件过滤KEY名称（废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + 'Values' => [ + 'description' => '条件过滤值列表', + 'type' => 'array', + 'items' => [ + 'description' => '条件过滤值'."\n" + .'INSTANCE_NICK、INSTANCE_NICK时只能录入一个', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => 'code和value关联关系', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => 'Code时其他情况下使用', + 'IN' => 'Code是INSTANCE_NICK、INSTANCE_NICK时使用', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2084210001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '财务单元分配规则id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.RuleExpressionIllegal', + 'errorMessage' => 'The auto-allocation rule configuration is invalid.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1111,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]', + 'title' => '创建财务单元自动分配规则', + ], + 'ModifyCostCenterRule' => [ + 'summary' => '修改财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的属主用户（废弃）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234567812345678', + ], + ], + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '485938', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '规则表达式', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '操作类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '叶子结点过滤类型（code非标签使用）', + 'TAG' => '叶子结点过滤类型（code是标签时使用）', + 'NARY' => '子条件关系（非叶子条件时使用）', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '关系表达式', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '条件表达式', + 'type' => 'array', + 'items' => [ + 'description' => '条件表达式 **整体结构见示例(可以多层嵌套），下面的字段只是字段说明**', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '筛选条件（废弃）', + 'type' => 'any', + 'required' => false, + 'example' => '无', + ], + 'FilterValues' => [ + 'description' => '子条件过滤', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '条件过滤KEY', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '账号', + 'ARTICLE' => '产品明细', + 'RESOURCE_GROUP' => '资源组', + 'xxx（用户自定义标签key）' => '业务标签，基于用户实际配置值', + 'PRODUCT' => '产品', + 'INSTANCE_NICK' => '实例名称', + 'INSTANCE_ID' => '实例ID(出账粒度)', + ], + 'example' => 'TAG-test-xxx-key', + ], + 'CodeName' => [ + 'description' => '条件过滤KEY名称（废弃）', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + 'Values' => [ + 'description' => '条件过滤值列表', + 'type' => 'array', + 'items' => [ + 'description' => '条件过滤值 INSTANCE_NICK、INSTANCE_NICK时只能录入一个', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => 'code和value关联关系', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => 'Code时其他情况下使用', + 'IN' => 'Code是INSTANCE_NICK、INSTANCE_NICK时使用', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '财务单元分配规则id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5632', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.RuleExpressionIllegal', + 'errorMessage' => 'The auto-allocation rule configuration is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5632,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]', + 'title' => '修改财务单元自动分配规则', + 'description' => '修改一个或多个财务单元', + ], + 'DeleteCostCenterRule' => [ + 'summary' => '删除财务单元自动分配规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '637127', + ], + ], + [ + 'name' => 'FilterExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '规则表达式', + 'description' => '规则表达式'."\n" + .'**删除操作时，该字段不需要录入**', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '操作类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIMENSION' => '叶子结点过滤类型（code非标签使用）', + 'TAG' => '叶子结点过滤类型（code=标签使用）', + 'NARY' => '子条件关系（非叶子条件时使用）', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '关系表达式', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '条件表达式', + 'type' => 'array', + 'items' => [ + 'description' => '条件表达式 '."\n" + .'**整体结构见示例(可以多层嵌套），下面的字段只是字段说明**', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + 'required' => false, + ], + 'Operand' => [ + 'description' => '筛选条件（不再使用）', + 'type' => 'any', + 'required' => false, + 'example' => '无', + ], + 'FilterValues' => [ + 'description' => '子表达式过滤条件', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '条件过滤KEY', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OWNER' => '账号', + 'ARTICLE' => '产品明细', + 'RESOURCE_GROUP' => '资源组', + 'xxx（用户自定义标签key）' => '业务标签，基于用户实际配置值', + 'PRODUCT' => '产品', + 'INSTANCE_NICK' => '实例名称', + 'INSTANCE_ID' => '出账粒度', + ], + 'example' => 'TAG-test-xxx-key'."\n", + ], + 'CodeName' => [ + 'description' => '条件过滤KEY名称', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + 'Values' => [ + 'description' => '条件过滤值', + 'type' => 'array', + 'items' => [ + 'description' => '条件过滤值 INSTANCE_NICK、INSTANCE_NICK时只能录入一个', + 'type' => 'string', + 'required' => false, + 'example' => '["TAG-test-xxx"]'."\n", + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => 'code和value关联关系', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LIKE' => 'Code时其他情况下使用', + 'IN' => 'Code是INSTANCE_NICK、INSTANCE_NICK时使用', + ], + 'example' => 'IN', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '财务单元分配规则id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37404', + ], + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'UUID', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified request contains invalid parameters.', + ], + [ + 'errorCode' => 'CostCenter.UnitNotExist', + 'errorMessage' => 'The financial unit does not exist or is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 37404,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\"\\n}","type":"json"}]', + 'title' => '删除财务单元自动分配规则', + 'description' => '本OpenAPI灰度中，仅对部分白名单用户开放，调用过多时不排除出现响应超时等性能问题。', + ], + 'QueryCostCenterRule' => [ + 'summary' => '查询财务单元规则', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '财务单元的ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '597745', + ], + ], + [ + 'name' => 'EcIdAccountIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '企业与账号列表，为空表示查询当前账号自身', + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'array', + 'items' => [ + 'description' => '企业与账号列表，为空表示查询当前账号自身', + 'type' => 'object', + 'properties' => [ + 'AccountIds' => [ + 'title' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'description' => '访问的账号列表，为空代表全选当前实体ID下所有账号', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1990699401005016', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EcId' => [ + 'title' => '企业实体ID', + 'description' => '企业实体ID', + 'type' => 'string', + 'required' => true, + 'example' => '1004064243473974', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'UUID', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的属主用户', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1977800748053695', + ], + 'RootCostCenterId' => [ + 'title' => '根财务单元ID', + 'description' => '根财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '597745', + ], + 'Id' => [ + 'description' => '财务单元自动分配规则id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32048', + ], + 'FilterExpression' => [ + 'description' => '规则表达式', + 'type' => 'object', + 'properties' => [ + 'ExpressionType' => [ + 'description' => '操作类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'DIMENSION' => '叶子结点过滤类型（code非标签使用）', + 'TAG' => '叶子结点过滤类型（code是标签时使用）', + 'NARY' => '子条件关系（非叶子条件时使用）', + ], + 'example' => 'NARY', + ], + 'OperatorType' => [ + 'description' => '关系表达式', + 'type' => 'string', + 'enumValueTitles' => [ + 'OR' => 'OR', + 'AND' => 'AND', + ], + 'example' => 'AND', + ], + 'Operands' => [ + 'description' => '条件表达式', + 'type' => 'array', + 'items' => [ + 'description' => '条件表达式 整体结构见示例(可以多层嵌套），下面的字段只是字段说明', + 'type' => 'any', + 'example' => '{'."\n" + .' '."\n" + .' "Operands": ['."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "TAG-xxx",'."\n" + .' "Values": ['."\n" + .' "xxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "TAG"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_ID",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "INSTANCE_NICK",'."\n" + .' "Values": ['."\n" + .' "111"'."\n" + .' ],'."\n" + .' "SelectType": "LIKE"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "RESOURCE_GROUP",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "ARTICLE",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "PRODUCT",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' },'."\n" + .' {'."\n" + .' "FilterValues": {'."\n" + .' "Code": "OWNER",'."\n" + .' "Values": ['."\n" + .' "xxxxx"'."\n" + .' ],'."\n" + .' "SelectType": "IN"'."\n" + .' },'."\n" + .' "ExpressionType": "DIMENSION"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + ], + ], + 'Operand' => [ + 'description' => '筛选条件（废弃）', + 'type' => 'any', + 'example' => '无', + ], + 'FilterValues' => [ + 'description' => '子条件过滤', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '条件过滤KEY', + 'type' => 'string', + 'enumValueTitles' => [ + 'OWNER' => '账号', + 'ARTICLE' => '产品明细', + 'RESOURCE_GROUP' => '资源组', + 'xxx（用户自定义标签key）' => '业务标签，基于用户实际配置值', + 'PRODUCT' => '产品', + 'INSTANCE_NICK' => '实例名称', + 'INSTANCE_ID' => '实例ID(出账粒度)', + ], + 'example' => 'TAG-test-xxx-key'."\n", + ], + 'CodeName' => [ + 'description' => '条件过滤KEY名称（废弃）', + 'type' => 'string', + 'example' => '无', + ], + 'Values' => [ + 'description' => '模块Code对应属性值类型。取值：'."\n" + .'- single_float：单一取值类型。'."\n" + .'- range_float：范围取值类型。', + 'type' => 'array', + 'items' => [ + 'description' => '条件过滤值 INSTANCE_NICK、INSTANCE_NICK时只能录入一个', + 'type' => 'string', + 'example' => '["TAG-test-xxx"]'."\n", + ], + ], + 'SelectType' => [ + 'description' => 'code和value关联关系', + 'type' => 'string', + 'enumValueTitles' => [ + 'LIKE' => 'Code时其他情况下使用', + 'IN' => 'Code是INSTANCE_NICK、INSTANCE_NICK时使用', + ], + 'example' => 'IN', + ], + ], + ], + ], + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'on:有效'."\n" + .'off 失效', + 'type' => 'string', + 'example' => 'on', + ], + 'IsDeleted' => [ + 'description' => '删除状态：'."\n" + .'* **0**：激活'."\n" + .'* **1**：失效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => 'Tue Nov 12 14:49:43 CST 2024', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => 'Wed Oct 16 10:15:37 CST 2024', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1977800748053695,\\n \\"RootCostCenterId\\": 0,\\n \\"CostCenterId\\": 597745,\\n \\"Id\\": 32048,\\n \\"FilterExpression\\": {\\n \\"ExpressionType\\": \\"NARY\\",\\n \\"OperatorType\\": \\"AND\\",\\n \\"Operands\\": [\\n \\"{\\\\n \\\\n \\\\\\"Operands\\\\\\": [\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"TAG-xxx\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"TAG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_ID\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_NICK\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"111\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"RESOURCE_GROUP\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"ARTICLE\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"PRODUCT\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"OWNER\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n ],\\n \\"Operand\\": \\"无\\",\\n \\"FilterValues\\": {\\n \\"Code\\": \\"TAG-test-xxx-key\\\\n\\",\\n \\"CodeName\\": \\"无\\",\\n \\"Values\\": [\\n \\"[\\\\\\"TAG-test-xxx\\\\\\"]\\\\n\\"\\n ],\\n \\"SelectType\\": \\"IN\\"\\n }\\n },\\n \\"Status\\": \\"on\\",\\n \\"IsDeleted\\": 0,\\n \\"GmtCreate\\": \\"Tue Nov 12 14:49:43 CST 2024\\",\\n \\"GmtModified\\": \\"Wed Oct 16 10:15:37 CST 2024\\"\\n}","type":"json"}]', + 'title' => '查询财务单元自动分配规则', + 'description' => '查询父财务单元及其子财务单元', + ], + 'AllocateCostCenterResource' => [ + 'summary' => '资源实例（实例型和分拆型）从源财务单元分配到目标财务单元。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FromOwnerAccountId', + 'in' => 'formData', + 'schema' => [ + 'description' => '源财务单元的属主用户 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1529600453335198', + ], + ], + [ + 'name' => 'FromCostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '源财务单元 ID（必传）。'."\n" + ."\n" + .'- 0 表示未分配财务单元 ID'."\n" + .'- 大于 0 表示已分配的财务单元 ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '637180', + ], + ], + [ + 'name' => 'ToCostCenterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标财务单元 ID，取值：'."\n" + ."\n" + .'- -1 表示已分配资源移除到未分配。'."\n" + .'- 大于 0 表示分配到指定财务单元。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '638288', + ], + ], + [ + 'name' => 'ResourceInstanceList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源实例列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceUserId' => [ + 'description' => '账单实例的属主用户 ID（必传）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '273394581313325532', + ], + 'InstanceId' => [ + 'description' => '出账粒度ID(必传)', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou;standard'."\n", + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SCU', + ], + 'PipCode' => [ + 'description' => '产品Code，与费用中心账单产品Code一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'ResourceNick' => [ + 'description' => '资源的自定义昵称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs-test-1', + ], + 'ApportionCode' => [ + 'description' => '分拆型实例的分拆型，只有分拆型产品实例才需要传这个参数。'."\n" + .'- 目前分拆项产品有八种商品，其商品code分别是oss、dcdn、snapshot、vod、cdn、live、cbwp。'."\n" + .'- 这个分拆项字段一般是通过QueryCostUnitResource获取用户的某一个财务单元（包含未分配）下的所有账单实例（包括分拆型实例会带分拆项）。', + 'type' => 'string', + 'required' => false, + 'example' => 'qwer1-cn-beijing', + ], + 'ResourceTag' => [ + 'description' => '资源的Tag标签', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-test1', + ], + 'RelatedResources' => [ + 'description' => '资源实例相关的资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'related-resource', + ], + 'ApportionName' => [ + 'description' => '资源分拆名。', + 'type' => 'string', + 'required' => false, + 'example' => 'split-item-test1', + ], + 'ResourceId' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou;standard:app', + ], + 'ResourceSource' => [ + 'description' => '资源来源。取值：'."\n" + .'- AUTO_ALLOCATE：自动分配。'."\n" + .'- MANUAL_ALLOCATE：手动分配。', + 'type' => 'string', + 'required' => false, + 'example' => 'AUTO_ALLOCATE', + ], + 'CommodityCode' => [ + 'description' => '账单实例的商品code（必传）。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + 'ResourceStatus' => [ + 'description' => '资源状态。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'ResourceUserName' => [ + 'description' => '资源归属用户名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'CommodityName' => [ + 'description' => '资源的商品名', + 'type' => 'string', + 'required' => false, + 'example' => 'RESOURCE_UDR', + ], + 'ResourceGroup' => [ + 'description' => '资源组。', + 'type' => 'string', + 'required' => false, + 'example' => 'xihe_mpp', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Nbid', + 'in' => 'query', + 'schema' => [ + 'title' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'description' => '一级售卖场ID，如果为空，默认使用当前用户所属的场ID填充', + 'type' => 'string', + 'required' => false, + 'example' => '2684201000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BssApiPlainResult', + 'description' => 'BssApiPlainResult', + 'type' => 'object', + 'properties' => [ + 'Metadata' => [ + 'title' => '返回结构元数据', + 'description' => '返回结构元数据', + 'type' => 'any', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'UUID', + ], + 'OwnerAccountId' => [ + 'title' => '财务单元的属主用户', + 'description' => '财务单元的属主用户', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529600453335198', + ], + 'CostCenterId' => [ + 'title' => '财务单元ID', + 'description' => '财务单元ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640403', + ], + 'IsSuccess' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation', + 'errorMessage' => 'Your account has no valid account relation yet.', + ], + [ + 'errorCode' => 'CostCenter.ResourceAuthFailed', + 'errorMessage' => 'The instance does not belong to the current user.', + ], + [ + 'errorCode' => 'CostCenter.ResourceNotExist', + 'errorMessage' => 'The specified instance is not found in our records.', + ], + [ + 'errorCode' => 'CostCenter.AllocateResourceRepeat', + 'errorMessage' => 'The instance has already been assigned a financial unit. Use transfer allocation for adjustment.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"CostCenterId\\": 640403,\\n \\"IsSuccess\\": true\\n}","type":"json"}]', + 'title' => '资源分配到财务单元', + ], + ], + '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', + ], + ], +]; -- cgit v1.2.3