From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/zh_cn/bssopenapi/2017-12-14/api-docs.php | 30200 +++++++++--------------- 1 file changed, 11002 insertions(+), 19198 deletions(-) (limited to 'data/zh_cn/bssopenapi/2017-12-14') diff --git a/data/zh_cn/bssopenapi/2017-12-14/api-docs.php b/data/zh_cn/bssopenapi/2017-12-14/api-docs.php index 13f38ef..4c7d8b6 100644 --- a/data/zh_cn/bssopenapi/2017-12-14/api-docs.php +++ b/data/zh_cn/bssopenapi/2017-12-14/api-docs.php @@ -1,829 +1,446 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'BssOpenApi', - 'version' => '2017-12-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'BssOpenApi', 'version' => '2017-12-14'], 'directories' => [ [ - 'id' => 179160, - 'title' => '资金流水', + 'children' => ['QueryAccountBalance', 'QueryAccountTransactionDetails', 'QueryAccountTransactions'], 'type' => 'directory', - 'children' => [ - 'QueryAccountBalance', - 'QueryAccountTransactionDetails', - 'QueryAccountTransactions', - ], + 'title' => '资金流水', + 'id' => 96899, ], [ - 'id' => 116853, - 'title' => '财务关联', + 'children' => ['QueryRelationList', 'QueryPermissionList', 'GetAccountRelation', 'AddAccountRelation', 'ModifyAccountRelation', 'ConfirmRelation', 'RelieveAccountRelation'], 'type' => 'directory', - 'children' => [ - 'QueryRelationList', - 'QueryPermissionList', - 'GetAccountRelation', - 'AddAccountRelation', - 'ModifyAccountRelation', - 'ConfirmRelation', - 'RelieveAccountRelation', - ], + 'title' => '财务关联', + 'id' => 96791, ], [ - 'id' => 116859, - 'title' => '资源标签', + 'children' => ['QueryInstanceByTag'], 'type' => 'directory', - 'children' => [ - 'QueryInstanceByTag', - 'TagResources', - 'UntagResources', - ], + 'title' => '资源标签', + 'id' => 96799, ], [ - 'id' => 116863, - 'title' => '卡券', + 'children' => ['QueryPrepaidCards', 'QueryRedeem', 'QueryCashCoupons'], 'type' => 'directory', - 'children' => [ - 'QueryPrepaidCards', - 'QueryRedeem', - 'QueryCashCoupons', - ], + 'title' => '卡券', + 'id' => 96803, ], [ - 'id' => 116874, - 'title' => '节省计划', + 'children' => ['QuerySavingsPlansInstance', 'QuerySavingsPlansDeductLog', 'DescribeSavingsPlansUsageTotal', 'DescribeSavingsPlansUsageDetail', 'DescribeSavingsPlansCoverageTotal', 'DescribeSavingsPlansCoverageDetail', 'QuerySavingsPlansDiscount'], 'type' => 'directory', - 'children' => [ - 'QuerySavingsPlansInstance', - 'QuerySavingsPlansDeductLog', - 'DescribeSavingsPlansUsageTotal', - 'DescribeSavingsPlansUsageDetail', - 'DescribeSavingsPlansCoverageTotal', - 'DescribeSavingsPlansCoverageDetail', - 'QuerySavingsPlansDiscount', - ], + 'title' => '节省计划', + 'id' => 96807, ], [ - 'id' => 116881, - 'title' => '虚商配额', + 'children' => ['CreateResellerUserQuota', 'SetResellerUserQuota', 'ChangeResellerConsumeAmount', 'QueryResellerAvailableQuota', 'SetResellerUserAlarmThreshold', 'QueryResellerUserAlarmThreshold', 'SetResellerUserStatus'], 'type' => 'directory', - 'children' => [ - 'CreateResellerUserQuota', - 'SetResellerUserQuota', - 'ChangeResellerConsumeAmount', - 'QueryResellerAvailableQuota', - 'SetResellerUserAlarmThreshold', - 'QueryResellerUserAlarmThreshold', - 'SetResellerUserStatus', - ], + 'title' => '虚商配额', + 'id' => 96816, ], [ - 'id' => 116886, - 'title' => '虚商账号', + 'children' => ['CreateAgAccount', 'GetCustomerAccountInfo', 'GetCustomerList'], 'type' => 'directory', - 'children' => [ - 'CreateAgAccount', - 'GetCustomerAccountInfo', - 'GetCustomerList', - ], + 'title' => '虚商账号', + 'id' => 96824, ], [ - 'id' => 116890, - 'title' => '资源包', + 'children' => ['QueryResourcePackageInstances', 'QueryDPUtilizationDetail', 'QueryRIUtilizationDetail', 'DescribeResourceUsageTotal', 'DescribeResourceUsageDetail', 'DescribeResourceCoverageTotal', 'DescribeResourceCoverageDetail', 'DescribeResourcePackageProduct', 'GetResourcePackagePrice', 'RenewResourcePackage', 'UpgradeResourcePackage'], 'type' => 'directory', - 'children' => [ - 'QueryResourcePackageInstances', - 'QueryDPUtilizationDetail', - 'QueryRIUtilizationDetail', - 'DescribeResourceUsageTotal', - 'DescribeResourceUsageDetail', - 'DescribeResourceCoverageTotal', - 'DescribeResourceCoverageDetail', - 'DescribeResourcePackageProduct', - 'GetResourcePackagePrice', - 'RenewResourcePackage', - 'UpgradeResourcePackage', - ], + 'title' => '资源包', + 'id' => 96828, ], [ - 'id' => 116904, - 'title' => '财务账单', + 'children' => ['SubscribeBillToOSS', 'UnsubscribeBillToOSS', 'QueryBillToOSSSubscription', 'QueryBillOverview', 'QueryBill', 'QueryAccountBill', 'QuerySettleBill', 'QueryInstanceBill', 'DescribeInstanceBill', 'QueryInstanceGaapCost', 'DescribeInstanceAmortizedCostByAmortizationPeriod', 'DescribeProductAmortizedCostByAmortizationPeriod', 'DescribeInstanceAmortizedCostByConsumePeriod', 'DescribeProductAmortizedCostByConsumePeriod', 'DescribeSplitItemBill', 'QuerySplitItemBill'], 'type' => 'directory', - 'children' => [ - 'SubscribeBillToOSS', - 'UnsubscribeBillToOSS', - 'QueryBillToOSSSubscription', - 'QueryBillOverview', - 'QueryBill', - 'QueryAccountBill', - 'QuerySettleBill', - 'QueryInstanceBill', - 'DescribeInstanceBill', - 'QueryInstanceGaapCost', - 'DescribeInstanceAmortizedCostByAmortizationPeriod', - 'DescribeProductAmortizedCostByAmortizationPeriod', - 'DescribeInstanceAmortizedCostByConsumePeriod', - 'DescribeProductAmortizedCostByConsumePeriod', - 'DescribeSplitItemBill', - 'QuerySplitItemBill', - ], + 'title' => '财务账单', + 'id' => 96841, ], [ - 'id' => 116920, - 'title' => '询价', + 'children' => ['InquiryPriceRefundInstance', 'GetPayAsYouGoPrice', 'GetSubscriptionPrice'], 'type' => 'directory', - 'children' => [ - 'InquiryPriceRefundInstance', - 'GetPayAsYouGoPrice', - 'GetSubscriptionPrice', - ], + 'title' => '询价', + 'id' => 96858, ], [ - 'id' => 116924, - 'title' => '实例', + 'children' => ['QueryAvailableInstances', 'ModifyInstance', 'SetRenewal', 'ConvertChargeType'], 'type' => 'directory', - 'children' => [ - 'QueryAvailableInstances', - 'ReleaseInstance', - 'CreateInstance', - 'ModifyInstance', - 'SetRenewal', - 'ConvertChargeType', - 'RenewInstance', - 'RefundInstance', - ], + 'title' => '实例', + 'id' => 96862, ], [ - 'id' => 116931, - 'title' => '订单', + 'children' => ['GetOrderDetail', 'QueryOrders', 'CancelOrder'], 'type' => 'directory', - 'children' => [ - 'GetOrderDetail', - 'QueryOrders', - 'CancelOrder', - ], + 'title' => '订单', + 'id' => 96871, ], [ - 'id' => 116935, - 'title' => '财务单元', + 'children' => ['CreateCostUnit', 'AllocateCostUnitResource', 'DeleteCostUnit', 'ModifyCostUnit', 'QueryCostUnit', 'QueryCostUnitResource', 'QueryFinancialAccountInfo'], 'type' => 'directory', - 'children' => [ - 'CreateCostUnit', - 'AllocateCostUnitResource', - 'DeleteCostUnit', - 'ModifyCostUnit', - 'QueryCostUnit', - 'QueryCostUnitResource', - 'QueryFinancialAccountInfo', - ], + 'title' => '财务单元', + 'id' => 96875, ], [ - 'id' => 116943, - 'title' => '发票', + 'children' => ['QueryEvaluateList', 'QueryCustomerAddressList', 'QueryInvoicingCustomerList', 'ApplyInvoice'], 'type' => 'directory', - 'children' => [ - 'QueryEvaluateList', - 'QueryCustomerAddressList', - 'QueryInvoicingCustomerList', - 'ApplyInvoice', - ], + 'title' => '发票', + 'id' => 96883, ], [ - 'id' => 116949, - 'title' => '产品', + 'children' => ['QuerySkuPriceList', 'QueryCommodityList', 'QueryPriceEntityList', 'DescribePricingModule', 'QueryProductList'], 'type' => 'directory', - 'children' => [ - 'QuerySkuPriceList', - 'QueryCommodityList', - 'QueryPriceEntityList', - 'DescribePricingModule', - 'QueryProductList', - ], + 'title' => '产品', + 'id' => 96888, ], [ - 'id' => 169993, - 'title' => '其他', + 'children' => ['QueryUserOmsData', 'SetAllExpirationDay', 'DescribeCostBudgetsSummary', 'RenewChangeInstance', 'CreateInstance', 'RefundInstance', 'ReleaseInstance', 'RenewInstance', 'TagResources', 'UntagResources'], 'type' => 'directory', - 'children' => [ - 'QueryUserOmsData', - 'SetAllExpirationDay', - 'DescribeCostBudgetsSummary', - 'RenewChangeInstance', - ], + 'title' => '其他', + 'id' => 96894, ], ], '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', - ], + 'schemas' => [ + 'AttributeDetailDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Status' => ['title' => '属性状态', 'type' => 'string'], + 'DefaultValue' => ['title' => '默认值', 'type' => 'string'], + 'Values' => [ + 'title' => '属性可选值列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '属性值（对应属性值定义中的identifyKey）', 'type' => 'string'], + 'CascadingAttributeValues' => [ + 'title' => '级联属性值列表（递归结构）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeDetailDTO'], ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', + 'AttributeInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'OperationalAttributeConfig' => ['title' => '运维属性配置', 'type' => 'string'], + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Name' => ['title' => '属性名称（已翻译）', 'type' => 'string'], + 'Description' => ['title' => '属性描述（已翻译）', 'type' => 'string'], + 'AttributeSource' => ['title' => '属性来源', 'type' => 'string'], + 'AttributeType' => ['title' => '属性类型', 'type' => 'string'], + 'Unit' => ['title' => '单位', 'type' => 'string'], + 'ValueType' => ['title' => '值类型', 'type' => 'string'], + 'OperationalAttributeType' => ['title' => '运维属性类型', 'type' => 'string'], + 'SubAttributes' => [ + 'title' => '子属性（完整信息）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeInfoDTO'], ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', + 'DescriptionAttributes' => [ + 'title' => '描述属性（基础信息）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/BaseAttributeInfoDTO'], ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => ' Some parameters arte mandatoryfor this request.', + 'CompositeAttributes' => [ + 'title' => '组合属性（基础信息）', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/BaseAttributeInfoDTO'], ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Some parametersare not valid.', + 'AttributeCategories' => [ + 'title' => '属性分类', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specifiedowner doesn’t belong to caller', + 'Values' => [ + 'title' => '属性值列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], + ], + ], + ], + 'AttributeValueInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'IdentifyKey' => ['title' => '唯一标识', 'type' => 'string'], + 'Description' => ['title' => '描述（已翻译）', 'type' => 'string'], + 'Value' => ['title' => '枚举值', 'type' => 'string'], + 'ValueName' => ['title' => '值名称（已翻译）', 'type' => 'string'], + 'Min' => ['title' => '最小值', 'type' => 'string'], + 'Max' => ['title' => '最大值', 'type' => 'string'], + 'Step' => ['title' => '步长', 'type' => 'string'], + 'DefaultValue' => ['title' => '默认值', 'type' => 'string'], + 'BoundedValue' => [ + 'title' => '上下限值', + 'type' => 'object', + 'properties' => [ + 'LowerBound' => [ + 'title' => '下限列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], + ], + 'UpperBound' => [ + 'title' => '上限列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], + ], + ], ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'OperationTags' => [ + 'title' => '运营标签', + 'type' => 'array', + 'items' => ['type' => 'string'], ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this action.', + 'DescriptionAttributeValues' => [ + 'title' => '描述属性值', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], ], - [ - 'errorCode' => 'AuthSiteFail', - 'errorMessage' => 'auth site failed.', + 'SubAttributeValues' => [ + 'title' => '子属性值', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], + ], ], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'BaseAttributeInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Name' => ['title' => '属性名称（已翻译）', 'type' => 'string'], + 'Description' => ['title' => '属性描述（已翻译）', 'type' => 'string'], + 'AttributeSource' => ['title' => '属性来源', 'type' => 'string'], + 'AttributeType' => ['title' => '属性类型', 'type' => 'string'], + 'Unit' => ['title' => '单位', 'type' => 'string'], + 'ValueType' => ['title' => '值类型', 'type' => 'string'], + 'OperationalAttributeType' => ['title' => '运维属性类型', 'type' => 'string'], + 'AttributeCategories' => [ + 'title' => '属性分类', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'Values' => [ + 'title' => '属性值列表', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/AttributeValueInfoDTO'], ], ], ], - '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', + 'SelectedComponentConfigDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '部件code', 'type' => 'string'], + 'Tag' => ['title' => '部件唯一标识（多节点、多盘场景用）', 'type' => 'string'], + 'AttributeConfigs' => [ + 'title' => '属性配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundedValue' => [ + 'title' => '上下限值（上下限类型属性使用）', + 'type' => 'object', + 'properties' => [ + 'LowerBound' => [ + 'title' => '下限值', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Value' => ['title' => '属性值', 'type' => 'string'], + ], + ], + 'UpperBound' => [ + 'title' => '上限值', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Value' => ['title' => '属性值', 'type' => 'string'], + ], + ], + ], + ], + 'Code' => ['title' => '属性code', 'type' => 'string'], + 'Value' => ['title' => '属性值', 'type' => 'string'], + ], + ], + 'maxItems' => 100, + ], + ], ], + ], + ], + 'apis' => [ + 'AddAccountRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TransactionNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '交易编号', - 'type' => 'string', - 'required' => false, - 'example' => '410874027490089', - ], - ], - [ - 'name' => 'RecordID', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => '订单号/账单号', - 'type' => 'string', - 'required' => false, - 'example' => '2022120336190912', - ], + 'schema' => ['description' => '关系类型，目前仅支持enterprise_group', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'enterprise_group'], ], [ - 'name' => 'TransactionChannelSN', + 'name' => 'ParentUserId', 'in' => 'query', - 'schema' => [ - 'description' => '交易渠道流水号', - 'type' => 'string', - 'required' => false, - 'example' => '2022112122001470591458665933', - ], + 'schema' => ['description' => '主账号的阿里云UID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1738376485192612'], ], [ - 'name' => 'CreateTimeStart', + 'name' => 'ChildNick', 'in' => 'query', - 'schema' => [ - 'description' => '创建时间起始', - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-20', - ], + 'schema' => ['description' => '显示名称，用于页面显示，便于明确账号使用场景', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xxx项目'], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'ChildUserId', 'in' => 'query', - 'schema' => [ - 'description' => '创建时间终止', - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-20', - ], + 'schema' => ['description' => '子账号的阿里云账号UID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1512996702208737'], ], [ - 'name' => 'TransactionType', + 'name' => 'RequestId', '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', - ], + 'schema' => ['description' => '请求唯一标识，用于标记一次请求，便于定位问题', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32324242444'], ], [ - 'name' => 'TransactionChannel', + 'name' => 'PermissionCodes', 'in' => 'query', + 'style' => 'repeatList', '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" + 'description' => '授予子账号的权限数据，权限点如下：'."\n" ."\n" - .'苹果支付：ApplePay', - 'type' => 'string', - 'required' => false, - 'example' => 'AccountBalance', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询token', - 'type' => 'string', + .'- 允许同步信控身份给关联账号: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' => 'ABEDSDS124DASA', + 'example' => 'CHECK_TARGET_CONSUMPTION', + 'maxItems' => 100, ], ], [ - 'name' => 'MaxResults', + 'name' => 'RoleCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '无效参数', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '授予子账号角色，目前仅支持财务托管角色(trusteeship)', + 'type' => 'array', + 'items' => ['description' => '财务托管角色。', 'type' => 'string', 'required' => false, 'example' => 'trusteeship'], 'required' => false, - 'example' => '0', + 'example' => 'trusteeship', + 'maxItems' => 100, ], ], ], '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', - ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => '返回信息'], + 'RequestId' => ['description' => '请求标识', 'type' => 'string', 'example' => '请求标识'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => '请求结果内容', + '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', - ], - ], - ], - ], - ], - ], + 'HostId' => ['description' => '请求来源ip', 'type' => 'string', 'example' => 'HostId'], + 'RelationId' => ['description' => '关联关系id', 'type' => 'integer', 'format' => 'int64', 'example' => 'RelationId'], ], ], ], ], ], ], - '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', + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-14T14:50:34.000Z', 'description' => '响应参数发生变更、错误码发生变更'], ], + 'ramActions' => [], + ], + 'AllocateCostUnitResource' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], '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', + 'name' => 'FromUnitUserId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。不填默认1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '源财务单元的属主用户ID（必传）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '273394581313325532'], ], [ - 'name' => 'PageSize', + 'name' => 'FromUnitId', 'in' => 'query', - 'schema' => [ - 'description' => '每页显示条数。不填默认20', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '源财务单元ID（必传）。'."\n" + .'- 0表示未分配财务单元ID'."\n" + .'- 大于0表示已分配的财务单元ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], ], [ - 'name' => 'TransactionType', + 'name' => 'ToUnitUserId', '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', - ], - ], + 'schema' => ['description' => '目标财务单元属主用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '241021678450941490'], ], [ - 'name' => 'TransactionFlow', + 'name' => 'ToUnitId', 'in' => 'query', - 'schema' => [ - 'description' => '收支类型。'."\n" - .'传入以下收支类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" - .'- 收入：Income。'."\n" - .'- 支出：Expense。', - 'type' => 'string', - 'required' => false, - 'example' => 'Income', - 'enum' => [ - 'Income', - 'Expense', - ], - ], + 'schema' => ['description' => '目标财务单元ID，取值：'."\n" + .'- -1表示已分配资源移除到未分配。'."\n" + .'- 大于0表示分配到指定财务单元。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '186419'], ], [ - 'name' => 'TransactionChannel', + 'name' => 'ResourceInstanceList', 'in' => 'query', + 'style' => 'repeatList', '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', + '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, ], ], ], @@ -832,422 +449,188 @@ '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', - ], + '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' => [ - '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', - ], - ], - ], - ], - ], - ], + '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\\": \\"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' => '查询用户账户流水信息。', + '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' => ' ', - ], - 'QueryRelationList' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-11-17T06:23:55.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:AllocateCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ApplyInvoice' => [ + 'summary' => '提交开票申请服务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'InvoiceAmount', 'in' => 'query', - 'schema' => [ - 'description' => '阿里云账号UID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1990699401005016', - ], + 'schema' => ['description' => '申请开票金额（单位：分）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], ], [ - 'name' => 'PageNum', + 'name' => 'CustomerId', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '发票抬头信息ID，对应QueryInvoicingCustomerList接口返回的ID参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '124132423'], ], [ - 'name' => 'PageSize', + 'name' => 'AddressId', 'in' => 'query', - 'schema' => [ - 'description' => '页大小，默认20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '邮寄地址ID，对应QueryCustomerAddressList接口返回的ID参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '237958367'], ], [ - 'name' => 'StatusList', + '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' => '关系状态列表，状态是RelationshipStatusEnum的枚举值。默认不传值查询当前生效状态。', + 'description' => '选择开票的待开票对象ID列表，对应QueryEvaluateList接口返回的ID参数。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'RELATED', - ], - 'required' => false, - 'example' => 'RELATED', - 'maxItems' => 8, + 'items' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '384752367', 'description' => ''], + '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' => '状态码。'."\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', - ], + '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' => '消息体', + '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', - ], - ], - ], - ], + 'InvoiceApplyId' => ['description' => '发票申请记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1323125534'], ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified request contains invalid parameters.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified request lacks essential parameters.', - ], + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-25T05:59:16.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyInvoice'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ApplyInvoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'CancelOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RelationId', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '51463', - ], + 'schema' => ['description' => '订单号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '73465432785'], ], ], 'responses' => [ @@ -1255,291 +638,151 @@ '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', - ], + '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' => '消息体。'."\n", + 'description' => '返回信息。', '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' => '主账号 子账号共享主账号信控身份', - ], - ], - ], - ], + 'HostId' => ['description' => '主机ID。', 'type' => 'string', 'example' => 'cn'], ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified request contains invalid parameters.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified request lacks essential parameters.', - ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrder'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:CancelOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'ChangeResellerConsumeAmount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RelationId', + 'name' => 'AdjustType', 'in' => 'query', - 'schema' => [ - 'title' => 'relationId', - 'description' => '账号关联id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => '消费金额调整方向 increase:增加,用户消费增加金额 decrease:减少,用户充值减少金额 [必填]', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'increase/decrease'], ], [ - 'name' => 'RequestId', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'title' => 'requestId', - 'description' => '请求唯一标识，用于标记一次请求，便于定位问题', - 'type' => 'string', - 'required' => false, - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], + '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' => [ - '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', - ], + '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'], ], + 'description' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter.', 'description' => ''], + ['errorCode' => '-1101', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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 消费抵扣。', + 'changeSet' => [ + ['createdAt' => '2022-12-29T03:08:01.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResellerConsumeAmount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ChangeResellerConsumeAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ConfirmRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1547,70 +790,36 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => '关系类型，目前仅支持enterprise_group', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'enterprise_group', - ], + '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' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => '主账号阿里云UID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1738376485192612'], ], [ - 'name' => 'ChildNick', + 'name' => 'ConfirmCode', 'in' => 'query', - 'schema' => [ - 'description' => '显示名称，用于页面显示，便于明确账号使用场景', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'xxx项目', - ], + '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' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + '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' => '32324242444', - ], + 'schema' => ['description' => '调用请求唯一标识', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'request_id'], ], [ 'name' => 'PermissionCodes', @@ -1618,43 +827,24 @@ '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', + .'- 允许同步信控身份给关联账号：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', + 'items' => ['type' => 'string', 'required' => false, 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY'], + 'required' => true, + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', 'maxItems' => 100, ], ], [ - 'name' => 'RoleCodes', + 'name' => 'RelationId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '授予子账号角色，目前仅支持财务托管角色(trusteeship)', - 'type' => 'array', - 'items' => [ - 'description' => '财务托管角色。', - 'type' => 'string', - 'required' => false, - 'example' => 'trusteeship', - ], - 'required' => false, - 'example' => 'trusteeship', - 'maxItems' => 100, - ], + 'schema' => ['description' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51463'], ], ], 'responses' => [ @@ -1662,204 +852,77 @@ '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', - ], + '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' => '数据', + 'description' => '返回数据', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => '请求来源ip', - 'type' => 'string', - 'example' => 'HostId', - ], - 'RelationId' => [ - 'description' => '关联关系id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'RelationId', - ], + 'HostId' => ['description' => '主机ID', 'type' => 'string', 'example' => 'HostId'], ], ], ], ], ], ], - '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确认。', + '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' => ' ', - ], - 'ModifyAccountRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2021-12-14T14:50:34.000Z', 'description' => '请求参数发生变更、错误码发生变更'], ], + 'ramActions' => [], + ], + 'ConvertChargeType' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], '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', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '子账号的阿里云账号UID'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'RequestId', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '请求唯一标识，用于标记一次请求，便于定位问题'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', - ], + 'schema' => ['description' => '实例当前的付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'> 调用成功后资源将被更变为相反的类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription'], ], [ - 'name' => 'RoleCodes', + 'name' => 'Period', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '暂时不支持角色修改', - 'type' => 'array', - 'items' => [ - 'description' => '角色 Code。', - 'type' => 'string', - 'required' => false, - 'example' => 'trusteeship', - ], - 'required' => false, - 'example' => 'trusteeship', - 'maxItems' => 200, - ], + 'schema' => ['description' => '预付费周期（月），如果转换为预付费类型，需要设置购买的预付费的周期时长。取值：'."\n" + .'- 1~9。'."\n" + .'- 12。'."\n" + .'- 24。'."\n" + .'- 36。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'], ], [ - 'name' => 'PermissionCodes', + 'name' => 'ProductCode', '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, - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ - 'name' => 'RelationId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51463', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-kasjgfjshgf'], ], ], 'responses' => [ @@ -1867,164 +930,184 @@ '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', - ], + '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' => '返回数据', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => '请求来源IP', - 'type' => 'string', - 'example' => '127.0.0.1', - ], + 'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '202657601410661'], ], ], ], ], ], ], - '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' => '支持添加、删除财务关联权限点。', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ], + 405 => [ + ['errorCode' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', 'errorMessage' => '您购买的数量超过限制。请重新购买。', 'description' => ''], + ['errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', 'errorMessage' => '您选购的服务存在未支付订单，请支付或作废后再下单！', 'description' => ''], + ['errorCode' => 'COMMODITY.INVALID_COMPONENT', 'errorMessage' => '必选模块未选择', 'description' => ''], + ['errorCode' => 'ORDER.QUANTITY_INVALID', 'errorMessage' => '您购买的数量超过限制。请重新购买。', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', - ], - 'ConfirmRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-12-26T09:54:10.000Z', 'description' => '错误码发生变更'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ConvertChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'readAndWrite', + ], + 'CreateAgAccount' => [ + 'summary' => '创建一个财务关联关系。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationType', + 'name' => 'LoginEmail', 'in' => 'query', - 'schema' => [ - 'description' => '关系类型，目前仅支持enterprise_group', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'enterprise_group', - ], + 'schema' => ['description' => '登录邮箱', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'email'], ], [ - 'name' => 'ParentUserId', + 'name' => 'AccountAttr', 'in' => 'query', - 'schema' => [ - 'description' => '主账号阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => '新增账号属性，需要在控制台的顶部菜单栏，单击账号属性，跳转至**安全设置**页面查看。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'ConfirmCode', + 'name' => 'EnterpriseName', 'in' => 'query', - 'schema' => [ - 'description' => '确认动作：'."\n" - ."\n" - .'- 子账号同意：child_agree'."\n" - .'- 子账号拒绝：child_disagree'."\n" - .'- 主账号取消确认：主账号取消确认', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'child_agree', - ], + 'schema' => ['description' => '企业名称（统一社会信用代码对应的企业名）。', 'type' => 'string', 'required' => false, 'example' => '阿里云测试有限公司'], ], [ - 'name' => 'ChildUserId', + 'name' => 'FirstName', 'in' => 'query', - 'schema' => [ - 'description' => '子账号阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + 'schema' => ['description' => '一级分类名称。', 'type' => 'string', 'required' => false, 'example' => '志成'], ], [ - 'name' => 'RequestId', + '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' => [ - 'description' => '调用请求唯一标识', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', + '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' => '创建一个财务云主子关系。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgAccount'], + ], + ], + 'ramActions' => [], + ], + 'CreateCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PermissionCodes', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'UnitEntityList', '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', + 'description' => '财务单元列表。', 'type' => 'array', 'items' => [ - 'type' => 'string', + '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, - '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', + 'maxItems' => 100, ], ], ], @@ -2033,34 +1116,26 @@ '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', - ], + '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' => '返回数据', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => '主机ID', - 'type' => 'string', - 'example' => 'HostId', + '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'], + ], + ], ], ], ], @@ -2068,24 +1143,35 @@ ], ], ], - '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、确认的权限点，必须与主账号发起邀约权限点一致才可以确认成功', + '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' => ' ', - ], - 'RelieveAccountRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCostUnit'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2093,67 +1179,96 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationType', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '关系类型，目前仅支持enterprise_group', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'enterprise_group', - ], + 'schema' => ['description' => '产品代码。可通过接口**QueryProductList**查询产品代码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Cdn'], ], [ - 'name' => 'ParentUserId', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '主账号的阿里云UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'Cdn'], ], [ - 'name' => 'ChildUserId', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '子账号的阿里云账号UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + 'schema' => ['description' => '付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription'], ], [ - 'name' => 'RequestId', + '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' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', + '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' => 'RelationId', + 'name' => 'PricingCycle', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => '账号关联id，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', + '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' => 'RelationId', + 'example' => '2', + 'enum' => [], ], ], ], @@ -2162,282 +1277,163 @@ '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', - ], + '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' => '返回数据', + 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'hostid', - 'type' => 'string', - 'example' => 'HostId', - ], + 'OrderId' => ['description' => '创建成功的订单ID。', 'type' => 'string', 'example' => '20240xxxx21'], + 'InstanceId' => ['description' => '订单对应的实例ID。', 'type' => 'string', 'example' => 'OSSBAG-cn-v1hxxxxx23'], ], ], ], ], ], ], - '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' => [], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'INSUFFICIENT.AVAILABLE.QUOTA', 'errorMessage' => 'The account balance is negative. Add funds to the account and try again.', 'description' => '您的账户可用额度小于0，请先充值后再尝试购买'], + ], + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', 'errorMessage' => 'Please complete your basic personal information first.', 'description' => ''], + ['errorCode' => '400', 'errorMessage' => 'Failure to check order before create instance.', 'description' => ''], + ['errorCode' => 'ORDER.ACCOUNT_INFORMATION_INCOMPLETE', 'errorMessage' => 'Your information is incomplete. Complete your information before ordering', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + '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)，查询已创建的实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateResellerUserQuota' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型'."\n" - .'instance 节省计划实例', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => '金额，单位元[Quota开户必填]', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100'], ], [ - 'name' => 'ResourceId', + 'name' => 'Currency', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '资源id列表', - 'type' => 'array', - 'items' => [ - 'description' => '资源 ID', - 'type' => 'string', - 'required' => false, - 'example' => 'spn-XXXXXX', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'schema' => ['description' => '币种名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CNY：人民币。USD：美元。JPY：日元。'], ], [ - 'name' => 'Tag', + 'name' => 'OutBizId', '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, - ], + 'schema' => ['description' => '外部系统业务流水号', 'type' => 'string', 'required' => false, 'example' => '7ed0bedc-056e-4a71-9249-4581615c028f'], ], ], 'responses' => [ 200 => [ + 'headers' => [], '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', - ], - ], - ], - ], - ], - ], - ], + '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'], ], ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter.', 'description' => ''], + ['errorCode' => '-303', 'errorMessage' => 'Record is exists already.', 'description' => ''], + ['errorCode' => 'CreditInnerError', 'errorMessage' => 'This interface has some error. Please try again.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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 消费账本。', + 'changeSet' => [ + ['createdAt' => '2022-12-29T03:08:01.000Z', 'description' => '错误码发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '资源类型'."\n" - .'instance 节省计划实例', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', - ], - ], - [ - 'name' => 'ResourceId', + 'name' => 'OwnerUid', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '资源id列表', - 'type' => 'array', - 'items' => [ - 'description' => '资源id', - 'type' => 'string', - 'required' => false, - 'example' => 'spn-XXXXXX', - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => '财务单元的属主用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2135342'], ], [ - 'name' => 'Tag', + 'name' => 'UnitId', '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, - ], + 'schema' => ['description' => '财务单元ID，-1表示财务单元根。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '376348'], ], ], 'responses' => [ @@ -2445,294 +1441,396 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码。', - 'type' => 'string', - 'example' => 'InternalError', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], + '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' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', + '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'], + ], ], ], ], ], ], - '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', + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-17T06:23:55.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'bss:DeleteCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeCostBudgetsSummary' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'BudgetName', + 'in' => 'query', + 'schema' => ['title' => '预算名称', 'description' => '预算名称。模糊匹配', 'type' => 'string', 'required' => false, 'example' => '全年预算'], + ], + [ + 'name' => 'BudgetStatus', 'in' => 'query', 'schema' => [ - 'description' => '资源类型'."\n" - .'instance 节省计划实例', + 'title' => '预算状态', + 'description' => '预算状态，枚举值：overdue（已过期）,notOverdue（未过期）。不填写则默认取全部', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', + 'required' => false, + 'enumValueTitles' => ['notOverdue' => 'notOverdue', 'overdue' => 'overdue'], + 'example' => 'notOverdue', ], ], [ - 'name' => 'All', + 'name' => 'BudgetType', 'in' => 'query', 'schema' => [ - 'description' => '是否全部删除，仅当未传入tagkey.n时有效。取值范围：-true-false', - 'type' => 'boolean', + 'title' => '预算类型', + 'description' => '预算类型。枚举值：cost(费用预算), byquantity（按量编制预算）, asset（使用率及覆盖率预算）。'."\n" + .'不填写则默认取全部', + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'enumValueTitles' => ['cost' => 'cost', 'byquantity' => 'byquantity', 'asset' => 'asset'], + 'example' => 'cost', ], ], [ - 'name' => 'ResourceId', + 'name' => 'NextToken', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '资源id列表', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID', - 'type' => 'string', - 'required' => false, - 'example' => 'spn-xxxxxx', - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['title' => '开始读取的位置', 'description' => '当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错，空则代表从头开始读取。默认：空', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0='], ], [ - 'name' => 'TagKey', + 'name' => 'MaxResults', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签键列表', - 'type' => 'array', - 'items' => [ - 'description' => '标签键。N的取值范围为1~20。', - 'type' => 'string', - 'required' => false, - 'example' => 'codename', - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['title' => '读取的最大数据记录数量', 'description' => '读取的最大数据记录数量。默认值：10，最大值：10，最小值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回值信息', + 'title' => 'BssResult', + 'description' => 'BssResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码', - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Message' => [ - 'description' => '错误信息'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], + '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' => '返回数据'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + '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' => '[{"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', + 'title' => '查询成本管理预算概要信息', + 'summary' => '查询用户 “成本管理-预算”的概要信息。', + 'description' => '本OpenAPI灰度中，仅对部分白名单用户开放，调用过多时不排除出现响应超时等性能问题。', + 'changeSet' => [ + ['createdAt' => '2022-12-06T08:39:39.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCostBudgetsSummary'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCostBudgetsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ + 'summary' => '以摊销月视角查询月实例摊销成本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ExpiryTimeEnd', - 'in' => 'query', + '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' => [ - 'description' => '卡包过期结束时间止，格式：yyyy-mm-ddhh:mm:ss。', - 'type' => 'string', + 'title' => '账期月筛选条件', + 'description' => '账期月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '账期月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => false, 'example' => '2022-09', 'maxLength' => 256], 'required' => false, - 'example' => '2018-08-01 00:00:00', + 'maxItems' => 10, ], ], [ - 'name' => 'ExpiryTimeStart', - 'in' => 'query', + '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' => '卡包过期时间起，格式：yyyy-mm-dd。', - 'type' => 'string', + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '账单购买者ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'example' => '2018-08-01 00:00:00', + 'maxItems' => 10, ], ], [ - 'name' => 'EffectiveOrNot', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '卡包是否生效。取值范围：-true。-false。', - 'type' => 'boolean', + '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, - 'example' => 'true', + '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' => [ - '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', - ], + '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', - 'itemNode' => true, 'properties' => [ - 'PrepaidCard' => [ - 'description' => '返回数据。', + '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' => [ - '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', - ], + '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'], ], ], ], @@ -2744,243 +1842,247 @@ ], '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.', - ], + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + '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小时可使用。', + 'changeSet' => [ + ['createdAt' => '2023-01-10T03:48:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-12-29T06:56:28.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ['createdAt' => '2022-12-23T03:13:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-22T07:15:03.000Z', 'description' => 'OpenAPI 下线'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'DescribeInstanceAmortizedCostByConsumePeriod' => [ + 'summary' => '以账期月视角查询月实例摊销成本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], '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' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['title' => '账期月、摊销月', 'description' => '账期月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => true, 'example' => '2022-10', 'maxLength' => 256], ], [ - 'name' => 'ExpiryTimeEnd', - 'in' => 'query', + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '失效结束时间。格式：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', + 'title' => '摊销月筛选条件', + 'description' => '摊销月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '摊销月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => false, 'example' => '2022-09'."\n", 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'example' => '2018-08-01T00:00:00Z', + 'maxItems' => 10, ], ], [ - 'name' => 'EffectiveOrNot', - 'in' => 'query', - 'schema' => [ - 'description' => '提货券是否生效：'."\n" - .'- true。'."\n" - .'- false。'."\n" - ."\n" - .'默认false。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['title' => '订阅类型', 'description' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => false, 'example' => 'Subscription', 'maxLength' => 256], ], [ - 'name' => 'PageNum', - 'in' => 'query', + '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' => '页码。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '账单购买者ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'example' => '1', + 'maxItems' => 10, ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每页显示条数。每页条数不允许超过300', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '资源归属账号筛选条件。 '."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。 '."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '资源归属账号ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'example' => '10', + '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' => [ - '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', - ], + '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' => '返回数据。', + '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', - ], - ], - ], + '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'], ], ], ], @@ -2992,85 +2094,128 @@ ], '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. ', - ], + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + '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小时可使用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAmortizedCostByConsumePeriod'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'DescribeInstanceBill' => [ + 'summary' => '查询用户某个账期内所有商品实例或计费项的消费汇总。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ExpiryTimeEnd', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '代金券终止过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', - 'type' => 'string', - 'required' => false, - 'example' => '2018-08-01T00:00:00Z', - ], + 'schema' => ['description' => '账期YYYY－MM。仅支持最近18个月账期。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-03'], ], [ - 'name' => 'ExpiryTimeStart', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '代金券起始过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', - 'type' => 'string', - 'required' => false, - 'example' => '2018-09-01T00:00:00Z', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'EffectiveOrNot', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '代金券是否生效。取值范围：'."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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' => [ @@ -3078,95 +2223,86 @@ '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', - ], + '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', - 'itemNode' => true, 'properties' => [ - 'CashCoupon' => [ - 'description' => '返回数据', + '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' => [ - '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' => '该代金券用于产品功能验证的测试', - ], + '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'], ], ], ], @@ -3176,405 +2312,384 @@ ], ], ], - '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.', - ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceBill'], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeInstanceBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'DescribePricingModule' => [ + 'summary' => '查询阿里云某个产品对应模块信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '每页个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => '产品代码，可通过接口**QueryProductList**查询产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ - 'name' => 'Locale', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '多语言信息'."\n" - ."\n" - .'- ZH 中文'."\n" - .'- EN 英文', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ZH', - ], + 'schema' => ['description' => '产品类型，可通过接口**QueryProductList**查询产品类型。'."\n" + .'>需要和**QueryProductList**接口返回的产品类型保持一致>', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'PageNum', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '查询页数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription'], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '节省计划实例ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn-xxxxxxx', + '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" ]'], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + '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（单机基础版）'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'title' => '查询产品模块信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-04T03:08:42.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePricingModule'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePricingModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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":""}]', + ], + 'DescribeProductAmortizedCostByAmortizationPeriod' => [ + 'summary' => '以摊销月视角查询月产品摊销成本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Tag', - 'in' => 'query', + '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' => '标签元素列表', + 'description' => '账期月筛选条件。'."\n" + .'最多元素个数：10。', 'type' => 'array', - 'items' => [ - 'description' => '标签元素', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签查询键', - 'type' => 'string', - 'required' => false, - 'example' => '测试标签', - ], - 'Value' => [ - 'description' => '标签查询值', - 'type' => 'string', - 'required' => false, - 'example' => '测试标签', - ], - ], - 'required' => false, - ], + 'items' => ['description' => '账期月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => false, 'example' => '2022-09', 'maxLength' => 256], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 10, ], ], [ - 'name' => 'Status', - 'in' => 'query', + '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' => '实例状态：'."\n" - .'NORMAL:有效'."\n" - .'RELEASE 失效', - 'type' => 'string', + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '账单购买者ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'example' => 'NORMAL', + 'maxItems' => 10, ], ], [ - 'name' => 'CommodityCode', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '商品Code', - 'type' => 'string', + 'description' => '资源归属账号筛选条件。'."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '资源归属账号ID。', 'type' => 'string', 'required' => false, 'example' => 'abc', 'maxLength' => 256], 'required' => false, - 'example' => 'savingplan_common_public_cn', + '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' => [ - 'description' => '返回值对象', + 'title' => 'BssResult>', + 'description' => 'BssResult', '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', - ], + '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' => '返回元素', + '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', - ], + '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' => '实例信息列表', + 'description' => '数据条目。', 'type' => 'array', 'items' => [ - 'description' => '实例信息', + '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', - ], + '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'], ], ], ], @@ -3586,53 +2701,41 @@ ], '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.', - ], + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + '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小时可使用。', + 'changeSet' => [ + ['createdAt' => '2023-01-10T03:48:20.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-12-29T06:56:28.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ['createdAt' => '2022-12-23T03:13:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-22T07:15:03.000Z', 'description' => 'OpenAPI 下线'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'DescribeProductAmortizedCostByConsumePeriod' => [ + 'summary' => '以账期月视角查询月产品摊销成本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3640,255 +2743,178 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => '查询类型：'."\n" - ."\n" - .'- spn 节省计划实例'."\n" - ."\n" - .'- product 抵扣云产品实例', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn', - ], + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['description' => '账期月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => true, 'example' => '2022-10'."\n", 'maxLength' => 256], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '摊销月筛选条件', + 'description' => '摊销月筛选条件。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '摊销月'."\n" + .'格式：YYYY－MM。', 'type' => 'string', 'required' => false, 'example' => '2022-09'."\n", 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', + 'maxItems' => 10, ], ], [ - 'name' => 'Locale', - 'in' => 'query', - 'schema' => [ - 'description' => '多语言选项，默认返回中文'."\n" - .'ZH 中文'."\n" - .'EN 英文', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ZH', - ], + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['description' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => false, 'example' => 'Subscription', 'maxLength' => 256], ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '查询页数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => ['description' => '产品。'."\n" + .'参考取值来源：'."\n" + .'查QueryProductList 查询产品信息，'."\n" + .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', 'type' => 'string', 'required' => false, 'example' => 'rds', 'maxLength' => 256], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn-XXXXXXX', - ], + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => ['description' => '产品明细。', 'type' => 'string', 'required' => false, 'example' => 'rds', 'maxLength' => 256], ], [ - 'name' => 'StartTime', - 'in' => 'query', + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => ['description' => '财务单元code。', 'type' => 'string', 'required' => false, 'example' => '123#'."\n", 'maxLength' => 256], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '查询开始时间', - 'type' => 'string', + 'description' => '账单购买者ID筛选条件。'."\n" + .'子账号ID。设置可查看财务云子账号账单，不填默认查看当前调用账号及其所有子账号。'."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '账单购买者ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'example' => '2022-01-01 00:00:00', + 'maxItems' => 10, ], ], [ - 'name' => 'EndTime', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '查询结束时间', - 'type' => 'string', + 'description' => '资源归属账号筛选条件。 '."\n" + .'资源归属账号ID，资源归属账号是实际使用资源的账号。 '."\n" + .'最多元素个数：10。', + 'type' => 'array', + 'items' => ['description' => '资源归属账号ID。', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 256], 'required' => false, - 'docRequired' => false, - 'example' => '2022-01-05 00:00:00', + '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' => [ - 'description' => '返回值', + 'title' => 'BssResult>', + 'description' => 'BssResult', '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', - ], + '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' => '返回元素', + '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', - ], + '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' => '抵扣明细列表', + 'description' => '数据条目。', 'type' => 'array', 'items' => [ - 'description' => '抵扣明细数据', + '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', - ], + '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'], ], ], ], @@ -3900,47 +2926,35 @@ ], '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.', - ], + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + '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小时可使用。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'DescribeResourceCoverageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3948,220 +2962,133 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000'], ], [ - 'name' => 'FilterParam', + 'name' => 'ResourceType', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'RI：预留实例；SCU：存储容量单位包', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RI'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Dimensions' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - 'required' => false, - ], - 'Values' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, + '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'], ], - 'required' => false, - ], - 'SelectType' => [ - 'type' => 'string', - 'required' => false, + 'description' => '', ], ], - '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, + 'description' => '', ], ], ], - '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' => [], + 'title' => '资源覆盖率明细', + 'summary' => '预留实例、SCU覆盖率明细查询。', + 'description' => '1. 与费用中心“资源实例管理”菜单中的“覆盖率概况”的列表数据一致。'."\n" + .'2. 当前支持RI和SCU两种资源的覆盖率查询。'."\n" + .'3. 提供“小时”、“天”，“月”三种维度的覆盖率查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceCoverageDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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' => '节省计划使用率汇总', + '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":""}]', ], - 'DescribeSavingsPlansUsageDetail' => [ - 'summary' => '节省计划使用率明细查询', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeResourceCoverageTotal' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4169,140 +3096,32 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + '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；查询逻辑为不包括该时间；为空表示截止到当前时间', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + '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' => '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', - ], + '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', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000'], ], [ - 'name' => 'FilterParam', + 'name' => 'ResourceType', '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, - ], + 'schema' => ['description' => 'RI：预留实例；SCU：存储容量单位包'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RI'], ], ], 'responses' => [ @@ -4310,356 +3129,373 @@ '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', - ], + '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' => '返回数据', + 'description' => '返回数据'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总数据个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'NextToken' => [ - 'description' => '下一页token', - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9', - ], - 'Items' => [ - 'description' => '数据项', + 'PeriodCoverage' => [ + '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', - ], + 'CoveragePercentage' => ['description' => '覆盖率', 'type' => 'number', 'format' => 'float', 'example' => '0.1'], + 'Period' => ['description' => '时段'."\n" + .'yyyyMMddHH', 'type' => 'string', 'example' => '2020110100'], ], + 'description' => '', + ], + ], + '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'], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"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' => '节省计划使用率明细', + 'title' => '资源覆盖率汇总', + 'summary' => '预留实例、SCU覆盖率汇总查询。', + 'description' => '与费用中心“资源实例管理”菜单中的“覆盖率概况”的汇总数据一致。'."\n" + .'当前支持RI和SCU两种资源的覆盖率查询。'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSavingsPlansCoverageTotal' => [ - 'summary' => '节省计划覆盖率汇总查询。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceCoverageTotal'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeResourcePackageProduct' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], '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', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => true, 'example' => 'ossbag'], ], - [ - 'name' => 'FilterParam', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ '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, + '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'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], - 'required' => false, ], ], - 'required' => false, ], - 'required' => false, ], ], - 'required' => false, ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'ProductCodeMissing', 'errorMessage' => 'Parameter ProductCode is missing.', 'description' => ''], + ['errorCode' => 'ProductNotSupported', 'errorMessage' => 'Product currently is not supported.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-19T03:45:42.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeResourceUsageDetail' => [ + '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' => '状态码', - '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', - ], + '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' => '返回数据。', + 'description' => '返回数据'."\n", 'type' => 'object', 'properties' => [ - 'PeriodCoverage' => [ - 'description' => '时段覆盖率', + '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' => [ - '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', + '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'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], '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', + 'title' => '资源使用率明细', + 'summary' => '预留实例、SCU使用率明细查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeResourceUsageTotal' => [ + 'summary' => '预留实例、SCU使用率汇总查询。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4667,139 +3503,192 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + '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', - ], + '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。', + 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度', 'type' => 'string', 'required' => true, 'docRequired' => true, + 'enumValueTitles' => ['MONTH' => 'MONTH', 'HOUR' => 'HOUR', 'DAY' => 'DAY'], 'example' => 'HOUR', ], ], [ - 'name' => 'Token', - 'in' => 'query', - 'schema' => [ - 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], - ], - [ - 'name' => 'MaxResults', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => '返回结果的最大个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号；只支持传入1个账号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', + 'description' => '资源包类型，枚举值包括RI/SCU；RI：预留实例； SCU：存储容量单位包', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => ['SCU' => 'SCU', 'RI' => 'RI'], + 'example' => 'RI', ], ], - [ - 'name' => 'FilterParam', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => '（根节点）', '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, + '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'], ], - 'required' => false, ], ], - 'required' => false, + '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'], + ], + ], ], - 'required' => false, ], - 'Tags' => [ + ], + ], + ], + ], + 'errorCodes' => [], + 'title' => '资源使用率汇总', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageTotal'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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":""}]', + ], + 'DescribeSavingsPlansCoverageDetail' => [ + '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, + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, + 'items' => ['type' => 'string'], ], ], - 'required' => false, ], - 'required' => false, ], ], - 'required' => false, ], ], ], @@ -4808,139 +3697,74 @@ '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', - ], + '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', - ], + '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', - ], + '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'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], - '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', + 'summary' => '节省计划覆盖率明细查询。', + 'changeSet' => [ + ['createdAt' => '2023-10-13T09:14:59.000Z', 'description' => '响应参数发生变更、错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'DescribeSavingsPlansCoverageTotal' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4948,693 +3772,689 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ModuleCode', + 'name' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'title' => 'moduleCode', - 'description' => '模块CODE', - 'type' => 'string', - 'required' => false, - 'example' => 'instance_type', - ], + 'schema' => ['description' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-07-15 00:00:00'], ], [ - 'name' => 'PayMode', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'title' => 'payMode', - 'description' => '付费类型:'."\n" - .'total 全预付'."\n" - .'half 半预付'."\n" - .'zero 0预付', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'zero' => '0预付', - 'total' => '全预付', - 'half' => '半预付', - ], - 'example' => 'total', - ], + 'schema' => ['description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', 'type' => 'string', 'required' => false, 'example' => '2021-07-20 00:00:00'], ], [ - 'name' => 'PageSize', + 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'title' => 'pageSize', - 'description' => '每页个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR'], ], [ - 'name' => 'SpnType', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'title' => 'spnType', - 'description' => '节省计划类型:'."\n" - .'ecs 计算型'."\n" - .'universal 通用型', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'ecs' => '计算型', - 'universal' => '通用型', - ], - 'example' => 'universal', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000'], ], [ - 'name' => 'Locale', + 'name' => 'FilterParam', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'locale', - 'description' => '多语言标识', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EN' => '英文', - 'ZH' => '中文', + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], ], - 'example' => 'ZH', ], ], - [ - 'name' => 'Cycle', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'cycle', - 'description' => '查询周期', - 'type' => 'string', - 'required' => true, - 'example' => '1:Year', + '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'], + ], + 'description' => '', + ], + ], + 'TotalCoverage' => [ + 'description' => '总覆盖率', + 'type' => 'object', + 'properties' => [ + 'CoveragePercentage' => ['description' => '总覆盖率', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'DeductAmount' => ['description' => '总抵扣金额', 'type' => 'number', 'format' => 'float', 'example' => '100'], + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [], + 'title' => '节省计划覆盖率汇总', + 'summary' => '节省计划覆盖率汇总查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageTotal'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'title' => 'pageNum', - 'description' => '查询页数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'Spec', - 'in' => 'query', - 'schema' => [ - 'title' => 'spec', - 'description' => '资源类型', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.g6', - ], + ], + '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"}]', + ], + 'DescribeSavingsPlansUsageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'CommodityCode', + 'name' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'title' => 'commodityCode', - 'description' => '商品CODE', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00'], ], [ - 'name' => 'Region', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => '地域信息', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00'], ], [ - 'name' => 'SpnCommodityCode', + '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' => [ - 'description' => '节省计划商品Code', - 'type' => 'string', - 'required' => false, - 'example' => 'savingplan_common_public_cn', + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'SelectType' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + ], + ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - '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', - ], + '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' => [ - 'title' => 'data', - 'description' => 'data', + 'description' => '返回数据', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'title' => 'hostId', - 'description' => '请求IP', - 'type' => 'string', - 'example' => '100.104.180.109', - ], + 'TotalCount' => ['description' => '总数据个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'NextToken' => ['description' => '下一页token', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9'], 'Items' => [ - 'description' => '折扣信息列表', + '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', - ], + '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'], ], + 'description' => '', ], ], ], ], - 'Code' => [ - 'title' => 'code', - 'description' => '错误码', - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Success' => [ - 'title' => 'success', - 'description' => '调用是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], ], + 'description' => '', ], ], ], - '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', + 'errorCodes' => [], + 'title' => '节省计划使用率明细', + 'summary' => '节省计划使用率明细查询', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeSavingsPlansUsageTotal' => [ + 'summary' => '节省计划使用率汇总查询', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Amount', + 'name' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '金额，单位元[Quota开户必填]', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '要查询的时间范围的开始。开始时间包含在时​​间范围内。时间格式 yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00'], ], [ - 'name' => 'Currency', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '币种名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CNY：人民币。USD：美元。JPY：日元。', - ], + 'schema' => ['description' => '要查询的时间范围的结束时间。不包含结束时间。如果不设置该参数，则结束时间为当前时间。时间格式 yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00'], ], [ - 'name' => 'OutBizId', + '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' => [ - 'description' => '外部系统业务流水号', - 'type' => 'string', - 'required' => false, - 'example' => '7ed0bedc-056e-4a71-9249-4581615c028f', + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'SelectType' => ['type' => 'string'], + ], + ], + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string'], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'SelectType' => ['type' => 'string'], + ], + ], + ], + ], ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" - ."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '调用结果的附加信息。', - 'type' => 'string', - 'example' => 'Successful!', - ], + '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' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', - 'type' => 'boolean', - 'example' => 'true', + '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'], + ], + 'description' => '', + ], + ], + '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'], + ], + ], + ], ], ], + 'description' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'title' => '节省计划使用率汇总', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageTotal'], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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 消费账本。', + '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":""}]', ], - 'SetResellerUserQuota' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSplitItemBill' => [ + 'summary' => '查询分账账单。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Amount', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '金额，单位元', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '750', - ], + 'schema' => ['description' => '账单日期，YYYY－MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-03'], ], [ - 'name' => 'Currency', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '币种类型', - 'type' => 'string', - 'required' => false, - 'example' => ' CNY：人民币。 USD：美元', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'OutBizId', + 'name' => 'ProductType', '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', - ], - ], - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, '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' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => '订阅类型。取值：'."\n" + ."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'> 必须和ProductCode参数一起使用。', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'], ], - 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.', - ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', 'type' => 'string', 'required' => false, 'example' => 'CAESEgoQCg4KCmd'], ], - ], - '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' => [], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'AdjustType', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => '消费金额调整方向 increase:增加,用户消费增加金额 decrease:减少,用户充值减少金额 [必填]', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'increase/decrease', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123'], ], [ - 'name' => 'Amount', + 'name' => 'InstanceID', 'in' => 'query', - 'schema' => [ - 'description' => '调整金额,单位为元,金额必须大于0。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10.00', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-kjhdskjgshfdlkjfdh'], ], [ - 'name' => 'Currency', + 'name' => 'SplitItemID', 'in' => 'query', - 'schema' => [ - 'description' => '币种', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CNY', - ], + 'schema' => ['description' => '分拆项ID。', 'type' => 'string', 'required' => false, 'example' => 'i-kjhdskjgshfdlkjfdh'], ], [ - 'name' => 'BusinessType', + 'name' => 'Granularity', 'in' => 'query', - 'schema' => [ - 'description' => '业务类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'quota_amount_adjust', - ], + 'schema' => ['description' => '查询账单的颗粒度。取值：'."\n" + .'- MONTHLY：月。与用户中心-分账账单-账期账单一致。'."\n" + .'- DAILY：日。与用户中心-分账账单-按天账单一致。'."\n" + ."\n" + .'> 选择DAILY需指定BillingDate。', 'type' => 'string', 'required' => false, 'example' => 'Monthly'], ], [ - 'name' => 'Source', + 'name' => 'BillingDate', 'in' => 'query', - 'schema' => [ - 'description' => '请求来源，填写系统名称即可', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'system', - ], + 'schema' => ['description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。', 'type' => 'string', 'required' => false, 'example' => '2020-03-02'], ], [ - 'name' => 'OutBizId', + 'name' => 'TagFilter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '外部业务主键ID，用于做幂等性校验使用', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1647396865', + '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' => 'ExtendMap', + 'name' => 'IsHideZeroCharge', 'in' => 'query', 'schema' => [ - 'description' => '消息扩展字段。', - 'type' => 'string', + 'description' => '根据原价（PretaxGrossAmount）和应付（PretaxAmount）是否都为0做过滤。取值：'."\n" + ."\n" + .'- false。'."\n" + .'- true。', + 'type' => 'boolean', 'required' => false, - 'example' => '{}', + 'enumValueTitles' => [], + 'example' => 'false', ], ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => ['description' => '产品Code，与费用中心账单产品Code一致。', 'type' => 'string', 'required' => false, 'example' => 'rds'], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '调用失败时，返回的错误码。更多信息，请参见错误码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '调用结果的附加信息。', - 'type' => 'string', - 'example' => 'successful', - ], + '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' => '修改后对应的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', + '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'], + ], + ], + ], + ], ], ], ], ], ], - '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.', - ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSplitItemBill'], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeSplitItemBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'GetAccountRelation' => [ + 'summary' => '查询财务关联详情。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5642,165 +4462,182 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ItemCodes', + 'name' => 'RelationId', 'in' => 'query', - 'schema' => [ - 'description' => '无需填写', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + '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 => [ - 'headers' => [], 'schema' => [ + 'title' => 'result', + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '调用失败时，返回的错误码。更多信息，请参见错误码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '调用结果的附加信息', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Successful!', - ], + 'Message' => ['title' => 'message', 'description' => '提示信息', 'type' => 'string', 'example' => '提示信息'], + 'RequestId' => ['title' => 'requestId', 'description' => '请求标识', 'type' => 'string', 'example' => 'RequestId'], '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', + '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'], ], ], ], ], - '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 \\"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' => '查询财务关联', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountRelation'], ], ], - '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' => '查询当前可用配额余额信息', + 'ramActions' => [], ], - 'SetResellerUserAlarmThreshold' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCustomerAccountInfo' => [ + 'summary' => '查询虚商下终端客户账号信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'AlarmType', - 'in' => 'query', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '预警类型：quota_low_balance（代表Quota低额预警）', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'quota_low_balance', + '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.', 'description' => ''], + ], [ - 'name' => 'AlarmThresholds', - 'in' => 'query', - 'schema' => [ - 'description' => '该预警类型下的用户预警规则列表，不传代表没有预警阈值', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"denominator\\":100,\\"numerator\\":30,\\"thresholdType\\":1}]', + ['errorCode' => 'VnoNoDataError', 'errorMessage' => 'There is no data by this request.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => '查找虚商客户账号信息', + 'changeSet' => [ + ['createdAt' => '2022-12-26T12:12:10.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + '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' => '调用失败时，返回的错误码。更多信息，请参见错误码。'."\n" - ."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '调用结果的附加信息。', - 'type' => 'string', - 'example' => 'Successful!', - ], + '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' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'success=true代表调用执行完成。success=false代表执行出现错误。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'UidList' => [ + 'description' => '用户uid列表。', + 'type' => 'array', + 'items' => ['description' => '用户uid列表。', 'type' => 'string', 'example' => '6210322125051645960'], + ], + ], ], ], ], @@ -5808,48 +4645,41 @@ ], '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' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ], + [ + ['errorCode' => 'VnoNoDataError', 'errorMessage' => 'There is no data by this request.', 'description' => ''], + ], + [ + ['errorCode' => 'NotFoundRamAction', 'errorMessage' => 'Not found ramAction for apiActon: GetCustomerList', 'description' => ''], ], 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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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', + '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列表', + 'changeSet' => [ + ['createdAt' => '2022-12-26T12:12:10.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetOrderDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5857,549 +4687,444 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AlarmType', + 'name' => 'OrderId', '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', - ], + 'schema' => ['description' => '订单号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32453453'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListResult', - 'description' => 'ListResult', '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' => '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', + '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'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], ], ], ], - '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 ', - ], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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', + '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' => '查询用户或分销客户某个订单详情信息。', + 'changeSet' => [ + ['createdAt' => '2024-07-10T08:53:00.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-03-14T11:48:07.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetPayAsYouGoPrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '需要设置的用户状态'."\n" - .'取值：'."\n" - .' Freeze：用户冻结状态'."\n" - .' Thaw：用户解冻状态'."\n" - .' Trusteeship：用户托管状态'."\n" - .' TrusteeshipCancel：用户非托管状态', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Freeze', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs'], ], [ - 'name' => 'BusinessType', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '业务类型'."\n" - .'取值：'."\n" - .' FREEZE：用户冻结业务'."\n" - .' TRUSTEESHIP：用户托管业务', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FREEZE', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ - 'name' => 'StopMode', + 'name' => 'SubscriptionType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '停机模式'."\n" - .'取值：'."\n" - .' 0：普通停机'."\n" - .' 1：立即停机', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '订阅类型。取值类型：PayAsYouGo（后付费）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PayAsYouGo'], ], - ], - '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', + [ + '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, ], ], ], - 'errorCodes' => [ + 'responses' => [ 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.', + '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分钱活动'], + ], + ], + ], + ], + ], + ], + ], + ], ], ], - 500 => [ - [ - 'errorCode' => ' UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-23T12:28:39.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'GetResourcePackagePrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'LoginEmail', - 'in' => 'query', - 'schema' => [ - 'description' => '登录邮箱', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'email', - ], - ], - [ - 'name' => 'AccountAttr', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '新增账号属性，需要在控制台的顶部菜单栏，单击账号属性，跳转至**安全设置**页面查看。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', 'type' => 'string', 'required' => true, 'example' => 'ossbag'], ], [ - 'name' => 'EnterpriseName', + 'name' => 'PackageType', 'in' => 'query', - 'schema' => [ - 'description' => '企业名称（统一社会信用代码对应的企业名）。', - 'type' => 'string', - 'required' => false, - 'example' => '阿里云测试有限公司', - ], + 'schema' => ['description' => '资源包类型。值与**描述资源包接口**返回的**ResourcePackage**的Code值相等。', 'type' => 'string', 'required' => true, 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common'], ], [ - 'name' => 'FirstName', + 'name' => 'EffectiveDate', 'in' => 'query', - 'schema' => [ - 'description' => '一级分类名称。', - 'type' => 'string', - 'required' => false, - 'example' => '志成', - ], + 'schema' => ['description' => '资源包生效时间，不填默认立即生效。'."\n" + .'订单类型为**购买**时，不支持询价**生效时间大于当前时间六个月**的资源包。'."\n" + .'订单类型为**升级**时，生效时间**必须小于等于**升级的资源包实际到期时间。'."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-10T12:00:00Z'], ], [ - 'name' => 'LastName', + 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'description' => '用户的姓。'."\n" - ."\n" - .'长度：最大64个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '吴', - ], + 'schema' => ['description' => '资源包规格大小。', 'type' => 'string', 'required' => true, 'example' => '500'], ], [ - 'name' => 'NationCode', + 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => '国家码', - 'type' => 'string', - 'required' => false, - 'example' => 'CN', - ], + 'schema' => ['description' => '资源包时长。值与规格大小的可用时长相符。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '6'], ], [ - 'name' => 'ProvinceName', + 'name' => 'PricingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '省份名称（非必填）。', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '资源包时长单位。取值：'."\n" + .'- Month：月。'."\n" + .'- Year：年。', 'type' => 'string', 'required' => false, 'example' => 'Month'], ], [ - 'name' => 'CityName', + 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => '城市名称（英文）。', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '订单类型，取值：'."\n" + .'- BUY：新购。'."\n" + .'- UPGRADE：升级。'."\n" + .'- RENEW：续费。'."\n" + ."\n" + .'默认值BUY。', 'type' => 'string', 'required' => false, 'example' => 'BUY'], ], [ - 'name' => 'Postcode', + 'name' => 'InstanceId', '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' => [], + 'schema' => ['description' => '用户实例ID。**订单类型为续费、升级时，必填。**', 'type' => 'string', 'required' => false, 'example' => 'OSSBAG-cn-0xl0002'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [], 'responses' => [ 200 => [ + 'headers' => [], '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', - ], + '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' => [ - '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', + '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'], + ], + ], + ], + ], ], ], ], @@ -6409,205 +5134,131 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - ], - [ - [ - 'errorCode' => 'VnoNoDataError', - 'errorMessage' => 'There is no data by this request.', - ], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'DurationInvalid', 'errorMessage' => 'Parameter duration can only be positive integer.', 'description' => ''], + ['errorCode' => 'ProductNotFound', 'errorMessage' => 'Product not found.', 'description' => ''], + ['errorCode' => 'PackageTypeNotFound', 'errorMessage' => 'No such resource package type found.', 'description' => ''], + ['errorCode' => 'SpecificationInvalid', 'errorMessage' => 'Parameter specification can only be positive integer.', 'description' => ''], + ['errorCode' => 'IdInvalid', 'errorMessage' => 'Parameter ownerId is invalid.', 'description' => ''], + ['errorCode' => 'EffectiveDateInvalid', 'errorMessage' => 'Parameter effectiveDate is invalid.', 'description' => ''], + ['errorCode' => 'IdMissing', 'errorMessage' => 'Paramter ownerId is missing.', 'description' => ''], + ['errorCode' => 'PackageTypeNotSupported', 'errorMessage' => 'Package type currently is not supported.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"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' => [ + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - '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', - ], - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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', - ], + 'GetSubscriptionPrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + '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' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs'], ], [ - 'name' => 'ExpiryTimeStart', + 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => '失效起始时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => '订单类型。取值范围：'."\n" + .'- NewOrder：新购。'."\n" + .'- Renewal：续费。'."\n" + .'- Upgrade：升级。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NewOrder'], ], [ - 'name' => 'ExpiryTimeEnd', + 'name' => 'ServicePeriodQuantity', 'in' => 'query', - 'schema' => [ - 'description' => '失效结束时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T13:00:00Z', - ], + 'schema' => ['description' => '服务时长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PageNum', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '产品类型，是否必输以具体产品的询价文档为准。', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ - 'name' => 'PageSize', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '每页条数，默认值20，最大300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '实例所属的Region ID（地域ID）。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'IncludePartner', + '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' => 'boolean', - 'required' => false, - 'example' => 'true', + '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, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 50, ], ], ], @@ -6616,224 +5267,110 @@ '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', - ], + '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' => '返回数据。', + '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', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], - 'Instances' => [ + 'PromotionDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Instance' => [ - 'description' => '实例详情数组。', + 'PromotionDetail' => [ + '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', - ], + 'PromotionDesc' => ['description' => '优惠描述。', 'type' => 'string', 'example' => 'test'], + 'PromotionId' => ['description' => '优惠标识。', 'type' => 'integer', 'format' => 'int64', 'example' => '1021199213'], + 'PromotionName' => ['description' => '优惠名称。', 'type' => 'string', 'example' => 'test'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], ], + 'description' => '', ], ], ], - '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' => '查询资源包实例服务', + '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. 根据查询到的产品配置参数调用本接口获取预付费产品的价格。'."\n" + .'4. 按照DescribePricingModule接口返回的config去拼接ModuleList下面的Config。不能有遗漏，否则询价会出错', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDPUtilizationDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-04-23T12:28:39.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubscriptionPrice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'InquiryPriceRefundInstance' => [ + 'summary' => 'InquiryPriceRefundInstance：调用本接口对需要退订的实例进行询价。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6841,748 +5378,282 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '筛选查询的实例ID，为空时返回所有的使用的实例明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-123123', - ], + 'schema' => ['title' => 'clientToken', 'description' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。', 'type' => 'string', 'required' => false, 'example' => '793F021C-B589-1225-82A9-99232AEBE494'], ], [ - 'name' => 'InstanceSpec', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '实例对应的规格。', - 'type' => 'string', - 'required' => false, - 'example' => 'Instancetyp', - ], + 'schema' => ['title' => 'productCode', 'description' => '退订场景必填，产品code', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ - 'name' => 'CommodityCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '商品code，如ecsRi、scu_bag等。如果填写该字段，则prodCode字段不生效', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ecsRi', - ], + 'schema' => ['title' => 'instanceId', 'description' => '退订场景必填，实例id', 'type' => 'string', 'required' => false, 'example' => 'i-bp1etb69sqxgl4*******'], ], [ - 'name' => 'DeductedInstanceId', + 'name' => 'ProductType', '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', - ], + 'schema' => ['title' => 'productType', 'description' => '退订场景必填，产品类型，无特殊说明传入“” 空字符串。', 'type' => 'string', 'required' => false, 'example' => '”“'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'result', + 'description' => 'result', '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', - ], + 'Message' => ['title' => 'message', 'description' => '执行结果说明', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'requestId', 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台。', 'type' => 'string', 'example' => 'UUID'], 'Data' => [ - 'description' => '返回数据。', + 'title' => 'data', + 'description' => 'data', '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', - ], - ], - ], - ], - ], - ], + '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' => '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.', - ], + ['errorCode' => 'ResourceNotExists', 'errorMessage' => 'The specific resource is not exists.', 'description' => ''], + ['errorCode' => 'ResourceStatusError', 'errorMessage' => 'The resource status error.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner does not belong to caller.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'The specified API is not applicable for the user.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'The user is not authorized for the specified API.', 'description' => ''], + ['errorCode' => 'BindMirrorInstanceError', 'errorMessage' => 'Charged images that are related to ECS.', 'description' => ''], + ['errorCode' => 'ExceedRefundQuotaError', 'errorMessage' => 'The number of unsubscription times has reached the upper limit.', 'description' => ''], + ['errorCode' => 'ExistUnPaidOrderError', 'errorMessage' => 'The instance has an unsettled order.', 'description' => ''], + ['errorCode' => 'ExistRefundingOrderError', 'errorMessage' => 'The instance ID is invalid: the instance may have expired, been refunded, or been released.', 'description' => ''], + ['errorCode' => 'NoRestValueError', 'errorMessage' => 'The refund amount is 0.', 'description' => ''], + ['errorCode' => 'AmbassadorOrderLimitError', 'errorMessage' => 'The instance has an ambassador order that may raise risks.', 'description' => ''], + ['errorCode' => 'ActivityForbiddenError', 'errorMessage' => 'Promotional orders do not support refunds.', 'description' => ''], + ['errorCode' => 'ProductCheckError', 'errorMessage' => 'The cloud service failed SPI preflight verification.', 'description' => ''], + ['errorCode' => 'CommodityNotSupported', 'errorMessage' => 'The specified commodity is not supported.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], ], ], - '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', + '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：云产品规则预校验未通过', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InquiryPriceRefundInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:RefundQueryRemainAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyAccountRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'RIInstanceId', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => '筛选查询的预留实例ID，为空时返回所有的使用的预留实例明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'dsudfgdsjh', - ], + 'schema' => ['description' => '关系类型，目前仅支持enterprise_group', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'enterprise_group'], ], [ - 'name' => 'InstanceSpec', + 'name' => 'RelationOperation', 'in' => 'query', - 'schema' => [ - 'description' => '预留实例对应的规格。', - 'type' => 'string', - 'required' => false, - 'example' => 'Instancetyp', - ], + 'schema' => ['description' => '修改动作'."\n" + .'- 添加：ADD'."\n" + .'- 删除：DELETE', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ADD'], ], [ - 'name' => 'RICommodityCode', + 'name' => 'ParentUserId', 'in' => 'query', - 'schema' => [ - 'description' => '取值：'."\n" - .'- ecsRi（默认值）：ECS的预留实例。'."\n" - .'- scu_bag：存储容量单位包。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecsRi', - ], + 'schema' => ['description' => '主账号的阿里云UID'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1738376485192612'], ], [ - 'name' => 'DeductedInstanceId', + 'name' => 'ChildNick', 'in' => 'query', - 'schema' => [ - 'description' => '被抵扣实例的ID，为空时返回所有实例的明细数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'jsdgfsdhgsdjh', - ], + 'schema' => ['description' => '显示名称，用于页面显示，便于明确账号使用场景', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '用户昵称'], ], [ - 'name' => 'StartTime', + 'name' => 'ChildUserId', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式：YYYY-MM-dd HH:mm:ss。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => '子账号的阿里云账号UID'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1512996702208737'], ], [ - 'name' => 'EndTime', + 'name' => 'RequestId', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式：YYYY-MM-dd HH:mm:ss。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => '请求唯一标识，用于标记一次请求，便于定位问题'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'request_id'], ], [ - 'name' => 'PageNum', + 'name' => 'RoleCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '页码，默认为1。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '暂时不支持角色修改', + 'type' => 'array', + 'items' => ['description' => '角色 Code。', 'type' => 'string', 'required' => false, 'example' => 'trusteeship'], 'required' => false, - 'example' => '1', + 'example' => 'trusteeship', + 'maxItems' => 200, ], ], [ - 'name' => 'PageSize', + 'name' => 'PermissionCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每页条数，默认为20，最大值为300。', - 'type' => 'integer', - 'format' => 'int32', + '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' => '20', + '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' => 'Success', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '返回数据。', + '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', - ], - ], - ], - ], - ], - ], + 'HostId' => ['description' => '请求来源IP', 'type' => 'string', 'example' => '127.0.0.1'], ], ], ], ], ], ], - '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的使用量情况。', + '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' => ' ', - ], - 'DescribeResourceUsageTotal' => [ - 'summary' => '预留实例、SCU使用率汇总查询。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ModifyCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], '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', + 'name' => 'UnitEntityList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'MONTH' => 'MONTH', - 'HOUR' => 'HOUR', - 'DAY' => 'DAY', + '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, ], - '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', + 'maxItems' => 100, ], ], ], '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', - ], + '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' => [ - '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', - ], - ], + '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'], ], ], ], @@ -7590,108 +5661,96 @@ ], ], ], - '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', + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCostUnit'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StartPeriod', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ - 'name' => 'EndPeriod', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'PeriodType', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => '付费类型，取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription'], ], [ - 'name' => 'NextToken', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'schema' => ['description' => '变配类型，取值'."\n" + .'- Upgrade：升级。'."\n" + .'- Downgrade：降级。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Upgrade'], ], [ - 'name' => 'MaxResults', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => '变更配置的实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-akjhkdsjhfskjfhd'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '如果为空查询当前账号及其托管子账号的数据，可传入托管子账号ID，明确查询该子账号数据。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => '用于保证请求的幂等性，防止请求重复提交。', 'type' => 'string', 'required' => false, 'example' => 'JAKSJFHFAKJSF'], ], [ - 'name' => 'ResourceType', + 'name' => 'Parameter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '资源包类型。枚举值：RI：预留实例；SCU：存储容量单位包。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RI', + '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, ], ], ], @@ -7700,198 +5759,140 @@ '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', - ], + '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' => '返回数据'."\n", + 'description' => '返回数据。', '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', - ], - ], - ], - ], + 'OrderId' => ['description' => '创建成功的订单ID。', 'type' => 'string', 'example' => '202653252354351'], + 'HostId' => ['description' => '主机ID。', 'type' => 'string', 'example' => 'testId'], ], ], ], ], ], ], - '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' => '资源使用率明细', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'ResourceNotExists', 'errorMessage' => 'The specific resource is not exists.', 'description' => ''], + ['errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', 'errorMessage' => 'Please complete your basic personal information first.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'DescribeResourceCoverageTotal' => [ - 'summary' => '预留实例、SCU覆盖率汇总查询。', - 'methods' => [ - 'post', - 'get', + '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.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => ' Some parameters arte mandatoryfor this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Some parametersare not valid.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specifiedowner doesn’t belong to caller', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '您无权执行此操作。'], + ['errorCode' => 'AuthSiteFail', 'errorMessage' => 'auth site failed.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => '查询用户账户余额信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-25T02:13:01.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-12-12T01:50:00.000Z', 'description' => '响应参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAccountBalance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'QueryAccountBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7899,145 +5900,125 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'StartPeriod', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '格式：yyyy-MM-dd HH:mm:ss； 查询逻辑为包括该时间'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => '账单日期，YYYY-MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07'], ], [ - 'name' => 'EndPeriod', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => '页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PeriodType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'MONTH：月维度； DAY：天维度； HOUR：小时维度；', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => '每页数量，默认值20，最大值：300。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + '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' => '123745698925000', - ], + 'schema' => ['description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '122'], ], [ - 'name' => 'ResourceType', + 'name' => 'Granularity', 'in' => 'query', 'schema' => [ - 'description' => 'RI：预留实例；SCU：存储容量单位包'."\n", + 'description' => '查询账单的颗粒度。取值：'."\n" + .'- MONTHLY：月。与费用中心-费用账单-账单明细-账期账单一致。'."\n" + .'- DAILY：日。与费用中心-费用账单-账单明细-按天账单一致。'."\n" + ."\n" + .'> 选择DAILY需指定BillingDate。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RI', + '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' => '状态码'."\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', - ], + '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' => '返回数据'."\n", + 'description' => '返回数据。', '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' => '总覆盖率', + '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' => [ - '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', + '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'], + ], + ], ], ], ], @@ -8047,25 +6028,47 @@ ], ], ], - '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", + 'title' => '账号账单查询服务', + 'summary' => '查询用户某个账期内的消费，并以资源所有者的维度进行汇总', + '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' => ' ', - ], - 'DescribeResourceCoverageDetail' => [ - 'summary' => '预留实例、SCU覆盖率明细查询。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-21T10:03:22.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountBill'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryAccountBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'QueryAccountTransactionDetails' => [ + 'summary' => '查询用户收支明细。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8073,468 +6076,143 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'StartPeriod', + 'name' => 'TransactionNumber', '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', - ], + 'schema' => ['description' => '交易编号', 'type' => 'string', 'required' => false, 'example' => '410874027490089'], ], [ - 'name' => 'EndPeriod', + 'name' => 'RecordID', 'in' => 'query', - 'schema' => [ - 'description' => '格式：yyyy-MM-dd HH:mm:ss；查询逻辑为不包括该时间；为空表示截止到当前时间', - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => '订单号/账单号', 'type' => 'string', 'required' => false, 'example' => '2022120336190912'], ], [ - 'name' => 'PeriodType', + 'name' => 'TransactionChannelSN', 'in' => 'query', - 'schema' => [ - 'description' => 'MONTH：月维度；'."\n" - .'DAY：天维度；'."\n" - .'HOUR：小时维度；', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => '交易渠道流水号', 'type' => 'string', 'required' => false, 'example' => '2022112122001470591458665933'], ], [ - 'name' => 'NextToken', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '分页token，首页查询时传空，查询结果中返回下一页token地址。当结果token为空时表示全部查完。', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'schema' => ['description' => '创建时间起始', 'type' => 'string', 'required' => false, 'example' => '2022-01-20'], ], [ - 'name' => 'MaxResults', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => '创建时间终止', 'type' => 'string', 'required' => false, 'example' => '2022-12-20'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'TransactionType', 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + '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' => 'ResourceType', + 'name' => 'TransactionChannel', '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', - ], - ], - ], - ], - ], - ], - ], - ], + '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'], ], - ], - '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' => [], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页查询token', 'type' => 'string', 'required' => false, 'example' => 'ABEDSDS124DASA'], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => true, - 'example' => 'ossbag', - ], + 'schema' => ['description' => '无效参数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], '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' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72353765387', - ], + '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' => '返回数据。', + 'description' => '请求结果内容', 'type' => 'object', 'properties' => [ - 'ResourcePackages' => [ + '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' => [ - 'ResourcePackage' => [ - 'description' => '资源包详情数组。', + 'AccountTransactionsList' => [ + 'description' => '明细列表', 'type' => 'array', 'items' => [ + 'description' => '结果', '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + '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'], ], ], ], @@ -8546,236 +6224,189 @@ ], ], ], - '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' => '[{"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' => '查询账户交易明细', + 'changeSet' => [ + ['createdAt' => '2022-09-29T14:59:34.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryAccountTransactionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'QueryAccountTransactions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'TransactionNumber', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', - 'type' => 'string', - 'required' => true, - 'example' => 'ossbag', - ], + 'schema' => ['description' => '交易编号。', 'type' => 'string', 'required' => false, 'example' => '133314076'], ], [ - 'name' => 'PackageType', + 'name' => 'RecordID', 'in' => 'query', - 'schema' => [ - 'description' => '资源包类型。值与**描述资源包接口**返回的**ResourcePackage**的Code值相等。', - 'type' => 'string', - 'required' => true, - 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common', - ], + 'schema' => ['description' => '订单/账单号。', 'type' => 'string', 'required' => false, 'example' => '20200302'], ], [ - 'name' => 'EffectiveDate', + 'name' => 'TransactionChannelSN', 'in' => 'query', - 'schema' => [ - 'description' => '资源包生效时间，不填默认立即生效。'."\n" - .'订单类型为**购买**时，不支持询价**生效时间大于当前时间六个月**的资源包。'."\n" - .'订单类型为**升级**时，生效时间**必须小于等于**升级的资源包实际到期时间。'."\n" - .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-10T12:00:00Z', - ], + 'schema' => ['description' => '交易渠道流水号。', 'type' => 'string', 'required' => false, 'example' => '12342134'], ], [ - 'name' => 'Specification', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '资源包规格大小。', - 'type' => 'string', - 'required' => true, - 'example' => '500', - ], + 'schema' => ['description' => '创建时间段起，不传时默认是当前时间往前一个月。格式例：2018-01-01T00:00:00Z。', 'type' => 'string', 'required' => false, 'example' => '2020-03-05T01:46:09Z'], ], [ - 'name' => 'Duration', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '资源包时长。值与规格大小的可用时长相符。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '6', - ], + 'schema' => ['description' => '创建时间段止，不传时默认是当前时间。格式例：2018-01-01T00:00:00Z。', 'type' => 'string', 'required' => false, 'example' => '2020-03-06T01:55:00Z'], ], [ - 'name' => 'PricingCycle', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '资源包时长单位。取值：'."\n" - .'- Month：月。'."\n" - .'- Year：年。', + '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' => 'Month', + 'example' => 'Payment', + 'enum' => ['Adjust', 'Payment', 'Refund', 'Withdraw', 'Consumption', 'Pay_Fail_Refund', 'Transfer'], ], ], [ - 'name' => 'OrderType', + 'name' => 'TransactionFlow', 'in' => 'query', 'schema' => [ - 'description' => '订单类型，取值：'."\n" - .'- BUY：新购。'."\n" - .'- UPGRADE：升级。'."\n" - .'- RENEW：续费。'."\n" - ."\n" - .'默认值BUY。', + 'description' => '收支类型。'."\n" + .'传入以下收支类型，查询返回对应类型结果，不存在时结果为空。不传默认返回所有类型。'."\n" + .'- 收入：Income。'."\n" + .'- 支出：Expense。', 'type' => 'string', 'required' => false, - 'example' => 'BUY', + 'example' => 'Income', + 'enum' => ['Income', 'Expense'], ], ], [ - 'name' => 'InstanceId', + 'name' => 'TransactionChannel', 'in' => 'query', 'schema' => [ - 'description' => '用户实例ID。**订单类型为续费、升级时，必填。**', + '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' => 'OSSBAG-cn-0xl0002', + 'example' => 'AccountBalance', + 'enum' => ['Alipay', 'AntCreditPay', 'MyBankCredit', 'HuaxiaBankCInstallment', 'BankTransfer', 'OfflineRemittance', 'CreditCard', 'AccountBalance', 'RegularBankCreditRefund', 'ApplePay'], ], ], ], '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', - ], + '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' => [ - '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' => [ + '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' => [ - 'Promotion' => [ - 'description' => '优惠详情。', + 'AccountTransactionsList' => [ + 'description' => '流水信息集合。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '优惠描述。', - 'type' => 'string', - 'example' => '购买半年，立享8.3折优惠', - ], - 'Id' => [ - 'description' => '优惠ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000680914', - ], + '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'], ], ], ], @@ -8787,143 +6418,107 @@ ], ], ], - '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' => '查询用户某个资源包的价格。', + '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' => ' ', - ], - 'RenewResourcePackage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-04-11T06:41:43.000Z', 'description' => '请求参数发生变更、错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccountTran', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryAvailableInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '用户实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lskd****sljhsdj', - ], + 'schema' => ['description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EffectiveDate', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '资源包生效时间，不填默认立即生效。'."\n" - ."\n" - .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Duration', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '资源包续费时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '每页条数，默认值为20，最大不超过300个。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'PricingCycle', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '资源包时长单位，取值：'."\n" - .'- Month'."\n" - .'- Year'."\n" - ."\n" - .'默认为Month。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Month', - ], + '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' => [ @@ -8931,46 +6526,55 @@ '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', - ], + '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' => [ - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204322560333', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'OSSBAG-cn-0xl0n****003', + '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'], + ], + ], ], ], ], @@ -8978,173 +6582,174 @@ ], ], ], - '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' => '为用户某个资源包实例续费。', + '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' => ' ', - ], - 'UpgradeResourcePackage' => [ - 'summary' => '升级用户某个资源包的实例。如本周期已升级，则无法继续升级，待次周期生效后再操作升级。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvailableInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryBill' => [ + 'summary' => '查询用户某个账期内的结算账单。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '用户实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'OSSBAG-cn-0xl*****x002', - ], + 'schema' => ['description' => '账期，YYYY-MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07'], ], [ - 'name' => 'EffectiveDate', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '资源包生效时间，不填默认次周期生效。'."\n" - ."\n" - .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => '类型。取值：'."\n" + .'- SubscriptionOrder'."\n" + .'- PayAsYouGoBill'."\n" + .'- Refund'."\n" + .'- Adjustment', 'type' => 'string', 'required' => false, 'example' => 'SubscriptionOrder'], ], [ - 'name' => 'Specification', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '升级资源包规格大小。', - 'type' => 'string', - 'required' => false, - 'example' => '51200', - ], + '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', - ], - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73387246238746', - ], + [ + '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' => [ - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73387246238746', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-0xl*****002', + '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'], + ], + ], + ], + ], ], ], ], @@ -9152,193 +6757,72 @@ ], ], ], - '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' => '升级资源包服务', + '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 \\"PaymentTime\\": \\"2020-03-11 08:00:00\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\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' => ' ', - ], - 'SubscribeBillToOSS' => [ - 'summary' => '使用OSS订阅账单文件，支持将账单数据存储到指定的OSS bucket中。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-03-28T11:11:32.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBill'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryBillOverview' => [ + 'summary' => '查询用户某个账期内的账单总览信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], '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', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。'."\n" - .'普通用户则无需指定，默认为调用账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12341324', - ], + 'schema' => ['description' => '账单日期，YYYY-MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07'], ], [ - 'name' => 'BeginBillingCycle', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '推送起始账期。订阅成功后，系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效，不会对历史数据重新推送。最多可推送最近1年内数据。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-03', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'BucketPath', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'title' => 'OSS Bucket存储路径', - 'description' => '订阅至Bucket下的指定目录。', - 'type' => 'string', - 'required' => false, - 'example' => 'testpath', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'RowLimitPerFile', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '单文件行数上限。当账单文件超过上限后，会拆成多个文件，并合并成一个压缩包。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300000', - ], + 'schema' => ['description' => '订阅类型：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => false, 'example' => 'Subscription'], ], [ - 'name' => 'UsingSsl', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => '是否通过SSL（Secure Sockets Layer）加密协议来保护网络通信。取值：'."\n" - ."\n" - .'- true：启用SSL加密，可以确保数据传输的安全性和完整性。'."\n" - ."\n" - .'- false（默认值）：不启用SSL加密。', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1234'], ], ], 'responses' => [ @@ -9346,232 +6830,132 @@ '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', + '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 Gateway'], + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], ], ], + 'description' => '', ], ], ], - '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文件名格式相同。', + '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 \\"PipCode\\": \\"rds\\",\\n \\"PretaxAmount\\": 100,\\n \\"ProductName\\": \\"NAT Gateway\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"NAT Gateway (Pay-As-You-Go)\\",\\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' => ' ', - ], - 'UnsubscribeBillToOSS' => [ - 'summary' => '取消详单导出订阅。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-03-28T11:11:32.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBillOverview'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryBillToOSSSubscription' => [ + 'summary' => '查询账单订阅到OSS储存桶的记录。', + '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' => [], + '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', - ], + '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', - ], + 'AccountName' => ['description' => '当前查询账号名称。', 'type' => 'string', 'example' => 'test@test.aliyunid.com'], + 'AccountID' => ['description' => '当前查询账号ID。', 'type' => 'string', 'example' => '185xxxxx03489'], 'Items' => [ 'type' => 'object', 'itemNode' => true, @@ -9583,49 +6967,20 @@ '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', - ], + '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' => '中文', - ], + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], 'example' => 'zh', ], - 'BucketPath' => [ - 'description' => 'OSS存储目录。', - 'type' => 'string', - 'example' => 'Billing/BillingItemDetailMonthly/', - ], - 'RowLimitPerFile' => [ - 'description' => '单文件行数上限。当账单文件超过上限后，会拆成多个文件，并合并成一个压缩包。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300000', - ], + 'BucketPath' => ['description' => 'OSS存储目录。', 'type' => 'string', 'example' => 'Billing/BillingItemDetailMonthly/'], + 'RowLimitPerFile' => ['description' => '单文件行数上限。当账单文件超过上限后，会拆成多个文件，并合并成一个压缩包。', 'type' => 'integer', 'format' => 'int32', 'example' => '300000'], ], ], ], @@ -9642,83 +6997,54 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryBillOverview' => [ - 'summary' => '查询用户某个账期内的账单总览信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBillToOSSSubscription'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeSubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryCashCoupons' => [ + 'summary' => '查询用户代金券信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], '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', + 'name' => 'ExpiryTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '代金券终止过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2018-08-01T00:00:00Z'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'ExpiryTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '代金券起始过期时间，格式：yyyy-MM-ddTHH:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2018-09-01T00:00:00Z'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'EffectiveOrNot', 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '1234', - ], + 'schema' => ['description' => '代金券是否生效。取值范围：'."\n" + .'- true'."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -9726,196 +7052,34 @@ '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', - ], + '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' => [ - 'description' => '返回数据。', 'type' => 'object', + 'itemNode' => true, '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', - ], - ], - ], + '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' => '该代金券用于产品功能验证的测试'], ], ], ], @@ -9925,22 +7089,42 @@ ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => ' Some parameters arte mandatoryfor this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Some parameter sare not valid.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specifiedowner doesn’t belong to caller', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => '查询用户代金券信息', + 'changeSet' => [ + ['createdAt' => '2023-07-19T02:26:52.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCoupons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryCommodityList' => [ + 'summary' => '该接口提供根据产品code获取商品信息列表的能力。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9948,348 +7132,54 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], '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', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'example' => 'ecs'], ], [ - 'name' => 'ProductType', + 'name' => 'Lang', 'in' => 'query', 'schema' => [ - 'description' => '产品类型。', + 'description' => '语言，不填时默认为zh(中文)', 'type' => 'string', 'required' => false, - 'example' => 'rds', + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], + 'example' => 'en', ], ], - [ - '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 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + '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' => [ - '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', - ], - ], + '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', ], ], ], @@ -10300,136 +7190,153 @@ ], ], ], - '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', + 'title' => '根据产品code查询商品信息列表', + 'description' => '该接口提供根据产品code获取商品信息列表的能力。', + 'changeSet' => [ + ['createdAt' => '2023-09-04T08:20:04.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCommodityList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'QueryCostUnit' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'OwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => '账单日期，YYYY-MM。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + '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' => '页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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' => [ - 'description' => '每页数量，默认值20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-17T06:23:54.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ [ - 'name' => 'OwnerID', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryCostUnitResource' => [ + 'summary' => '查询用户的财务单元所属的资源实例列表。当 UnitId 为 0，表示查未分配的主子资源实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsGroupByProduct', - 'in' => 'query', - 'schema' => [ - 'description' => '是否增加产品Code汇总。'."\n" - .'- true。'."\n" - .'- false。'."\n" - ."\n" - .'默认false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'OwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '财务单元的属主用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23453245'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'UnitId', 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '122', - ], + 'schema' => ['description' => '财务单元的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '235325'], ], [ - 'name' => 'Granularity', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '查询账单的颗粒度。取值：'."\n" - .'- MONTHLY：月。与费用中心-费用账单-账单明细-账期账单一致。'."\n" - .'- DAILY：日。与费用中心-费用账单-账单明细-按天账单一致。'."\n" - ."\n" - .'> 选择DAILY需指定BillingDate。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'MONTHLY', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'BillingDate', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-06-01', - ], + 'schema' => ['description' => '每页条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -10437,202 +7344,140 @@ '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', - ], + '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', - ], - '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', + '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'], + ], + ], ], - 'AccountName' => [ - 'description' => '账号。', - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', + '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'], + ], ], - 'Items' => [ + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T07:37:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-17T06:23:54.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + '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' => [ - 'Item' => [ - 'description' => '账单详情。', + 'CustomerInvoiceAddress' => [ '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', - ], + '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'], ], ], ], @@ -10644,27 +7489,33 @@ ], ], ], - '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', + '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' => '查询阿里云发票邮寄地址信息服务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCustomerAddressList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDPUtilizationDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10672,123 +7523,59 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '账期，YYYY-MM。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + 'schema' => ['description' => '筛选查询的实例ID，为空时返回所有的使用的实例明细。', 'type' => 'string', 'required' => false, 'example' => 'oss-123123'], ], [ - 'name' => 'Type', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => '类型。取值：'."\n" - .'- SubscriptionOrder 预付费订单'."\n" - .'- PayAsYouGoBill 后付费账单'."\n" - .'- Refund 退款账单'."\n" - .'- Adjustment 调账账单', - 'type' => 'string', - 'required' => false, - 'example' => 'SubscriptionOrder', - ], + 'schema' => ['description' => '实例对应的规格。', 'type' => 'string', 'required' => false, 'example' => 'Instancetyp'], ], [ - 'name' => 'ProductCode', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '商品code，如ecsRi、scu_bag等。如果填写该字段，则prodCode字段不生效', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecsRi'], ], [ - 'name' => 'ProductType', + 'name' => 'DeductedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '被抵扣实例的ID，为空时返回所有实例的明细数据。', 'type' => 'string', 'required' => false, 'example' => 'oss-123123'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription 预付费'."\n" - .'- PayAsYouGo 后付费'."\n" - .'> 必须和ProductCode参数一起使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '开始时间，格式：YYYY-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00'], ], [ - 'name' => 'IsHideZeroCharge', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '根据原价（PretaxGrossAmount）是否为0做过滤，默认为否（兼容现有逻辑）。'."\n" - .'- true：是。'."\n" - .'- false：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '结束时间，格式：YYYY-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00'], ], [ - 'name' => 'NextToken', + 'name' => 'LastToken', 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - ], + 'schema' => ['description' => '查询从LastToken之后开始返回。第一次查询填null，之后的从结果NextToken获取', 'type' => 'string', 'required' => false, 'example' => 'CAESF***zNTAw'], ], [ - 'name' => 'MaxResults', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '每次查询条数，默认为20，最大值为300。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'IncludeShare', 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', - ], + 'schema' => ['description' => '是否包含财务云子账号的资源包用量'."\n" + .'- true：包含'."\n" + .'- false：不包含', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ - 'name' => 'RecordID', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => '订单号、账单号。', - 'type' => 'string', - 'required' => false, - 'example' => '12233', - ], + 'schema' => ['description' => '产品code，如：ecs', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'oss'], ], ], 'responses' => [ @@ -10796,245 +7583,43 @@ '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', - ], + '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' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', - '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' => [ + 'NextToken' => ['description' => '下次请求查询开始标识，填充到request的LastToken字段中。如果返回为null，则标识查询结束', 'type' => 'string', 'example' => 'CAESF***zNTAw'], + 'DetailList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Item' => [ - 'description' => '账单详情。', + 'DetailList' => [ + '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', - ], + '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'], ], ], ], @@ -11046,29 +7631,45 @@ ], ], ], - '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笔/秒，如遇超时，请重试。', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner does not belong to caller.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'The specified API is not applicable for the user.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'The user is not authorized for the specified API.', 'description' => ''], + ['errorCode' => 'InvalidInstanceSpec', 'errorMessage' => 'The specified Instance specification is not valid.', 'description' => ''], + ['errorCode' => 'InvalidQueryTime', 'errorMessage' => 'The specified start time and end time are incorrect', 'description' => ''], + ['errorCode' => 'CommodityNotSupported', 'errorMessage' => 'The specified commodity is not supported.', 'description' => ''], + ], + ], + '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' => ' ', - ], - 'QueryInstanceBill' => [ - 'summary' => '查询用户某个账期内所有商品实例或计费项的消费汇总。API 已升级为 DescribeInstanceBill，此API不再提供50000行以后数据的查询。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:FrDeductLogQueryRequest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEvaluateList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11076,138 +7677,90 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '账期YYYY－MM。仅支持最近18个月账期。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], + 'schema' => ['description' => '类型，取值：'."\n" + .'- 1：搜索可开票金额负值。'."\n" + .'- 2：搜索可开票金额为正值。'."\n" + .'- 3：搜索所有不为0代开票信息。'."\n" + .'- 4：已开金额>0。'."\n" + ."\n" + .'> 默认为空则搜索全部。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ProductCode', + 'name' => 'OutBizId', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '订单/账单/合同编号', 'type' => 'string', 'required' => false, 'example' => '2387432832696'], ], [ - 'name' => 'ProductType', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。当ProductCode为云市场产品code时，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。'."\n" - ."\n" - .'>必须和**ProductCode**参数一起使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => '每页条数，默认是20，不能超过300', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'IsBillingItem', + 'name' => 'StartAmount', 'in' => 'query', - 'schema' => [ - 'description' => '是否按照计费项维度拉取数据。'."\n" - .'- false。与“费用中心-费用账单-账单明细-实例”账单一致。'."\n" - .'- true。与“费用中心-费用账单-账单明细-计费项”账单一致。'."\n" - ."\n" - .'默认 false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '查询开始金额', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ - 'name' => 'PageNum', + 'name' => 'EndAmount', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询终止金额', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], ], [ - 'name' => 'PageSize', + 'name' => 'StartBizTime', 'in' => 'query', - 'schema' => [ - 'description' => '每页数量，默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '支付成功时间开始区间。格式：yyyy-mm-dd hh:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2025-02-01 00:00:00'], ], [ - 'name' => 'IsHideZeroCharge', + 'name' => 'EndBizTime', 'in' => 'query', - 'schema' => [ - 'description' => '根据原价（**PretaxGrossAmount**）和应付（**PretaxAmount**）是否都为0做过滤。取值：'."\n" - .'- false。'."\n" - .'- true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '支付成功时间结束区间。格式：yyyy-mm-dd hh:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2025-03-01 00:00:00'], ], [ - 'name' => 'BillingDate', + 'name' => 'SortType', 'in' => 'query', - 'schema' => [ - 'description' => '账单日期，仅当**Granularity**为DAILY时必填，格式为YYYY-MM-DD。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-03', - ], + 'schema' => ['description' => '排序类型，取值：'."\n" + .'- 1：按ID进行倒排。'."\n" + .'- 2：按代开票类型倒排，id倒序二排序。'."\n" + .'- 3：按代开票类型顺排，id倒序二排序。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Granularity', + 'name' => 'StartSearchTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询账单的颗粒度。取值：'."\n" - .'- MONTHLY：月。与“费用中心-费用账单-账单明细-账期”账单一致。'."\n" - .'- DAILY：日。与“费用中心-费用账单-账单明细-按天”账单一致。'."\n" - ."\n" - .'选择DAILY需指定**BillingDate**。', - 'type' => 'string', - 'required' => false, - 'example' => 'MONTHLY', - ], + 'schema' => ['description' => '搜索开始时间', 'type' => 'string', 'required' => false, 'example' => '2025-02-01 00:00:00'], ], [ - 'name' => 'BillOwnerId', + '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' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '待开票对象归属的开票主体列表', + 'type' => 'array', + 'items' => ['description' => '待开票对象归属的开票主体。取值示例：'."\n" + .'- ALIYUN_SERVICE：阿里云计算有限公司（服务）'."\n" + .'- ALICOM_SERVICE：阿里巴巴云计算（北京）有限公司（服务）', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN_SERVICE'], 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '122', + 'example' => 'ALIYUN', + 'maxItems' => 100, ], ], ], @@ -11216,299 +7769,64 @@ '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', - ], + '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' => '返回数据。', + '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' => [ + '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' => [ - 'Item' => [ - 'description' => '账单详情。', + 'Evaluate' => [ + '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' => '其它', - ], + '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'], ], ], ], @@ -11520,31 +7838,31 @@ ], ], ], - '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" - .'- 国际站服务地址请选择新加坡。', + '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' => ' ', - ], - 'DescribeInstanceBill' => [ - 'summary' => '查询用户某个账期内所有商品实例或计费项的消费汇总。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryEvaluate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFinancialAccountInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11552,161 +7870,150 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'UserId', 'in' => 'query', + 'schema' => ['description' => '阿里云账号UID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1990699401005016'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '账期YYYY－MM。仅支持最近18个月账期。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', + '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'], + ], + ], + ], ], ], - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryFinancialAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '产品类型。当ProductCode为云市场产品code时，此参数必填。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。'."\n" + ."\n" + .'>必须和**ProductCode**参数一起使用。', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'], ], [ 'name' => 'IsBillingItem', 'in' => 'query', - 'schema' => [ - 'description' => '是否按照计费项维度拉取数据。'."\n" - ."\n" - .'- false（默认值）：与费用与成本-费用账单-账单明细-实例账单一致。'."\n" - .'- true：与费用与成本-费用账单-账单明细-计费项账单一致。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否按照计费项维度拉取数据。'."\n" + .'- false。与“费用中心-费用账单-账单明细-实例”账单一致。'."\n" + .'- true。与“费用中心-费用账单-账单明细-计费项”账单一致。'."\n" + ."\n" + .'默认 false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'NextToken', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCm', - ], + 'schema' => ['description' => '页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MaxResults', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '账单日期，仅当**Granularity**为DAILY时必填，格式为YYYY-MM-DD。', 'type' => 'string', 'required' => false, 'example' => '2020-03-03'], ], [ 'name' => 'Granularity', 'in' => 'query', - 'schema' => [ - 'description' => '查询账单的颗粒度。取值如下：'."\n" - ."\n" - .'- MONTHLY：月。与费用与成本-费用账单-账单明细-账期账单一致。'."\n" - .'- DAILY：日。与费用与成本-费用账单-账单明细-按天账单一致。'."\n" - ."\n" - .'> 选择DAILY需指定BillingDate。', - 'type' => 'string', - 'required' => false, - 'example' => 'MONTHLY', - ], + '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', - ], - ], - [ - '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', - ], + 'schema' => ['description' => '资源归属账号ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '122'], ], ], 'responses' => [ @@ -11714,325 +8021,83 @@ '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', - ], + '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', - ], + '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' => [ - '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', + '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' => '其它'], + ], ], ], ], @@ -12043,103 +8108,201 @@ ], ], ], - '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笔/秒，如遇超时，请重试。', + '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' => ' ', - ], - 'QueryInstanceGaapCost' => [ - 'summary' => '该 API 不再更新。请前往使用如下API获取对应分摊成本：DescribeInstanceAmortizedCostByAmortizationPeriod - 查询实例摊销月摊销成本；DescribeProductAmortizedCostByAmortizationPeriod- 查询产品摊销月摊销成本；DescribeInstanceAmortizedCostByConsumePeriod- 查询实例账期月摊销成本；DescribeProductAmortizedCostByConsumePeriod- 查询产品账期月摊销成本。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-03-28T11:11:32.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryInstanceBill'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryInstanceByTag' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PageNum', + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '资源类型'."\n" + .'instance 节省计划实例', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '资源id列表', + 'type' => 'array', + 'items' => ['description' => '资源 ID', 'type' => 'string', 'required' => false, 'example' => 'spn-XXXXXX'], 'required' => false, - 'example' => '1', + 'maxItems' => 50, ], ], [ - 'name' => 'PageSize', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每页数量，默认值：20，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'example' => '20', + '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' => '根据标签信息查询实例列表。', + 'changeSet' => [ + ['createdAt' => '2022-09-15T02:56:20.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-09-15T02:56:20.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryInstanceByTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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', - ], + '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', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => '订阅类型。取值：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'], ], ], 'responses' => [ @@ -12147,53 +8310,18 @@ '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', - ], + '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', - ], + '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, @@ -12204,279 +8332,71 @@ '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', - ], + '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'], ], ], ], @@ -12490,48 +8410,18 @@ ], '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. ', - ], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'DurationInvalid', 'errorMessage' => 'Parameter duration can only be positive integer.', 'description' => ''], + ['errorCode' => 'ProductNotFound', 'errorMessage' => 'Product not found.', 'description' => ''], + ['errorCode' => 'InvalidBillingCycle', 'errorMessage' => 'BillingCycle not Invalid.', 'description' => ''], + ['errorCode' => 'ProdCodeNotFind', 'errorMessage' => 'Product code not find. ', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"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":""}]', @@ -12539,631 +8429,366 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ - 'summary' => '以摊销月视角查询月实例摊销成本。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-12-26T11:27:13.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2022-12-26T08:07:36.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeGaapBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryInvoicingCustomerList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'BillingCycle', - 'in' => 'formData', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ '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, + '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'], + ], + ], + ], + ], + ], + ], + ], ], - 'required' => false, - 'maxItems' => 10, ], ], + ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInvoicingCustomerList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'title' => '订阅类型', - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerInvoiceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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' => 'formData', - 'schema' => [ - 'description' => '产品。'."\n" - .'参考取值来源：'."\n" - .'查QueryProductList 查询产品信息，'."\n" - .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'in' => 'query', + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => '产品明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '财务单元code', - 'description' => '财务单元code。', - 'type' => 'string', - 'required' => false, - 'example' => '123#', - 'maxLength' => 256, - ], + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => '订阅类型。取值类型：'."\n" + .'- Subscription：预付费。'."\n" + .'- PayAsYouGo：后付费。', 'type' => 'string', 'required' => false, 'example' => 'Subscription'], ], [ - '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' => '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' => 'BillOwnerIdList', - 'in' => 'formData', - 'style' => 'repeatList', + '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' => [ - 'description' => '资源归属账号筛选条件。'."\n" - .'资源归属账号ID，资源归属账号是实际使用资源的账号。'."\n" - .'最多元素个数：10。', - 'type' => 'array', - 'items' => [ - 'description' => '资源归属账号ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, + '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'], + ], + ], + ], + ], + ], + ], + ], ], - 'required' => false, - 'maxItems' => 10, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - '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, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 10, ], ], + ], + ], + 'QueryPermissionList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - 'maxLength' => 2560, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => ['description' => '关系ID。取值从QueryRelationList接口返回的结果字段relationId获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '51463'], ], ], '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！', - ], + '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", + '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' => '数据条目。', + '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' => [ - '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', - ], + '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' => '主账号 子账号共享主账号信控身份'], ], ], ], @@ -13175,541 +8800,214 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryPermissionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'QueryPrepaidCards' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => '摊销月'."\n" - .'格式：YYYY－MM。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-10', - 'maxLength' => 256, - ], + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '卡包过期结束时间止，格式：yyyy-mm-ddhh:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2018-08-01 00:00:00'], ], [ - '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' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => ['description' => '卡包过期时间起，格式：yyyy-mm-dd。', 'type' => 'string', 'required' => false, 'example' => '2018-08-01 00:00:00'], ], [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, - ], + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => ['description' => '卡包是否生效。取值范围：-true。-false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], - [ - 'name' => 'ProductCode', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品。'."\n" - .'参考取值来源：'."\n" - .'查QueryProductList 查询产品信息，'."\n" - .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, + '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'], + ], + ], + ], + ], + ], + ], ], ], - [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => '产品明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => ' Some parameters arte mandatoryfor this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Some parameters are not valid.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specifiedowner doesn’t belong to caller', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], ], - [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '财务单元code。', - 'type' => 'string', - 'required' => false, - 'example' => '123#'."\n", - 'maxLength' => 256, - ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], + ], + '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' => '查询用户卡包信息。', + 'changeSet' => [], + 'ramActions' => [ [ - '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, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescrbePrepaidCards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 10, ], ], + ], + ], + 'QueryPriceEntityList' => [ + 'summary' => '本API是用来查询一个商品下有哪些定价对象。'."\n" + .'定价对象是用来计量和计算费用的最小产品能力。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - 'maxLength' => 2560, - ], + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => ['description' => '商品code，可通过**QueryCommodityList**接口查询商品code。', 'type' => 'string', 'required' => true, 'example' => 'ecs'], ], [ - 'name' => 'MaxResults', - 'in' => 'formData', + 'name' => 'Lang', + 'in' => 'query', 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '语言，不填时默认为zh(中文)', + 'type' => 'string', 'required' => false, - 'example' => '20', + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], + 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BssResult>', - 'description' => 'BssResult', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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", - ], + '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' => [ - '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' => '数据条目。', + 'PriceEntityInfoList' => [ + 'description' => '定价对象列表', 'type' => 'array', 'items' => [ - 'description' => '数据项。', + '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', + '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'], + ], + ], + ], ], ], ], @@ -13720,648 +9018,225 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + 'title' => '商品定价对象列表查询', + 'description' => '本API是用来查询一个商品下有哪些定价对象。'."\n" + .'定价对象是用来计量和计算费用的最小产品能力。', + 'responseParamsDescription' => '一个商品会有一到多个定价对象，每个定价对象下有一到多个定价因子', + 'changeSet' => [ + ['createdAt' => '2023-09-04T08:20:04.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPriceEntityList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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小时可使用。', + '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"}]', ], - 'DescribeInstanceAmortizedCostByConsumePeriod' => [ - 'summary' => '以账期月视角查询月实例摊销成本。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryProductList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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' => 'QueryTotalCount', + 'in' => 'query', + 'schema' => ['description' => '是否返回产品总数目，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'AmortizationPeriodFilter', - 'in' => 'formData', - 'style' => 'repeatList', + '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' => [ - 'title' => '摊销月筛选条件', - 'description' => '摊销月筛选条件。'."\n" - .'最多元素个数：10。', - 'type' => 'array', - 'items' => [ - 'description' => '摊销月'."\n" - .'格式：YYYY－MM。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-09'."\n", - 'maxLength' => 256, + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], ], - 'required' => false, - 'maxItems' => 10, + 'description' => '', ], ], + ], + 'title' => '查询产品信息', + 'summary' => '查询当前账号可订购的产品清单，返回产品code、产品名称和订阅模式（预付费/后付费）等信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-04T03:08:42.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryProductList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'title' => '订阅类型', - 'description' => '订阅类型。取值：'."\n" - ."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryProductList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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":""}]', + ], + 'QueryRIUtilizationDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '产品。'."\n" - .'参考取值来源：'."\n" - .'查QueryProductList 查询产品信息，'."\n" - .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => '产品明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'name' => 'RIInstanceId', + 'in' => 'query', + 'schema' => ['description' => '筛选查询的预留实例ID，为空时返回所有的使用的预留实例明细。', 'type' => 'string', 'required' => false, 'example' => 'dsudfgdsjh'], ], [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '财务单元code', - 'description' => '财务单元code。', - 'type' => 'string', - 'required' => false, - 'example' => '123#'."\n", - 'maxLength' => 256, - ], + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => ['description' => '预留实例对应的规格。', 'type' => 'string', 'required' => false, 'example' => 'Instancetyp'], ], [ - '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' => 'RICommodityCode', + 'in' => 'query', + 'schema' => ['description' => '取值：'."\n" + .'- ecsRi（默认值）：ECS的预留实例。'."\n" + .'- scu_bag：存储容量单位包。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecsRi'], ], [ - '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' => 'DeductedInstanceId', + 'in' => 'query', + 'schema' => ['description' => '被抵扣实例的ID，为空时返回所有实例的明细数据。', 'type' => 'string', 'required' => false, 'example' => 'jsdgfsdhgsdjh'], ], [ - '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' => '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' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - 'maxLength' => 2560, - ], + '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' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + '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' => [ - '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", - ], + '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' => '返回数据', + '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', + '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'], + ], ], ], ], @@ -14374,546 +9249,244 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => 'InvalidQueryTime', 'errorMessage' => 'The specified start time and end time are incorrect', 'description' => ''], + ['errorCode' => 'InvalidInstanceSpec', 'errorMessage' => 'The specified Instance specification is not valid.', 'description' => ''], + ['errorCode' => 'CommodityNotSupported', 'errorMessage' => 'The specified RI commodity is not supported.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryRiUtilizationDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'QueryRedeem' => [ + 'summary' => '查询用户提货券信息。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => '账期月'."\n" - .'格式：YYYY－MM。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-10'."\n", - 'maxLength' => 256, - ], + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => ['description' => '失效开始时间。格式：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2018-08-01T00:00:00Z'], ], [ - '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' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => ['description' => '失效结束时间。格式：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2018-08-01T00:00:00Z'], ], [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - ."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, - ], + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => ['description' => '提货券是否生效：'."\n" + .'- true。'."\n" + .'- false。'."\n" + ."\n" + .'默认false。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], ], [ - 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '产品。'."\n" - .'参考取值来源：'."\n" - .'查QueryProductList 查询产品信息，'."\n" - .'查DescribeResourcePackageProduct 查询某个资源包产品的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'ProductDetail', - 'in' => 'formData', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页显示条数。每页条数不允许超过300', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品明细。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, + '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.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller. ', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller. ', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-08T08:23:44.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-08T03:58:50.000Z', 'description' => '请求参数发生变更'], + ], + 'ramActions' => [ [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '财务单元code。', - 'type' => 'string', - 'required' => false, - 'example' => '123#'."\n", - 'maxLength' => 256, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRedeem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryRelationList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - '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' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '阿里云账号UID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1990699401005016'], ], [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - 'maxLength' => 2560, - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MaxResults', - 'in' => 'formData', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '页大小，默认20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '关系状态列表，状态是RelationshipStatusEnum的枚举值。默认不传值查询当前生效状态。', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => 'RELATED'], 'required' => false, - 'example' => '20', + 'example' => 'RELATED', + 'maxItems' => 8, ], ], ], '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", - ], + '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' => '消息说明。', + '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' => '数据条目。', + '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' => [ - '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', - ], + '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'], ], ], ], @@ -14925,31 +9498,55 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], ], ], - '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', + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRelationList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRelationList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryResellerAvailableQuota' => [ + 'summary' => '查询用户（代付场景下设置消费配额）的当前可用配额余额信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14957,565 +9554,398 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'ItemCodes', 'in' => 'query', - 'schema' => [ - 'description' => '账单日期，YYYY－MM。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], + 'schema' => ['description' => '无需填写', 'type' => 'string', 'required' => false, 'example' => '无'], ], - [ - 'name' => 'ProductCode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + '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.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter.', 'description' => ''], + ['errorCode' => '-304', 'errorMessage' => 'Record is not exists.', 'description' => ''], + ['errorCode' => 'CreditInnerError', 'errorMessage' => 'This interface has some error. Please try again.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => '查询当前可用配额余额信息', + 'changeSet' => [ + ['createdAt' => '2022-12-29T03:08:01.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ], + 'ramActions' => [ [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerAvailableQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryResellerUserAlarmThreshold' => [ + 'summary' => ' ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - ."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。'."\n" - ."\n" - .'> 必须和ProductCode参数一起使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'AlarmType', 'in' => 'query', 'schema' => [ - 'description' => '用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错。空代表从头开始读取。', + 'title' => '预警类型 [必填,quota_low_balance:Quota低额预警 month_consume_high:月消费高额预警', + 'description' => '预警类型[必填,quota_low_balance:Quota低额预警]', 'type' => 'string', 'required' => false, - 'example' => 'CAESEgoQCg4KCmd', + 'enumValueTitles' => ['quota_low_balance' => 'quota_low_balance'], + 'example' => 'quota_low_balance', ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '本次读取的最大数据记录数量。默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + '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. ', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller. ', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure. ', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter ', 'description' => ''], + ], + ], + '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 额度低额预警规则', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'BillOwnerId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryResourcePackageInstances' => [ + 'summary' => '查询用户某个资源包的实例，仅支持查询有效的资源包。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'InstanceID', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'SplitItemID', + 'name' => 'ExpiryTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '分拆项ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], + 'schema' => ['description' => '失效起始时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-02T12:00:00Z'], ], [ - 'name' => 'Granularity', + 'name' => 'ExpiryTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '查询账单的颗粒度。取值：'."\n" - .'- MONTHLY：月。与用户中心-分账账单-账期账单一致。'."\n" - .'- DAILY：日。与用户中心-分账账单-按天账单一致。'."\n" - ."\n" - .'> 选择DAILY需指定BillingDate。', - 'type' => 'string', - 'required' => false, - 'example' => 'Monthly', - ], + 'schema' => ['description' => '失效结束时间。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-02T13:00:00Z'], ], [ - 'name' => 'BillingDate', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '账单日期，仅当Granularity为DAILY时必填，格式为YYYY-MM-DD。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-02', - ], + 'schema' => ['description' => '页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'TagFilter', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', + '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' => [ - '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', + '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'], + ], + ], + ], + ], ], - '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, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'OwnerIdInvalid', 'errorMessage' => 'Parameter ownerId is invalid.', 'description' => ''], + ['errorCode' => 'OwnerIdMissing', 'errorMessage' => 'Paramter ownerId is missing.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryResourcePackageInstances'], + ], + ], + 'ramActions' => [ [ - 'name' => 'IsHideZeroCharge', - 'in' => 'query', - 'schema' => [ - 'description' => '根据原价（PretaxGrossAmount）和应付（PretaxAmount）是否都为0做过滤。取值：'."\n" - ."\n" - .'- false。'."\n" - .'- true。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'false', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QuerySavingsPlansDeductLog' => [ + 'summary' => '查询节省计划抵扣的明细数据', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'PipCode', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'description' => '产品Code，与费用中心账单产品Code一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + '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' => 'Success', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '返回数据。', + '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', - ], + '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' => '账单详情。', + 'description' => '抵扣明细列表', 'type' => 'array', 'items' => [ + 'description' => '抵扣明细数据', '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', - ], + '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'], ], ], ], @@ -15525,26 +9955,41 @@ ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner does not belong to caller.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'The specified API is not applicable for the user.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'The user is not authorized for the specified API.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], + ], + ], + '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' => '节省计划抵扣明细查询', + 'changeSet' => [ + ['createdAt' => '2023-12-07T07:38:22.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-28T12:44:15.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDeductLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QuerySavingsPlansDiscount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15552,424 +9997,309 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'ModuleCode', + 'in' => 'query', + 'schema' => ['title' => 'moduleCode', 'description' => '模块CODE', 'type' => 'string', 'required' => false, 'example' => 'instance_type'], + ], + [ + 'name' => 'PayMode', 'in' => 'query', 'schema' => [ - 'description' => '账单日期，YYYY－MM。', + 'title' => 'payMode', + 'description' => '付费类型:'."\n" + .'total 全预付'."\n" + .'half 半预付'."\n" + .'zero 0预付', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', + 'enumValueTitles' => ['zero' => '0预付', 'total' => '全预付', 'half' => '半预付'], + 'example' => 'total', ], ], [ - 'name' => 'ProductCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['title' => 'pageSize', 'description' => '每页个数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'ProductType', + 'name' => 'SpnType', 'in' => 'query', 'schema' => [ - 'description' => '产品类型。', + 'title' => 'spnType', + 'description' => '节省计划类型:'."\n" + .'ecs 计算型'."\n" + .'universal 通用型', 'type' => 'string', - 'required' => false, - 'example' => 'rds', + 'required' => true, + 'enumValueTitles' => ['ecs' => '计算型', 'universal' => '通用型'], + 'example' => 'universal', ], ], [ - 'name' => 'SubscriptionType', + 'name' => 'Locale', 'in' => 'query', 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'Subscription：预付费。'."\n" - .'PayAsYouGo：后付费。'."\n" - .'说明：必须和ProductCode参数一起使用。', + 'title' => 'locale', + 'description' => '多语言标识', 'type' => 'string', 'required' => false, - 'example' => 'PayAsYouGo', + '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' => [ - 'description' => '页码，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + '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'], + 'title' => '查询节省计划折扣明细', + 'summary' => '查询节省计划折扣信息列表。', + 'changeSet' => [ + ['createdAt' => '2024-08-20T06:32:11.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-25T08:39:50.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansDiscount'], + ], + ], + 'ramActions' => [], + '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"}]', + ], + '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' => '每页数量，默认值：20，最大值：300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '每页个数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'minimum' => '1', 'example' => '20'], ], [ - 'name' => 'BillOwnerId', + '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' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', - 'type' => 'integer', - 'format' => 'int64', + '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, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', + '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' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '返回数据', + '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', - ], + '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' => [ - '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', + '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'], ], ], ], @@ -15979,28 +10309,47 @@ ], ], ], - '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)页面开通后才可提供', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner does not belong to caller.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'The specified API is not applicable for the user.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'The user is not authorized for the specified API.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], + ], + ], + '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' => ' ', - ], - 'InquiryPriceRefundInstance' => [ - 'summary' => 'InquiryPriceRefundInstance：调用本接口对需要退订的实例进行询价。', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QuerySettleBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16008,434 +10357,340 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'description' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。', - 'type' => 'string', - 'required' => false, - 'example' => '793F021C-B589-1225-82A9-99232AEBE494', - ], + 'schema' => ['description' => '账期，YYYY-MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07'], ], [ - 'name' => 'ProductCode', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => '退订场景必填，产品code', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '类型。取值：'."\n" + .'- SubscriptionOrder 预付费订单'."\n" + .'- PayAsYouGoBill 后付费账单'."\n" + .'- Refund 退款账单'."\n" + .'- Adjustment 调账账单', 'type' => 'string', 'required' => false, 'example' => 'SubscriptionOrder'], ], [ - 'name' => 'InstanceId', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'title' => 'instanceId', - 'description' => '退订场景必填，实例id', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1etb69sqxgl4*******', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'title' => 'productType', - 'description' => '退订场景必填，产品类型，无特殊说明传入“” 空字符串。', - 'type' => 'string', - 'required' => false, - 'example' => '”“', - ], + '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' => [ - 'title' => 'result', - 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => '执行结果说明', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台。', - 'type' => 'string', - 'example' => 'UUID', - ], + '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' => [ - 'title' => 'data', - 'description' => 'data', + 'description' => '返回数据。', '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', + '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'], + ], + ], + ], + ], ], ], ], - '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.', - ], + '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 \\"OutstandingAmount\\": 0,\\n \\"PaymentTime\\": \\"2020-03-11 08:00:00\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QuerySettleBill'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySettleBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'QuerySkuPriceList' => [ + 'summary' => '通常一个产品功能会有1到多个SKU，有的产品会多达数万级别的SKU。'."\n" + .'本API是用来查询一个指定的产品功能下的SKU列表及其目录价。接口入参支持按照某种SKU配置的条件来进行过滤查询。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => '商品code，可通过**QueryCommodityList**接口查询商品code。', 'type' => 'string', 'required' => true, 'example' => 'ecs'], ], [ - 'name' => 'ProductType', + 'name' => 'PriceEntityCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '定价对象code，可通过**QueryPriceEntityList**接口查询定价对象code。', 'type' => 'string', 'required' => true, 'example' => 'instance_type'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值类型：PayAsYouGo（后付费）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => '每页返回的数量，最大不能超过50', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], ], [ - 'name' => 'Region', + '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' => '实例所属的 Region ID。', - 'type' => 'string', + 'description' => '定价因子条件集合，可通过**QueryPriceEntityList**接口查询定价因子code和定价因子值。', + 'type' => 'object', 'required' => false, - 'example' => 'cn-hangzhou', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => '{"vm_region_no":"cn-shiwei-shenshu"}', 'description' => '定价因子值对'], + 'description' => '定价对象因值集合', + ], ], ], [ - 'name' => 'ModuleList', + 'name' => 'Lang', '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, + 'description' => '语言，不填时默认为zh(中文)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], + 'example' => 'en', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回结果。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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', - ], + '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' => [ - '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' => [ + 'SkuPricePage' => [ + 'description' => '定价对象sku信息', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'PromotionDetail' => [ - 'description' => '优惠详情。', + 'TotalCount' => ['description' => 'sku总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '18732'], + 'NextPageToken' => ['description' => '下一页的token', 'type' => 'string', 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332'], + 'SkuPriceList' => [ + 'description' => 'sku列表', 'type' => 'array', 'items' => [ - 'description' => '优惠详情。', + 'description' => 'sku对象', 'type' => 'object', 'properties' => [ - 'PromotionDesc' => [ - 'description' => '优惠描述。', - 'type' => 'string', - 'example' => '仅提供测试使用的1分钱活动', - ], - 'PromotionId' => [ - 'description' => '优惠标识。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10200210', + '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', + ], + ], + ], + ], + ], + ], ], - 'PromotionName' => [ - 'description' => '优惠名称。', - 'type' => 'string', - 'example' => '仅提供测试使用的1分钱活动', + '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`'], ], ], ], @@ -16448,315 +10703,169 @@ ], ], ], - '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', + 'title' => '查询商品定价对象下sku列表', + 'changeSet' => [ + ['createdAt' => '2023-09-04T08:20:04.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-10-09T03:43:34.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySkuPriceList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'QuerySplitItemBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ServicePeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => '服务时长单位。取值范围：'."\n" - .'- Year：年。'."\n" - .'- Month：月。', - 'type' => 'string', - 'required' => false, - 'example' => 'Year', - ], - ], - [ - 'name' => 'SubscriptionType', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值类型：Subscription（预付费）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '账单日期，YYYY－MM。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-03'], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'OrderType', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '订单类型。取值范围：'."\n" - .'- NewOrder：新购。'."\n" - .'- Renewal：续费。'."\n" - .'- Upgrade：升级。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NewOrder', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'ServicePeriodQuantity', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '服务时长。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '订阅类型。取值：'."\n" + .'Subscription：预付费。'."\n" + .'PayAsYouGo：后付费。'."\n" + .'说明：必须和ProductCode参数一起使用。', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo'], ], [ - 'name' => 'ProductType', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型，是否必输以具体产品的询价文档为准。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Region', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的Region ID（地域ID）。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '每页数量，默认值：20，最大值：300。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'InstanceId', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => '指定询价的实例 ID，升级场景必须设置，用于获取实例升级前配置。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-khkjhxxxxxxxxx', - ], + 'schema' => ['description' => '资源归属账号的ID，资源归属账号是实际使用资源的账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123'], ], - [ - '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 => [ + ], + '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', - ], + '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' => '产品价格信息。', + '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' => [ + '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' => [ - 'PromotionDetail' => [ - 'description' => '优惠详情。', + 'Item' => [ + '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', - ], + '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'], ], ], ], @@ -16768,25 +10877,44 @@ ], ], ], - '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. 根据查询到的产品配置参数调用本接口获取预付费产品的价格。', + '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' => ' ', - ], - 'QueryAvailableInstances' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QuerySplitItemBill'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySplitItemBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryUserOmsData' => [ + 'summary' => '根据传入的云产品查询相应的计量记录。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16794,323 +10922,245 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'Table', 'in' => 'query', - 'schema' => [ - 'description' => '地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '用量数据产品和明细信息，一般为ProductCode，不同产品存在多种计量模型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ - 'name' => 'PageNum', + 'name' => 'DataType', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '计量数据时间类型，参考具体产品文档描述选用。'."\n" + .'- Raw：小时。'."\n" + .'- Hour：小时。'."\n" + .'- Day：天。'."\n" + .'- Month：月。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Hour'], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '每页条数，默认值为20，最大不超过300个。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '请求的开始时间。'."\n" + ."\n" + .'日期格式按照ISO8601标准标示，并需要使用UTC时间。格式：yyyy-mm-ddThh:mm:ssZ。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-20T12:00:00Z'], ], [ - 'name' => 'ProductCode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。可通过接口**QueryProductList**查询产品代码。'."\n" - ."\n" - .'> 当设置了region时，不为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '请求的结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601标准标示，并需要使用UTC时间。格式：yyyy-mm-ddThh:mm:ssZ。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-21T12:00:00Z'], ], [ - 'name' => 'ProductType', + 'name' => 'Marker', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '设定结果从NextToken之后按字母排序的第一个开始返回。默认从头返回。', 'type' => 'string', 'required' => false, 'example' => 'NextToken'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => '分页查询每页行数，1~200，默认值100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '订阅类型。'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', + '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.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryUserOmsData'], + ], + ], + 'ramActions' => [ [ - 'name' => 'InstanceIDs', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。多个ID用英文逗号分隔，最大不超过100个。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-xxxxxxxxxxxx', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeUserOmsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'RefundInstance' => [ + 'summary' => '调用本接口退订不再需要的实例。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTimeStart', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间段起，符合ISO8601标准的utc时间格式，例如2016-05-23T12:00:00Z。', - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['title' => 'clientToken', 'description' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。调用后如果返回了结果，可以解析到退款订单编号，代表调用成功。', 'type' => 'string', 'required' => false, 'example' => '793F021C-B589-1225-82A9-99232AEBE494'], ], [ - 'name' => 'EndTimeEnd', + 'name' => 'ImmediatelyRelease', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间段止，符合ISO8601标准的utc时间格式，例如2016-05-23T12:00:00Z。', - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['title' => 'immediatelyRelease', 'description' => '退订场景必填。1：标识立即释放。0：标识先停机，根据停机策略停机。仅部分商品支持。默认都是立即释放。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'CreateTimeStart', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '创建时间段起，符合ISO8601标准的utc时间格式。', - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['title' => 'productCode', 'description' => '退订场景必填，产品code。如果调用后错误码提示产品不支持，可提交工单申请云产品允许开通此功能。', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '创建时间段止，符合ISO8601标准的utc时间格式。', - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['title' => 'instanceId', 'description' => '退订场景必填，实例id，非自定义名称。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1etb69sqxgl4*******'], ], [ - 'name' => 'RenewStatus', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '续费状态，取值：'."\n" - .'- AutoRenewal：自动续费。'."\n" - .'- ManualRenewal：手动续费。'."\n" - .'- NotRenewal：不续费。', - 'type' => 'string', - 'required' => false, - 'example' => 'AutoRenewal', - ], + 'schema' => ['title' => 'productType', 'description' => '退订场景必填，产品类型，无特殊说明传入空字符串。在调试工具上，无需手动输入，鼠标放到输入框上，会弹出"输入空字符串"的按钮，点击此按钮即可。通过代码发起退订时，传入英文字符下的空字符串 ""。', 'type' => 'string', 'required' => false, 'example' => '空字符串'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'result', + 'description' => 'result', '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', - ], + 'Message' => ['title' => 'message', 'description' => '执行结果说明', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'requestId', 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台。', 'type' => 'string', 'example' => 'UUID'], 'Data' => [ - 'description' => '返回数据。', + 'title' => 'data', + 'description' => 'data', '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', - ], - ], - ], - ], + '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.', 'description' => ''], + ['errorCode' => 'ResourceStatusError', 'errorMessage' => 'The resource status error.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner does not belong to caller.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'The specified API is not applicable for the user.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'The user is not authorized for the specified API.', 'description' => ''], + ['errorCode' => 'BindMirrorInstanceError', 'errorMessage' => 'Charged images that are related to ECS.', 'description' => ''], + ['errorCode' => 'ExceedRefundQuotaError', 'errorMessage' => 'The number of unsubscription times has reached the upper limit.', 'description' => ''], + ['errorCode' => 'ExistUnPaidOrderError', 'errorMessage' => 'The instance has an unsettled order.', 'description' => ''], + ['errorCode' => 'ExistRefundingOrderError', 'errorMessage' => 'The instance ID is invalid: the instance may have expired, been refunded, or been released.', 'description' => ''], + ['errorCode' => 'NoRestValueError', 'errorMessage' => 'The refund amount is 0.', 'description' => ''], + ['errorCode' => 'AmbassadorOrderLimitError', 'errorMessage' => 'The instance has an ambassador order that may raise risks.', 'description' => ''], + ['errorCode' => 'ActivityForbiddenError', 'errorMessage' => 'Promotional orders do not support refunds.', 'description' => ''], + ['errorCode' => 'ProductCheckError', 'errorMessage' => 'The cloud service failed SPI preflight verification.', 'description' => ''], + ['errorCode' => 'CommodityNotSupported', 'errorMessage' => 'The specified commodity is not supported.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => '系统异常，请重试'], + ], + ], + '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：云产品规则预校验未通过', + 'changeSet' => [ + ['createdAt' => '2022-12-26T09:13:22.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefundInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:RefundBatchRemainRefund', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17123,78 +11173,42 @@ [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => '产品代码', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['title' => 'productType', 'description' => '产品类型', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], ], 'responses' => [ @@ -17204,76 +11218,53 @@ 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => '执行结果说明', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '执行链路追踪字符串，排查问题时，可以提供给平台', - 'type' => 'string', - 'example' => 'UUID', - ], + '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', - ], + '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', - ], + '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.', - ], + ['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.', 'description' => '幂等参数错误'], ], ], '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', + 'changeSet' => [ + ['createdAt' => '2022-05-11T01:18:01.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ReleaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'RelieveAccountRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17281,100 +11272,89 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。可通过接口**QueryProductList**查询产品代码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Cdn', - ], + 'schema' => ['description' => '关系类型，目前仅支持enterprise_group', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'enterprise_group'], ], [ - 'name' => 'ProductType', + 'name' => 'ParentUserId', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Cdn', - ], + 'schema' => ['description' => '主账号的阿里云UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1738376485192612'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'ChildUserId', 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '子账号的阿里云账号UID，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1512996702208737'], ], [ - 'name' => 'Period', + 'name' => 'RequestId', 'in' => 'query', - 'schema' => [ - 'description' => '预付费周期。单位为月，按年付费产品请输入12的整数倍。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => '请求唯一标识，用于标记一次请求，便于定位问题', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'request_id'], ], [ - 'name' => 'RenewalStatus', + 'name' => 'RelationId', 'in' => 'query', + 'schema' => ['description' => '账号关联id，【parentUserId，childUserId，RelationType】 或者【relationId】必须填写一组', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'RelationId'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '自动续费状态，取值：'."\n" - .'- AutoRenewal：自动续费。'."\n" - .'- ManualRenewal：手动续费。'."\n" - ."\n" - .'默认ManualRenewal。', - 'type' => 'string', - 'required' => false, - 'example' => 'ManualRenewal', + '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' => '解除主、子账号关联。', + 'changeSet' => [ + ['createdAt' => '2021-12-14T14:50:34.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ], + 'ramActions' => [], + ], + 'RenewChangeInstance' => [ + 'summary' => '对一个实例续费的同时进行变配操作，实际变配时间，是续费订单生效的时间，并自动支付。不支持ECS和RDS系列产品的创建。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RenewPeriod', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '自动续费周期， 单位为月。'."\n" - .'> 当设置**RenewalStatus**为**AutoRenewal**时，必须设置。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', 'type' => 'string', 'required' => true, 'example' => 'rds'], ], [ - 'name' => 'ClientToken', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '客户端幂等参数，服务端会查询是否有相同ClientToken的请求，如果有，直接返回上次调用结果。', - 'type' => 'string', - 'required' => false, - 'example' => 'JASIOFKVNVIXXXXXX', - ], + 'schema' => ['description' => '产品类型', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'Logistics', + 'name' => 'InstanceId', '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"}', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-skjdhaskjdh'], ], [ 'name' => 'Parameter', @@ -17387,18 +11367,8 @@ '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', - ], + '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, ], @@ -17407,68 +11377,37 @@ ], ], [ - 'name' => 'PricingCycle', + 'name' => 'ClientToken', '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' => [], - ], + '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' => [ - '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', - ], + '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' => '返回信息。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '创建成功的订单ID。', - 'type' => 'string', - 'example' => '20240xxxx21', - ], - 'InstanceId' => [ - 'description' => '订单对应的实例ID。', - 'type' => 'string', - 'example' => 'OSSBAG-cn-v1hxxxxx23', - ], + 'OrderId' => ['description' => '创建成功的订单ID。', 'type' => 'string', 'example' => '202407022550621'], + 'HostId' => ['description' => '执行主机所在站点', 'type' => 'string', 'example' => '100.100.64.1:8150'], ], ], ], @@ -17476,162 +11415,162 @@ ], ], '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', - ], + ['errorCode' => 'ResourceNotExists', 'errorMessage' => 'The specific resource is not exists. ', 'description' => ''], + ['errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL ', 'errorMessage' => 'Please complete your basic personal information first. ', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + ], + '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' => '续费变配服务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'bss:RenewChangeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'RenewInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ - 'name' => 'ProductType', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-skjdhaskjdh'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'RenewPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '预付费续费时长，单位：月。取值：'."\n" + .'- 1~9。'."\n" + .'- 12。'."\n" + .'- 24。'."\n" + .'- 36。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '6'], ], [ - 'name' => 'ModifyType', + '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' => [ - 'description' => '变配类型，取值'."\n" - .'- Upgrade：升级。'."\n" - .'- Downgrade：降级。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Upgrade', + '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.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'ResourceStatusError', 'errorMessage' => 'The resource status error.', 'description' => ''], + ['errorCode' => 'ResourceNotExists', 'errorMessage' => 'The specific resource is not exists.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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' => false, - 'example' => 'rm-akjhkdsjhfskjfhd', - ], + 'schema' => ['description' => '用户实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lskd****sljhsdj'], ], [ - 'name' => 'ClientToken', + 'name' => 'EffectiveDate', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性，防止请求重复提交。', - 'type' => 'string', - 'required' => false, - 'example' => 'JAKSJFHFAKJSF', - ], + 'schema' => ['description' => '资源包生效时间，不填默认立即生效。'."\n" + ."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-02T12:00:00Z'], ], [ - 'name' => 'Parameter', + 'name' => 'Duration', '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, - ], + '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' => [ @@ -17639,40 +11578,17 @@ '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', - ], + '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' => 'string', - 'example' => '202653252354351', - ], - 'HostId' => [ - 'description' => '主机ID。', - 'type' => 'string', - 'example' => 'testId', - ], + 'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '204322560333'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'OSSBAG-cn-0xl0n****003'], ], ], ], @@ -17681,141 +11597,170 @@ ], '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.', - ], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'DurationInvalid', 'errorMessage' => 'Parameter duration can only be positive integer.', 'description' => ''], + ['errorCode' => 'ProductNotFound', 'errorMessage' => 'Product not found.', 'description' => ''], + ['errorCode' => 'PackageTypeNotFound', 'errorMessage' => 'No such resource package type found.', 'description' => ''], + ['errorCode' => 'SpecificationInvalid', 'errorMessage' => 'Parameter specification can only be positive integer.', 'description' => ''], + ['errorCode' => 'IdInvalid', 'errorMessage' => 'Parameter ownerId is invalid.', 'description' => ''], + ['errorCode' => 'EffectiveDateInvalid', 'errorMessage' => 'Parameter effectiveDate is invalid.', 'description' => ''], + ['errorCode' => 'IdMissing', 'errorMessage' => 'Paramter ownerId is missing.', 'description' => ''], + ['errorCode' => 'PackageTypeNotSupported', 'errorMessage' => 'Package type currently is not supported.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"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执行变配。', + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewResourcePackage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'SetRenewal' => [ - 'methods' => [ - 'post', - 'get', + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAllExpirationDay'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetRenewal' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '产品代码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '产品类型。', 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '续费状态，取值：'."\n" + .'- AutoRenewal：自动续费。'."\n" + .'- ManualRenewal：手动续费。'."\n" + .'- NotRenewal：不续费。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AutoRenewal'], ], ], 'responses' => [ @@ -17823,26 +11768,10 @@ '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', - ], + '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'], ], ], ], @@ -17853,341 +11782,268 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ConvertChargeType' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRenewal'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetResellerUserAlarmThreshold' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ProductType', + 'name' => 'AlarmType', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '预警类型：quota_low_balance（代表Quota低额预警）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'quota_low_balance'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'AlarmThresholds', 'in' => 'query', - 'schema' => [ - 'description' => '实例当前的付费类型，取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。'."\n" - ."\n" - .'> 调用成功后资源将被更变为相反的类型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => '该预警类型下的用户预警规则列表，不传代表没有预警阈值', 'type' => 'string', 'required' => false, 'example' => '[{\\"denominator\\":100,\\"numerator\\":30,\\"thresholdType\\":1}]'], ], - [ - 'name' => 'Period', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '预付费周期（月），如果转换为预付费类型，需要设置购买的预付费的周期时长。取值：'."\n" - .'- 1~9。'."\n" - .'- 12。'."\n" - .'- 24。'."\n" - .'- 36。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', + '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'], + ], ], ], - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'CreditInnerError', 'errorMessage' => 'This interface has some error. Please try again.', 'description' => ''], + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + '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额度低额预警规则。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserAlarmThreshold'], ], + ], + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rm-kasjgfjshgf', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + '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' => '状态码。', - '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', - ], - ], - ], + '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' => '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' => '您购买的数量超过限制。请重新购买。', - ], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'CreditInnerError', 'errorMessage' => 'This interface has some error. Please try again.', 'description' => ''], + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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', + '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额度', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserQuota'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetResellerUserStatus' => [ + 'summary' => '开启或关闭用户sql审计功能', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], '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', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '预付费续费时长，单位：月。取值：'."\n" - .'- 1~9。'."\n" - .'- 12。'."\n" - .'- 24。'."\n" - .'- 36。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '6', - ], + 'schema' => ['description' => '需要设置的用户状态'."\n" + .'取值：'."\n" + .' Freeze：用户冻结状态'."\n" + .' Thaw：用户解冻状态'."\n" + .' Trusteeship：用户托管状态'."\n" + .' TrusteeshipCancel：用户非托管状态', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Freeze'], ], [ - 'name' => 'ClientToken', + 'name' => 'BusinessType', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。', - 'type' => 'string', - 'required' => false, - 'example' => 'ASKJHKLASJHAFSLKJH', - ], + 'schema' => ['description' => '业务类型'."\n" + .'取值：'."\n" + .' FREEZE：用户冻结业务'."\n" + .' TRUSTEESHIP：用户托管业务', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FREEZE'], ], [ - 'name' => 'ProductType', + 'name' => 'StopMode', 'in' => 'query', - 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '停机模式'."\n" + .'取值：'."\n" + .' 0：普通停机'."\n" + .' 1：立即停机', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], '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' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => '订单ID。', - 'type' => 'string', - 'example' => '202657601410661', - ], - ], - ], + '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'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => '-116', 'errorMessage' => 'Fail to modify Enduser status, Quota is less than 0.', 'description' => ''], + ], 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.', - ], + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ['errorCode' => 'ParameterError', 'errorMessage' => 'Missing the must parameter.', 'description' => ''], + ['errorCode' => 'SYSTEM_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => 'CreditInnerError', 'errorMessage' => 'This interface has some error. Please try again.', 'description' => ''], + ['errorCode' => 'NOT_ALLOW_CANCEL_TRUSTSHIP', 'errorMessage' => 'Only supports setting to trusteeship.', 'description' => '仅支持设置为停机托管'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => ' UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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', + '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' => '根据上传参数设置托管、冻结状态。', + 'changeSet' => [ + ['createdAt' => '2023-01-05T11:54:31.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-29T03:08:01.000Z', 'description' => '错误码发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserStatus'], + ], ], + 'ramActions' => [], + ], + 'SubscribeBillToOSS' => [ + 'summary' => '使用OSS订阅账单文件，支持将账单数据存储到指定的OSS bucket中。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18195,4662 +12051,2610 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'SubscribeBucket', 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'description' => '需要幂等场景必填。UUID生成的字符串。此字段用于幂等，多次调用传入同样的值，会返回第一次的结果。调用后如果返回了结果，可以解析到退款订单编号，代表调用成功。', - 'type' => 'string', - 'required' => false, - 'example' => '793F021C-B589-1225-82A9-99232AEBE494', - ], + 'schema' => ['description' => '存储订阅账单文件的OSS Bucket名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxxxxx-bucket'], ], [ - 'name' => 'ImmediatelyRelease', + 'name' => 'SubscribeType', 'in' => 'query', - 'schema' => [ - 'title' => 'immediatelyRelease', - 'description' => '退订场景必填。1：标识立即释放。0：标识先停机，根据停机策略停机。仅部分商品支持。默认都是立即释放。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '订阅的账单类型。取值类型：'."\n" + .'- BillingItemDetailForBillingPeriod：计费项消费明细。'."\n" + .'- InstanceDetailForBillingPeriod：实例消费明细。'."\n" + .'- BillingItemDetailMonthly：计费项消费账期汇总。'."\n" + .'- InstanceDetailMonthly：实例消费账期汇总。'."\n" + .'- SplitItemDetailDaily: 分账账单按天汇总。'."\n" + .'- MonthBill：月账单PDF。仅支持订阅MA。', 'type' => 'string', 'required' => false, 'example' => 'BillingItemDetailForBillingPeriod'], ], [ - 'name' => 'ProductCode', + 'name' => 'MultAccountRelSubscribe', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => '退订场景必填，产品code。如果调用后错误码提示产品不支持，可提交工单申请云产品允许开通此功能。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '对于多级账号，可指定推送账单的类型。可选值为：'."\n" + .'- MA：推送主账号及财务云非托管子账号账单。'."\n" + .'- ACP1：推送虚商子账号账单。'."\n" + ."\n" + .'默认：MA。', 'type' => 'string', 'required' => false, 'example' => 'MA'], ], [ - 'name' => 'InstanceId', + 'name' => 'BucketOwnerId', 'in' => 'query', - 'schema' => [ - 'title' => 'instanceId', - 'description' => '退订场景必填，实例id，非自定义名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1etb69sqxgl4*******', - ], + 'schema' => ['description' => '存储文件的Oss Owner对应的UID。如果是Bid/ReSeller订阅，并需要推送到子账号的OSS上时指定，需要此账号为调用账号子账号，并对此账号授予AliyunConsumeDump2OSSRole权限。'."\n" + .'普通用户则无需指定，默认为调用账号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12341324'], ], [ - 'name' => 'ProductType', + 'name' => 'BeginBillingCycle', 'in' => 'query', - 'schema' => [ - 'title' => 'productType', - 'description' => '退订场景必填，产品类型，无特殊说明传入空字符串。在调试工具上，无需手动输入，鼠标放到输入框上，会弹出"输入空字符串"的按钮，点击此按钮即可。通过代码发起退订时，传入英文字符下的空字符串 ""。', - 'type' => 'string', - 'required' => false, - 'example' => '空字符串', - ], + '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' => [ - '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', - ], + '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'], ], ], ], ], - '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" + '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" - .'1. 该接口仅支持直销客户调用，分销客户无法使用。'."\n" + .'- 用户一次订阅一个类型的账单文件。'."\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" + .'- 订阅后次日开始每日推送上一日生成的账单文件，每月4号推送上月整账期的全量账单文件。月账单PDF每月4号推送上月账单文件。'."\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', + .'- 按天生成的账单文件可能存在时延，延迟生成的账单会在生成次日推送，也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。'."\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' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T12:39:38.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-05-19T13:30:50.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubscribeBillToOSS'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + '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' => '支持添加资源上配置的标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UnsubscribeBillToOSS' => [ + 'summary' => '取消详单导出订阅。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OrderId', + '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' => [ - 'description' => '订单号', - 'type' => 'string', + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnsubscribeBillToOSS'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + '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, - 'docRequired' => true, - 'example' => '32453453', + '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' => '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + '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'], ], ], ], ], - '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.', + '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' => '取消资源上配置的标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], + 'UpgradeResourcePackage' => [ + 'summary' => '升级用户某个资源包的实例。如本周期已升级，则无法继续升级，待次周期生效后再操作升级。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], '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', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '用户实例ID。', 'type' => 'string', 'required' => true, 'example' => 'OSSBAG-cn-0xl*****x002'], ], [ - 'name' => 'PageSize', + 'name' => 'EffectiveDate', 'in' => 'query', - 'schema' => [ - 'description' => '每页条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '资源包生效时间，不填默认次周期生效。'."\n" + ."\n" + .'日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-02-02T12:00:00Z'], ], [ - 'name' => 'ProductCode', + 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => '升级资源包规格大小。', 'type' => 'string', 'required' => false, 'example' => '51200'], ], - [ - 'name' => 'ProductType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + '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'], + ], + ], + ], ], ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值类型：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotApplicable', 'errorMessage' => 'This API is not applicable for caller.', 'description' => ''], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Absent some mandatory parameter for this request.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'This request contain some invalid parameter', 'description' => ''], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => '用户身份错误'], + ['errorCode' => 'DurationInvalid', 'errorMessage' => 'Parameter duration can only be positive integer.', 'description' => ''], + ['errorCode' => 'ProductNotFound', 'errorMessage' => 'Product not found.', 'description' => ''], + ['errorCode' => 'PackageTypeNotFound', 'errorMessage' => 'No such resource package type found.', 'description' => ''], + ['errorCode' => 'SpecificationInvalid', 'errorMessage' => 'Parameter specification can only be positive integer.', 'description' => ''], + ['errorCode' => 'IdInvalid', 'errorMessage' => 'Parameter ownerId is invalid.', 'description' => ''], + ['errorCode' => 'EffectiveDateInvalid', 'errorMessage' => 'Parameter effectiveDate is invalid.', 'description' => ''], + ['errorCode' => 'IdMissing', 'errorMessage' => 'Paramter ownerId is missing.', 'description' => ''], + ['errorCode' => 'PackageTypeNotSupported', 'errorMessage' => 'Package type currently is not supported.', 'description' => ''], ], - [ - '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', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'PaymentStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '支付状态。非退款订单，取值范围：'."\n" - .'- Unpaid：未支付。'."\n" - .'- Paid：已支付。'."\n" - .'- Cancelled：已作废。'."\n" - ."\n" - .'> 对于退款订单可置NULL。', - 'type' => 'string', - 'required' => false, - 'example' => 'Paid', - ], + ], + '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' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeResourcePackage'], ], + ], + 'ramActions' => [ [ - 'name' => 'CreateTimeStart', - 'in' => 'query', - 'schema' => [ - 'description' => '创建时间段起（缺省查询当前时间最近1小时内订单），格式：YYYY-MM-ddTHH:mm:ssZ，时区： UTC', - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T13:00:00Z', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => 'business-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'AccountAbnormal', 'message' => 'Your account has been suspended or has outstanding issues, please contact customer service.', 'http_code' => 400, 'description' => '您的账户出现异常，详情请联系客服'], + ['code' => 'AccountNoQueryPricePermission', 'message' => '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.', 'http_code' => 400, 'description' => '由于您没有折扣查询权限，无法访问该页面。请联系主账号前往费用中心授权，需要授权的权限点为 queryprice'], + ['code' => 'AccountNotExist', 'message' => 'Account does not exist.', 'http_code' => 400, 'description' => '账号不存在'], + ['code' => 'AccountNotFound', 'message' => 'The specified account does not exist in the system.', 'http_code' => 404, 'description' => '账号不存在'], + ['code' => 'AccountRiskFound', 'message' => 'You account has undefined risk.', 'http_code' => 500, 'description' => '当前账号存在风险，请提交工单后重试'], + ['code' => 'ActionInProcess', 'message' => 'Action in process, please wait.', 'http_code' => 400, 'description' => '业务处理中，请稍后'], + ['code' => 'ActivityNotFound', 'message' => 'Activity does not exist.', 'http_code' => 500, 'description' => '活动不存在'], + ['code' => 'AmountExceedLimit', 'message' => 'Amount exceeds limits, please try a different card.', 'http_code' => 400, 'description' => '金额超过限制，请联系发卡行或换卡重试'], + ['code' => 'AmountLimitExceed', 'message' => 'The transaction amount exceeds the single or daily limit. Please try reducing the transaction amount or contact your bank to increase the limit.', 'http_code' => 400, 'description' => '本次交易金额超过了单笔或每日限额。请尝试减少交易金额，或联系您的银行提高限额。'], + ['code' => 'ApplyPaperContractError', 'message' => 'Failed to apply for a paper contract.', 'http_code' => 400, 'description' => '申请过纸质合同失败'], + ['code' => 'AsyncFormalContractError', 'message' => 'Application for contract confirmation failed.', 'http_code' => 400, 'description' => '申请合同转正失败'], + ['code' => 'AuthSiteFail', 'message' => 'auth site failed.', 'http_code' => 400, 'description' => '账号和归属站点不匹配，请检查endpoint是否准确'], + ['code' => 'AvailableTransferAmountNotEnough', 'message' => 'The available amount for granting or recycling is insufficient.', 'http_code' => 400, 'description' => '可划拨/回收的金额不足，请确认后重试。'], + ['code' => 'BillingAccountOperateForbid', 'message' => 'Operation is forbidden for your billing account.', 'http_code' => 400, 'description' => '您是分销商关联的客户，禁止进行当前操作'], + ['code' => 'CanApplyContractError', 'message' => 'Failed to apply for contract verification.', 'http_code' => 400, 'description' => '是否可以申请合同校验失败'], + ['code' => 'CanApplyInvoiceEmptyError', 'message' => 'Current invoice cannot be queried. Contract application is not allowed.', 'http_code' => 400, 'description' => '无法查询到当前发票，不允许申请合同'], + ['code' => 'CanApplyInvoiceNegativeError', 'message' => 'Current invoice amount is negative, contract application is not allowed.', 'http_code' => 400, 'description' => '当前发票金额为负数，不允许申请合同'], + ['code' => 'CanApplyInvoiceStatusError', 'message' => 'Invoice status incorrect, unable to apply for contract.', 'http_code' => 400, 'description' => '发票状态不正确，无法申请合同'], + ['code' => 'CANCEL_INVOICE_ERROR', 'message' => 'Cancel invoice fail.', 'http_code' => 400, 'description' => '发票作废失败'], + ['code' => 'CANCEL_INVOICE_STATUS_ERROR', 'message' => 'The status of this invoice does not meet the cancel conditions.', 'http_code' => 400, 'description' => '该申请单状态不符合作废条件'], + ['code' => 'CantDeletePaymentMethodWhileOpenAutoCharge', 'message' => 'You have turned on the auto-recharge function. After the payment method is unbound, the auto-recharge function cannot be completed. If you need to untie, please turn off auto-recharge before operation.', 'http_code' => 400, 'description' => '您已开启自动充值功能，支付方式解绑后将无法完成自动充值功能。如需解绑，请先关闭自动充值后再行操作。'], + ['code' => 'CantDeleteWhileOpenAutoRecharge', 'message' => 'You have turned on the auto-recharge function. After the payment method is unbound, the auto-recharge function cannot be completed. If you need to untie, please turn off auto-recharge before operation.', 'http_code' => 400, 'description' => '您已开启自动充值功能，支付方式解绑后将无法完成自动充值功能。如需解绑，请先关闭自动充值后再行操作。'], + ['code' => 'CanTransferAmountNotEnough', 'message' => 'Recoverable/allocated amount is insufficient, please confirm and try again.', 'http_code' => 400, 'description' => '可回收/划拨金额不足，请确认后重试'], + ['code' => 'CardAlreadyBind', 'message' => 'The specified card has already been added.', 'http_code' => 400, 'description' => '您已经添加了该银行卡，请不要重复添加。'], + ['code' => 'CardBalanceNotEnough', 'message' => 'The card balance is not enough for this transfer, please change the card and try again.', 'http_code' => 400, 'description' => '卡余额不足，请换卡重试'], + ['code' => 'CardBindAccountNumberLimit', 'message' => 'The card has been bound to an Alibaba Cloud account.', 'http_code' => 400, 'description' => '该卡已绑定到阿里云账号上.'], + ['code' => 'CardClassNotSupport', 'message' => 'This card type is not supported. Try a different type of card.', 'http_code' => 400, 'description' => '暂不支持添加该类型银行卡，请更换其他类型银行卡重试。'], + ['code' => 'CardCountryNotSupport', 'message' => 'Country not supported this payment method type yet.', 'http_code' => 400, 'description' => '暂不支持该银行卡的发卡国家。'], + ['code' => 'CardCurrencyNotSupport', 'message' => 'The card does not support the current transaction currency. Try a different card that supports the current transaction currency.', 'http_code' => 400, 'description' => '该卡片不支持当前交易币种，请使用支持当前交易币种的银行卡重试。'], + ['code' => 'CardHasBindOnOtherAccount', 'message' => 'The specified card has been added to another Alibaba Cloud account.', 'http_code' => 400, 'description' => '该银行卡已经被添加在其他阿里云账号上。'], + ['code' => 'CardNotSupport3DVerification', 'message' => 'The card does not support 3D Secure authentication. Contact your issuing bank to enable 3D Secure authentication, or try a different card.', 'http_code' => 400, 'description' => '该银行卡不支持3D验证，请联系您的发卡行开通3D验证功能，或更换其他银行卡重试。'], + ['code' => 'CardNumberInvalid', 'message' => 'The card number is invalid. Enter a valid card number.', 'http_code' => 400, 'description' => '银行卡号无效，请输入正确的银行卡号。'], + ['code' => 'ChannelProcessFail', 'message' => 'Channel system error, please contact your issuer bank or submit a ticket.', 'http_code' => 400, 'description' => '渠道处理异常，请联系发卡行或提交工单'], + ['code' => 'ChannelProcessFail', 'message' => 'Channel processing is abnormal, please contact the issuing bank or submit a work order.', 'http_code' => 400, 'description' => '渠道处理异常，请联系发卡行或提交工单。'], + ['code' => 'ChargeLimit', 'message' => 'Recharge is prohibited for the account associated with the ecological partner.', 'http_code' => 400, 'description' => '生态伙伴关联的账号禁止充值，请联系生态运营咨询'], + ['code' => 'ClaimAmountExceedLimit', 'message' => 'Claim amount exceeds limit.', 'http_code' => 400, 'description' => '认领金额超过限制，请检查后重试'], + ['code' => 'CloseAutoWriteoffError', 'message' => 'close auto write off error.', 'http_code' => 400, 'description' => '关闭自动核销失败'], + ['code' => 'ConfirmInvoiceInfoFail', 'message' => 'The current invoice has an order bill that exceeds the contract.', 'http_code' => 400, 'description' => '当前发票存在超开合同的订账单'], + ['code' => 'ConfirmInvoiceInfoFail', 'message' => 'Failed to confirm invoice booking information.', 'http_code' => 400, 'description' => '确认发票订账单信息失败'], + ['code' => 'ContractIdEmptyError', 'message' => 'Contract ID cannot be empty.', 'http_code' => 400, 'description' => '合同ID不能为空'], + ['code' => 'ContractIdNotNumberError', 'message' => 'Contract ID is not of numerical type.', 'http_code' => 400, 'description' => '合同ID不是数字类型'], + ['code' => 'ContractNoEmptyError', 'message' => 'Contract number cannot be empty.', 'http_code' => 400, 'description' => '合同编号不能为空'], + ['code' => 'ContractNoInvalidError', 'message' => 'Contract not found.', 'http_code' => 400, 'description' => '没有找到合同'], + ['code' => 'ContractStatusInvalidForApplyPaperContractError', 'message' => 'The current contract status does not allow the application for mailing contracts.', 'http_code' => 400, 'description' => '当前合同状态不允许申请邮寄合同'], + ['code' => 'ContractStatusInvalidForCancelError', 'message' => 'Formal contracts do not allow rejection.', 'http_code' => 400, 'description' => '正式合同不允许拒绝'], + ['code' => 'CouponExist', 'message' => 'The coupon collection has reached the upper limit, and the system has recalculated the best price.', 'http_code' => 500, 'description' => '券领取已达上限，系统已重新计算最优价格'], + ['code' => 'CouponOverMaxRelease', 'message' => 'Coupon Over Max Release.', 'http_code' => 500, 'description' => '券已领完，系统已重新计算最优价格 '], + ['code' => 'CreateCouponError', 'message' => 'create coupon error.', 'http_code' => 500, 'description' => '领券下单失败，系统已重新计算最优价格'], + ['code' => 'CreateOrderFailed', 'message' => 'Failed to create transfer order due to system processing error.', 'http_code' => 400, 'description' => '过户单创建失败'], + ['code' => 'DecinedByBank', 'message' => 'Your bank declined this transaction. Please contact your issuing bank for the specific reason, or try using another card.', 'http_code' => 400, 'description' => '您的银行拒绝了本次交易。请联系您的发卡银行咨询交易被拒绝的具体原因，或尝试更换其他银行卡。'], + ['code' => 'DeclinedByIssuerBank', 'message' => 'Declined by your card issuer bank. Please contact your issuer bank to ensure that your card is activated for online payment and try again.', 'http_code' => 400, 'description' => '发卡行拒绝，请联系发卡行确保银行卡在线支付业务已开通，然后重试。'], + ['code' => 'DeleteContractError', 'message' => 'Failed to delete contract.', 'http_code' => 400, 'description' => '删除合同失败'], + ['code' => 'DeleteReasonEmptyError', 'message' => 'Reason for deletion cannot be empty.', 'http_code' => 400, 'description' => '删除原因不能为空'], + ['code' => 'ExceedQueryTimesLimit', 'message' => 'Exceed daily query times limit.', 'http_code' => 400, 'description' => '超过每天查询次数限制'], + ['code' => 'ExistApprovingProcess', 'message' => 'There is a credit control setting process in the approval process, please contact the business manager.', 'http_code' => 400, 'description' => '存在审批中的信控设置流程，请联系商务经理。'], + ['code' => 'ExistUnconfirmedContract', 'message' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', 'http_code' => 400, 'description' => '您操作的账户存在待确认的信控合同，请先确认合同。'."\n"], + ['code' => 'ExpireCard', 'message' => 'Your bank card has expired. Please use another card that is not expired for payment.', 'http_code' => 400, 'description' => '您的银行卡已过期。请使用尚未过期的银行卡进行支付。'], + ['code' => 'ExpiredCard', 'message' => 'The specified card has been expired.', 'http_code' => 400, 'description' => '该银行卡已经过期。'], + ['code' => 'ExpiryDateWrong', 'message' => 'The card expiry date format is incorrect. Please enter it in the correct month/year format (e.g., MM/YY) and try again.', 'http_code' => 400, 'description' => '您输入的卡片有效期格式不正确。请按照正确的月份/年份格式（例如：MM/YY）输入后重新尝试。'], + ['code' => 'ForbiddenAccessContractError', 'message' => 'Please confirm if you have contract authority.', 'http_code' => 400, 'description' => '请确认是否有合同权限'], + ['code' => 'FormalContractError', 'message' => 'Contract confirmation failed.', 'http_code' => 400, 'description' => '合同转正失败'], + ['code' => 'FormalVipContractError', 'message' => 'Key customer contract confirmation failed.', 'http_code' => 400, 'description' => '大客户合同转正失败'], + ['code' => 'FormalWanWangContractError', 'message' => 'Wanwang Contract Confirmation Failure.', 'http_code' => 400, 'description' => '万网合同转正失败'], + ['code' => 'FunctionPaused', 'message' => 'This function is temporarily suspended for maintenance or updates.', 'http_code' => 400, 'description' => '暂停开放此功能'], + ['code' => 'GenerateFileUrlError', 'message' => 'Failed to generate download address.', 'http_code' => 400, 'description' => '生成下载地址失败'], + ['code' => 'GetAccountInfoFail', 'message' => 'Failed to get account information, please try again later.', 'http_code' => 400, 'description' => '获取账号信息失败，请稍后再试'], + ['code' => 'GetContractNoError', 'message' => 'Error in obtaining contract number.', 'http_code' => 400, 'description' => '获取合同编号错误'], + ['code' => 'GetFileUrlError', 'message' => 'Error in obtaining contract file download address.', 'http_code' => 400, 'description' => '获取合同文件下载地址错误'], + ['code' => 'GetFormalResultError', 'message' => 'Error in obtaining contract confirmation results.', 'http_code' => 400, 'description' => '获取合同转正结果错误'], + ['code' => 'IdempotentParameterMismatch', 'message' => '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.', 'http_code' => 400, 'description' => '幂等参数错误'], + ['code' => 'InconsistentConsignerIdentityInfo', 'message' => 'The real name information verified by E-sign is inconsistent. Please enter the correct mobile phone number and name.', 'http_code' => 400, 'description' => '经E签宝核验实名信息不一致，请输入正确的手机号和姓名'], + ['code' => 'InnerAccountNoQueryPricePermission', 'message' => '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.', 'http_code' => 400, 'description' => '因数据安全及合规要求，对集团上云账号金额信息权限管控，由此带来的不便敬请谅解。您可以通过HCRM/云间平台查看，详见：https://aliyuque.antfin.com/yunfei.xyf/kr0b8h/yvdm6izaeulmq8g2。'], + ['code' => 'InnerSubAccountNoQueryPricePermission', 'message' => '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.', 'http_code' => 400, 'description' => '因数据安全及合规要求，对集团上云账号金额信息权限管控，由此带来的不便敬请谅解。您可以通过HCRM/云间平台查看，详见：https://aliyuque.antfin.com/yunfei.xyf/kr0b8h/yvdm6izaeulmq8g2。'], + ['code' => 'InstanceInfoError', 'message' => 'Instance information provided is incomplete or contains invalid data.', 'http_code' => 400, 'description' => '实例信息有误'], + ['code' => 'InstanceNotBelongToAccount', 'message' => 'The specified instance does not belong to the current account.', 'http_code' => 400, 'description' => '您要处理的实例不属于当前账户，无法打开！'], + ['code' => 'InstanceNumberTooLarge', 'message' => 'The instance num exceed 2000.', 'http_code' => 400, 'description' => '对应条件下的实例ID大于2000个，无法在页面查询，请导出/订阅账单明细进行查看。'], + ['code' => 'INSUFFICIENT.AVAILABLE.QUOTA', 'message' => 'The account balance is negative. Add funds to the account and try again.', 'http_code' => 200, 'description' => '您的账户可用额度小于0，请先充值后再尝试购买'], + ['code' => 'InternalError', 'message' => 'An error occurred in the internal server.', 'http_code' => 500, 'description' => '系统异常，请重试'], + ['code' => 'InvalidAmountFormat', 'message' => 'The transaction amount is invalid. Please try using another payment method, or contact customer service.', 'http_code' => 400, 'description' => '交易金额不合法。请尝试更换其他支付方式，或联系客服。'], + ['code' => 'InvalidBillingAccount', 'message' => 'The caller does not have permission for the specified billing account.', 'http_code' => 400, 'description' => '当前登录账号不是此账户的管理员，无权操作此账户。'], + ['code' => 'InvalidBindRequest', 'message' => 'Invalid bind card request.', 'http_code' => 400, 'description' => '无效的绑卡请求.'], + ['code' => 'InvalidCaller', 'message' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', 'http_code' => 401, 'description' => '调用者主账号无效 或者 无权限查询企业成员账号信息。'], + ['code' => 'InvalidCaptcha', 'message' => 'Invalid Captcha.', 'http_code' => 400, 'description' => '您的验证码错误或者已过期，请重新获取'], + ['code' => 'InvalidCard', 'message' => 'There is a problem with the card. Try a different card or submit a ticket.', 'http_code' => 400, 'description' => '该银行卡存在问题，请更换银行卡重试或提交工单。'], + ['code' => 'InvalidCardExpireTime', 'message' => 'The specified card expiration date is invalid. Check the expiration date and try again.', 'http_code' => 400, 'description' => '您输入的银行卡有效期有误，请确认后重新输入。'], + ['code' => 'InvalidCardNumber', 'message' => 'The card number you entered is incorrect. Please carefully check your card number for any errors or omissions and try again.', 'http_code' => 400, 'description' => '您输入的银行卡号不正确。请仔细核对您的银行卡号，确保没有输入错误或遗漏后重新输入。'], + ['code' => 'InvalidContractError', 'message' => 'Invalid contract failed.', 'http_code' => 400, 'description' => '作废合同失败'], + ['code' => 'InvalidCurrency', 'message' => 'Sorry, this currency is not supported for the current transaction. Please try using a supported currency or contact customer service for more details.', 'http_code' => 400, 'description' => '抱歉，当前交易不支持此币种。请尝试使用支持的币种进行交易，或联系客服了解详情。'], + ['code' => 'InvalidCvv', 'message' => 'Invalid cvv code.', 'http_code' => 400, 'description' => 'Cvv码异常'], + ['code' => 'InvalidFundAccount', 'message' => 'The caller does not have permission for the specified fund account.', 'http_code' => 400, 'description' => '当前登录账号不是此账户的管理员，无权操作此账户。'], + ['code' => 'InvalidFundAccount', 'message' => 'The caller does not have permission for the specified billing account.', 'http_code' => 400, 'description' => '当前登录账号不是此账户的管理员，无权操作此账户。'], + ['code' => 'InvalidOwner', 'message' => 'The specified owner doesn\'t belong to caller.', 'http_code' => 400, 'description' => '用户身份错误'], + ['code' => 'InvalidParameter', 'message' => 'Transaction information is incorrect. Please check the transaction details you entered (e.g., amount, card number) and try again.', 'http_code' => 400, 'description' => '交易信息有误。请检查您填写的交易信息（如金额、卡号等）是否有误后重试。'], + ['code' => 'InvalidReasonEmptyError', 'message' => 'Reason for invalidation cannot be empty.', 'http_code' => 400, 'description' => '作废原因不能为空'], + ['code' => 'InvalidSecurityCode', 'message' => 'The security code is invalid ,please contact your issuing bank or try a different card.', 'http_code' => 400, 'description' => '您的卡安全码失效，请联系发卡行或换卡重试'], + ['code' => 'InvalidTime', 'message' => 'Invalid Time.', 'http_code' => 400, 'description' => '超出成本分析的日期选择范围，请重新选择'], + ['code' => 'InvoiceAlreadyInvoicingCanNotClose', 'message' => 'Invoice is being issued and cannot be closed.', 'http_code' => 400, 'description' => '发票开具中，无法作废'], + ['code' => 'InvoiceAmountFormatInvalid', 'message' => 'Illegal format of invoiced amount.', 'http_code' => 400, 'description' => '申请开票金额格式不合法'], + ['code' => 'InvoiceAmountInValid', 'message' => 'Illegal amount requested for invoicing.', 'http_code' => 400, 'description' => '申请开票金额不合法'], + ['code' => 'InvoiceAmountNegativeInvalid', 'message' => 'The sum of the selected amounts is negative and cannot be invoiced.', 'http_code' => 400, 'description' => '所选金额总和为负数，不可开票'], + ['code' => 'InvoiceAmountNotValid', 'message' => 'The invoiced amount field is illegal, and supports up to 2 decimal places.', 'http_code' => 400, 'description' => '申请开票金额字段不合法，最多支持2位小数'], + ['code' => 'InvoiceApplyNotAllowedForTestUser', 'message' => 'Test accounts are not permitted to perform invoicing operations.', 'http_code' => 400, 'description' => '该账号为测试账号，不可申请开票'], + ['code' => 'InvoiceAutoApplyConfigNotMatchRealName', 'message' => 'Automatic invoicing only supports the viewpoint consistent with real-name authentication. Please select again.', 'http_code' => 400, 'description' => '自动开票仅支持与实名认证一致的抬头，请您重新选择'], + ['code' => 'InvoiceCandidateNotFound', 'message' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.', 'http_code' => 400, 'description' => '根据传入的开票对象列表和账号列表，查询不到有效的待开票数据'], + ['code' => 'InvoiceCandidateSearchTimeInvalid', 'message' => 'Invoicing Candidate query time is illegal.', 'http_code' => 400, 'description' => '开票对象查询时间不合法'], + ['code' => 'InvoiceContractUnsupportedWanwangOrderError', 'message' => 'The current invoice has a World Wide Web order that does not support invoicing.', 'http_code' => 400, 'description' => '当前发票存在不支持开票的万网订单'], + ['code' => 'InvoiceDataDontExistError', 'message' => 'There are no orders being processed in the current invoice.', 'http_code' => 400, 'description' => '当前发票中不存在正在处理的订账单'], + ['code' => 'InvoiceDataEmptyError', 'message' => 'There are no subscription bills in the current invoice that can apply for contracts.', 'http_code' => 400, 'description' => '当前发票中不存在可以申请合同的订账单'], + ['code' => 'InvoiceDataOverOpeningContract', 'message' => 'The current invoice has an order bill that exceeds the contract.', 'http_code' => 400, 'description' => '当前发票存在超开合同的订账单'], + ['code' => 'InvoiceDataUsedError', 'message' => 'The current invoice has a subscription bill for a contract that has already been applied.', 'http_code' => 400, 'description' => '当前发票存在已申请合同的订账单'], + ['code' => 'InvoiceFileDownloadError', 'message' => 'Download failed, please try again later.', 'http_code' => 400, 'description' => '下载失败，请稍后再试。'], + ['code' => 'InvoiceManualAmountNotAllowed', 'message' => 'Cross-account independent invoicing, amount cannot be specified.', 'http_code' => 400, 'description' => '跨账号独立开票，不可指定金额'], + ['code' => 'InvoiceModeInvalid', 'message' => 'InvoiceMode field is illegal.', 'http_code' => 400, 'description' => 'InvoiceMode字段不合法'], + ['code' => 'InvoiceModeNotValid', 'message' => 'The invoice mode field is invalid. Please select a valid option.', 'http_code' => 400, 'description' => 'InvoiceMode字段不合法'], + ['code' => 'InvoiceOuUnsupportedError', 'message' => 'There are entities in the current invoice that do not support invoicing.', 'http_code' => 400, 'description' => '当前发票存在不支持开票的主体'], + ['code' => 'InvoiceRecipientEmailsMoreThanThree', 'message' => 'Maximum 3 email addresses allowed for invoice application.', 'http_code' => 400, 'description' => '申请开票时最多可选3个邮箱'], + ['code' => 'InvoiceRemarkTooLong', 'message' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.', 'http_code' => 400, 'description' => '发票备注长度过长，请适当缩写后重新提交！'], + ['code' => 'InvoiceSpecialOnlyForEnterprises', 'message' => 'Special invoices can only be issued by enterprise accounts.', 'http_code' => 400, 'description' => '企业类型才能开专票'], + ['code' => 'InvoiceStatusError', 'message' => 'The current invoice status is incorrect, unable to retrieve the contract.', 'http_code' => 400, 'description' => '当前发票状态不正确，无法开取合同'], + ['code' => 'InvoiceTdsValidateAuditing', 'message' => 'This user TAN NO. In the process of approval, please do not submit repeatedly.', 'http_code' => 400, 'description' => '该用户TAN NO.正在审批中，请勿重复提交。'], + ['code' => 'InvoiceTdsValidateDuplicate', 'message' => 'The tan no. It has been saved, please do not submit it again.', 'http_code' => 400, 'description' => '该TAN NO.已经被保存，请勿重复提交。'], + ['code' => 'InvoiceTdsValidateFailed', 'message' => 'The tan no. It has been used by other accounts. Please confirm whether the input is correct.', 'http_code' => 400, 'description' => '该TAN NO.已经被其他账号使用请确认输入是否正确。'], + ['code' => 'InvoiceTitleNotExist', 'message' => 'Invoice title does not exist.', 'http_code' => 400, 'description' => '发票抬头不存在'], + ['code' => 'InvoiceTypeInvalid', 'message' => 'InvoiceType field is illegal.', 'http_code' => 400, 'description' => 'InvoiceType字段不合法'."\n"], + ['code' => 'InvoiceTypeNotValid', 'message' => 'The invoice type field is invalid. Please select a valid option.', 'http_code' => 400, 'description' => 'InvoiceType字段不合法'], + ['code' => 'InvoiceUnificationCheckEmailFail', 'message' => 'No default email for unified invoicing check.', 'http_code' => 400, 'description' => '统一开票检查无默认邮箱'], + ['code' => 'InvoiceUnificationCheckTitleFail', 'message' => 'No default invoice title for unified invoicing check.', 'http_code' => 400, 'description' => '统一开票检查无默认发票抬头'], + ['code' => 'InvoiceUsedError', 'message' => 'The current invoice has already applied for a contract.', 'http_code' => 400, 'description' => '当前发票已申请过合同'], + ['code' => 'LimitRecharge', 'message' => 'Account limit recharge.', 'http_code' => 400, 'description' => '账号限制充值'], + ['code' => 'LimitWithdraw', 'message' => 'Account limit withdraw.', 'http_code' => 400, 'description' => '账号限制提现'], + ['code' => 'MaxOffsetLimit', 'message' => 'Exceeded maximum page turning limit.', 'http_code' => 400, 'description' => '超过最大翻页限制，请导出后查看'], + ['code' => 'NoAvailablePaymentMethod', 'message' => 'Sorry, there are no available payment methods at this time. Please check your network connection or try again later. If the issue persists, please contact customer service.', 'http_code' => 400, 'description' => '抱歉，当前无可用支付方式。请确认您的网络连接，或稍后再试。如果问题持续，请联系客服。'], + ['code' => 'NoFundAccountPermission', 'message' => 'The caller does not have permission for the specified fund account.', 'http_code' => 400, 'description' => '当前登录账号没有权限操作指定账户。'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action.', 'http_code' => 400, 'description' => '您无权执行此操作。'], + ['code' => 'NoQueryPricePermission', 'message' => 'If you do not have discount query permission, please contact the main account for authorization. The permission code is queryprice.', 'http_code' => 400, 'description' => '没有折扣查询权限，请联系主账号授权，权限点为 queryprice.'."\n"], + ['code' => 'NotActiveService', 'message' => 'You are not active the service，please use after activation.', 'http_code' => 400, 'description' => '您没有开通服务，请开通后使用'], + ['code' => 'NotEligibleForTransfer', 'message' => 'The selected instances do not meet transfer eligibility requirements.', 'http_code' => 400, 'description' => '不符合过户要求'], + ['code' => 'NotOpenUnifiedSettle', 'message' => 'The unified settlement is not open for caller.', 'http_code' => 400, 'description' => '尚未对您开放统一结算功能，敬请期待'], + ['code' => 'NotSupportAllocateCredit', 'message' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.', 'http_code' => 400, 'description' => '当前不支持自助分配信控额度，请联系您的服务经理修改'], + ['code' => 'NoValidInstanceFund', 'message' => 'No valid instance found.', 'http_code' => 400, 'description' => '未找到有效实例'], + ['code' => 'OldFinanceCloudUserNoPermission', 'message' => 'Old finance cloud user has no permission to query new menus.', 'http_code' => 400, 'description' => '旧版财务云客户无权访问新菜单，请升级新版企业组织后再试。'], + ['code' => 'OneCardBindUidLimit', 'message' => 'Each bank card can only be linked to one Alibaba Cloud account. The card number you entered has already been bound to another Alibaba Cloud account. Please try again with a different bank card.', 'http_code' => 400, 'description' => '每张银行卡只能绑定到一个阿里云账号上，您输入的卡号已绑定在其他阿里云账号上，请更换其他银行卡重试。'], + ['code' => 'OpenAutoWriteoffError', 'message' => 'open auto write off error.', 'http_code' => 400, 'description' => '开启自动核销失败'], + ['code' => 'OperationTypeError', 'message' => 'Invalid operation type specified, please use a valid operation type.', 'http_code' => 400, 'description' => '操作类型错误'], + ['code' => 'OrderExpiredOrProcessed', 'message' => 'The transfer order has expired or been completed, cannot be processed.', 'http_code' => 400, 'description' => '过户单已过期或已处理'], + ['code' => 'OrderNotExist', 'message' => 'The transaction order does not exist. Please refresh the page and try to initiate a new transaction.', 'http_code' => 400, 'description' => '交易订单不存在。请刷新页面后重新尝试发起交易。'], + ['code' => 'OrderNotOperational', 'message' => 'The transfer order is not in a state that allows operations.', 'http_code' => 400, 'description' => '过户单不可操作'], + ['code' => 'OrderQueryError', 'message' => 'Failed to query transfer order information due to system error.', 'http_code' => 400, 'description' => '过户单信息查询出错'], + ['code' => 'PageInfoError', 'message' => 'Invalid pagination parameters provided, please check page number and size.', 'http_code' => 400, 'description' => '分页信息错误'], + ['code' => 'PaperContractMultipleApplyError', 'message' => 'This contract has already applied for a paper contract.', 'http_code' => 400, 'description' => '该合同已申请过纸质合同'], + ['code' => 'ParamError', 'message' => 'Parameter error.', 'http_code' => 500, 'description' => '参数有误 '], + ['code' => 'ParameterError', 'message' => 'Invalid or missing required parameters in the request.', 'http_code' => 400, 'description' => '参数错误'], + ['code' => 'PARAM_ERROR', 'message' => 'param is error.', 'http_code' => 400, 'description' => '参数错误'], + ['code' => 'PARAM_INVALID', 'message' => 'Parameter error.', 'http_code' => 533, 'description' => '参数异常'], + ['code' => 'PaymentChannelProcessFail', 'message' => 'Payment channel process fail, please contact your issuer bank or submit a ticket.', 'http_code' => 400, 'description' => '支付渠道处理失败，请联系发卡行或提交工单'], + ['code' => 'PaymentDeclinedByBank', 'message' => 'payment is declined by issuer bank.', 'http_code' => 400, 'description' => '支付被发卡行拒绝'], + ['code' => 'PaymentMethodNotExist', 'message' => 'The specific card not exist or has been deleted, please check and try again.', 'http_code' => 400, 'description' => '支付方式不存在或已被删除，请检查后重试'], + ['code' => 'PaymentTypeNotSupportSettleCurrency', 'message' => 'PayPal currently does not support non-USD payments. Please set PayPal as your preferred payment method when both the current and next month\'s settlement currencies are USD.', 'http_code' => 400, 'description' => 'Paypal暂不支持以非美元付款，在设置Paypal为首选支付方式时，请将当前结算币种和次月结算币种设置为USD.'], + ['code' => 'PayNotQualified', 'message' => 'Sorry, your transaction does not meet the payment requirements. Please try using another card or payment method.', 'http_code' => 400, 'description' => '抱歉，您的交易不符合支付条件。请尝试更换其他银行卡或支付方式。'], + ['code' => 'PaySystemAccessDenied', 'message' => 'Payment channel is temporarily inaccessible. Please try again later or use another payment method. If the issue persists, please contact our customer service.', 'http_code' => 400, 'description' => '支付渠道暂时无法访问。请稍等片刻后重试，如果问题持续，请联系我们的客服团队。'], + ['code' => 'PaySystemAuthenticationFail', 'message' => 'Payment channel authentication failed. Please try again later, or try using another payment method.', 'http_code' => 400, 'description' => '支付渠道认证失败。请稍后重新尝试，或尝试更换其他支付方式。'], + ['code' => 'PaySystemAuthenticationRequired', 'message' => 'This transaction requires 3D Secure verification. Please follow the instructions on the page to complete your bank\'s 3D Secure verification.', 'http_code' => 400, 'description' => '本次交易需要进行3D安全验证。请按照页面提示完成银行的3D安全验证。'], + ['code' => 'PaySystemCardNotSupported', 'message' => 'Sorry, this card is not supported by the current payment channel. Please try using another card or payment method.', 'http_code' => 400, 'description' => '抱歉，当前支付渠道不支持此银行卡。请尝试更换其他银行卡或支付方式。'], + ['code' => 'PaySystemOrderIsClosed', 'message' => 'This transaction order has been closed or is no longer valid. Please initiate a new transaction. If the order was paid, please contact customer service for verification.', 'http_code' => 400, 'description' => '本次交易订单已关闭或已失效。请重新发起交易。如果订单已支付，请联系客服核实。'], + ['code' => 'PaySystemOTPVerifyTimesExceedLimit', 'message' => 'Too many incorrect verification code attempts. Please wait for a while before trying to get a new code, or try another verification method with your bank.', 'http_code' => 400, 'description' => '验证码错误次数过多。请等待一段时间后再尝试获取验证码，或尝试联系银行进行其他验证。'], + ['code' => 'PaySystemOTPVerifyUnmatched', 'message' => 'Your bank card has expired. Please use another card that is not expired for payment.', 'http_code' => 400, 'description' => '您的银行卡已过期。请使用尚未过期的银行卡进行支付。'], + ['code' => 'PaySystemSuspectedCard', 'message' => 'Your bank card has an issue. Please contact your issuing bank to inquire about its status and any abnormalities.', 'http_code' => 400, 'description' => '您的银行卡存在异常。请联系您的发卡银行，咨询银行卡状态和是否存在异常。'], + ['code' => 'PaySystemUserPaymentVerificationFailed', 'message' => 'Your payment information failed verification. Please check if your payment details (e.g., password, fingerprint, OTP) are correct, or contact the payment channel\'s customer service.', 'http_code' => 400, 'description' => '您的支付信息未能通过验证。请检查您的支付信息（如密码、指纹、动态口令等）是否正确，或联系支付渠道客服。'], + ['code' => 'PaySystemUserStatusAbnormal', 'message' => 'Your account status is abnormal, unable to complete this transaction. Please contact customer service to inquire about your account status.', 'http_code' => 400, 'description' => '您的账户状态异常，无法完成本次交易。请联系客服查询您的账户状态。'], + ['code' => 'PaySystemVerificationInProcess', 'message' => 'Verification code is being processed. Please wait patiently for the result and do not repeat the operation. If there is no response for a long time, please contact customer service.', 'http_code' => 400, 'description' => '验证码正在验证中，请耐心等待结果，切勿重复操作。如果长时间无响应，请联系客服。'], + ['code' => 'PAY_QUERY_ORDER_EMPTY_RESULT', 'message' => 'Query order is empty, please check order parameters.', 'http_code' => 501, 'description' => '查询订单为空'], + ['code' => 'PAY_QUERY_ORDER_ERROR', 'message' => 'Query Order Exception.', 'http_code' => 502, 'description' => '查询订单异常'], + ['code' => 'PAY_SYSTEM_EXCEPTION', 'message' => 'Internal system error occurred, please contact technical support.', 'http_code' => 500, 'description' => '系统异常'], + ['code' => 'QueryConnectedRelationListInfoError', 'message' => 'Query information of Party A\'s associated entity list is abnormal, please try again later.', 'http_code' => 400, 'description' => '查询甲方关联实体列表信息异常，请稍后重试'], + ['code' => 'QueryContractTaskInfoError', 'message' => 'Query contract task information is abnormal, please try again later.', 'http_code' => 400, 'description' => '查询合同任务信息异常，请稍后重试'], + ['code' => 'QueryCountExceedLimit', 'message' => 'The count of queries exceeds the daily query limit.', 'http_code' => 400, 'description' => '查询次数超过每天的次数限制'], + ['code' => 'QueryInvioceListInfoError', 'message' => 'Invoice header list query information is abnormal, please try again later.', 'http_code' => 400, 'description' => '查询发票抬头列表信息异常，请稍后重试'], + ['code' => 'QueryInvioceListInfoFail', 'message' => 'Failed to query invoice header list information, please try again later.', 'http_code' => 400, 'description' => '查询发票抬头列表信息失败，请稍后重试'], + ['code' => 'QueryInvoiceInfoError', 'message' => 'Exception in querying invoice information. Please try again later.', 'http_code' => 400, 'description' => '查询发票信息异常，请稍后重试'], + ['code' => 'QueryInvoiceInfoFail', 'message' => 'Failed to query invoice information.', 'http_code' => 400, 'description' => '查询发票信息失败'], + ['code' => 'QueryPartyaInfoError', 'message' => 'Party A entity name query is abnormal, please try again later.', 'http_code' => 400, 'description' => '查询甲方主体名称异常，请稍后重试'], + ['code' => 'RC_3TH_LOGISTICS_DETAIL_REQUEST', 'message' => 'Failed to query the details of the third party logistics node.', 'http_code' => 509, 'description' => '查询第三方物流节点详情失败'], + ['code' => 'RC_GET_USER_ERROR', 'message' => 'Failed to obtain the group account HavanaId required for order query.', 'http_code' => 508, 'description' => '获取订单查询需要的集团账号HavanaId失败'], + ['code' => 'RC_ORDER_CONFIRM_FAIL', 'message' => 'Confirm receipt failed.', 'http_code' => 505, 'description' => '确认收货失败'], + ['code' => 'RC_ORDER_DETAIL_FAIL', 'message' => 'Failed to query order details.', 'http_code' => 503, 'description' => '查询订单详情失败'], + ['code' => 'RC_ORDER_LIST_FAIL', 'message' => 'Failed to query order list.', 'http_code' => 502, 'description' => '查询订单列表失败'], + ['code' => 'RC_ORDER_LOGISTICS_FAIL', 'message' => 'No logistics information.', 'http_code' => 504, 'description' => '暂无物流信息'], + ['code' => 'RC_ORDER_LOGISTICS_OVERVIEW_FAIL', 'message' => 'Failed to query logistics overview information.', 'http_code' => 510, 'description' => '查询物流概览信息失败 '], + ['code' => 'RC_PAGE_SIZE_MAX_LIMIT_REQUEST', 'message' => 'PageSize parameter setting is too large.', 'http_code' => 507, 'description' => '分页参数设置过大'], + ['code' => 'RC_PARAM_IS_EMPTY', 'message' => 'Required field values in request parameters cannot be empty.', 'http_code' => 501, 'description' => '请求参数中必要字段取值不能为空'], + ['code' => 'RC_QUERY_OPEN_BY_SYSTEM_ORDER', 'message' => 'Post-paid commodity for service, the system automatically orders and opens. This kind of order does not support customer inquiry.', 'http_code' => 514, 'description' => '针对免开通后付费商品，系统自动下单开通。此类订单不支持对客查询。'], + ['code' => 'RC_REFUND_QUOTA_EXCEED', 'message' => 'Exceeding the limit.', 'http_code' => 523, 'description' => '抱歉，已经超出本月可退订的总额度'], + ['code' => 'RC_SYSTEM_ERROR', 'message' => 'An error occurred in the internal server.', 'http_code' => 500, 'description' => '系统异常，请重试'], + ['code' => 'RC_TIME_OUT', 'message' => 'The system timed out, the query data may be too much, please shorten the time range or select a specific product and re-query.', 'http_code' => 513, 'description' => '系统超时，查询数据可能过多，请缩短时间范围或选择特定产品后重新查询'], + ['code' => 'RC_UNKNOWN_ERROR', 'message' => 'Unknown error.', 'http_code' => 511, 'description' => '未知错误'], + ['code' => 'RealNameAuthenticationNotCompleted', 'message' => 'real-name authentication is not completed.', 'http_code' => 400, 'description' => '未完成实名认证'], + ['code' => 'RealNameAuthenticationTypeUnsupported', 'message' => 'The system only supports individual users authenticated by ID number and enterprise users authenticated by social unified credit code.', 'http_code' => 400, 'description' => '系统只支持以身份证号认证的个人用户和以社会统一信用代码认证的企业用户，请更新认证后重试。'], + ['code' => 'RejectContractError', 'message' => 'Refusal of contract failed.', 'http_code' => 400, 'description' => '拒绝合同失败'], + ['code' => 'RejectVipContractError', 'message' => 'Refusal of major client contract failed.', 'http_code' => 400, 'description' => '拒绝大客户合同失败'], + ['code' => 'RejectWanWangContractError', 'message' => 'Refusal of the World Wide Web contract failed.', 'http_code' => 400, 'description' => '拒绝万网合同失败'], + ['code' => 'RelationOrderDataError', 'message' => 'Abnormal contract related billing data.', 'http_code' => 400, 'description' => '合同关联订账单数据异常'], + ['code' => 'RequestCountExceedBankLimit', 'message' => 'The number of requests has exceeded the limit of the issuer bank. Please try again later.', 'http_code' => 400, 'description' => '请求数量超过发卡行限制，请稍后再试'], + ['code' => 'RequestTimeout', 'message' => 'Request timed out. Please try again later.', 'http_code' => 400, 'description' => '请求超时，请稍后再试'], + ['code' => 'ResourceCreatingNotAllowWithdraw', 'message' => 'The resource you purchased is being created and cannot withdraw during this period.', 'http_code' => 400, 'description' => '您购买的资源正在创建中，期间不可进行余额提现，请稍后重试'], + ['code' => 'ResourceNotExists', 'message' => 'The specified resource does not exist.', 'http_code' => 400, 'description' => '资源实例不存在'], + ['code' => 'RiskReject', 'message' => 'The request rejected by risk control.', 'http_code' => 400, 'description' => '请求被风控拒绝'], + ['code' => 'RiskReject', 'message' => 'The card poses a security risk. Try a different card or submit a ticket.', 'http_code' => 400, 'description' => '该银行卡存在安全风险，请更换其他银行卡重试或提交工单.'], + ['code' => 'RiskSystemRejected', 'message' => 'This transaction has been rejected by the risk control system due to potential risk. If you have questions, please contact our customer service team.', 'http_code' => 400, 'description' => '交易存在风险，已被系统拒绝。如有疑问，请联系我们的客服团队了解具体的风控拒绝原因。'], + ['code' => 'SameAccountTransfer', 'message' => 'Target account is identical to source account, transfer operation is not allowed.', 'http_code' => 400, 'description' => '目标账户与当前账户为同一账户，无法过户，请更换目标账户'], + ['code' => 'SameLicenseNoError', 'message' => 'The identification numbers of Party B and Party C in the payment agreement cannot be the same.', 'http_code' => 400, 'description' => '代付协议乙方和丙方的识别号不能相同'], + ['code' => 'SameName', 'message' => 'The specified name already exists.', 'http_code' => 400, 'description' => '名称已存在'], + ['code' => 'SAME_NAME', 'message' => 'The specified name already exists.', 'http_code' => 400, 'description' => '名称已存在'], + ['code' => 'SettleBillBeingWrittenOff', 'message' => 'Settle bill is being written off.', 'http_code' => 400, 'description' => '账单正在核销中，请稍后重试'], + ['code' => 'SettleTaskCloseError', 'message' => 'close unified settlement task error.', 'http_code' => 400, 'description' => '结算任务关闭失败, 请刷新页面后重试'], + ['code' => 'SettleTaskDeleteError', 'message' => 'delete unified settlement task error.', 'http_code' => 400, 'description' => '结算任务删除失败，请刷新页面后重试'], + ['code' => 'SettleTaskPauseError', 'message' => 'pause unified settlement task error.', 'http_code' => 400, 'description' => '结算任务暂停失败，请刷新页面后重试'], + ['code' => 'SettleTaskRestartError', 'message' => 'restart unified settlement task error.', 'http_code' => 400, 'description' => '结算任务重启失败，请刷新页面后重试'], + ['code' => 'SettleTaskSaveError', 'message' => 'Failed to save settlement task.', 'http_code' => 400, 'description' => '结算任务保存失败'], + ['code' => 'SettleTaskStopError', 'message' => 'stop unified settlement task error.', 'http_code' => 400, 'description' => '结算任务停止失败，请刷新页面后重试'], + ['code' => 'SettleTitleDup', 'message' => 'Duplicate unified settlement title.', 'http_code' => 400, 'description' => '统一结算标题重复'], + ['code' => 'SettleTitleTooLong', 'message' => 'Unified settlement document title is too long.', 'http_code' => 400, 'description' => '统一结算单标题超长，请控制标题长度在200个字符以下'], + ['code' => 'SpecifiedWriteoffCycleConflict', 'message' => 'Specified writeoff cycle conflict.', 'http_code' => 400, 'description' => '该账期上一笔指定核销尚未完成，请稍后再试'], + ['code' => 'SPN_INSTANCE_HAS_SHARED', 'message' => 'Savings plan instance has shared.', 'http_code' => 400, 'description' => '节省计划实例设置了共享，不能再设置抵扣标签'], + ['code' => 'SubAccountNoQueryPricePermission', 'message' => '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.', 'http_code' => 400, 'description' => '由于您没有折扣查询权限，无法访问该页面。请联系主账号前往RAM控制台授权，需要授权的Action为 bss:QueryPrice'], + ['code' => 'SystemBusyError', 'message' => 'System is busy now, please retry later.', 'http_code' => 400, 'description' => '系统繁忙，请稍后再试'], + ['code' => 'SystemError', 'message' => 'Internal system error occurred, please try again or contact technical support.', 'http_code' => 400, 'description' => '系统异常，请稍后重试或联系技术支持.'], + ['code' => 'TaskAlreadyExist', 'message' => 'The task already exists.', 'http_code' => 400, 'description' => '该任务已经存在'], + ['code' => 'TASK_EXIST', 'message' => 'task has already exist.', 'http_code' => 400, 'description' => '该表已存在,不可重复订阅'], + ['code' => 'TaxInfoStatusNotAllowUpdate', 'message' => 'Tax information cannot be modified in the current tax qualification status.', 'http_code' => 400, 'description' => '当前税务资质状态不允许修改税务信息。'], + ['code' => 'TaxInfoTaxNumberInvalid', 'message' => 'VAT No is not valid.', 'http_code' => 400, 'description' => '税号格式不合法。'], + ['code' => 'TransferFailed', 'message' => 'Transfer operation failed due to processing error, please try again.', 'http_code' => 400, 'description' => '过户失败'], + ['code' => 'TransferForbiddenWithoutCashBookPaymentMethod', 'message' => 'Non-credit users cannot use account balance. Please contact the business manager to apply for credit limit first.', 'http_code' => 400, 'description' => '非信控用户不可以使用账户余额，请先联系商务经理申请信控。'], + ['code' => 'UnconfirmedContractError', 'message' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', 'http_code' => 400, 'description' => '您操作的账户存在待确认的信控合同，请先确认合同。'], + ['code' => 'UniqueAgentLimit', 'message' => 'The valid agent already exists.', 'http_code' => 400, 'description' => '被委托方已存在，请更换被委托方后重新创建"'], + ['code' => 'UniqueIdNotValid', 'message' => 'The card binding request has expired. Please refresh and try again.', 'http_code' => 400, 'description' => '绑卡请求已失效，请刷新页面后重试.'], + ['code' => 'UnpayAmountNotEnough', 'message' => 'Unpay amount not enough.', 'http_code' => 400, 'description' => '账单正在核销中，您支付的金额大于剩余待核销金额，请勿重复支付!'], + ['code' => 'UNPAY_AMOUNT_NOT_ENOUGH', 'message' => 'unpay amount not enough.', 'http_code' => 400, 'description' => '账单正在核销中，您支付的金额大于剩余待核销金额，请勿重复支付!'], + ['code' => 'UpdateContractMemoError', 'message' => 'Error in modifying contract remarks.', 'http_code' => 400, 'description' => '修改合同备注错误'], + ['code' => 'UserAccountInfoEmptyError', 'message' => 'AliyunId cannot be empty.', 'http_code' => 400, 'description' => 'aliyunId不能为空'], + ['code' => 'UserIdInvalidError', 'message' => 'User not found.', 'http_code' => 400, 'description' => '没有找到用户'], + ['code' => 'UserInfoEmptyError', 'message' => 'UserId cannot be empty.', 'http_code' => 400, 'description' => 'userId不能为空'], + ['code' => 'UserInfoError', 'message' => 'User information provided is incomplete or contains invalid data.', 'http_code' => 400, 'description' => '用户信息有误'], + ['code' => 'UsernameUidMismatch', 'message' => 'The entered UID and account name do not match, please verify and re-enter.', 'http_code' => 400, 'description' => '您输入的接收UID和账号不匹配，请输入正确的账号信息'], + ['code' => 'ValidAuth', 'message' => 'Valid auth check failed.', 'http_code' => 200, 'description' => '权限验证不通过'], + ['code' => 'VericationTimeExceedLimit', 'message' => 'Verification times exceeds limit, please try a different card.', 'http_code' => 400, 'description' => '验证次数超过限制， 请换卡重试'], + ['code' => 'WithdrawAmountExceedLimit', 'message' => 'Withdraw amount exceeds limit.', 'http_code' => 400, 'description' => '提现金额超过限制'], + ['code' => 'InvoiceApplySpecialTitleOnlyForCommon', 'message' => 'The invoice title is the general ticket title of the special process application, and the special invoice cannot be issued.', 'http_code' => 400, 'description' => '该发票抬头为特殊流程申请的普票抬头，不支持开具专用发票'], + ['code' => 'EnterpriseInvoiceTitleApplyOnlyForPersonal', 'message' => 'The application process is limited to personal real-name authentication users.', 'http_code' => 400, 'description' => '该申请流程仅限个人实名认证用户使用'], + ['code' => 'EnterpriseInvoiceTitleApplyAlreadyExist', 'message' => 'Invoice title data already exists in the application.', 'http_code' => 400, 'description' => '已存在申请中的抬头数据'], + ['code' => 'InvoiceTitleRegisterNoIsEmpty', 'message' => 'Unified Social Credit Code cannot be empty.', 'http_code' => 400, 'description' => '统一社会信用代码不能为空'], + ['code' => 'RC_NO_REFUND_REMAIN_CHOSEN', 'message' => 'No refund resources selected.', 'http_code' => 502, 'description' => '没有选择退款资源'], + ['code' => 'RC_NOREASON_REFUND_RESPONSE_INVALID', 'message' => 'Only one instance is allowed to be returned if there is no reason to unsubscribe at a time for five days.', 'http_code' => 514, 'description' => '五天无理由一次退订只允许退一个实例'], + ['code' => 'RC_INVALID_INSTANCE', 'message' => 'The instance you selected to unsubscribe is invalid, please return to the unsubscribe list page to refresh and try again.', 'http_code' => 504, 'description' => '你选择退订的实例不合法，请返回退订列表页刷新重试'], + ['code' => 'RC_QUERY_RESOURCE_ERROR', 'message' => 'Failed to obtain unsubscribe resource information.', 'http_code' => 509, 'description' => '获取退订资源信息失败'], + ['code' => 'RC_INVALID_RENEW_INSTANCE', 'message' => 'The instance unsubscription period you selected is invalid, please return to the unsubscription list page to refresh and try again.', 'http_code' => 506, 'description' => '你选择的实例退订周期不合法，请返回退订列表页刷新重试'], + ['code' => 'RC_SERVICE_TIMEOUT', 'message' => 'Service call timed out, try to reduce the number of queries and retry.', 'http_code' => 522, 'description' => '服务调用超时，尝试减少查询数量后重试'], + ['code' => 'RISK_REJECT_RR321', 'message' => 'The request rejected by risk control.', 'http_code' => 400, 'description' => '请求被风控拒绝'], + ['code' => 'NOT_ALLOW_CANCEL_TRUSTSHIP', 'message' => 'Only supports setting to trusteeship.', 'http_code' => 400, 'description' => '仅支持设置为停机托管'], + ['code' => 'PayChannelPolicy', 'message' => 'The transaction is restricted by policy.', 'http_code' => 400, 'description' => '政策限制'], + ['code' => 'PayChannelStolenCard', 'message' => 'The card has been reported as stolen (fraud account).', 'http_code' => 400, 'description' => '被盗卡（欺诈账户）'], + ['code' => 'PayChannelFraudReject', 'message' => 'The transaction was rejected due to risk control.', 'http_code' => 400, 'description' => '由于风险控制，交易无法进一步处理款'], + ['code' => 'PayChannelBlockedByCardholder', 'message' => 'The card has been locked by the cardholder.', 'http_code' => 400, 'description' => '该卡被用户锁定'], + ['code' => 'PayChannelSellerAccountRestricted', 'message' => 'The seller\'s channel account is restricted.', 'http_code' => 400, 'description' => '卖家渠道账户受限'], + ['code' => 'PayChannelSelectedCardBrandNotAvailable', 'message' => 'The selected card brand is not available.', 'http_code' => 400, 'description' => '用户选择的支付银行卡品牌不可用'], + ['code' => 'PayChannelRestrictedCard', 'message' => 'The issuing bank has restricted the usage scope of the card.', 'http_code' => 400, 'description' => '发卡行限制了该卡的使用范围'], + ['code' => 'PayChannelPayOrderInvalidStatus', 'message' => 'The payment order status in the payment channel is invalid.', 'http_code' => 400, 'description' => '支付渠道支付订单状态非法'], + ['code' => 'PayChannelUserKycNotQualified', 'message' => 'Payment failed due to the user\'s KYC status.', 'http_code' => 400, 'description' => '由于用户的 KYC 状态，支付失败'], + ['code' => 'PayChannelReEnterTransaction', 'message' => 'The transaction cannot be processed temporarily.', 'http_code' => 400, 'description' => '交易暂时无法处理'], + ['code' => 'PayChannelCannotVerifyPin', 'message' => 'Unable to verify the PIN.', 'http_code' => 400, 'description' => '无法验证 PIN 码'], + ['code' => 'PayChannelInvalidIssuer', 'message' => 'Unable to contact the cardholder\'s issuing bank for authorization.', 'http_code' => 400, 'description' => '无法联系持卡人的发卡行进行交易授权'], + ['code' => 'PayChannelVerifyTimesExceedLimit', 'message' => 'Too many failed verification attempts for the current code.', 'http_code' => 400, 'description' => '当前验证码在支付验证中失败次数过多'], + ['code' => 'PayChannelOrderAlreadyPaid', 'message' => 'The order has already been paid in the payment channel.', 'http_code' => 400, 'description' => '支付渠道已经支付成功'], + ['code' => 'PayChannelIdentityVerifyFailed', 'message' => 'Identity verification timed out or failed to obtain results.', 'http_code' => 400, 'description' => '身份验证超时或无法获取结果'], + ['code' => 'PayChannelPinRequired', 'message' => 'A PIN is required to process the transaction but was not provided.', 'http_code' => 400, 'description' => '处理交易必须提供 PIN 码，但持卡人未提供'], + ['code' => 'PayChannelUserPaymentVerificationFailed', 'message' => 'The user failed payment verification such as OTP or PIN.', 'http_code' => 400, 'description' => '用户在 OTP、PIN 等验证方式中未能通过支付验证'], + ['code' => 'PayChannelBlockedFirstUsed', 'message' => 'The card may be temporarily frozen due to first-use activation or special conditions.', 'http_code' => 400, 'description' => '卡片可能因以下原因被临时冻结：未激活首次使用，或受特殊条件限制（例如新卡未激活）'], + ['code' => 'PayChannelOrderStatusInvalid', 'message' => 'The order status is invalid and cannot be processed.', 'http_code' => 400, 'description' => '订单状态无效，无法继续处理'], + ['code' => 'PayChannelIdentityAgeNotEnough', 'message' => 'The user\'s age does not meet the requirement.', 'http_code' => 400, 'description' => '用户年龄未达到要求'], + ['code' => 'PayChannelLawViolation', 'message' => 'The transaction was rejected by the issuing bank.', 'http_code' => 400, 'description' => '发卡行拒绝了该交易'], + ['code' => 'PayChannelCloseFailed', 'message' => 'Failed to close the order in the payment channel.', 'http_code' => 400, 'description' => '支付渠道关单失败'], + ['code' => 'PayChannelPayOrderNotExist', 'message' => 'The payment order does not exist in the payment channel.', 'http_code' => 400, 'description' => '支付渠道支付订单不存在'], + ['code' => 'PayChannelCardNotSupported', 'message' => 'The bank card used for the transaction is not supported.', 'http_code' => 400, 'description' => '用于交易的银行卡不被支持'], + ['code' => 'PayChannelCloseInnerException', 'message' => 'Internal exception occurred while closing the order in the payment channel.', 'http_code' => 400, 'description' => '支付渠道关单内部异常'], + ['code' => 'PayChannelUserAmountExceedLimit', 'message' => 'The payment amount exceeds the user\'s payment limit.', 'http_code' => 400, 'description' => '支付金额超过了用户的支付限额'], + ['code' => 'PayChannelVerifyUnmatched', 'message' => 'The verification code is invalid.', 'http_code' => 400, 'description' => '验证码无效'], + ['code' => 'PayChannelPickupCard', 'message' => 'The issuing bank requests to retain the payment card, usually in suspected counterfeit or fraud scenarios.', 'http_code' => 400, 'description' => '发卡行要求扣留支付卡，通常出现在疑似伪卡或盗刷场景中'], + ['code' => 'PayChannelFailed', 'message' => 'The payment channel returned a failure.', 'http_code' => 400, 'description' => '支付渠道返回失败'], + ['code' => 'PayChannelBuyerAccountRestricted', 'message' => 'The buyer\'s channel account is restricted.', 'http_code' => 400, 'description' => '渠道账户受限'], + ['code' => 'PayChannelGeneralFail', 'message' => 'Unknown error occurred in the payment channel.', 'http_code' => 400, 'description' => '支付渠道未知异常'], + ['code' => 'PayChannelLostCard', 'message' => 'The card has been reported as lost (fraud account).', 'http_code' => 400, 'description' => '挂失卡（欺诈账户）'], + ['code' => 'PayChannelNoSelectedAccount', 'message' => 'The cardholder selected a non-existent account.', 'http_code' => 400, 'description' => '持卡人选择了不存在的指定账户'], + ['code' => 'PayChannelLifecycle', 'message' => 'The transaction was rejected due to invalid card data.', 'http_code' => 400, 'description' => '由于无效的卡片数据，交易被拒绝'], + ['code' => 'PayChannelInvalidIdentityStatus', 'message' => 'The identity status is abnormal.', 'http_code' => 400, 'description' => '身份状态异常'], + ['code' => 'PayChannelSystemError', 'message' => 'External payment channel system error.', 'http_code' => 400, 'description' => '外部支付渠道系统异常'], + ['code' => 'PayChannelAuthenticationRequired', 'message' => 'Payment channel requires 3D Secure authentication.', 'http_code' => 400, 'description' => '需要进行 3D Secure 验证'], + ['code' => 'PayChannelInvalidPin', 'message' => 'The provided PIN is incorrect or does not meet the requirements.', 'http_code' => 400, 'description' => '提供的 PIN 码不正确或不符合要求'], + ['code' => 'PayChannelTradeStatusError', 'message' => 'The payment channel trade status does not support this operation.', 'http_code' => 400, 'description' => '支付渠道交易状态不支持此操作'], + ['code' => 'PayChannelExpiredCode', 'message' => 'The payment code has expired.', 'http_code' => 400, 'description' => '支付码已过期'], + ['code' => 'PayChannelTransactionNotAllowedAtTerminal', 'message' => 'The transaction is not allowed at the terminal.', 'http_code' => 400, 'description' => '终端不允许该交易'], + ['code' => 'PayChannelStopRecurringPayment', 'message' => 'The cardholder has cancelled the recurring payment.', 'http_code' => 400, 'description' => '持卡人已取消复购'], + ['code' => 'InvalidCard', 'message' => 'The credit card is invalid.', 'http_code' => 400, 'description' => '您的银行卡无效。请前往支付方式管理检查并更新绑定的银行卡。'], + ['code' => 'PaymentParamIllegal', 'message' => 'The payment parameters are illegal.', 'http_code' => 400, 'description' => '支付参数有误。请检查后重试。'], + ['code' => 'ExpiredCard', 'message' => 'The credit card has expired.', 'http_code' => 400, 'description' => '您的信用卡已过期。请更换其他信用卡。'], + ['code' => 'BindCardNotExist', 'message' => 'The bindcard information was not found during payment.', 'http_code' => 400, 'description' => '绑卡信息未找到。请重新绑卡或联系客服。'], + ['code' => 'PaymentDeclinedByBank', 'message' => 'The payment was declined by the bank.', 'http_code' => 400, 'description' => '您的银行拒绝了本次交易。请联系您的银行了解原因。'], + ['code' => 'PaymentOrderStatusInvalid', 'message' => 'The payment order status returned by the channel is invalid.', 'http_code' => 400, 'description' => '支付渠道订单状态异常。请联系客服。'], + ['code' => 'AmountLimitExceed', 'message' => 'The amount exceeds the limit.', 'http_code' => 400, 'description' => '交易金额超过限额。请调整金额或联系客服。'], + ['code' => 'ThirdPartyPayerAccountStatusInvalid', 'message' => 'The third-party payer account status is invalid.', 'http_code' => 400, 'description' => '第三方资金账户状态异常。请联系客服。'], + ['code' => 'InvalidCardNumber', 'message' => 'The credit card number is invalid.', 'http_code' => 400, 'description' => '您的银行卡卡号无效。请前往支付方式管理检查并更新绑定的银行卡。'], + ['code' => 'CurrencyNotSupport', 'message' => 'The currency is not supported.', 'http_code' => 400, 'description' => '不支持当前币种交易。请更换其他币种或支付方式。'], + ['code' => 'RepeatRefundRequestInconsist', 'message' => 'The repeated refund request parameters are inconsistent.', 'http_code' => 400, 'description' => '二次退款参数不一致。请检查后重试。'], + ['code' => 'PaymentOrderNotExist', 'message' => 'The payment order does not exist in the channel.', 'http_code' => 400, 'description' => '支付渠道订单不存在。请刷新页面或重新发起交易。'], + ['code' => 'PaymentOrderIsClosed', 'message' => 'The payment order has been closed by the channel.', 'http_code' => 400, 'description' => '支付渠道订单已关闭。请刷新页面或重新发起交易。'], + ['code' => 'RefundTimeExceedLimit', 'message' => 'The refund time exceeds the maximum allowed refund period.', 'http_code' => 400, 'description' => '退款时间已超过允许范围。请联系客服。'], + ['code' => 'TradeInCaptureOrCancelNotAllowRefund', 'message' => 'Refund is not allowed when the trade is in capture or cancel status.', 'http_code' => 400, 'description' => '交易状态不允许退款。请联系客服。'], + ['code' => 'PaymentChargeback', 'message' => 'The user has initiated a chargeback.', 'http_code' => 400, 'description' => '用户已拒付本次交易。请联系客服。'], + ['code' => 'TransactionTypeNotPermitted', 'message' => 'The credit card does not support this transaction type.', 'http_code' => 400, 'description' => '您的信用卡不支持该交易类型。请更换其他信用卡或支付方式。'], + ['code' => 'InvalidAmount', 'message' => 'The amount is invalid.', 'http_code' => 400, 'description' => '金额无效。请检查后重试。'], + ['code' => 'RecurringPaymentForbidden', 'message' => 'The user has forbidden recurring payments.', 'http_code' => 400, 'description' => '您已禁止代扣功能。请联系客服。'], + ['code' => 'RefundAmountExceedLimit', 'message' => 'The cumulative refund amount exceeds the payment order amount.', 'http_code' => 400, 'description' => '退款金额超过支付单总金额。请检查退款金额。'], + ['code' => 'BillingAgreementCancelled', 'message' => 'The billing agreement has been cancelled.', 'http_code' => 400, 'description' => '代扣协议已取消。请联系客服。'], + ['code' => 'RequestTrafficExceedLimit', 'message' => 'The request traffic exceeds the channel rate limit.', 'http_code' => 400, 'description' => '支付渠道请求频繁，请稍后再试。'], + ['code' => 'ExpiryDateWrong', 'message' => 'The credit card expiry date is wrong.', 'http_code' => 400, 'description' => '信用卡过期日期错误。请检查后重试。'], + ['code' => 'PaymentOrderFrozen', 'message' => 'The payment order has been frozen by the channel.', 'http_code' => 400, 'description' => '支付渠道订单已冻结。请联系客服。'], + ['code' => 'BillingAgreementIllegal', 'message' => 'The billing agreement status is illegal.', 'http_code' => 400, 'description' => '代扣协议状态异常。请联系客服。'], + ['code' => 'Cvv2Declined', 'message' => 'The credit card CVV2 is invalid.', 'http_code' => 400, 'description' => '您输入的CVV2无效。请检查后重试。'], + ['code' => 'AgreementNotExist', 'message' => 'The billing agreement does not exist.', 'http_code' => 400, 'description' => '代扣协议不存在。请联系客服。'], + ['code' => 'COUPON_NOT_FOUND', 'message' => 'No claimable SLA coupons.', 'http_code' => 400, 'description' => '无可申领的SLA优惠券'], + ['code' => 'CouponNotFound', 'message' => 'No claimable SLA coupons.', 'http_code' => 400, 'description' => '无可申领的SLA优惠券'], + ['code' => 'InvoiceTitleNotExistSubSite', 'message' => 'There is currently no valid invoice title, please add a title before submitting the application.', 'http_code' => 400, 'description' => '当前无有效发票抬头，请新增抬头后再提交申请'], + ['code' => 'InvoiceCnApiNotSupportInIntlSite', 'message' => 'Domestic station interface, not callable in international environment.', 'http_code' => 400, 'description' => '国内站接口，不可在国际环境调用'], + ['code' => 'InvoiceIntlApiNotSupportInCnSite', 'message' => 'International station interface, cannot be called in domestic environment.', 'http_code' => 400, 'description' => '国际站接口，不可在国内环境调用'], + ['code' => 'InvoiceApplyAmountNotEnough', 'message' => 'The current invoiced amount exceeds the total invoiced amount, please check the order again.', 'http_code' => 400, 'description' => '当前开票金额超过总可开票金额，请重新勾选订单'], + ['code' => 'InvoiceApplyAmountNotEnoughSubSite', 'message' => 'The currently submitted invoicing amount exceeds the total invoicing amount, please check again.', 'http_code' => 400, 'description' => '当前提交的开票金额超过总可开票金额，请重新勾选'], + ['code' => 'SUBSCRIPTION_0001', 'message' => 'invalid param.', 'http_code' => 400, 'description' => '参数错误'], + ['code' => 'SUBSCRIPTION_0007', 'message' => 'Limited to once per hour.', 'http_code' => 400, 'description' => '每小时仅允许操作一次。如需再次修改，请下个小时重试.'], + ['code' => 'MultiAccountQueryNotSupported', 'message' => 'The historical month dimension summary does not support multi-account query.', 'http_code' => 400, 'description' => ' "按产品/按账号"维度下，该月份仅支持单账号查看。切换其他维度可查看多账号，或通过导出获取。'], + ['code' => 'LimitedOperation', 'message' => 'Limited to once per hour.', 'http_code' => 400, 'description' => '每小时仅允许操作一次。如需再次修改，请下个小时重试.'], + ['code' => 'F-10000-16-00609', 'message' => 'Subscription not exist.', 'http_code' => 405, 'description' => '订阅不存在'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateInstance'], ], - '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.', - ], - ], + 'createdAt' => '2024-12-03T10:49:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QuerySavingsPlansDiscount'], + ['description' => '请求参数发生变更', 'api' => 'QuerySavingsPlansInstance'], ], - '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' => ' ', + 'createdAt' => '2024-08-20T06:32:36.000Z', + 'description' => '', ], - 'CancelOrder' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetOrderDetail'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-07-10T08:53:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryAccountBalance'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-06-25T02:13:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'SubscribeBillToOSS'], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'OrderId', - 'in' => 'query', - 'schema' => [ - 'description' => '订单号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '73465432785', - ], - ], + 'createdAt' => '2024-06-19T12:39:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QueryCostUnitResource'], ], - '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', - ], - ], - ], - ], - ], - ], + 'createdAt' => '2024-06-19T07:38:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeSplitItemBill'], ], - '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' => ' ', + 'createdAt' => '2024-06-18T13:01:33.000Z', + 'description' => '', ], - 'CreateCostUnit' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryAvailableInstances'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-05-13T07:34:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'GetPayAsYouGoPrice'], + ['description' => '错误码发生变更', 'api' => 'GetSubscriptionPrice'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-04-23T12:28:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CreateResourcePackage'], + ['description' => '响应参数发生变更', 'api' => 'DescribeResourcePackageProduct'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', + 'createdAt' => '2024-04-19T03:46:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateAgAccount'], ], - '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, - ], - ], + 'createdAt' => '2024-04-17T11:59:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryBill'], + ['description' => '错误码发生变更', 'api' => 'QueryBillOverview'], + ['description' => '错误码发生变更', 'api' => 'QueryInstanceBill'], ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2024-03-28T11:11:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetOrderDetail'], ], - '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' => ' ', + 'createdAt' => '2024-03-14T11:48:31.000Z', + 'description' => '', ], - 'AllocateCostUnitResource' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'SetRenewal'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-01-25T01:36:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeInstanceBill'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-12-13T02:06:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'QueryAccountBalance'], ], - '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, - ], - ], + 'createdAt' => '2023-12-12T01:50:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansDeductLog'], ], - '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', - ], - ], - ], - ], - ], - ], + 'createdAt' => '2023-12-07T07:38:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeSplitItemBill'], ], - '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' => ' ', + 'createdAt' => '2023-11-21T10:03:28.000Z', + 'description' => '', ], - 'DeleteCostUnit' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryAccountBill'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-11-21T10:03:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeSavingsPlansCoverageDetail'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-10-13T09:15:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryCommodityList'], + ['description' => '请求参数发生变更', 'api' => 'QueryPriceEntityList'], + ['description' => '请求参数发生变更', 'api' => 'QuerySkuPriceList'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', + 'createdAt' => '2023-09-04T08:20:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateInstance'], ], - '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', - ], - ], + 'createdAt' => '2023-08-22T07:26:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryRedeem'], ], - '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', - ], - ], - ], - ], - ], - ], + 'createdAt' => '2023-08-08T08:23:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'QueryRedeem'], ], - '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' => ' ', + 'createdAt' => '2023-08-08T03:59:01.000Z', + 'description' => '', ], - 'ModifyCostUnit' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansInstance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-07-24T02:24:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QueryCashCoupons'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-07-19T02:27:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpgradeResourcePackage'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2023-06-21T08:17:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansDiscount'], + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansInstance'], ], - '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, - ], - ], + 'createdAt' => '2023-05-25T08:40:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateSavingsPlansInstance'], + ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'QuerySavingsPlansInstance'], ], - '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', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2023-03-27T09:27:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QueryResellerUserAlarmThreshold'], ], - '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' => ' ', + 'createdAt' => '2023-03-24T08:23:05.000Z', + 'description' => '', ], - 'QueryCostUnit' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ['description' => '响应参数发生变更', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-01-10T03:48:53.000Z', + 'description' => '成本账单openAPI，摊销视角', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'SetResellerUserStatus'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-01-05T11:57:24.000Z', + 'description' => '增加停机模式字段', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2022-12-29T06:56:59.000Z', + 'description' => '添加错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'ChangeResellerConsumeAmount'], + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'CreateResellerUserQuota'], + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'QueryResellerAvailableQuota'], + ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'SetResellerUserStatus'], ], - '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', - ], - ], + 'createdAt' => '2022-12-29T03:08:31.000Z', + 'description' => '新增错误码', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'GetCustomerAccountInfo'], + ['description' => '错误码发生变更', 'api' => 'GetCustomerList'], ], - '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' => ' ', + 'createdAt' => '2022-12-26T12:12:37.000Z', + 'description' => '更新api可用性', ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryInstanceGaapCost'], ], - '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' => ' ', + 'createdAt' => '2022-12-26T11:27:34.000Z', + 'description' => '添加错误码', ], - '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.', - ], - ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryInstanceGaapCost'], ], - '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' => ' ', + 'createdAt' => '2022-12-26T10:55:47.000Z', + 'description' => '取消默认错误码', ], - '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`', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ConvertChargeType'], ], - '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列表', + 'createdAt' => '2022-12-26T09:54:32.000Z', + 'description' => '新增错误码映射', ], - 'QueryCommodityList' => [ - 'summary' => '该接口提供根据产品code获取商品信息列表的能力。', - 'methods' => [ - 'get', + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'InquiryPriceRefundInstance'], + ['description' => '错误码发生变更', 'api' => 'RefundInstance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-12-26T09:14:09.000Z', + 'description' => '修改对客透出的错误码，非系统错误统一透出400错误', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ['description' => '请求参数发生变更', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2022-12-23T03:13:51.000Z', + 'description' => '成本账单api发布新增必填项、新增数据校验', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], + ], + 'createdAt' => '2022-12-22T07:22:12.000Z', + 'description' => '成本账单openAPI接口，通过摊销月视角查询产品、实例摊销数据目前暂未开放用户使用', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansInstance'], + ], + 'createdAt' => '2022-12-09T01:45:05.000Z', + 'description' => '节省计划查询实例，实例数据新增周期类型字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeCostBudgetsSummary'], + ], + 'createdAt' => '2022-12-06T08:45:26.000Z', + 'description' => '预算API ，发布DescribeCostBudgetsSummary的openAPI接口', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AllocateCostUnitResource'], + ['description' => '错误码发生变更', 'api' => 'CreateCostUnit'], + ['description' => '错误码发生变更', 'api' => 'DeleteCostUnit'], + ['description' => '错误码发生变更', 'api' => 'ModifyCostUnit'], + ['description' => '错误码发生变更', 'api' => 'QueryCostUnit'], + ['description' => '错误码发生变更', 'api' => 'QueryCostUnitResource'], + ], + 'createdAt' => '2022-11-17T07:15:44.000Z', + 'description' => '后台接口版本号升级，不影响接口的正常使用。', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansDeductLog'], + ], + 'createdAt' => '2022-10-17T02:12:18.000Z', + 'description' => '节省计划抵扣流水添加抵扣实例ownerId', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'QuerySkuPriceList'], + ], + 'createdAt' => '2022-10-09T03:48:44.000Z', + 'description' => '1、增加了根据产品查询商品列表的接口2、增加了根据商品code查询商品定价对象的接口3、增加了根据商品定价对象code查询sku价格信息的接口', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryAccountTransactionDetails'], + ], + 'createdAt' => '2022-09-29T15:06:13.000Z', + 'description' => '补充API描述信息', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'SetAllExpirationDay'], + ], + 'createdAt' => '2022-09-28T07:08:13.000Z', + 'description' => '展示返回值日志', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QueryResourcePackageInstances'], + ], + 'createdAt' => '2022-09-19T02:14:50.000Z', + 'description' => '更换hsf', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryInstanceByTag'], + ['description' => '错误码发生变更', 'api' => 'QueryInstanceByTag'], + ['description' => '错误码发生变更', 'api' => 'TagResources'], + ['description' => '错误码发生变更', 'api' => 'TagResources'], + ['description' => '错误码发生变更', 'api' => 'UntagResources'], + ['description' => '错误码发生变更', 'api' => 'UntagResources'], + ], + 'createdAt' => '2022-09-15T02:56:54.000Z', + 'description' => '添加权限校验', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'UnsubscribeBillToOSS'], + ['description' => '错误码发生变更', 'api' => 'UnsubscribeBillToOSS'], + ], + 'createdAt' => '2022-09-13T02:50:59.000Z', + 'description' => '增加账单API Meta信息说明。', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'SetRenewal'], + ], + 'createdAt' => '2022-09-06T08:59:09.000Z', + 'description' => '添加返回值记录', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'DescribePricingModule'], + ['description' => '错误码发生变更', 'api' => 'QueryProductList'], + ], + 'createdAt' => '2022-07-04T03:27:28.000Z', + 'description' => 'API：QueryProductList和DescribePricingModule 的后端服务provider切换到新应用', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'QueryBillToOSSSubscription'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'SubscribeBillToOSS'], + ], + 'createdAt' => '2022-05-19T13:44:10.000Z', + 'description' => 'OSS订阅账单支持指定Bucket存储路径，新增参数BucketPath。', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ReleaseInstance'], + ], + 'createdAt' => '2022-05-11T01:19:19.000Z', + 'description' => '提供国家云虚商侧主动释放实例的管控接口', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'QueryAccountTransactions'], + ], + 'createdAt' => '2022-04-11T08:54:50.000Z', + 'description' => '查询收支明细api增加3个查询条件：交易类型、交易渠道、收支类型', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeInstanceBill'], + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeSplitItemBill'], + ], + 'createdAt' => '2022-01-18T06:42:03.000Z', + 'description' => '添加计费项code', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'AddAccountRelation'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'ConfirmRelation'], + ['description' => 'OpenAPI 下线', 'api' => 'GetAccountRelation'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'ModifyAccountRelation'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'RelieveAccountRelation'], + ], + 'createdAt' => '2021-12-15T03:36:39.000Z', + 'description' => '升级财务关联OpenAPI接口，支持按照relationId操作账号关联', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateSavingsPlansInstance'], + ], + 'createdAt' => '2021-10-26T09:04:50.000Z', + 'description' => '修改创建节省计划实例接口必填描述', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateSavingsPlansInstance'], + ], + 'createdAt' => '2021-10-26T07:30:44.000Z', + 'description' => '添加节省计划实例创建api', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'QuerySavingsPlansInstance'], + ], + 'createdAt' => '2021-09-07T10:00:07.000Z', + 'description' => '节省计划新增上一张期使用率字段', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceBill'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCommodityList'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageDetail'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InquiryPriceRefundInstance'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountTransactions'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefundInstance'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryDPUtilizationDetail'], + ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrder'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateCostUnitResource'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryResourcePackageInstances'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySkuPriceList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountRelation'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageDetail'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceCoverageDetail'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserQuota'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QuerySplitItemBill'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPriceEntityList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInvoicingCustomerList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstance'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageTotal'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAccountBalance'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountTransactionDetails'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserAlarmThreshold'], + ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCostUnit'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansDiscount'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageDetail'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansDeductLog'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgAccount'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageTotal'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCostUnit'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPrepaidCards'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRelationList'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvailableInstances'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewResourcePackage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrderDetail'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCustomerAddressList'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountBill'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCostUnit'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResellerUserQuota'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceCoverageTotal'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRedeem'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubscribeBillToOSS'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPayAsYouGoPrice'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResourcePackagePrice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyInvoice'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCostUnit'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryProductList'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnsubscribeBillToOSS'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubscriptionPrice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryResellerAvailableQuota'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserStatus'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAllExpirationDay'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCashCoupons'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryOrders'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCostUnitResource'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePricingModule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEvaluateList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResellerConsumeAmount'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourcePackageProduct'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProductAmortizedCostByConsumePeriod'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAmortizedCostByConsumePeriod'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QuerySettleBill'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSplitItemBill'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBillToOSSSubscription'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeResourcePackage'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageTotal'], + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCostBudgetsSummary'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerAccountInfo'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryInstanceBill'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBill'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRenewal'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertChargeType'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBillOverview'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryRIUtilizationDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryUserOmsData'], + ], + ], + 'ram' => [ + 'productCode' => 'BssOpenApi', + 'productName' => '阿里云交易和账单管理API', + 'ramCodes' => ['bss', 'bssapi', 'efc'], + 'ramLevel' => '操作级', + 'ramConditions' => [ + [ + 'name' => 'bssapi:ProductType', + 'schema' => ['type' => 'STRING', 'description' => '操作资源的产品类型，示例：ecs'], + ], + [ + 'name' => 'bssapi:ProductCode', + 'schema' => ['type' => 'STRING', 'description' => '操作资源的产品code，示例：ecs'], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'SetResellerUserQuota', + 'description' => '设置用户配额账本的Quota额度', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryResellerUserAlarmThreshold', + 'description' => '查询Quota额度低额预警规则', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品代码。', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + [ + 'apiName' => 'QueryInstanceGaapCost', + 'description' => '查询月费用分摊服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeGaapBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => '语言，不填时默认为zh(中文)', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英文', - 'zh' => '中文', - ], - 'example' => 'en', + ], + [ + 'apiName' => 'QueryResourcePackageInstances', + 'description' => '查询资源包实例服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateResellerUserQuota', + 'description' => '创建配额账本和消费账本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'GetSubscriptionPrice', + 'description' => '预付费产品询价服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryCashCoupons', + 'description' => '查询用户代金券信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCoupons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetRenewal', + 'description' => '设置实例自动续费服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'InquiryPriceRefundInstance', + 'description' => '退订实例询价', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:RefundQueryRemainAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'CommodityCode', - 'in' => 'query', - 'schema' => [ - 'description' => '商品code，可通过**QueryCommodityList**接口查询商品code。', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + [ + 'apiName' => 'ModifyInstance', + 'description' => '实例变更服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => '语言，不填时默认为zh(中文)', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '英文', - 'zh' => '中文', - ], - 'example' => 'en', + ], + [ + 'apiName' => 'DescribeResourcePackageProduct', + 'description' => '描述资源包产品服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'QueryCostUnitResource', + 'description' => '查询财务单元的资源', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCostUnit', + 'description' => '删除财务单元', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'bss:DeleteCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelOrder', + 'description' => '取消未支付订单服务', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:CancelOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryBillOverview', + 'description' => '账单总览查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCommodityList', + 'description' => '根据产品code查询商品信息列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'RenewResourcePackage', + 'description' => '资源包续费服务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'SetResellerUserStatus', + 'description' => '设置托管、冻结状态', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ApplyInvoice', + 'description' => '发票申请服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ApplyInvoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ModifyCostUnit', + 'description' => '修改财务单元', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryBillToOSSSubscription', + 'description' => '详单订阅查询', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeSubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', + [ + 'apiName' => 'QueryAvailableInstances', + 'description' => '实例查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型，可通过接口**QueryProductList**查询产品类型。'."\n" - .'>需要和**QueryProductList**接口返回的产品类型保持一致>', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + ], + [ + 'apiName' => 'QueryInstanceBill', + 'description' => '实例账单查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => '订阅类型。取值：'."\n" - .'- Subscription：预付费。'."\n" - .'- PayAsYouGo：后付费。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', + ], + [ + 'apiName' => 'AllocateCostUnitResource', + 'description' => '资源分配到财务单元', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:AllocateCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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（单机基础版）', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'QueryRIUtilizationDetail', + 'description' => '预留实例用量查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryRiUtilizationDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'RefundInstance', + 'description' => '退订实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:RefundBatchRemainRefund', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryAccountBill', + 'description' => '账号账单查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryAccountBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryPrepaidCards', + 'description' => '账户卡包查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescrbePrepaidCards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'QueryProductList', + 'description' => '查询产品信息', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryProductList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'QueryTotalCount', - 'in' => 'query', - 'schema' => [ - 'description' => '是否返回产品总数目，默认为false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + [ + 'apiName' => 'SubscribeBillToOSS', + 'description' => '设置OSS订阅账单文件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + ], + [ + 'apiName' => 'QueryPriceEntityList', + 'description' => '商品定价对象列表查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，最大300，默认为20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'QueryCustomerAddressList', + 'description' => '查询发票邮寄地址服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateInstance', + 'description' => '实例创建服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryDPUtilizationDetail', + 'description' => '资源包用量查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:FrDeductLogQueryRequest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeCostBudgetsSummary', + 'description' => '查询成本管理预算概要信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCostBudgetsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryBill', + 'description' => '账单查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'QueryInvoicingCustomerList', + 'description' => '发票抬头查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerInvoiceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetResourcePackagePrice', + 'description' => '资源包产品询价服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSavingsPlansUsageTotal', + 'description' => '节省计划使用率汇总', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetCustomerAccountInfo', + 'description' => '查找虚商客户账号信息', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'bss:GetCustomerAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Table', - 'in' => 'query', - 'schema' => [ - 'description' => '用量数据产品和明细信息，一般为ProductCode，不同产品存在多种计量模型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', + [ + 'apiName' => 'SetResellerUserAlarmThreshold', + 'description' => '设置Quota额度低额预警规则', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DataType', - 'in' => 'query', - 'schema' => [ - 'description' => '计量数据时间类型，参考具体产品文档描述选用。'."\n" - .'- Raw：小时。'."\n" - .'- Hour：小时。'."\n" - .'- Day：天。'."\n" - .'- Month：月。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Hour', + ], + [ + 'apiName' => 'QueryResellerAvailableQuota', + 'description' => '查询当前可用配额余额信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerAvailableQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'QuerySkuPriceList', + 'description' => '查询商品定价对象下sku列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'QueryAccountTransactions', + 'description' => '账户流水收支明细查询接口', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccountTran', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Marker', - 'in' => 'query', - 'schema' => [ - 'description' => '设定结果从NextToken之后按字母排序的第一个开始返回。默认从头返回。', - 'type' => 'string', - 'required' => false, - 'example' => 'NextToken', + ], + [ + 'apiName' => 'QueryOrders', + 'description' => '订单列表查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询每页行数，1~200，默认值100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'UnsubscribeBillToOSS', + 'description' => '取消详单订阅服务', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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"}]', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeSavingsPlansCoverageDetail', + 'description' => '节省计划覆盖率明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', + [ + 'apiName' => 'DescribeSavingsPlansUsageDetail', + 'description' => '节省计划使用率明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', + ], + ], + [ + 'apiName' => 'QueryAccountBalance', + 'description' => '查询用户账户余额信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + 'apiName' => 'QueryCostUnit', + 'description' => '查询财务单元', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'apiName' => 'RenewInstance', + 'description' => '实例续费服务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'GetPayAsYouGoPrice', + 'description' => '后付费产品询价服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ReleaseInstance', + 'description' => '释放实例', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ReleaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ChangeResellerConsumeAmount', + 'description' => '进行用户 Quota 消费抵扣', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ChangeResellerConsumeAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryUserOmsData', + 'description' => '根据传入的云产品查询相应的计量记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeUserOmsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeResourcePackage', + 'description' => '升级资源包服务', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'UnifyExpireDay', - 'in' => 'query', - 'schema' => [ - 'description' => '当前统一到期日设置只支持未过期云服务器ECS实例，已过期实例无法对齐统一到期日。设置完成后，可在续费时对齐设置的统一到期时间'."\n" - ."\n" - .'日期范围：每月1号至28号', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + [ + 'apiName' => 'DescribeSavingsPlansCoverageTotal', + 'description' => '节省计划覆盖率汇总', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'ConvertChargeType', + 'description' => '切换实例付费模式', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ConvertChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'SetAllExpirationDay', + 'description' => '设置ECS统一到期日', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RenewChangeInstance', + 'description' => '续费变配服务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'bss:RenewChangeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetCustomerList', + 'description' => '查询子账号列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribePricingModule', + 'description' => '查询产品模块信息', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'bss:DescribePricingModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'BudgetName', - 'in' => 'query', - 'schema' => [ - 'title' => '预算名称', - 'description' => '预算名称。模糊匹配', - 'type' => 'string', - 'required' => false, - 'example' => '全年预算', + [ + 'apiName' => 'CreateCostUnit', + 'description' => '创建财务单元', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'BudgetStatus', - 'in' => 'query', - 'schema' => [ - 'title' => '预算状态', - 'description' => '预算状态，枚举值：overdue（已过期）,notOverdue（未过期）。不填写则默认取全部', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'notOverdue' => 'notOverdue', - 'overdue' => 'overdue', - ], - 'example' => 'notOverdue', + ], + [ + 'apiName' => 'QueryEvaluateList', + 'description' => '待开票对象查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryEvaluate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'BudgetType', - 'in' => 'query', - 'schema' => [ - 'title' => '预算类型', - 'description' => '预算类型。枚举值：cost(费用预算), byquantity（按量编制预算）, asset（使用率及覆盖率预算）。'."\n" - .'不填写则默认取全部', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cost' => 'cost', - 'byquantity' => 'byquantity', - 'asset' => 'asset', - ], - 'example' => 'cost', + ], + [ + 'apiName' => 'GetOrderDetail', + 'description' => '订单详情查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '开始读取的位置', - 'description' => '当前调用开始读取的位置，参数值必须为空或者使用返回结果中的NextToken设值，否则会报错，空则代表从头开始读取。默认：空', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + [ + 'apiName' => 'DescribeInstanceAmortizedCostByConsumePeriod', + 'description' => '查询实例账期月摊销成本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryAccountTransactionDetails', + 'description' => '账户流水收支明细详情查询接口', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryAccountTransactionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSplitItemBill', + 'description' => '分账账单服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeSplitItemBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '为资源添加标签', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QuerySettleBill', + 'description' => '结算账单查询服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySettleBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '读取的最大数据记录数量', - 'description' => '读取的最大数据记录数量。默认值：10，最大值：10，最小值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', + ], + [ + 'apiName' => 'UntagResources', + 'description' => '取消资源的标签', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], + [ + 'apiName' => 'DescribeProductAmortizedCostByConsumePeriod', + 'description' => '查询产品账期月摊销成本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'QueryRedeem', + 'description' => '查询提货券服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRedeem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'QuerySavingsPlansInstance', + 'description' => '节省计划实例查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QuerySplitItemBill', + 'description' => '查询分账账单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySplitItemBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + [ + 'apiName' => 'DescribeResourceCoverageTotal', + 'description' => '资源覆盖率汇总', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品代码，可通过接口**QueryProductList**查询产品代码，或查看**阿里云产品Code速查手册**。', - 'type' => 'string', - 'required' => true, - 'example' => 'rds', + [ + 'apiName' => 'QuerySavingsPlansDeductLog', + 'description' => '节省计划抵扣明细查询', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDeductLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '产品类型', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + ], + [ + 'apiName' => 'DescribeResourceUsageDetail', + 'description' => '资源使用率明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-skjdhaskjdh', + ], + [ + 'apiName' => 'QuerySavingsPlansDiscount', + 'description' => '查询节省计划折扣明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDiscount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - '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, + ], + [ + 'apiName' => 'DescribeResourceCoverageDetail', + 'description' => '资源覆盖率明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。', - 'type' => 'string', - 'required' => false, - 'example' => 'JASIOFKVNVIXXXXXX', + ], + [ + 'apiName' => 'DescribeProductAmortizedCostByAmortizationPeriod', + 'description' => '查询产品摊销月摊销成本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'RenewPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => '预付费续费时长，单位：月。取值：'."\n" - .'- 1~9。'."\n" - .'- 12。'."\n" - .'- 24。'."\n" - .'- 36。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', + ], + [ + 'apiName' => 'DescribeInstanceBill', + 'description' => '查询实例账单服务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeInstanceBill', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], + [ + 'apiName' => 'QueryInstanceByTag', + 'description' => '按标签查询实例', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryInstanceByTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ResourceNotExists', - 'errorMessage' => 'The specific resource is not exists. ', + [ + 'apiName' => 'QueryPermissionList', + 'description' => '查询权限详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryPermissionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRelationList', + 'description' => '查询企业财务关系列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRelationList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], - [ - 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL ', - 'errorMessage' => 'Please complete your basic personal information first. ', + ], + ], + [ + 'apiName' => 'QueryFinancialAccountInfo', + 'description' => '查看企业财务账号信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryFinancialAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError ', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + [ + 'apiName' => 'DescribeInstanceAmortizedCostByAmortizationPeriod', + 'description' => '查询实例摊销月摊销成本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeResourceUsageTotal', + 'description' => '资源使用率汇总', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - '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', ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3