diff options
Diffstat (limited to 'data/en_us/bssopenapi/2017-12-14')
| -rw-r--r-- | data/en_us/bssopenapi/2017-12-14/api-docs.php | 29638 |
1 files changed, 11400 insertions, 18238 deletions
diff --git a/data/en_us/bssopenapi/2017-12-14/api-docs.php b/data/en_us/bssopenapi/2017-12-14/api-docs.php index 0e1ea20..bd3f03b 100644 --- a/data/en_us/bssopenapi/2017-12-14/api-docs.php +++ b/data/en_us/bssopenapi/2017-12-14/api-docs.php @@ -1,1622 +1,1240 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'BssOpenApi', - 'version' => '2017-12-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'BssOpenApi', 'version' => '2017-12-14'], 'directories' => [ [ - 'id' => 179160, - 'title' => 'Capital Flow', + 'children' => ['QueryAccountBalance', 'QueryAccountTransactionDetails'], 'type' => 'directory', - 'children' => [ - 'QueryAccountBalance', - 'QueryAccountTransactionDetails', - 'QueryAccountTransactions', - ], + 'title' => 'Fund transactions', ], [ - 'id' => 116853, - 'title' => 'Financial Association', + 'children' => ['QueryRelationList', 'QueryPermissionList', 'ModifyAccountRelation', 'ConfirmRelation', 'RelieveAccountRelation'], 'type' => 'directory', - 'children' => [ - 'QueryRelationList', - 'QueryPermissionList', - 'GetAccountRelation', - 'AddAccountRelation', - 'ModifyAccountRelation', - 'ConfirmRelation', - 'RelieveAccountRelation', - ], + 'title' => 'Account linking', ], [ - 'id' => 116859, - 'title' => 'Resource Tag', + 'children' => ['QueryInstanceByTag'], 'type' => 'directory', - 'children' => [ - 'QueryInstanceByTag', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Resource tags', ], [ - 'id' => 116863, - 'title' => 'Card Coupon', + 'children' => ['QueryPrepaidCards'], 'type' => 'directory', - 'children' => [ - 'QueryPrepaidCards', - 'QueryRedeem', - 'QueryCashCoupons', - ], + 'title' => 'Coupons and vouchers', ], [ - 'id' => 116874, - 'title' => 'Saving Plan', + 'children' => ['QuerySavingsPlansInstance', 'QuerySavingsPlansDeductLog', 'DescribeSavingsPlansUsageTotal', 'DescribeSavingsPlansUsageDetail', 'DescribeSavingsPlansCoverageTotal', 'DescribeSavingsPlansCoverageDetail', 'QuerySavingsPlansDiscount'], 'type' => 'directory', - 'children' => [ - 'QuerySavingsPlansInstance', - 'QuerySavingsPlansDeductLog', - 'DescribeSavingsPlansUsageTotal', - 'DescribeSavingsPlansUsageDetail', - 'DescribeSavingsPlansCoverageTotal', - 'DescribeSavingsPlansCoverageDetail', - 'QuerySavingsPlansDiscount', - ], + 'title' => 'Savings plans', ], [ - 'id' => 116881, - 'title' => 'Virtual Quotient Quota', + 'children' => ['CreateResellerUserQuota', 'ChangeResellerConsumeAmount', 'QueryResellerAvailableQuota', 'SetResellerUserAlarmThreshold', 'QueryResellerUserAlarmThreshold', 'SetResellerUserStatus'], 'type' => 'directory', - 'children' => [ - 'CreateResellerUserQuota', - 'SetResellerUserQuota', - 'ChangeResellerConsumeAmount', - 'QueryResellerAvailableQuota', - 'SetResellerUserAlarmThreshold', - 'QueryResellerUserAlarmThreshold', - 'SetResellerUserStatus', - ], + 'title' => 'Partner platform quotas', ], [ - 'id' => 116886, - 'title' => 'Virtual Merchant Account', + 'children' => ['CreateAgAccount', 'GetCustomerAccountInfo'], 'type' => 'directory', - 'children' => [ - 'CreateAgAccount', - 'GetCustomerAccountInfo', - 'GetCustomerList', - ], + 'title' => 'Partner platform accounts', ], [ - 'id' => 116890, - 'title' => 'Resource Package', + 'children' => ['DescribeResourceUsageTotal', 'DescribeResourceUsageDetail', 'DescribeResourceCoverageTotal', 'DescribeResourceCoverageDetail', 'GetResourcePackagePrice', 'RenewResourcePackage', 'UpgradeResourcePackage'], 'type' => 'directory', - 'children' => [ - 'QueryResourcePackageInstances', - 'QueryDPUtilizationDetail', - 'QueryRIUtilizationDetail', - 'DescribeResourceUsageTotal', - 'DescribeResourceUsageDetail', - 'DescribeResourceCoverageTotal', - 'DescribeResourceCoverageDetail', - 'DescribeResourcePackageProduct', - 'GetResourcePackagePrice', - 'RenewResourcePackage', - 'UpgradeResourcePackage', - ], + 'title' => 'Resource plans', ], [ - 'id' => 116904, - 'title' => 'Financial Bills', + 'children' => ['SubscribeBillToOSS', 'UnsubscribeBillToOSS', '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' => 'Financial bills', ], [ - 'id' => 116920, - 'title' => 'Inquiry', + 'children' => ['GetPayAsYouGoPrice', 'GetSubscriptionPrice'], 'type' => 'directory', - 'children' => [ - 'InquiryPriceRefundInstance', - 'GetPayAsYouGoPrice', - 'GetSubscriptionPrice', - ], + 'title' => 'Pricing', ], [ - 'id' => 116924, - 'title' => 'Instance', + 'children' => ['QueryAvailableInstances', 'ModifyInstance', 'ConvertChargeType'], 'type' => 'directory', - 'children' => [ - 'QueryAvailableInstances', - 'ReleaseInstance', - 'CreateInstance', - 'ModifyInstance', - 'SetRenewal', - 'ConvertChargeType', - 'RenewInstance', - 'RefundInstance', - ], + 'title' => 'Instances', ], [ - 'id' => 116931, - 'title' => 'Order', + 'children' => ['QueryOrders', 'CancelOrder'], 'type' => 'directory', - 'children' => [ - 'GetOrderDetail', - 'QueryOrders', - 'CancelOrder', - ], + 'title' => 'Orders', ], [ - 'id' => 116935, - 'title' => 'Financial Unit', + 'children' => ['CreateCostUnit', 'DeleteCostUnit', 'ModifyCostUnit', 'QueryFinancialAccountInfo'], 'type' => 'directory', - 'children' => [ - 'CreateCostUnit', - 'AllocateCostUnitResource', - 'DeleteCostUnit', - 'ModifyCostUnit', - 'QueryCostUnit', - 'QueryCostUnitResource', - 'QueryFinancialAccountInfo', - ], + 'title' => 'Financial units', ], [ - 'id' => 116943, - 'title' => 'Invoice', + 'children' => ['QueryEvaluateList', 'QueryCustomerAddressList', 'QueryInvoicingCustomerList', 'ApplyInvoice'], 'type' => 'directory', - 'children' => [ - 'QueryEvaluateList', - 'QueryCustomerAddressList', - 'QueryInvoicingCustomerList', - 'ApplyInvoice', - ], + 'title' => 'Invoices', ], [ - 'id' => 116949, - 'title' => 'Product', + 'children' => ['QuerySkuPriceList', 'QueryCommodityList', 'QueryPriceEntityList', 'DescribePricingModule', 'QueryProductList'], 'type' => 'directory', - 'children' => [ - 'QuerySkuPriceList', - 'QueryCommodityList', - 'QueryPriceEntityList', - 'DescribePricingModule', - 'QueryProductList', - ], + 'title' => 'Products', ], [ - 'id' => 169993, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'QueryUserOmsData', - 'SetAllExpirationDay', - 'DescribeCostBudgetsSummary', - 'RenewChangeInstance', + 'QueryUserOmsData', 'DescribeCostBudgetsSummary', 'RenewChangeInstance', 'AddAccountRelation', 'AllocateCostUnitResource', 'CreateInstance', 'DescribeResourcePackageProduct', 'GetAccountRelation', 'GetCustomerList', 'GetOrderDetail', 'InquiryPriceRefundInstance', 'QueryAccountTransactions', 'QueryBillToOSSSubscription', 'QueryCashCoupons', 'QueryCostUnit', 'QueryCostUnitResource', 'QueryDPUtilizationDetail', 'QueryRIUtilizationDetail', 'QueryRedeem', 'QueryResourcePackageInstances', + 'RefundInstance', 'ReleaseInstance', 'RenewInstance', 'SetAllExpirationDay', 'SetRenewal', 'SetResellerUserQuota', 'TagResources', 'UntagResources', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ - 'schemas' => [], - ], - 'apis' => [ - 'QueryAccountBalance' => [ - 'summary' => 'Queries the balance of your account.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '16176743-6DC7-4CB3-BB25-A13982D8DFAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvailableAmount' => [ - 'description' => 'The available balance of the account.'."\n", - 'type' => 'string', - 'example' => '10000.00', - ], - 'CreditAmount' => [ - 'description' => 'The credit balance of the account.'."\n", - 'type' => 'string', - 'example' => '0.00', - ], - 'MybankCreditAmount' => [ - 'description' => 'The credit line controlled by MYbank.'."\n", - 'type' => 'string', - 'example' => '0.00', - ], - 'Currency' => [ - 'description' => 'The type of the currency. Valid values:'."\n" - ."\n" - .'* CNY: Chinese Yuan'."\n" - .'* USD: US dollar'."\n" - .'* JPY: Japanese Yen'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'AvailableCashAmount' => [ - 'description' => 'The available balance in cash.'."\n", - 'type' => 'string', - 'example' => '10000.00', - ], - 'QuotaLimit' => [ - 'description' => 'The quota limit for eco customers.', - 'type' => 'string', - 'example' => '10000.00'."\n", - ], + 'schemas' => [ + 'AttributeDetailDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'description' => 'The unique code for the attribute.', 'type' => 'string', 'example' => ''], + 'Status' => ['title' => '属性状态', 'description' => 'The status of the attribute.', 'type' => 'string', 'example' => ''], + 'DefaultValue' => ['title' => '默认值', 'description' => 'The default value of the attribute.', 'type' => 'string', 'example' => ''], + 'Values' => [ + 'title' => '属性可选值列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['title' => '属性值（对应属性值定义中的identifyKey）', 'description' => 'The specific value of the attribute.', 'type' => 'string', 'example' => ''], + 'CascadingAttributeValues' => [ + 'title' => '级联属性值列表（递归结构）', + 'type' => 'array', + 'items' => ['description' => 'Details of the cascading attribute.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeDetailDTO'], + 'description' => 'A list of dependent attributes that become available when the sibling `Value` parameter is selected.', + 'example' => '', ], ], + 'description' => 'Contains a specific value for the attribute and any associated cascading attributes.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of possible values for the attribute.', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', + 'description' => 'Contains the details of an attribute.', + 'title' => '', + 'example' => '', + ], + 'AttributeInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'OperationalAttributeConfig' => ['title' => '运维属性配置', 'description' => 'Configuration for the operational attribute.', 'type' => 'string', 'example' => ''], + 'Code' => ['title' => '属性code', 'description' => 'The unique code that identifies the attribute.', 'type' => 'string', 'example' => ''], + 'Name' => ['title' => '属性名称（已翻译）', 'description' => 'The name of the attribute.', 'type' => 'string', 'example' => ''], + 'Description' => ['title' => '属性描述（已翻译）', 'description' => 'The description of the attribute.', 'type' => 'string', 'example' => ''], + 'AttributeSource' => ['title' => '属性来源', 'description' => 'The source of the attribute.', 'type' => 'string', 'example' => ''], + 'AttributeType' => ['title' => '属性类型', 'description' => 'The type of the attribute.', 'type' => 'string', 'example' => ''], + 'Unit' => ['title' => '单位', 'description' => 'The unit of the attribute value.', 'type' => 'string', 'example' => ''], + 'ValueType' => ['title' => '值类型', 'description' => 'The value type of the attribute.', 'type' => 'string', 'example' => ''], + 'OperationalAttributeType' => ['title' => '运维属性类型', 'description' => 'The type of the operational attribute.', 'type' => 'string', 'example' => ''], + 'SubAttributes' => [ + 'title' => '子属性（完整信息）', + 'type' => 'array', + 'items' => ['description' => 'A subattribute. See `AttributeInfoDTO` for details.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeInfoDTO'], + 'description' => 'A list of subattributes.', + 'example' => '', + ], + 'DescriptionAttributes' => [ + 'title' => '描述属性（基础信息）', + 'type' => 'array', + 'items' => ['description' => 'A description attribute. See `BaseAttributeInfoDTO` for details.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/BaseAttributeInfoDTO'], + 'description' => 'A list of description attributes.', + 'example' => '', + ], + 'CompositeAttributes' => [ + 'title' => '组合属性（基础信息）', + 'type' => 'array', + 'items' => ['description' => 'A composite attribute. See `BaseAttributeInfoDTO` for details.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/BaseAttributeInfoDTO'], + 'description' => 'A list of composite attributes.', + 'example' => '', + ], + 'AttributeCategories' => [ + 'title' => '属性分类', + 'type' => 'array', + 'items' => ['description' => 'The category name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of the attribute\'s categories.', + 'example' => '', ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', + 'Values' => [ + 'title' => '属性值列表', + 'type' => 'array', + 'items' => ['description' => 'A possible attribute value. See `AttributeValueInfoDTO` for details.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'A list of possible values for the attribute.', + 'example' => '', ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => ' Some parameters arte mandatoryfor this request.', + ], + 'description' => 'Details of the attribute.', + 'title' => '', + 'example' => '', + ], + 'AttributeValueInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'description' => 'The unique code for the attribute value.', 'type' => 'string', 'example' => ''], + 'IdentifyKey' => ['title' => '唯一标识', 'description' => 'The key of the associated attribute.', 'type' => 'string', 'example' => ''], + 'Description' => ['title' => '描述（已翻译）', 'description' => 'The description of the attribute value.', 'type' => 'string', 'example' => ''], + 'Value' => ['title' => '枚举值', 'description' => 'The attribute\'s programmatic value.', 'type' => 'string', 'example' => ''], + 'ValueName' => ['title' => '值名称（已翻译）', 'description' => 'The display name for the value.', 'type' => 'string', 'example' => ''], + 'Min' => ['title' => '最小值', 'description' => 'The minimum allowed value for the attribute.', 'type' => 'string', 'example' => ''], + 'Max' => ['title' => '最大值', 'description' => 'The maximum allowed value for the attribute.', 'type' => 'string', 'example' => ''], + 'Step' => ['title' => '步长', 'description' => 'The increment for numerical attributes.', 'type' => 'string', 'example' => ''], + 'DefaultValue' => ['title' => '默认值', 'description' => 'The default value for the attribute.', 'type' => 'string', 'example' => ''], + 'BoundedValue' => [ + 'title' => '上下限值', + 'type' => 'object', + 'properties' => [ + 'LowerBound' => [ + 'title' => '下限列表', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'An array of `AttributeValueInfoDTO` objects that collectively define the lower bound.', + 'example' => '', + ], + 'UpperBound' => [ + 'title' => '上限列表', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'An array of `AttributeValueInfoDTO` objects that collectively define the upper bound.', + 'example' => '', + ], + ], + 'description' => 'Defines the lower and upper bounds for the attribute value.', + 'example' => '', ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Some parametersare not valid.', + 'OperationTags' => [ + 'title' => '运营标签', + 'type' => 'array', + 'items' => ['description' => 'An operation tag.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The operation tags for this attribute value.', + 'example' => '', ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specifiedowner doesn’t belong to caller', + 'DescriptionAttributeValues' => [ + 'title' => '描述属性值', + 'type' => 'array', + 'items' => ['description' => 'An attribute value that provides additional detail.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'A list of attribute values that provide additional details about the current value.', + 'example' => '', ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'SubAttributeValues' => [ + 'title' => '子属性值', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'A single subattribute value.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'A list of possible values for a single subattribute.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A map of subattribute identifiers to a list of their possible values.', + 'example' => '', ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this action.', + ], + 'description' => 'Represents the information and metadata for a specific attribute value.', + 'title' => '', + 'example' => '', + ], + 'BaseAttributeInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'description' => 'The unique code of the attribute.', 'type' => 'string', 'example' => ''], + 'Name' => ['title' => '属性名称（已翻译）', 'description' => 'The name of the attribute.', 'type' => 'string', 'example' => ''], + 'Description' => ['title' => '属性描述（已翻译）', 'description' => 'The description of the attribute.', 'type' => 'string', 'example' => ''], + 'AttributeSource' => ['title' => '属性来源', 'description' => 'The source of the attribute.', 'type' => 'string', 'example' => ''], + 'AttributeType' => ['title' => '属性类型', 'description' => 'The type of the attribute.', 'type' => 'string', 'example' => ''], + 'Unit' => ['title' => '单位', 'description' => 'The unit of the attribute.', 'type' => 'string', 'example' => ''], + 'ValueType' => ['title' => '值类型', 'description' => 'The value type of the attribute.', 'type' => 'string', 'example' => ''], + 'OperationalAttributeType' => ['title' => '运维属性类型', 'description' => 'The operational type of the attribute.', 'type' => 'string', 'example' => ''], + 'AttributeCategories' => [ + 'title' => '属性分类', + 'type' => 'array', + 'items' => ['description' => 'A category of the attribute.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The categories of the attribute.', + 'example' => '', ], - [ - 'errorCode' => 'AuthSiteFail', - 'errorMessage' => 'auth site failed.', + 'Values' => [ + 'title' => '属性值列表', + 'type' => 'array', + 'items' => ['description' => 'Details of a specific attribute value.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AttributeValueInfoDTO'], + 'description' => 'The possible values of the attribute.', + 'example' => '', ], ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'description' => 'Basic information about an attribute.', + 'title' => '', + 'example' => '', + ], + 'SelectedComponentConfigDTO' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '部件code', 'description' => 'The unique code that identifies the component.', 'type' => 'string', 'example' => ''], + 'Tag' => ['title' => '部件唯一标识（多节点、多盘场景用）', 'description' => 'The tag associated with the component. You can use tags to categorize or filter components.', 'type' => 'string', 'example' => ''], + 'AttributeConfigs' => [ + 'title' => '属性配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundedValue' => [ + 'title' => '上下限值（上下限类型属性使用）', + 'type' => 'object', + 'properties' => [ + 'LowerBound' => [ + 'title' => '下限值', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'description' => 'The code that identifies the lower bound.', 'type' => 'string', 'example' => ''], + 'Value' => ['title' => '属性值', 'description' => 'The value of the lower bound.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The lower bound of the attribute\'s value range.', + 'example' => '', + ], + 'UpperBound' => [ + 'title' => '上限值', + 'type' => 'object', + 'properties' => [ + 'Code' => ['title' => '属性code', 'description' => 'The code that identifies the upper bound.', 'type' => 'string', 'example' => ''], + 'Value' => ['title' => '属性值', 'description' => 'The value of the upper bound.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The upper bound of the attribute\'s value range.', + 'example' => '', + ], + ], + 'description' => 'The bounded value for an attribute. Use this when an attribute\'s value must be within a specific range.', + 'example' => '', + ], + 'Code' => ['title' => '属性code', 'description' => 'The code that identifies the attribute.', 'type' => 'string', 'example' => ''], + 'Value' => ['title' => '属性值', 'description' => 'The value assigned to the attribute.', 'type' => 'string', 'example' => ''], + ], + 'description' => 'The container for the properties of an attribute configuration.', + 'title' => '', + 'example' => '', + ], + 'maxItems' => 100, + 'description' => 'A list of attribute configurations for the component.', + 'example' => '', ], ], + 'description' => 'Represents the configuration of a selected component.', + 'title' => '', + 'example' => '', ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"16176743-6DC7-4CB3-BB25-A13982D8DFAD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AvailableAmount\\": \\"10000.00\\",\\n \\"CreditAmount\\": \\"0.00\\",\\n \\"MybankCreditAmount\\": \\"0.00\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"AvailableCashAmount\\": \\"10000.00\\",\\n \\"QuotaLimit\\": \\"10000.00\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAccountBalanceResponse>\\n <Message>success</Message>\\n <RequestId>16176743-6DC7-4CB3-BB25-A13982D8DFAD</RequestId>\\n <Data>\\n <AvailableCashAmount>0.00</AvailableCashAmount>\\n <MybankCreditAmount>0.00</MybankCreditAmount>\\n <Currency>CNY</Currency>\\n <AvailableAmount>-11.19</AvailableAmount>\\n <CreditAmount>0.00</CreditAmount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryAccountBalanceResponse>","errorExample":""}]', - 'title' => 'QueryAccountBalance', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryAccountTransactionDetails' => [ - 'summary' => 'Queries the details of transactions within your account.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + ], + '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', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the transaction.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '410874027490089', - ], + 'schema' => ['description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'enterprise_group', 'title' => ''], ], [ - 'name' => 'RecordID', + 'name' => 'ParentUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the order or bill.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022120336190912', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1738376485192612', 'title' => ''], ], [ - 'name' => 'TransactionChannelSN', + 'name' => 'ChildNick', 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the transaction channel.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022112122001470591458665933', - ], + 'schema' => ['description' => 'The display name of the member. This helps clarify the scenario in which the account is used.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xxx project'."\n", 'title' => ''], ], [ - 'name' => 'CreateTimeStart', + 'name' => 'ChildUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the creation time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-20', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1512996702208737', 'title' => ''], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'RequestId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the creation time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-20', - ], + 'schema' => ['description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32324242444', 'title' => ''], ], [ - 'name' => 'TransactionType', + 'name' => 'PermissionCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the transaction.'."\n", - 'type' => 'string', + 'description' => 'The permissions that can be granted to the member. Valid values:'."\n" + ."\n" + .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" + .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" + .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" + .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" + .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" + .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" + .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n" + ."\n" + .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', + 'type' => 'array', + 'items' => ['description' => 'The permission that is granted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', 'title' => ''], 'required' => false, - 'example' => 'CHARGE', + 'example' => 'CHECK_TARGET_CONSUMPTION', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'TransactionChannel', + 'name' => 'RoleCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The transaction channel.'."\n", - 'type' => 'string', + 'description' => 'The roles that can be assigned to the member. Set the value to trusteeship.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The role that is assigned to the member in a trusteeship.'."\n" + .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', 'type' => 'string', 'required' => false, 'example' => 'trusteeship', 'title' => ''], 'required' => false, - 'example' => 'ALIPAY', + 'example' => 'trusteeship', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The token that is used for paging.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABEDSDS124DASA', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Message returned'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'Request ID'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'HostId' => ['description' => 'The IP address of the request', 'type' => 'string', 'example' => 'HostId', 'title' => ''], + 'RelationId' => ['description' => 'The ID of the financial relationship.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'RelationId', 'title' => ''], + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Message returned\\\\n\\",\\n \\"RequestId\\": \\"Request ID\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\",\\n \\"RelationId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId/>\\n<Data>\\n <HostId/>\\n</Data>\\n<Code/>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'AddAccountRelation', + 'summary' => 'Creates a financial relationship.', + 'description' => 'For more information about a financial relationship, see <props="intl">[Usage notes on the trusteeship]( https://www.alibabacloud.com/help/doc-detail/116383.html)</props>. '."\n" + ."\n" + .'If enterprise names used by the management account and a member for real-name verification are the same, you do not need to call an API operation for confirmation. Otherwise, you must call the ConfirmRelation operation for confirmation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-14T14:50:34.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'AllocateCostUnitResource' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxResults', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FromUnitUserId', 'in' => 'query', + 'schema' => ['description' => 'The user ID of the owner of the source cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '273394581313325532', 'title' => ''], + ], + [ + 'name' => 'FromUnitId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the source cost center.'."\n" + ."\n" + .'* A value of 0 indicates that the resources to be transferred have not been allocated to a cost center.'."\n" + .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ToUnitUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID of the owner of the destination cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '241021678450941490', 'title' => ''], + ], + [ + 'name' => 'ToUnitId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination cost center.'."\n" + ."\n" + .'* A value of -1 indicates that the allocated resources are changed to unallocated.'."\n" + .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '186419', 'title' => ''], + ], + [ + 'name' => 'ResourceInstanceList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'This parameter is invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'description' => 'The resource instances to be transferred.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApportionCode' => ['description' => 'The split item of the shared instance. This parameter is required only for shared instances.'."\n" + ."\n" + .'* Eight cloud services support bill splitting. The commodity codes of the eight services are oss, dcdn, snapshot, vod, cdn, live, and cbwp.'."\n" + .'* You can obtain the split item of a shared instance by calling QueryCostUnitResource operation to obtain all resource instances within a cost center.', 'type' => 'string', 'required' => false, 'example' => 'qwer1-cn-beijing', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code of the resource instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''], + 'ResourceUserId' => ['description' => 'The user ID of the resource instance owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '273394581313325532', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the resource instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou;standard', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + ], + 'required' => true, + 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The responses.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'asadadad-edafafafaasd', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '845C629F-47A7-4F46-A470-ED5047C4C250', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used for paging.'."\n", - 'type' => 'string', - 'example' => 'ASHDADS', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'MaxResults' => [ - 'description' => 'This parameter is invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'yidi', - ], - 'AccountTransactionsList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AccountTransactionsList' => [ - 'description' => 'The details of the transactions within the account.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The results returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'BillingCycle' => [ - 'description' => 'The billing cycle.'."\n", - 'type' => 'string', - 'example' => '2022-10', - ], - 'TransactionChannel' => [ - 'description' => 'The transaction channel.'."\n", - 'type' => 'string', - 'example' => 'ALIPAY', - ], - 'RecordID' => [ - 'description' => 'The ID of the order or bill.'."\n", - 'type' => 'string', - 'example' => '2022120336190912', - ], - 'Remarks' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'Amount' => [ - 'description' => 'The amount of the transaction.'."\n", - 'type' => 'string', - 'example' => '1.00', - ], - 'TransactionAccount' => [ - 'description' => 'The transaction account.'."\n", - 'type' => 'string', - 'example' => 'fortune_test@xxx.com', - ], - 'TransactionTime' => [ - 'description' => 'The time when the transaction was made.'."\n", - 'type' => 'string', - 'example' => '2022-10-01', - ], - 'TransactionType' => [ - 'description' => 'The type of the transaction. If one of the following transaction types is specified, results for the specified transaction type are returned. If the transaction type that you specified does not belong to the following transaction types, no result is returned. If the parameter is left empty, results for all transaction types are returned. Valid values:'."\n" - ."\n" - .'Payment, Withdraw, Refund, Consumption, Transfer, and Adjust.'."\n", - 'type' => 'string', - 'example' => 'Consumption', - ], - 'TransactionFlow' => [ - 'description' => 'Indicates whether the transaction is of the income type or the expenditure type. If one of the following types is specified, results for the specific type are returned. If the type that you specified for the parameter does not belong to the following types, no result is returned. If the parameter is left empty, results for transactions of the income and expenditure types are all returned. Valid values:'."\n" - ."\n" - .'Income and Expense.'."\n", - 'type' => 'string', - 'example' => 'Income', - ], - 'FundType' => [ - 'description' => 'The type of transaction payment. Valid values:'."\n" - ."\n" - .'Cash: pay for the transaction in cash. Deposit: pay for the transaction with deposit. RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank. DirectPay: directly pay for the transaction.'."\n", - 'type' => 'string', - 'example' => 'Cash', - ], - 'TransactionChannelSN' => [ - 'description' => 'The serial number of the transaction channel.'."\n", - 'type' => 'string', - 'example' => '123232434343532', - ], - 'TransactionNumber' => [ - 'description' => 'The number of the transaction.'."\n", - 'type' => 'string', - 'example' => '43342334', - ], - 'Balance' => [ - 'description' => 'The balance of the account.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], - ], + 'ToUnitUserId' => ['description' => 'The user ID of the owner of the destination cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34857693874', 'title' => ''], + 'IsSuccess' => ['description' => 'Indicates whether resources are allocated to the specified cost center. Valid values:'."\n" + ."\n" + .'* true: The resources are allocated to the specified cost center.'."\n" + .'* false: The resources fail to be allocated to the specified cost center.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ToUnitId' => ['description' => 'The ID of the destination cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32857346527', 'title' => ''], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - '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"}]', - ], - 'QueryAccountTransactions' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"845C629F-47A7-4F46-A470-ED5047C4C250\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ToUnitUserId\\": 34857693874,\\n \\"IsSuccess\\": true,\\n \\"ToUnitId\\": 32857346527\\n }\\n}","errorExample":""},{"type":"xml","example":"<AllocateCostUnitResourceResponse>\\r\\n <Data>\\r\\n <CostUnitOperate>\\r\\n <IsSuccess>true</IsSuccess>\\r\\n <ToUnitId>1245</ToUnitId>\\r\\n <ToUnitUserId>1686</ToUnitUserId>\\r\\n </CostUnitOperate>\\r\\n </Data>\\r\\n <Message>Successful!</Message>\\r\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>success</Code>\\r\\n</AllocateCostUnitResourceResponse>","errorExample":""}]', + 'title' => 'AllocateCostUnitResource', + 'summary' => 'Transfers resource instances from the source cost center to the destination cost center.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-17T06:23:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:AllocateCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ApplyInvoice' => [ + 'summary' => 'Submits an invoicing request.', + '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' => 'TransactionNumber', + 'name' => 'InvoiceAmount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the transaction.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '133314076', - ], + 'schema' => ['description' => 'The invoice amount, in cents.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'RecordID', + 'name' => 'CustomerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the order or bill.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20200302', - ], + 'schema' => ['description' => 'The invoicing customer ID. This ID corresponds to the `ID` parameter returned by the `QueryInvoicingCustomerList` operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '124132423', 'title' => ''], ], [ - 'name' => 'TransactionChannelSN', + 'name' => 'AddressId', 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the transaction channel.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12342134', - ], + 'schema' => ['description' => 'The mailing address ID. This ID corresponds to the `ID` parameter returned by the `QueryCustomerAddressList` operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '237958367', 'title' => ''], ], [ - 'name' => 'CreateTimeStart', + 'name' => 'InvoicingType', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the creation time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-05T01:46:09Z', - ], + 'schema' => ['description' => 'The invoice type. Valid values:'."\n" + ."\n" + .'- 0: special invoice'."\n" + ."\n" + .'- 1: general invoice', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'ProcessWay', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the creation time range to query. By default, the transactions in the last month are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-06T01:55:00Z', - ], + 'schema' => ['description' => 'The invoicing channel. This parameter must be set to 1. The following list describes the channel types:'."\n" + ."\n" + .'- 0: Processed by Alibaba Cloud (Not applicable to this operation)'."\n" + ."\n" + .'- 1: Processed by the tax platform', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'ApplyUserNick', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The applicant nickname. The system does not verify this value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InvoiceByAmount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value is 20.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to create an invoice for a specific amount. If you set this parameter to `true`, an invoice is created for the amount specified in the `InvoiceAmount` parameter. If you set this parameter to `false`, an invoice is created for the total amount of the items specified in the `SelectedIds` parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'TransactionType', + 'name' => 'UserRemark', + 'in' => 'query', + 'schema' => ['description' => 'The user\'s remarks.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'SelectedIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the transaction. If you specify one of the following transaction types for this parameter, the results for the specified transaction type are returned. If the transaction type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for all the following transaction types are returned by default. Valid values:'."\n" - ."\n" - .'* Payment'."\n" - .'* Withdraw'."\n" - .'* Refund'."\n" - .'* Consumption'."\n" - .'* Transfer'."\n" - .'* Adjust'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Payment', - 'enum' => [ - 'Adjust', - 'Payment', - 'Refund', - 'Withdraw', - 'Consumption', - 'Pay_Fail_Refund', - 'Transfer', - ], + 'description' => 'The IDs of the items to be invoiced. These IDs correspond to the `ID` parameter returned by the `QueryEvaluateList` operation.', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '384752367', 'title' => ''], + 'required' => true, + 'example' => '384752367', + 'maxItems' => 10000, + 'title' => '', ], ], [ - 'name' => 'TransactionFlow', + 'name' => 'emails', 'in' => 'query', + 'schema' => ['description' => 'The email addresses of the invoice recipient. To specify multiple addresses, separate them with commas (,). The value cannot exceed 200 characters.', 'type' => 'string', 'required' => false, 'example' => 'aaa@aa.com,bbb@bb.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the transaction flow. If you specify one of the following types for this parameter, the results for the specified type are returned. If the type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for the following two types are returned by default. Valid values:'."\n" - ."\n" - .'* Income'."\n" - .'* Expense'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Income', - 'enum' => [ - 'Income', - 'Expense', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'InvoiceApplyId' => ['description' => 'The ID of the invoice request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1323125534', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InvoiceApplyId\\": 1323125534\\n }\\n}","type":"json"}]', + 'title' => 'ApplyInvoice', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyInvoice'], + ], + ], + 'ramActions' => [ [ - 'name' => 'TransactionChannel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The transaction channel. If you specify one of the following transaction channels for this parameter, the results for the specified transaction channel are returned. If the transaction channel that you specify does not belong to the following transaction channels, no result is returned. If you leave this parameter empty, the results for all the following transaction channels are returned by default. Valid values:'."\n" - ."\n" - .'* AccountBalance'."\n" - .'* BankTransfer'."\n" - .'* Alipay'."\n" - .'* AntCreditPay'."\n" - .'* OfflineRemittance'."\n" - .'* RegularBankCreditRefund'."\n" - .'* CreditCard'."\n" - .'* MyBankCredit'."\n" - .'* HuaxiaBankCInstallment'."\n" - .'* ApplePay'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AccountBalance', - 'enum' => [ - 'Alipay', - 'AntCreditPay', - 'MyBankCredit', - 'HuaxiaBankCInstallment', - 'BankTransfer', - 'OfflineRemittance', - 'CreditCard', - 'AccountBalance', - 'RegularBankCreditRefund', - 'ApplePay', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ApplyInvoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + ], + 'CancelOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '73465432785'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8634E02D-0942-4B1D-8295-5352FE9A1F39', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '30D2285E-A848-4ECB-AA74-4954C60858A1'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AccountName' => [ - 'description' => 'The name of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'AccountTransactionsList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AccountTransactionsList' => [ - 'description' => 'The information about transactions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BillingCycle' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'TransactionChannel' => [ - 'description' => 'The transaction channel.'."\n" - ."\n" - .'* AccountBalance'."\n" - .'* BankTransfer'."\n" - .'* Alipay'."\n" - .'* AntCreditPay'."\n" - .'* OfflineRemittance'."\n" - .'* RegularBankCreditRefund'."\n" - .'* CreditCard'."\n" - .'* MyBankCredit'."\n" - .'* HuaxiaBankCInstallment'."\n" - .'* ApplePay'."\n", - 'type' => 'string', - 'example' => 'AccountBalance', - ], - 'RecordID' => [ - 'description' => 'The number of the order or bill.'."\n", - 'type' => 'string', - 'example' => '2020030242', - ], - 'Remarks' => [ - 'description' => 'The remarks on the transaction.'."\n", - 'type' => 'string', - 'example' => 'NAT_GW', - ], - 'Amount' => [ - 'description' => 'The amount.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'TransactionAccount' => [ - 'description' => 'The transaction account. For example, the account is a recharge account in Alipay or a transfer account.'."\n", - 'type' => 'string', - 'example' => '213562146', - ], - 'TransactionTime' => [ - 'description' => 'The time when the transaction was made.'."\n", - 'type' => 'string', - 'example' => '2020-03-10T02:03:20Z', - ], - 'TransactionType' => [ - 'description' => 'The type of the transaction.'."\n" - ."\n" - .'* Payment'."\n" - .'* Withdraw'."\n" - .'* Refund'."\n" - .'* Consumption'."\n" - .'* Transfer'."\n" - .'* Adjust'."\n", - 'type' => 'string', - 'example' => 'Consumption', - ], - 'TransactionFlow' => [ - 'description' => 'The type of the transaction flow.'."\n" - ."\n" - .'* Income'."\n" - .'* Expense'."\n", - 'type' => 'string', - 'example' => 'Expense', - ], - 'FundType' => [ - 'description' => 'The type of transaction payment. Valid values:'."\n" - ."\n" - .'* Cash: pay for the transaction in cash.'."\n" - .'* Deposit: pay for the transaction with deposit.'."\n" - .'* RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank.'."\n" - .'* DirectPay: directly pay for the transaction.'."\n", - 'type' => 'string', - 'example' => 'Cash', - ], - 'TransactionChannelSN' => [ - 'description' => 'The serial number of the transaction channel.'."\n", - 'type' => 'string', - 'example' => '1234354325', - ], - 'TransactionNumber' => [ - 'description' => 'The number of the transaction.'."\n", - 'type' => 'string', - 'example' => '43342334', - ], - 'Balance' => [ - 'description' => 'The balance of the account.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], - ], + 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'title' => '', 'example' => 'cn'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<QueryAccountTransactionsResponse>\\n <Message>Successful!</Message>\\n <RequestId>8C451EDE-8F92-4896-B4E6-68159A27B0F5</RequestId>\\n <Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <AccountTransactionsList>\\n <AccountTransactionsList>\\n <TransactionType>Consumption</TransactionType>\\n <BillingCycle>2020-03</BillingCycle>\\n <TransactionNumber>133xxxxxx90112</TransactionNumber>\\n <Amount>0.81</Amount>\\n <TransactionAccount/>\\n <TransactionTime>2020-03-10T02:03:20Z</TransactionTime>\\n <TransactionChannelSN/>\\n <Remarks>NAT_GW</Remarks>\\n <FundType>Cash</FundType>\\n <TransactionFlow>Expense</TransactionFlow>\\n <RecordID>2020xxxxx706693</RecordID>\\n <Balance>0.00</Balance>\\n <TransactionChannel>AccountBalance</TransactionChannel>\\n </AccountTransactionsList>\\n </AccountTransactionsList>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryAccountTransactionsResponse>","errorExample":""}]', - 'title' => 'QueryAccountTransactions', - 'summary' => 'Queries transactions within your Alibaba Cloud account.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"30D2285E-A848-4ECB-AA74-4954C60858A1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\"\\n }\\n}","type":"json"}]', + 'title' => 'CancelOrder', + 'summary' => 'Cancels an unpaid order.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRelationList' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrder'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:CancelOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ChangeResellerConsumeAmount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'AdjustType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1990699401005016', - ], + 'schema' => ['description' => 'The adjustment direction for the consumption amount. This parameter is required. Valid values: \\`increase\\` and \\`decrease\\`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'increase/decrease', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The adjustment amount, in CNY. The value must be greater than 0.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.00', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Currency', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The currency.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CNY', 'title' => ''], ], [ - 'name' => 'StatusList', + 'name' => 'BusinessType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The states of the relationships between the management account and its members. The valid values of this parameter are the enumeration members of the RelationshipStatusEnum data type. If you do not specify this parameter, valid relationship states are queried by default.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'RELATED', - ], - 'required' => false, - 'example' => 'RELATED', - 'maxItems' => 8, - ], + 'schema' => ['description' => 'The business type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'quota_amount_adjust', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source of the request. Specify the system name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'system', 'title' => ''], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the business operation. This ID is used to ensure idempotence.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1647396865', 'title' => ''], + ], + [ + 'name' => 'ExtendMap', + 'in' => 'query', + 'schema' => ['description' => 'The extended message fields.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7FC5D662-37FD-40A6-85B1-33442D815184', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FinancialRelationInfoList' => [ - 'description' => 'The relationships.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The time when the relationship became invalid. If no value is returned, the relationship is still valid.'."\n", - 'type' => 'string', - 'example' => '2021-03-08T15:12Z', - ], - 'RelationType' => [ - 'description' => 'The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.'."\n", - 'type' => 'string', - 'example' => 'FinancialManagement', - ], - 'AccountNickName' => [ - 'description' => 'The display name of the account.'."\n", - 'type' => 'string', - 'example' => 'test4', - ], - 'StartTime' => [ - 'description' => 'The time when the relationship became valid. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.'."\n", - 'type' => 'string', - 'example' => '2021-03-02T15:12Z', - ], - 'State' => [ - 'description' => 'The state of the relationship. One of the enumeration members of the RelationshipStatusEnum data type is returned.'."\n", - 'type' => 'string', - 'example' => 'RELATED', - ], - 'AccountId' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1851253838840762', - ], - 'SetupTime' => [ - 'description' => 'The time when the relationship was established. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.'."\n", - 'type' => 'string', - 'example' => '2021-03-02T15:12Z', - ], - 'AccountType' => [ - 'description' => 'The type of the account. Valid values: MASTER and MEMBER.'."\n", - 'type' => 'string', - 'example' => 'MEMBER', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'caiwuyun_test4', - ], - 'RelationId' => [ - 'description' => 'The ID of the relationship.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51463', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see the "Error codes" section.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => ['description' => 'The consumed quota amount after the modification.', 'type' => 'string', 'example' => '300.00', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\`: the request was successful. \\`false\\`: the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified request contains invalid parameters.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified request lacks essential parameters.', - ], + ['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' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', - ], + ['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\\": \\"7FC5D662-37FD-40A6-85B1-33442D815184\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"FinancialRelationInfoList\\": [\\n {\\n \\"EndTime\\": \\"2021-03-08T15:12Z\\",\\n \\"RelationType\\": \\"FinancialManagement\\",\\n \\"AccountNickName\\": \\"test4\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"State\\": \\"RELATED\\",\\n \\"AccountId\\": 1851253838840762,\\n \\"SetupTime\\": \\"2021-03-02T15:12Z\\",\\n \\"AccountType\\": \\"MEMBER\\",\\n \\"AccountName\\": \\"caiwuyun_test4\\",\\n \\"RelationId\\": 51463\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>7FC5D662-37FD-40A6-85B1-33442D815184</RequestId>\\n<Data>\\n <TotalCount>100</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <FinancialRelationInfoList>\\n <AccountId>1851253838840762</AccountId>\\n <EndTime/>\\n <State>RELATED</State>\\n <RelationType>FinancialManagement</RelationType>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <SetupTime>2021-03-02T15:12Z</SetupTime>\\n <RelationId>51463</RelationId>\\n <AccountNickName>test4</AccountNickName>\\n <AccountType>MEMBER</AccountType>\\n <AccountName>caiwuyun_test4</AccountName>\\n </FinancialRelationInfoList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'summary' => 'Queries the members of a management account.', - 'requestParamsDescription' => 'Enumeration members of RelationshipStatusEnum'."\n" - ."\n" - .'|Enumeration member|Description|Remarks|'."\n" - .'|---|:---:|---:|'."\n" - .'|INITIAL|The relationship is initialized.|The relationship is invalid.|'."\n" - .'|CONFIRMING|The invitation is to be confirmed.|The relationship is invalid.|'."\n" - .'|REJECTED|The invitation is rejected.|The relationship is invalid.|'."\n" - .'|CONNECTION\\_CANCELED|The relationship is removed.|The relationship is invalid.|'."\n" - .'|RELATED|The relationship is established.|The relationship is valid.|'."\n" - .'|CHANGE\\_CONFIRMING|The valid relationship is changed and to be confirmed.|The relationship is valid.|'."\n" - .'|CONNECTION\\_MASTER\\_CANCEL|The invitation is canceled.|The relationship is invalid.|', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryPermissionList' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'ChangeResellerConsumeAmount', + 'description' => 'Adjusts the consumed quota amount for a user.', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'summary' => '', + ], + 'ConfirmRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RelationId', + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => ['description' => 'The type of relationship. Currently, only enterprise\\_group is supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'enterprise_group'], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1738376485192612'], + ], + [ + 'name' => 'ConfirmCode', + 'in' => 'query', + 'schema' => ['description' => 'The confirmation action. Valid values:'."\n" + ."\n" + .'- `child_agree`: The RAM user agrees to the invitation.'."\n" + ."\n" + .'- `child_disagree`: The RAM user rejects the invitation.'."\n" + ."\n" + .'- Alibaba Cloud account cancellation confirmation: Alibaba Cloud account cancellation confirmation', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'child_agree'], + ], + [ + 'name' => 'ChildUserId', 'in' => 'query', + 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1512996702208737'], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'request_id'], + ], + [ + 'name' => 'PermissionCodes', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the relationship. Set this parameter to the value of the RelationId response parameter returned by calling the QueryRelationList operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The permissions to grant to the RAM user. Valid values:'."\n" + ."\n" + .'- SYNCHRONIZE\\_FINANCE\\_IDENTITY: Allows the synchronization of financial identity to the linked account.'."\n" + ."\n" + .'- SYNCHRONIZE\\_FINANCE\\_DISCOUNT\\_POLICY\\_TO\\_TARGET: Allows the synchronization of discounts to the linked account.'."\n" + ."\n" + .'- FORBID\\_WITHDRAW\\_CASH: Prohibits the linked account from withdrawing the account balance.'."\n" + ."\n" + .'- FORBID\\_MANAGE\\_INVOICE: Prohibits the linked account from managing invoices.'."\n" + ."\n" + .'- CHECK\\_FINANCE\\_INFO: Allows viewing of account linking information.'."\n" + ."\n" + .'- MANAGE\\_TARGET\\_INVOICE: Allows the management of invoices for the linked account.'."\n" + ."\n" + .'- CHECK\\_TARGET\\_CONSUMPTION: Allows viewing of the consumption details of the linked account.', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY'], 'required' => true, - 'docRequired' => true, - 'example' => '51463', + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'maxItems' => 100, + 'title' => '', ], ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the relationship. Obtain this value from the relationId parameter in the response of the QueryRelationList operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '51463'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F6E29451-A3CD-4705-806D-0112D08F5C49', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => '返回信息'], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'request_id'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The time when the relationship expired. If no value is returned, the relationship is still valid.'."\n", - 'type' => 'string', - 'example' => '2021-03-06T15:12Z', - ], - 'RelationType' => [ - 'description' => 'The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.'."\n", - 'type' => 'string', - 'example' => 'FinancialManagement', - ], - 'StartTime' => [ - 'description' => 'The time when the relationship took effect. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the relationship took effect at 20:00:00 on May 23, 2016 (UTC+8).'."\n", - 'type' => 'string', - 'example' => '2021-03-02T15:12Z', - ], - 'State' => [ - 'description' => 'The status of the relationship. For more information about valid values of this parameter, see the enumeration values of the RelationshipStatusEnum type in the following table.'."\n", - 'type' => 'string', - 'example' => 'RELATED', - ], - 'MasterId' => [ - 'description' => 'The ID of the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1990699401005016', - ], - 'MemberId' => [ - 'description' => 'The ID of the member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1851253838840762', - ], - 'SetupTime' => [ - 'description' => 'The time when the relationship was established. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the relationship was established at 20:00:00 on May 23, 2016 (UTC+8).'."\n", - 'type' => 'string', - 'example' => '2021-03-02T15:12Z', - ], - 'PermissionList' => [ - 'description' => 'The list of permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The time when the permission expired. If no value is returned, the permission is still valid. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the permission expired at 20:00:00 on May 23, 2016 (UTC+8).'."\n", - 'type' => 'string', - 'example' => '2021-03-05T15:12Z', - ], - 'StartTime' => [ - 'description' => 'The time when the permission took effect. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. For example, 2016-05-23T12:00:00Z indicates that the permission took effect at 20:00:00 on May 23, 2016 (UTC+8).'."\n", - 'type' => 'string', - 'example' => '2021-03-02T15:12Z', - ], - 'PermissionCode' => [ - 'description' => 'The code of the permission.'."\n", - 'type' => 'string', - 'example' => 'allow_synchronize_finance_identity', - ], - 'PermissionName' => [ - 'description' => 'The name of the permission.'."\n", - 'type' => 'string', - 'example' => 'The management account shares the credit control identity with the member.'."\n", - ], - ], - ], - ], + 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'title' => '', 'example' => 'HostId'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified request contains invalid parameters.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified request lacks essential parameters.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F6E29451-A3CD-4705-806D-0112D08F5C49\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"RelationType\\": \\"FinancialManagement\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"State\\": \\"RELATED\\",\\n \\"MasterId\\": 1990699401005016,\\n \\"MemberId\\": 1851253838840762,\\n \\"SetupTime\\": \\"2021-03-02T15:12Z\\",\\n \\"PermissionList\\": [\\n {\\n \\"EndTime\\": \\"2021-03-05T15:12Z\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"PermissionCode\\": \\"allow_synchronize_finance_identity\\",\\n \\"PermissionName\\": \\"主账号 子账号共享主账号信控身份\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>F6E29451-A3CD-4705-806D-0112D08F5C49</RequestId>\\n<Data>\\n <MemberId>1851253838840762</MemberId>\\n <EndTime/>\\n <State>RELATED</State>\\n <RelationType>FinancialManagement</RelationType>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <SetupTime>2021-03-02T15:12Z</SetupTime>\\n <MasterId>1990699401005016</MasterId>\\n <PermissionList>\\n <EndTime/>\\n <PermissionName>主账号允许子账号共享主账号信控身份</PermissionName>\\n <StartTime>2021-03-02T15:12Z</StartTime>\\n <PermissionCode>allow_synchronize_finance_identity</PermissionCode>\\n </PermissionList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'summary' => 'Queries, by relationship ID, permissions granted to accounts between which a management-member relationship is established.', + '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' => 'ConfirmRelation', + 'summary' => 'Confirms an invitation from an Alibaba Cloud account.', + 'description' => '1\\. A RAM user must confirm an invitation for Financial Management account linking only if the real-name authentication information of the RAM user is inconsistent with that of the Alibaba Cloud account.'."\n" + .'2\\. To confirm the invitation, the specified permissions must match those in the original invitation.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The following table describes the RelationshipStatusEnum type.'."\n" - ."\n" - .'|Enumeration value|Description|Remarks|'."\n" - .'|---|:---:|---:|'."\n" - .'|INITIAL|The relationship is being initialized.|The relationship does not take effect.|'."\n" - .'|CONFIRMING|The invitation is to be confirmed.|The relationship does not take effect.|'."\n" - .'|REJECTED|The invitation is rejected.|The relationship does not take effect.|'."\n" - .'|CONNECTION\\_CANCELED|The relationship is terminated.|The relationship does not take effect.|'."\n" - .'|RELATED|The relationship is established.|The relationship is effective.|'."\n" - .'|CHANGE\\_CONFIRMING|The effective relationship has changed and needs to be confirmed.|The relationship is effective.|'."\n" - .'|CONNECTION\\_MASTER\\_CANCEL|The invitation is canceled.|The relationship does not take effect.|', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetAccountRelation' => [ - 'summary' => 'Queries the details of a financial relationship.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ConvertChargeType' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationId', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'title' => 'relationId', - 'description' => 'The ID of the financial relationship. Value returned by calling the AddAccountRelation operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The type of the product.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'RequestId', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'title' => 'requestId', - 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'requestId', - ], + 'schema' => ['description' => 'The current billing method of the instance. Valid values:'."\n" + ."\n" + .'- Subscription: The instance is a subscription instance.'."\n" + ."\n" + .'- PayAsYouGo: The instance is a pay-as-you-go instance.'."\n" + ."\n" + .'> After a successful call, the billing method of the instance is switched.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Subscription'], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration, in months. This parameter is required if you change the billing method to subscription. Valid values:'."\n" + ."\n" + .'- 1 to 9.'."\n" + ."\n" + .'- 12\\.'."\n" + ."\n" + .'- 24\\.'."\n" + ."\n" + .'- 36\\.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '6'], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rm-kasjgfjshgf'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => 'result'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Message returned'."\n", - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'RequestId', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'title' => 'data', - 'description' => 'data'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'id', - 'description' => 'The ID of the financial relationship.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'ID of the financial relationship'."\n", - ], - 'ParentUserId' => [ - 'title' => 'parentUserId', - 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'ID of the Alibaba Cloud account that is used as the management account'."\n", - ], - 'ChildUserId' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as a member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'ID of the Alibaba Cloud account that is used as a member'."\n", - ], - 'StartTime' => [ - 'description' => 'The time when the financial relationship between the management account and the member was established.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-11-01', - ], - 'EndTime' => [ - 'description' => 'The time when the financial relationship between the management account and the member was terminated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-12-01', - ], - 'Type' => [ - 'title' => 'type', - 'description' => 'The type of the financial relationship.'."\n", - 'type' => 'string', - 'example' => 'enterprise_group', - ], - 'Status' => [ - 'description' => 'The status of the financial relationship between the management account and the member.'."\n" - ."\n" - .'- RELATED [Association established]'."\n" - .'- CONFIRMING [To be confirmed by the other party]'."\n" - .'- REJECTED [Refused by the other party]'."\n" - .'- CONNECTION_CANCELED [Financial sub-account cancel request]'."\n" - .'- CONNECTION_MASTER_CANCEL [Financial master account cancel invitation]'."\n" - .'- CHANGE_CONFIRMING [Relationship change to be confirmed]'."\n" - .'- INITIAL [Initial new relationship status]', - 'type' => 'string', - 'example' => 'RELATED', - ], - 'GmtModified' => [ - 'description' => 'The time when the financial relationship between the management account and the member was modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-12-01', - ], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '202657601410661'], ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the call is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"提示信息\\",\\n \\"RequestId\\": \\"RequestId\\",\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"ParentUserId\\": 0,\\n \\"ChildUserId\\": 0,\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Type\\": \\"enterprise_group\\",\\n \\"Status\\": \\"RELATED 【已建立关联】\\",\\n \\"GmtModified\\": 0\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetAccountRelation', - ], - 'AddAccountRelation' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'Invalid user identity.'], + ], + 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' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202657601410661\\"\\n }\\n}","type":"json"}]', + 'title' => 'ConvertChargeType', + 'summary' => 'Changes the billing method for an instance. You can convert Server Load Balancer (SLB), elastic IP addresses (EIPs), and NAT Gateway instances from pay-as-you-go to subscription. You can also convert SLB and EIP instances from subscription to pay-as-you-go.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ConvertChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertChargeType'], + ], ], + ], + 'CreateAgAccount' => [ + 'summary' => 'Creates an account linking relationship.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationType', + 'name' => 'LoginEmail', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'enterprise_group', - ], + 'schema' => ['description' => 'The logon email address of the member account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'email'], ], [ - 'name' => 'ParentUserId', + 'name' => 'AccountAttr', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => 'The properties of the new account. In the console, click Account Properties in the top menu bar to go to the **Security Settings** page and view the properties.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '1'], ], [ - 'name' => 'ChildNick', + 'name' => 'EnterpriseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the member. This helps clarify the scenario in which the account is used.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'xxx project'."\n", - ], + 'schema' => ['description' => 'The name of the enterprise. This is the enterprise name that corresponds to the Unified Social Credit Code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '阿里云测试有限公司'], ], [ - 'name' => 'ChildUserId', + 'name' => 'FirstName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + 'schema' => ['description' => 'The first name of the user under the level 1 category.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '志成'], ], [ - 'name' => 'RequestId', + 'name' => 'LastName', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '32324242444', - ], + 'schema' => ['description' => 'The last name of the user.'."\n" + ."\n" + .'Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '吴'], ], [ - 'name' => 'PermissionCodes', + 'name' => 'NationCode', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The country code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CN'], + ], + [ + 'name' => 'ProvinceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the province. This parameter is optional.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '北京'], + ], + [ + 'name' => 'CityName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the city in English.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '北京'], + ], + [ + 'name' => 'Postcode', + 'in' => 'query', + 'schema' => ['description' => 'The postal code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '350000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The permissions that can be granted to the member. Valid values:'."\n" - ."\n" - .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" - .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" - .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" - .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" - .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" - .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" - .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n" - ."\n" - .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', - 'type' => 'array', - 'items' => [ - 'description' => 'The permission that is granted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'LOGIN_EMAIL_HAS_BEEN_USED'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'loginEmail=685741089H@chinaunicom.cn,has used'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AgRelationDto' => [ + 'description' => 'The level 2 relationship between the master account (MPK) and the member account (PK).', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the account linking relationship.', 'type' => 'string', 'title' => '', 'example' => 'FINACE_CLOUD'], + 'Pk' => ['description' => 'The UID of the member account (PK) that is managed by the master account (MPK).', 'type' => 'string', 'title' => '', 'example' => '1728240534507590'], + 'RamAdminRoleName' => ['description' => 'The name of the RAM role.', 'type' => 'string', 'title' => '', 'example' => 'admin-role'], + 'Mpk' => ['description' => 'The UID of the master account (MPK).', 'type' => 'string', 'title' => '', 'example' => '1785287436011964'], + ], + 'title' => '', + 'example' => '', + ], ], - 'required' => false, - 'example' => 'CHECK_TARGET_CONSUMPTION', - 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'CreateAgAccount', + 'description' => 'Creates a master-member relationship for financial management.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgAccount'], + ], + ], + 'ramActions' => [], + ], + 'CreateCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RoleCodes', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'UnitEntityList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The roles that can be assigned to the member. Set the value to trusteeship.'."\n", + 'description' => 'The list of cost centers.', 'type' => 'array', 'items' => [ - 'description' => 'The role that is assigned to the member in a trusteeship.'."\n" - .'The params[PermissionCodes, RoleCodes] can not be null at the same time.', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => ['description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '-1'], + 'OwnerUid' => ['description' => 'The user ID of the owner of the new cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '982375623'], + 'UnitName' => ['description' => 'The name of the cost center.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], + ], 'required' => false, - 'example' => 'trusteeship', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'trusteeship', 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -1625,66 +1243,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Message returned'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'Request ID'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'The IP address of the request', - 'type' => 'string', - 'example' => 'HostId', - ], - 'RelationId' => [ - 'description' => 'The ID of the financial relationship.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'RelationId', + 'CostUnitDtoList' => [ + 'description' => 'The list of cost center entities.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => ['description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'], + 'UnitName' => ['description' => 'The name of the cost center.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'UnitId' => ['description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '84327659328'], + 'OwnerUid' => ['description' => 'The user ID of the owner of the new cost center.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '26387563'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"请求标识\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\",\\n \\"RelationId\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId/>\\n<Data>\\n <HostId/>\\n</Data>\\n<Code/>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'AddAccountRelation', - 'summary' => 'Creates a financial relationship.', - 'description' => 'For more information about a financial relationship, see <props="intl">[Usage notes on the trusteeship]( https://www.alibabacloud.com/help/doc-detail/116383.html)</props>. '."\n" - ."\n" - .'If enterprise names used by the management account and a member for real-name verification are the same, you do not need to call an API operation for confirmation. Otherwise, you must call the ConfirmRelation operation for confirmation.', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateCostUnit', + 'summary' => 'Creates one or more cost centers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyAccountRelation' => [ - '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1692,138 +1316,100 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationType', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'enterprise_group', - ], + 'schema' => ['description' => 'The code of the service to which the instance belongs. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'RelationOperation', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The operation to be performed. Valid values:'."\n" - ."\n" - .'* ADD'."\n" - .'* DELETE'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ADD', - ], + 'schema' => ['description' => 'The type of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'ParentUserId', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: the subscription billing method.'."\n" + .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription', 'title' => ''], ], [ - 'name' => 'ChildNick', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the member. This helps clarify the scenario in which the account is used.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Display name of the member'."\n", - ], + 'schema' => ['description' => 'The subscription duration. Unit: month. The value must be an integral multiple of 12.'."\n" + ."\n" + .'> This parameter is required if you create a subscription instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''], ], [ - 'name' => 'ChildUserId', + 'name' => 'RenewalStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', - ], + 'schema' => ['description' => 'The renewal method. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + ."\n" + .'Default value: ManualRenewal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ManualRenewal', 'title' => ''], ], [ - 'name' => 'RequestId', + 'name' => 'RenewPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', - ], + 'schema' => ['description' => 'The auto-renewal period. Unit: month.'."\n" + ."\n" + .'> This parameter is required if the **RenewalStatus** parameter is set to **AutoRenewal**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''], ], [ - 'name' => 'RoleCodes', + 'name' => 'ClientToken', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The roles that can be assigned to the member. You cannot modify the roles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The role that is assigned to the member.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'trusteeship', - ], - 'required' => false, - 'example' => 'trusteeship', - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The server checks whether a request that uses the same client token has been received. If a request that uses the same client token has been received, the server returns the same request result as the previous request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'JASIOFKVNVIXXXXXX', 'title' => ''], ], [ - 'name' => 'PermissionCodes', + 'name' => 'Logistics', + 'in' => 'query', + 'schema' => ['description' => 'The logistics address of this order. This parameter is generally valid for physical orders.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"cityCode":"330100","cityName":"Hangzhou","contactName":"Test","countryCode":"","districtName":"Puyan Street","email":"\\*\\*@example.com","mobilePhone":"153564848844","phone":"1234567","provCode":"330000","provName":"Zhejiang","streetCode":"33010610","streetName":"Zhuantang","zipCode":"0000"}'."\n", 'title' => ''], + ], + [ + 'name' => 'Parameter', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The permissions that can be modified. Valid values:'."\n" - ."\n" - .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" - .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" - .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" - .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" - .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" - .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" - .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n", + 'description' => 'The details of the modules.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The permission that is granted.'."\n", - 'type' => 'string', + 'description' => 'The modules.'."\n", + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value property of the Nth module. Value of N: 1 to 100.'."\n", 'type' => 'string', 'required' => true, 'example' => 'disk', 'title' => ''], + 'Code' => ['description' => 'The code property of the Nth module. Value of N: 1 to 100. If multiple module property parameters are involved, concatenate multiple parameters based on the value of N in sequence.'."\n", 'type' => 'string', 'required' => true, 'example' => 'InstanceType', 'title' => ''], + ], 'required' => false, - 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'title' => '', ], 'required' => false, - 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'RelationId', + 'name' => 'PricingCycle', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The ID of the financial relationship. Set this parameter to the value of the relationId response parameter returned by calling the QueryRelationList operation.'."\n", + 'description' => 'The cycle type of the prepaid period'."\n" + .'- PricingCycle=1 indicates that the unit of the prepaid period is in years; '."\n" + .'- PricingCycle=2 indicates that the unit of the prepaid period is in months; '."\n" + .'- PricingCycle=3 indicates that the unit of the prepaid period is in days;'."\n" + .'- Default value: PricingCycle=2'."\n" + ."\n" + .'Applicable only to certain product types (ProductType being ddos_originpre_public_cn, ddosDip, ddoscoo, ddos_originpre_public_intl, ddosDip_intl, ddoscoo_intl)', 'type' => 'integer', 'format' => 'int64', 'required' => false, - 'example' => '51463', + 'example' => '2', + 'enum' => [], + 'title' => '', ], ], ], @@ -1832,165 +1418,172 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Message returned'."\n", - ], - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'request_id', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'HostId'."\n", - 'type' => 'string', - 'example' => 'HostId', - ], + 'OrderId' => ['description' => 'The ID of the order that was created.'."\n", 'type' => 'string', 'example' => '20240xxxx21', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance for which the order was created.'."\n", 'type' => 'string', 'example' => 'OSSBAG-cn-v1hxxxxx23', 'title' => ''], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回消息\\",\\n \\"RequestId\\": \\"48602faf-abbe-4d46-8029-654cc5aead5d\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"127.0.0.1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message/>\\n<RequestId/>\\n<Data>\\n <HostId/>\\n</Data>\\n<Code/>\\n<Success/>","errorExample":""}]', - 'summary' => 'Adds or removes permissions granted to a member in a financial relationship.', + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'INSUFFICIENT.AVAILABLE.QUOTA', 'errorMessage' => 'The account balance is negative. Add funds to the account and try again.', 'description' => 'Your account balance drops below 0. Top up your account and try again.'], + ], + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'], + ['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' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"20240xxxx21\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-v1hxxxxx23\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InstanceId>OSSBAG-cn-v1hxxxxx23</InstanceId>\\n <OrderId>20240xxxx21</OrderId>\\n </Data>\\n</CreateInstanceResponse>","errorExample":""}]', + 'title' => 'CreateInstance', + 'summary' => 'Creates an instance. If you call this operation, an order for a new instance is created and the order is automatically paid for. You cannot create Elastic Compute Service (ECS) instances or ApsaraDB RDS instances by calling the operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ConfirmRelation' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => 'After the creation is successful, you can use the [instance query service](https://www.alibabacloud.com/help/en/boa/latest/api-bssopenapi-2017-12-14-queryavailableinstances?spm=a2c63.p38356.0.0.53aa436fJ6R68k) to query the created instances.', + 'changeSet' => [ + ['createdAt' => '2024-12-03T10:49:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-22T07:26:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateResellerUserQuota' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RelationType', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Type of the financial relationship'."\n", - ], + 'schema' => ['description' => 'The amount in CNY. This parameter is required to activate a quota.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '100'], ], [ - 'name' => 'ParentUserId', + 'name' => 'Currency', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', - ], + 'schema' => ['description' => 'The currency.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'CNY：人民币。USD：美元。JPY：日元。'], ], [ - 'name' => 'ConfirmCode', + 'name' => 'OutBizId', 'in' => 'query', + 'schema' => ['description' => 'The business transaction ID of the external system.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '7ed0bedc-056e-4a71-9249-4581615c028f'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The operation to be performed to confirm the invitation. Valid values:'."\n" - ."\n" - .'* child_agree: The member accepts the invitation.'."\n" - .'* child_disagree: The member rejects the invitation.'."\n" - .'* Canceled by the master account: The management account cancels the confirmation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'child_agree', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code that is returned if the call fails. For more information, see Error codes.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'Data' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates that the request was successful. A value of false indicates that the request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', ], ], + ], + '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' => 'CreateResellerUserQuota', + 'summary' => 'Creates a user quota ledger and a quota consumption ledger.', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ChildUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResellerUserQuota'], + ], + ], + ], + 'DeleteCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PermissionCodes', + 'name' => 'OwnerUid', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The permissions that can be granted to the member. Valid values:'."\n" - ."\n" - .'* SYNCHRONIZE_FINANCE_IDENTITY: allows the credit control identity to be shared with the member.'."\n" - .'* SYNCHRONIZE_FINANCE_DISCOUNT_POLICY_TO_TARGET: allows the discount policy to be shared with the member.'."\n" - .'* FORBID_WITHDRAW_CASH: does not allow the member to withdraw the balance.'."\n" - .'* FORBID_MANAGE_INVOICE: does not allow the member to manage invoices.'."\n" - .'* CHECK_FINANCE_INFO: requests to view information about the financial relationship.'."\n" - .'* MANAGE_TARGET_INVOICE: allows the member to manage invoices.'."\n" - .'* CHECK_TARGET_CONSUMPTION: allows the member to view the bills.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', - ], - 'required' => true, - 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The user ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '2135342'], ], [ - 'name' => 'RelationId', + 'name' => 'UnitId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the financial relationship. Set this parameter to the value of the RelationId response parameter returned by calling the QueryRelationList operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51463', - ], + 'schema' => ['description' => 'The ID of the cost center. A value of -1 indicates the root cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '376348'], ], ], 'responses' => [ @@ -1998,608 +1591,1004 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Message returned'."\n", - ], - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'request_id', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'HostId'."\n", - 'type' => 'string', - 'example' => 'HostId', - ], + 'IsSuccess' => ['description' => 'Indicates whether the operation was completed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'UnitId' => ['description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123412343'], + 'OwnerUid' => ['description' => 'The user ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12431'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"request_id\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\"\\n }\\n}","errorExample":""}]', - 'summary' => 'Confirms the invitation initiated by the master account.', - 'description' => '1\\. A member needs to confirm an invitation only if a financial management relationship is established between the management account and the member and enterprise names used by the management account and the member for real-name verification are different. 2. The permissions to be confirmed must be the same as those granted to the member when the management account initiates the invitation.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DeleteCostUnit', + 'summary' => 'Deletes a cost center.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RelieveAccountRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'bss:DeleteCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCostUnit'], + ], ], + ], + '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' => 'RelationType', + 'name' => 'BudgetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the financial relationship. Set the value to enterprise_group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'enterprise_group', - ], + 'schema' => ['title' => '', 'description' => 'The name of the budget. Supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => '全年预算'], ], [ - 'name' => 'ParentUserId', + 'name' => 'BudgetStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the management account. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The status of the budget. If you do not specify this parameter, budgets in all statuses are returned.', + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1738376485192612', + 'enumValueTitles' => ['notOverdue' => 'The budget is not overdue.', 'overdue' => 'The budget is overdue.'], + 'example' => 'notOverdue', ], ], [ - 'name' => 'ChildUserId', + 'name' => 'BudgetType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used as the member. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The type of the budget. If you do not specify this parameter, budgets of all types are returned.', + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1512996702208737', + 'enumValueTitles' => ['cost' => 'Cost budget', 'byquantity' => 'Quantity-based budget', 'asset' => 'Usage and coverage budget'], + 'example' => 'cost', ], ], [ - 'name' => 'RequestId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'request_id', - ], + 'schema' => ['title' => '', 'description' => 'The token that is used to retrieve the next page of results. Set this parameter to the NextToken value that is returned in the response to the previous request. If you do not specify this parameter, the query starts from the first page.', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0='], ], [ - 'name' => 'RelationId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the financial relationship between the management account and the member. You must set the RelationId parameter or all of the ParentUserId, ChildUserId, and RelationType parameters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'RelationId', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of items to return. Valid values: 1 to 10. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'BssResult<CostBudgetResponse>', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Message returned'."\n", - ], - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => 'request_id', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data that is returned.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'hostid'."\n", - 'type' => 'string', - 'example' => 'HostId', + 'NextToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0='], + 'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Items' => [ + 'description' => 'The list of items.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of budgets.', + 'type' => 'object', + 'properties' => [ + 'BudgetName' => ['description' => 'The name of the budget.', 'type' => 'string', 'title' => '', 'example' => '全年预算'], + 'BudgetStatus' => ['description' => 'The status of the budget.', 'type' => 'string', 'title' => '', 'example' => 'overdue'], + 'BudgetType' => ['description' => 'The type of the budget.', 'type' => 'string', 'title' => '', 'example' => 'cost'], + 'Budget' => [ + 'description' => 'Information about the budget.'."\n" + ."\n" + .'- BudgetCycleType: The budget period. Valid values: daily, monthly, quarterly, and yearly.'."\n" + ."\n" + .'- TotalBudgetAmount: The total budget amount.'."\n" + ."\n" + .'- BudgetMemo: The notes for the budget.', + 'type' => 'object', + 'enumValueTitles' => [], + 'title' => '', + 'example' => '{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }', + ], + 'CalculatedValues' => ['description' => 'Information about the estimate-to-actual comparison.'."\n" + ."\n" + .'- ActualConsumeSum: The accumulated actual consumption.'."\n" + ."\n" + .'- ActualAddForecastedAmount: The sum of the accumulated actual value and the predicted value. For a cost budget, this value represents the actual spending to date plus the forecasted spending until the budget period ends.'."\n" + ."\n" + .'- ActualAndBudgetComparison: The comparison of the actual consumption to the budget. This value is calculated using the following formula: (Accumulated actual value / Total budget amount) × 100%.', 'type' => 'object', 'title' => '', 'example' => '{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }'], + 'ConsumePeriod' => ['description' => 'Information about the billing cycle.'."\n" + ."\n" + .'- ConsumePeriodBegin: The start date of the budget.'."\n" + ."\n" + .'- ConsumePeriodEnd: The end date of the budget.', 'type' => 'object', 'title' => '', 'example' => '{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'HostId' => ['title' => '', 'description' => 'The website.', 'type' => 'string', 'example' => 'cn'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回消息\\",\\n \\"RequestId\\": \\"request_id\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"HostId\\"\\n }\\n}","type":"json"}]', - 'summary' => 'Terminates a financial relationship between the management account and a member.', - ], - 'QueryInstanceByTag' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [], + 'title' => 'DescribeCostBudgetsSummary', + 'summary' => 'Queries a summary of cost budgets.', + 'description' => 'This OpenAPI is in beta and available only to whitelisted users. Excessive calls may cause performance issues, such as response timeouts.', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ + 'summary' => 'Queries the monthly amortized costs of instances for a specified amortization month.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The amortization month.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'example' => '2022-10'], + ], + [ + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the resource. Specify the savings plan instance as the type of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', + 'title' => '', + 'description' => 'The filter condition for the billing cycle.'."\n" + .'Maximum number of elements: 10.', + 'type' => 'array', + 'items' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '2022-09'], + 'required' => false, + 'maxItems' => 10, + 'example' => '', ], ], [ - 'name' => 'ResourceId', - 'in' => 'query', + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'example' => 'Subscription'], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => ['description' => 'The product code. To obtain the value of this parameter, call QueryProductList or DescribeResourcePackageProduct.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the product.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The code of the cost center.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'example' => '123#'], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of resources.'."\n", + 'description' => 'The filter condition for the ID of the bill owner.'."\n" + .'This parameter specifies the ID of a RAM user. You can set this parameter to query the bills of a RAM user. If you do not set this parameter, the bills of the current account and all RAM users of the current account are queried.'."\n" + .'Maximum number of elements: 10.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spn-XXXXXX', - ], + 'items' => ['description' => 'The ID of the bill owner.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123'], 'required' => false, - 'maxItems' => 50, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tag', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The filter condition for the account to which the resource belongs.'."\n" + .'The resource ownership account is the account that actually uses the resource.'."\n" + .'Maximum number of elements: 10.', 'type' => 'array', - 'items' => [ - 'description' => 'The key-value pair.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '001', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The ID of the account to which the resource belongs.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123'], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The filter condition for the instance ID.'."\n" + .'You can query multiple instances. If you do not set this parameter, all instances are queried.'."\n" + .'Maximum number of elements: 10.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'abc'], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The position from which to start reading the current call. The value of this parameter must be empty or the value of NextToken that is returned in the last call. Otherwise, an error is reported. If this parameter is empty, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'maxLength' => 2560, 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data records to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The values returned.'."\n", + 'title' => 'BssResult<BssCostBillBaseResponse>', + 'description' => 'BssResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'param is null', - ], - 'NextToken' => [ - 'description' => 'The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the QueryInstanceByTag operation was called.'."\n", - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCm', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9EC6C0B7-3397-5FAE-9915-8972CDDB1211', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagResource' => [ - 'description' => 'The instances returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'spn-xxxxx', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource. The returned resource type indicates a savings plan instance.'."\n", - 'type' => 'string', - 'example' => 'instance', - ], - 'Tag' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key-value pair.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => '10', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The position from which to start reading the current call. The value of this parameter must be empty or the value of NextToken that is returned in the last call. Otherwise, an error is reported. If this parameter is empty, the query starts from the beginning.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185766xxxx'], + 'AccountName' => ['description' => 'The account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'MaxResults' => ['description' => 'The maximum number of entries returned for the current request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Items' => [ + 'description' => 'The data entries.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data item.', + 'type' => 'object', + 'properties' => [ + 'CostUnit' => ['title' => '', 'description' => 'The cost center.', 'type' => 'string', 'example' => '未分配'], + 'CostUnitCode' => ['title' => '', 'description' => 'The code of the cost center.', 'type' => 'string', 'example' => '1234'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组 '], + 'Tag' => ['description' => 'The tags of the instance.', 'type' => 'string', 'title' => '', 'example' => 'tag'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x'], + 'IntranetIP' => ['description' => 'The internal IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => '杭州'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => '杭州1'], + 'SplitAccountName' => ['description' => 'The name of the account to which the attached resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'test**1122'], + 'SplitProductDetail' => ['description' => 'The name of the product details for the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'SplitItemID' => ['description' => 'The ID of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'i-28bycvyb4'], + 'SplitItemName' => ['description' => 'The name of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'], + 'ConsumePeriod' => ['title' => '', 'description' => 'The billing cycle.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'example' => '202210'], + 'AmortizationStatus' => ['title' => '', 'description' => 'The amortization status. Valid values:'."\n" + ."\n" + .'- amortized: amortized'."\n" + ."\n" + .'- unAmortized: unamortized', 'type' => 'string', 'example' => 'amortized'], + 'AmortizationPeriod' => ['title' => '', 'description' => 'The amortization month.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'example' => '202210'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'BillOwnerID' => ['description' => 'The ID of the account to which the resource belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillOwnerName' => ['description' => 'The name of the account to which the resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'ProductDetailCode' => ['description' => 'The code of the product details.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS '], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'PretaxGrossAmount' => ['title' => '', 'description' => 'The list price.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'InvoiceDiscount' => ['title' => '', 'description' => 'The discount amount.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'RoundDownDiscount' => ['title' => '', 'description' => 'The rounded-down discount.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'PretaxAmount' => ['title' => '', 'description' => 'The pretax amount.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DeductedByCashCoupons' => ['title' => '', 'description' => 'The amount deducted by cash coupons.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DeductedByCoupons' => ['title' => '', 'description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'DeductedByPrepaidCard' => ['title' => '', 'description' => 'The amount paid with a prepaid card.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'ExpenditureAmount' => ['title' => '', 'description' => 'The expenditure amount (invoicable).', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'PreviouslyAmortizedPretaxGrossAmount' => ['description' => 'Previously amortized list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedInvoiceDiscount' => ['description' => 'Previously amortized discount amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedRoundDownDiscount' => ['description' => 'Previously amortized rounding discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxAmount' => ['description' => 'Previously amortized pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCashCoupons' => ['description' => 'Previously amortized deduction by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCoupons' => ['description' => 'Previously amortized deduction by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByPrepaidCard' => ['description' => 'Previously amortized payment by prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedExpenditureAmount' => ['description' => 'Previously amortized expenditure amount (invoicable).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxGrossAmount' => ['description' => 'Current amortized list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationInvoiceDiscount' => ['description' => 'Current amortized discount amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationRoundDownDiscount' => ['description' => 'Current amortized rounded-down discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxAmount' => ['description' => 'Current amortized pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCashCoupons' => ['description' => 'Current amortized deduction by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCoupons' => ['description' => 'Current amortized deduction by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByPrepaidCard' => ['description' => 'Current amortized payment by prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationExpenditureAmount' => ['description' => 'Current amortized expenditure amount (invoicable).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxGrossAmount' => ['description' => 'Remaining unamortized list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationInvoiceDiscount' => ['description' => 'Remaining unamortized discount amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationRoundDownDiscount' => ['description' => 'Remaining unamortized rounding discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxAmount' => ['description' => 'Remaining unamortized pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCashCoupons' => ['description' => 'Remaining unamortized deduction by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCoupons' => ['description' => 'Remaining unamortized deduction by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByPrepaidCard' => ['description' => 'Remaining unamortized payment by prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationExpenditureAmount' => ['description' => 'Remaining unamortized expenditure amount (invoicable).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount.', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'Previously amortized amount after discount.', 'title' => '', 'example' => '0'], + 'CurrentAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'Current amortized amount after discount.', 'title' => '', 'example' => '0'], + 'RemainingAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'Remaining unamortized amount after discount.', 'title' => '', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"param is null\\",\\n \\"NextToken\\": \\"CAESEgoQCg4KCm\\",\\n \\"RequestId\\": \\"9EC6C0B7-3397-5FAE-9915-8972CDDB1211\\",\\n \\"Success\\": true,\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"spn-xxxxx\\",\\n \\"ResourceType\\": \\"instance\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"10\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'summary' => 'Queries instances by tag.', - ], - 'TagResources' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'DescribeInstanceAmortizedCostByAmortizationPeriod', + 'description' => '- Amortized costs cannot be used for settlement or reconciliation. They are used to allocate your subscription and pay-as-you-go fees based on specified allocation rules.'."\n" + ."\n" + .'- The final data for a month is available after 12:00 on the sixth day of the following month. The reason for this delay is that scenarios such as delayed billing, refunds, bill adjustments, and overdue payment write-offs can occur during the month. The data for the current month does not include unsettled pay-as-you-go fees for which bills have not yet been generated.'."\n" + ."\n" + .'- Amortized cost data from the last 12 months is available.'."\n" + ."\n" + .'- Data for attached resources is reflected in the amortized costs 48 hours after the split bill is generated. To use this feature, you must first enable [split bills](https://usercenter2.aliyun.com/finance/split-bill). Data for items that are not attached resources is updated 48 hours after the detailed bill is generated.'."\n" + ."\n" + .'- For months before August 2021, amortized costs are not updated intra-month. They are updated only after 12:00 on the sixth day of the following month. Consequently, specific costs for attached resources, such as domain names, buckets, and EIPs, for products such as CDN, OSS, and Internet Shared Bandwidth are not available for these months.'."\n" + ."\n" + .'- Amortized cost data is available for querying 48 hours after you enable the [Amortized Cost](https://usercenter2.aliyun.com/finance/amortized-costs) feature.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAmortizedCostByAmortizationPeriod'], + ], + ], + ], + 'DescribeInstanceAmortizedCostByConsumePeriod' => [ + 'summary' => 'Queries the monthly amortized cost of an instance by billing cycle.', + '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', - 'in' => 'query', + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYY-MM.', 'maxLength' => 256, 'required' => true, 'title' => '', 'type' => 'string', 'example' => '2022-10'], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the resource. Specify savings plan instance as the type of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', + 'description' => 'The filter for the amortization month.'."\n" + .'Maximum number of elements: 10.', + 'items' => ['description' => 'The amortization month.'."\n" + .'Format: YYYY-MM.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => '2022-09'."\n"], + 'maxItems' => 10, + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'ResourceId', - 'in' => 'query', + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'maxLength' => 256, 'required' => false, 'title' => '', 'type' => 'string', 'example' => 'Subscription'], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => ['description' => 'The product code.'."\n" + .'To obtain the value of this parameter, call QueryProductList to query product information, or call DescribeResourcePackageProduct to query information about a specific resource plan.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the product.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the cost center.', 'maxLength' => 256, 'required' => false, 'title' => '', 'type' => 'string', 'example' => '123#'."\n"], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of resources.'."\n", + 'description' => 'The filter for the ID of the bill payer.'."\n" + .'This is the ID of a RAM user. If you specify this parameter, you can view the bills of the RAM user. If you leave this parameter empty, the bills of the current account and all its RAM users are returned.'."\n" + .'Maximum number of elements: 10.', + 'items' => ['description' => 'The ID of the bill payer.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => '123'], + 'maxItems' => 10, + 'required' => false, 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spn-XXXXXX', - ], - 'required' => true, - 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tag', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The filter for the ID of the resource owner.'."\n" + .'The resource owner is the account that actually uses the resource.'."\n" + .'Maximum number of elements: 10.', + 'items' => ['description' => 'The ID of the resource owner.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => '123'], + 'maxItems' => 10, + 'required' => false, 'type' => 'array', - 'items' => [ - 'description' => 'The information about a tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag. You can create N tag keys at a time. Valid values of N: 1 to 20. The value of this parameter can be an empty string.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The value of the tag N. Valid values of N: 1 to 20.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '001', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The filter for the instance ID.'."\n" + .'You can query multiple instances. If you leave this parameter empty, all instances are queried.'."\n" + .'Maximum number of elements: 10.', + 'items' => ['description' => 'The instance ID.', 'maxLength' => 256, 'required' => false, 'type' => 'string', 'title' => '', 'example' => 'abc'], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. You must set the value to the token that is returned in the previous call. If you leave this parameter empty, the query starts from the beginning.', 'maxLength' => 2560, 'required' => false, 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n"], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data records to return in this call. Default value: 20. Maximum value: 300.', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => '', 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'BssResult', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'InternalError', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'."\n"], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned.', + 'properties' => [ + 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, all the results are returned.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n"], + 'AccountID' => ['description' => 'The ID of the account.', 'type' => 'string', 'title' => '', 'example' => '185766xxxx'."\n"], + 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'MaxResults' => ['description' => 'The maximum number of entries returned on the current page.', 'format' => 'int32', 'type' => 'integer', 'title' => '', 'example' => '100'], + 'TotalCount' => ['description' => 'The total number of entries.', 'format' => 'int32', 'type' => 'integer', 'title' => '', 'example' => '100'], + 'Items' => [ + 'description' => 'The data entries.', + 'items' => [ + 'description' => 'The data item.', + 'properties' => [ + 'CostUnit' => ['description' => 'The cost center.', 'title' => '', 'type' => 'string', 'example' => '未分配'."\n"], + 'CostUnitCode' => ['description' => 'The code of the cost center.', 'title' => '', 'type' => 'string', 'example' => '1234'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'."\n"], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组 '."\n"], + 'Tag' => ['description' => 'The tags of the instance.', 'type' => 'string', 'title' => '', 'example' => 'tag'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x'."\n"], + 'IntranetIP' => ['description' => 'The private IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'."\n"], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => '杭州'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => '杭州1'."\n"], + 'SplitAccountName' => ['description' => 'The name of the account to which the attached resource belongs.', 'type' => 'string', 'title' => '', 'example' => 'test**1122'."\n"], + 'SplitProductDetail' => ['description' => 'The name of the attached resource\'s product details.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'SplitItemID' => ['description' => 'The ID of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'i-28bycvyb4'."\n"], + 'SplitItemName' => ['description' => 'The name of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'."\n"], + 'ConsumePeriod' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYYMM.', 'title' => '', 'type' => 'string', 'example' => '202210'], + 'AmortizationStatus' => ['description' => 'The amortization status. Valid values:'."\n" + ."\n" + .'- amortized: The cost is amortized.'."\n" + ."\n" + .'- unAmortized: The cost is not amortized.', 'title' => '', 'type' => 'string', 'example' => 'amortized'], + 'AmortizationPeriod' => ['description' => 'The amortization month.'."\n" + .'Format: YYYYMM.', 'title' => '', 'type' => 'string', 'example' => '202210'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'format' => 'int64', 'type' => 'integer', 'title' => '', 'example' => '185xxxxx489'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'BillOwnerID' => ['description' => 'The ID of the resource owner.', 'format' => 'int64', 'type' => 'integer', 'title' => '', 'example' => '185xxxxx489'], + 'BillOwnerName' => ['description' => 'The name of the resource owner.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'."\n"], + 'ProductDetailCode' => ['description' => 'The code of the product details.', 'type' => 'string', 'title' => '', 'example' => 'rds'."\n"], + 'ProductDetail' => ['description' => 'The details of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS '."\n"], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'PretaxGrossAmount' => ['description' => 'The list price.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'InvoiceDiscount' => ['description' => 'The discount.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'RoundDownDiscount' => ['description' => 'The amount deducted by rounding down.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'DeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'DeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card.', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'ExpenditureAmount' => ['description' => 'The expenditure amount (invoicable).', 'format' => 'double', 'title' => '', 'type' => 'number', 'example' => '0'], + 'PreviouslyAmortizedPretaxGrossAmount' => ['description' => 'The list price of the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedInvoiceDiscount' => ['description' => 'The discount on the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedRoundDownDiscount' => ['description' => 'The rounding discount of the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxAmount' => ['description' => 'The pretax amount of the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons from the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCoupons' => ['description' => 'The amount deducted by coupons from the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card for the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedExpenditureAmount' => ['description' => 'The expenditure amount of the cost that was amortized before the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxGrossAmount' => ['description' => 'The list price of the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationInvoiceDiscount' => ['description' => 'The discount on the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationRoundDownDiscount' => ['description' => 'The rounding discount of the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxAmount' => ['description' => 'The pretax amount of the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons from the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCoupons' => ['description' => 'The amount deducted by coupons from the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card for the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'CurrentAmortizationExpenditureAmount' => ['description' => 'The expenditure amount of the cost that is amortized in the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxGrossAmount' => ['description' => 'The list price of the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationInvoiceDiscount' => ['description' => 'The discount on the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationRoundDownDiscount' => ['description' => 'The rounding discount of the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxAmount' => ['description' => 'The pretax amount of the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons from the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCoupons' => ['description' => 'The amount deducted by coupons from the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card for the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'RemainingAmortizationExpenditureAmount' => ['description' => 'The expenditure amount of the cost that is not amortized at the end of the current amortization period.', 'format' => 'double', 'type' => 'number', 'title' => '', 'example' => '0'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount.', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount for the cost that was amortized before the current amortization period.', 'title' => '', 'example' => '0'], + 'CurrentAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount for the cost that is amortized in the current amortization period.', 'title' => '', 'example' => '0'], + 'RemainingAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount for the cost that is not amortized at the end of the current amortization period.', 'title' => '', 'example' => '0'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + 'title' => 'BssResult<BssCostBillBaseResponse>', + 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InternalError\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1537A007-72D7-4165-8A26-8694A38E219A\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'summary' => 'Add tags to resources.', - ], - 'UntagResources' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NotActiveService', 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'DescribeInstanceAmortizedCostByConsumePeriod', + 'description' => '- Amortized costs are not used for settlement or reconciliation. They are used to allocate your cloud expenses, including both subscription and pay-as-you-go fees, based on specified allocation rules.'."\n" + ."\n" + .'- The final data for a month is available after 12:00 on the sixth day of the following month. This delay accounts for events such as delayed billing, refunds, bill adjustments, and overdue payment write-offs. Data for the current month does not include unsettled pay-as-you-go fees.'."\n" + ."\n" + .'- Amortized cost data is available for the past 12 months.'."\n" + ."\n" + .'- Data for attached resources in the amortized costs is updated 48 hours after the split bill is generated. To view the costs of attached resources, you must first enable [split bills](https://usercenter2.aliyun.com/finance/split-bill). Data for other resources is updated 48 hours after the detailed bill is generated.'."\n" + ."\n" + .'- For months before August 2021, amortized costs are not updated mid-month. They are updated only after 12:00 on the sixth day of the following month. In addition, specific costs for attached resources, such as domain names, buckets, and EIPs, of products such as CDN, OSS, and Internet Shared Bandwidth, are not provided for this period.'."\n" + ."\n" + .'- Amortized cost data is available only after you enable the [Amortized Costs](https://usercenter2.aliyun.com/finance/amortized-costs) feature. The data becomes available 48 hours after enablement.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeInstanceBill' => [ + 'summary' => 'Queries the consumption summary of all product instances or billable items for an account within a billing cycle.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource. Specify the savings plan instance as the type of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => 'The billing cycle in YYYY-MM format. Only billing cycles within the past 18 months are supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2020-03'], ], [ - 'name' => 'All', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to remove all tags. This parameter is valid only if the TagKey.n parameter is not set. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'ResourceId', + 'name' => 'ProductType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spn-xxxxxx', - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'TagKey', + 'name' => 'SubscriptionType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key of the tag N. Valid values of N: 1 to 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'codename', - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PayAsYouGo'], + ], + [ + 'name' => 'IsBillingItem', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to pull data by billing item dimension.'."\n" + ."\n" + .'- false (default): The data is consistent with the Instance Bill page under Expenses and Costs > Bills > Bill Details.'."\n" + ."\n" + .'- true: The data is consistent with the Billing Item Bill page under Expenses and Costs > Bills > Bill Details.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that specifies the starting point for reading data. Leave this parameter empty to read the first page of results. To read the next page, set this parameter to the NextToken value that was returned in the previous response. Any other value will cause an error.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CAESEgoQCg4KCm'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of data records to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'IsHideZeroCharge', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to exclude bills where both PretaxGrossAmount and PretaxAmount are 0.'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => ['description' => 'The bill date. This parameter is required only when Granularity is set to DAILY. The format is YYYY-MM-DD.'."\n" + ."\n" + .'> The month of BillingDate must match the month of BillingCycle. For example, if BillingCycle is 2020-03, BillingDate must be in the format 2020-03-DD. If the months do not match, the query returns results based on the BillingCycle setting.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2020-03-02'], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => ['description' => 'The granularity of the bills to query. Valid values:'."\n" + ."\n" + .'- MONTHLY: Monthly. This corresponds to the bills on the Bills by Billing Cycle tab of the Bill Details page.'."\n" + ."\n" + .'- DAILY: Daily. This corresponds to the bills on the Bills by Day tab of the Bill Details page.'."\n" + ."\n" + .'> Specify BillingDate if you select DAILY.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MONTHLY'], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource ownership account. This is the account that actually uses the resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '122'], + ], + [ + 'name' => 'InstanceID', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'abc'], + ], + [ + 'name' => 'PipCode', + 'in' => 'query', + 'schema' => ['description' => 'The product code. This is the same as the product code on the bill in the User Center.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The values returned.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that marks the position for the next query. An empty value indicates that all data has been read. To continue the query, set the NextToken request parameter to this value in your next call.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCm'], + 'BillingCycle' => ['description' => 'The billing date. Format: YYYY-MM.', 'type' => 'string', 'title' => '', 'example' => '2020-03'], + 'MaxResults' => ['description' => 'The maximum number of records returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '122'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountName' => ['description' => 'The user account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'Items' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BillingDate' => ['description' => 'The billing date is in YYYY-MM-DD format. This parameter has a value only when Granularity is set to DAILY.', 'type' => 'string', 'title' => '', 'example' => '2020-03-20'], + 'InstanceConfig' => ['description' => 'The detailed configuration of the instance.', 'type' => 'string', 'title' => '', 'example' => 'CPU：12'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x '], + 'Item' => ['description' => 'The bill type:'."\n" + ."\n" + .'- SubscriptionOrder: A prepaid order.'."\n" + ."\n" + .'- PayAsYouGoBill: A postpaid bill.'."\n" + ."\n" + .'- Refund: A refund.'."\n" + ."\n" + .'- Adjustment: An adjustment.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGoBill'], + 'Tag' => ['description' => 'The tag of the resource.', 'type' => 'string', 'title' => '', 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-dadada'], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'BillAccountName' => ['description' => 'The name of the account associated with the bill.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: Subscription.'."\n" + ."\n" + .'- PayAsYouGo: Pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'BizType' => ['description' => 'The service type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'title' => '', 'example' => 'ecs.sn1ne.3xlarge '], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.1'], + 'BillingItem' => ['description' => 'The billing item. This property has a value only when IsBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '带宽'], + 'BillingItemCode' => ['description' => 'The billing item code.', 'type' => 'string', 'title' => '', 'example' => 'disk'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => '杭州'], + 'CostUnit' => ['description' => 'The cost center.', 'type' => 'string', 'title' => '', 'example' => '未分配 '], + 'ListPriceUnit' => ['description' => 'The unit of the list price. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '元'], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组 '], + 'PipCode' => ['description' => 'The product code. It is the same as the product code on the bill in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ServicePeriodUnit' => ['description' => 'The unit of the service period.', 'type' => 'string', 'title' => '', 'example' => '秒'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.1'], + 'CommodityCode' => ['description' => 'The product code. This is the same as the product detail code in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The name of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS '], + 'NickName' => ['description' => 'The nickname of the instance.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'ProductDetail' => ['description' => 'The details of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS '], + 'Usage' => ['description' => 'The usage.'."\n" + ."\n" + .'> This parameter is valid only when isBillingItem is set to true. The usage data is the total usage from all bills in an epoch, not the actual purchased amount. For example, if you use 1 GB of storage and a bill is generated every hour, the hourly usage is 1 GB. The daily usage on the bill is 1 GB × 24 = 24 GB.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'IntranetIP' => ['description' => 'The internal IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'], + 'OwnerID' => ['description' => 'The Account ID of the resource owner in a multi-account payment scenario.', 'type' => 'string', 'title' => '', 'example' => '123'], + 'UsageUnit' => ['description' => 'The usage unit. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => 'GB'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => '122'], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.1'], + 'DeductedByResourcePackage' => ['description' => 'The amount deducted by the resource plan. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '0.1'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ServicePeriod' => ['description' => 'The service period.', 'type' => 'string', 'title' => '', 'example' => '3600'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => '杭州1'], + 'ListPrice' => ['description' => 'The list price. This is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.1'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'BillingType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => '其它'], + 'ItemName' => ['description' => 'The name of the project.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'float', 'description' => 'The amount after a discount is applied. This amount includes the payable amount after coupon deductions. The formula is: Discounted amount = List price - Discount amount.', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"C7C15585-8349-4C62-BEE4-5A391841B9BE\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'summary' => 'Removes tags from resources.', - ], - 'QueryPrepaidCards' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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 \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\\\t\\",\\n \\"DeductedByCoupons\\": 0.1,\\n \\"BillingItem\\": \\"带宽\\",\\n \\"BillingItemCode\\": \\"disk\\",\\n \\"Region\\": \\"杭州\\",\\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 \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\\\t\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"OwnerID\\": \\"123\\",\\n \\"UsageUnit\\": \\"GB\\",\\n \\"BillAccountID\\": \\"122\\",\\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 \\"ProductCode\\": \\"rds\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"AfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeInstanceBill', + 'description' => '- Data for the current month is for reference only and may be adjusted during the month due to delayed billing, refunds, adjustments, or write-offs for overdue payments. The final bill is available after 12:00 on the third day of the next month.'."\n" + ."\n" + .'- The bill data for the current month does not include pay-as-you-go resources that are not yet settled.'."\n" + ."\n" + .'- You can query data from the past 18 months.'."\n" + ."\n" + .'- Bill data is updated with a 24-hour delay compared to actual usage. Information related to instance IDs is updated with a 48-hour delay. This includes instance configurations, instance types, instance nicknames, resource groups, public IP addresses, private IP addresses, and zones.'."\n" + ."\n" + .'- Bill data does not provide costs for individual attached resources of services such as CDN, OSS, and Internet Shared Bandwidth. For example, costs are not provided for individual domain names, buckets, or EIPs. To view the costs of attached resources, go to the Split Bill page.'."\n" + ."\n" + .'- For Alibaba Cloud Communications products, you can query bill details only starting in June 2020. For HiChina products, including Domain Names and trademarks, you can query details for bills from November 2020 onward.'."\n" + ."\n" + .'- Each account can make up to 10 queries per second. If a timeout error occurs, try again.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceBill'], + ], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'DescribePricingModule' => [ + 'summary' => 'Queries the module information of a specified Alibaba Cloud product.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ExpiryTimeEnd', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2018-08-01T00:00:00Z', - ], + 'schema' => ['description' => 'The product code. You can call the **QueryProductList** operation to query the product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'ExpiryTimeStart', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the expiration time of prepaid cards to query. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2018-08-01T00:00:00Z', - ], + 'schema' => ['description' => 'The product type. You can call the **QueryProductList** operation to query the product type.'."\n" + .'><notice>The product type must be consistent with the product type returned by the **QueryProductList** operation.></notice>', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'EffectiveOrNot', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the prepaid card takes effect. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + .'- Subscription: upfront.'."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription', 'title' => ''], ], ], 'responses' => [ @@ -2607,586 +2596,642 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7EA6C02D-06D0-4213-9C3B-E67910F7D1EB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'This API is not applicable for caller.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C40A8EE0-8084-49FE-B66E-5E1C3B6AE025', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The returned data.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'PrepaidCard' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the prepaid card. Valid values:'."\n" - ."\n" - .'* Available: The prepaid card is valid.'."\n" - .'* Expired: The prepaid card expired.'."\n" - .'* Cancelled: The prepaid card is invalid.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'ExpiryTime' => [ - 'description' => 'The time when the prepaid card expired.'."\n", - 'type' => 'string', - 'example' => '2019-08-04T01:39:11Z', - ], - 'GrantedTime' => [ - 'description' => 'The time when the prepaid card was issued.'."\n", - 'type' => 'string', - 'example' => '2018-08-03T01:39:11Z', - ], - 'NominalValue' => [ - 'description' => 'The nominal value of the prepaid card.'."\n", - 'type' => 'string', - 'example' => '100.00', - ], - 'EffectiveTime' => [ - 'description' => 'The time when the prepaid card took effect.'."\n", - 'type' => 'string', - 'example' => '2018-08-03T01:39:11Z', - ], - 'PrepaidCardNo' => [ - 'description' => 'The number of the prepaid card.'."\n", - 'type' => 'string', - 'example' => 'Q-7edaab979fc9', - ], - 'ApplicableScenarios' => [ - 'description' => 'The scenario to which the prepaid card is applicable.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PrepaidCardId' => [ - 'description' => 'The ID of the prepaid card.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '213432432', - ], - 'ApplicableProducts' => [ - 'description' => 'The services to which the prepaid card is applicable.'."\n", - 'type' => 'string', - 'example' => 'All Alibaba Cloud services'."\n", + 'ModuleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Module' => [ + 'description' => 'The module and pricing property information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'The name of the pricing module.', 'type' => 'string', 'example' => '实例', 'title' => ''], + 'PriceType' => ['description' => 'The price type. Valid values:'."\n" + .'- Usage: usage-based.'."\n" + .'- Hour: hourly price.'."\n" + .'- Day: daily price.'."\n" + .'- Week: weekly price.'."\n" + .'- Month: monthly price.'."\n" + .'- Year: yearly price.', 'type' => 'string', 'example' => 'Month', 'title' => ''], + 'Currency' => ['description' => 'The currency. CNY: Chinese Yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'ModuleCode' => ['description' => 'The identifier of the pricing module.', 'type' => 'string', 'example' => 'InstanceType', 'title' => ''], + 'ConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConfigList' => [ + 'type' => 'array', + 'items' => ['description' => 'The collection of pricing property codes that the module depends on.', 'type' => 'string', 'example' => '[ "Region","InstanceType" ]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Balance' => [ - 'description' => 'The balance of the prepaid card.'."\n", - 'type' => 'string', - 'example' => '100.00', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AttributeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Attribute' => [ + 'description' => 'The pricing property values of the module.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'DBInstanceStorage', 'title' => ''], + 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '存储空间', 'title' => ''], + 'Unit' => ['description' => 'The property unit.', 'type' => 'string', 'example' => 'GB', 'title' => ''], + 'Values' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AttributeValue' => [ + 'description' => 'The property.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The value type of the property corresponding to the module code. Valid values:'."\n" + .'- single_float: single numeric type.'."\n" + .'- single_string: single string type.'."\n" + .'- range_float: range value type.', 'type' => 'string', 'example' => 'single_string', 'title' => ''], + 'Value' => ['description' => 'The property value corresponding to the module code.'."\n" + .'> When Type is set to range_float, the format 1024-1024000:1024 indicates a range from 1024 to 1024000 with a step size of 1024.', 'type' => 'string', 'example' => 'mysql.n2.medium.1', 'title' => ''], + 'Remark' => ['description' => 'The description of the module value.', 'type' => 'string', 'example' => '连接数：4000 IOPS与存储空间大小有关', 'title' => ''], + 'Name' => ['description' => 'The property value corresponding to the module code.', 'type' => 'string', 'example' => '2 核 4GB（单机基础版）', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => ' Some parameters arte mandatoryfor this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Some parameters are not valid.', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specifiedowner doesn’t belong to caller', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"7EA6C02D-06D0-4213-9C3B-E67910F7D1EB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PrepaidCard\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"ExpiryTime\\": \\"2019-08-04 01:39:11\\",\\n \\"GrantedTime\\": \\"2019-08-04 01:39:11\\",\\n \\"NominalValue\\": \\"100.00\\",\\n \\"EffectiveTime\\": \\"2019-08-04 01:39:11\\",\\n \\"PrepaidCardNo\\": \\"Q-7edaab979fc9\\",\\n \\"ApplicableScenarios\\": \\"阿里云按量付费账单,阿里云新购\\",\\n \\"PrepaidCardId\\": 213432432,\\n \\"ApplicableProducts\\": \\"通用\\",\\n \\"Balance\\": \\"100.00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'summary' => 'Queries prepaid cards.', + 'title' => 'Query product module information', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRedeem' => [ - 'summary' => 'Queries the information about a voucher.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePricingModule'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePricingModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeProductAmortizedCostByAmortizationPeriod' => [ + 'summary' => 'Queries the monthly amortized cost of products for a specified month.', + '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' => 'The start time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2018-08-01T00:00:00Z', - ], + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['description' => 'The amortization month.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'title' => '', 'example' => '2022-10'], ], [ - 'name' => 'ExpiryTimeEnd', - 'in' => 'query', + 'name' => 'ConsumePeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', + 'description' => 'The filter for billing cycle months.'."\n" + .'You can specify a maximum of 10 elements.', + 'type' => 'array', + 'items' => ['description' => 'The billing cycle month.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '2022-09'], 'required' => false, - 'docRequired' => false, - 'example' => '2018-08-01T00:00:00Z', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EffectiveOrNot', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the redemption coupon takes effect. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'Subscription'], ], [ - 'name' => 'PageNum', - 'in' => 'query', + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => ['description' => 'The product code.'."\n" + .'For more information about how to obtain this parameter, see QueryProductList and DescribeResourcePackageProduct.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the product.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the cost center.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123#'."\n"], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of billable accounts. This parameter is used to filter bills by the RAM user who pays for the resources. If you specify this parameter, you can query the bills of the specified RAM user. If you leave this parameter empty, the bills of the current account and all its RAM users are queried.'."\n" + .'You can specify a maximum of 10 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the billable account.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123'], 'required' => false, - 'docRequired' => false, - 'example' => '1', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of resource owners. The resource owner is the account that uses the resources.'."\n" + .'You can specify a maximum of 10 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource owner.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'abc'], 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The token that marks the position to start the query. If you leave this parameter empty, the query starts from the beginning. Set this parameter to the value of NextToken that is returned in the last response to query the next page of results.', 'type' => 'string', 'required' => false, 'maxLength' => 2560, 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', + 'description' => 'BssResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'."\n"], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'."\n"], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Redeem' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Redeem' => [ - 'description' => 'The details of the redemption coupon.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExpiryTime' => [ - 'description' => 'The time when the redemption coupon expired.'."\n", - 'type' => 'string', - 'example' => '2018-06-13 20:25:00', - ], - 'GrantedTime' => [ - 'description' => 'The time when the redemption coupon was issued.'."\n", - 'type' => 'string', - 'example' => '2018-05-14 20:25:00', - ], - 'Status' => [ - 'description' => 'The status of the redemption coupon. Valid values:'."\n" - ."\n" - .'* Generated'."\n" - .'* CallBack'."\n" - .'* RefundPending'."\n" - .'* Canceled'."\n" - .'* Order_Canceled'."\n" - .'* ActivePending'."\n" - .'* ActiveSuccess'."\n" - .'* ExchangePending'."\n" - .'* ExchangeSuccess'."\n" - .'* Expired'."\n", - 'type' => 'string', - 'example' => 'Generated', - ], - 'Specification' => [ - 'description' => 'The specifications of the redemption coupon.'."\n", - 'type' => 'string', - 'example' => 'N/A'."\n", - ], - 'NominalValue' => [ - 'description' => 'The nominal value of the redemption coupon.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'EffectiveTime' => [ - 'description' => 'The time when the redemption coupon took effect.'."\n", - 'type' => 'string', - 'example' => '2018-05-14 20:25:00', - ], - 'RedeemId' => [ - 'description' => 'The ID of the redemption coupon.'."\n", - 'type' => 'string', - 'example' => '1342', - ], - 'RedeemNo' => [ - 'description' => 'The number of the redemption coupon.'."\n", - 'type' => 'string', - 'example' => '4889*****1610', - ], - 'ApplicableProducts' => [ - 'description' => 'The services to which the redemption coupon is applicable.'."\n", - 'type' => 'string', - 'example' => 'Elastic Compute Service (ECS)'."\n", - ], - 'Balance' => [ - 'description' => 'The balance of the redemption coupon.'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], + 'NextToken' => ['description' => 'The token that is used to query the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n"], + 'AccountID' => ['description' => 'The ID of the account.', 'type' => 'string', 'title' => '', 'example' => '185766xxxx'], + 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'MaxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Items' => [ + 'description' => 'The data entries.', + 'type' => 'array', + 'items' => [ + 'description' => 'A data entry.', + 'type' => 'object', + 'properties' => [ + 'ConsumePeriod' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'title' => '', 'example' => '202210'], + 'AmortizationStatus' => ['description' => 'The amortization status. Valid values:'."\n" + ."\n" + .'- amortized: The cost is amortized.'."\n" + ."\n" + .'- unAmortized: The cost is not amortized.', 'type' => 'string', 'title' => '', 'example' => 'amortized'], + 'AmortizationPeriod' => ['description' => 'The amortization month.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'title' => '', 'example' => '202210'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'BillOwnerID' => ['description' => 'The ID of the resource owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillOwnerName' => ['description' => 'The name of the resource owner.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'."\n"], + 'ProductDetailCode' => ['description' => 'The code of the product details.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductDetail' => ['description' => 'The details of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'."\n"], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'."\n"], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'InvoiceDiscount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RoundDownDiscount' => ['description' => 'The amount rounded down.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByPrepaidCard' => ['description' => 'The amount paid by prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'ExpenditureAmount' => ['description' => 'The expenditure amount. This amount can be invoiced.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxGrossAmount' => ['description' => 'The pretax gross amount that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedInvoiceDiscount' => ['description' => 'The discount that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedRoundDownDiscount' => ['description' => 'The amount rounded down that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxAmount' => ['description' => 'The pretax amount that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCoupons' => ['description' => 'The amount deducted by coupons that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByPrepaidCard' => ['description' => 'The amount paid by prepaid card that was amortized before the beginning of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedExpenditureAmount' => ['description' => 'The expenditure amount that was amortized before the beginning of the period. This amount can be invoiced.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxGrossAmount' => ['description' => 'The pretax gross amount that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationInvoiceDiscount' => ['description' => 'The discount that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationRoundDownDiscount' => ['description' => 'The amount rounded down that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxAmount' => ['description' => 'The pretax amount that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCoupons' => ['description' => 'The amount deducted by coupons that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByPrepaidCard' => ['description' => 'The amount paid by prepaid card that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationExpenditureAmount' => ['description' => 'The expenditure amount that is amortized in the current period. This amount can be invoiced.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxGrossAmount' => ['description' => 'The unamortized pretax gross amount at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationInvoiceDiscount' => ['description' => 'The unamortized discount at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationRoundDownDiscount' => ['description' => 'The unamortized amount rounded down at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxAmount' => ['description' => 'The unamortized pretax amount at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCashCoupons' => ['description' => 'The unamortized amount deducted by cash coupons at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCoupons' => ['description' => 'The unamortized amount deducted by coupons at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByPrepaidCard' => ['description' => 'The unamortized amount paid by prepaid card at the end of the period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationExpenditureAmount' => ['description' => 'The unamortized expenditure amount at the end of the period. This amount can be invoiced.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after a discount is applied.', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount that was amortized before the beginning of the period, after a discount is applied.', 'title' => '', 'example' => '0'], + 'CurrentAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount that is amortized in the current period, after a discount is applied.', 'title' => '', 'example' => '0'], + 'RemainingAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The unamortized amount at the end of the period, after a discount is applied.', 'title' => '', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], '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\\",\\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' => 'DescribeProductAmortizedCostByAmortizationPeriod', + 'description' => '- Amortized costs are for cost allocation purposes only and cannot be used for settlement or reconciliation. This feature allocates your cloud expenses, including both subscription and pay-as-you-go fees, based on specified allocation rules.'."\n" + ."\n" + .'- The final data for a month is available after 12:00 on the sixth day of the following month. Data for the current month is not final. This is because it does not include unsettled pay-as-you-go fees and may change due to events such as delayed billing, refunds, bill adjustments, and overdue payment write-offs.'."\n" + ."\n" + .'- Amortized cost data for the past 12 months is available.'."\n" + ."\n" + .'- Data for attached resources, which requires you to enable [split bills](https://usercenter2.aliyun.com/finance/split-bill), is updated 48 hours after the split bill is generated. Data for other resources is updated 48 hours after the detailed bill is generated.'."\n" + ."\n" + .'- For months before August 2021, amortized costs were not updated during the month. They were updated only after 12:00 on the sixth day of the following month. In addition, cost details for attached resources, such as domain names, buckets, and EIPs, for products such as CDN, OSS, and Internet Shared Bandwidth are not available for this period.'."\n" + ."\n" + .'- Amortized cost data becomes available 48 hours after you enable the [Amortized Cost](https://usercenter2.aliyun.com/finance/amortized-costs) feature.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<QueryRedeemResponse>\\n <Message>Successful!</Message>\\n <RequestId>E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNum>1</PageNum>\\n <Redeem>\\n </Redeem>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRedeemResponse>","errorExample":""}]', - 'title' => 'QueryRedeem', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryCashCoupons' => [ - 'summary' => 'Queries the information about vouchers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProductAmortizedCostByAmortizationPeriod'], + ], ], + ], + 'DescribeProductAmortizedCostByConsumePeriod' => [ + 'summary' => 'Queries the monthly amortized cost of a product for a specific billing cycle.', + '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'], 'parameters' => [ [ - 'name' => 'ExpiryTimeEnd', - 'in' => 'query', + 'name' => 'BillingCycle', + 'in' => 'formData', + 'schema' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'maxLength' => 256, 'title' => '', 'example' => '2022-10'."\n"], + ], + [ + 'name' => 'AmortizationPeriodFilter', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The filter conditions for the amortization month.'."\n" + .'Maximum number of elements: 10.', + 'type' => 'array', + 'items' => ['description' => 'The amortization month.'."\n" + .'Format: YYYY-MM.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '2022-09'."\n"], 'required' => false, - 'example' => '2018-08-01T00:00:00Z', + 'maxItems' => 10, + 'example' => '', ], ], [ - 'name' => 'ExpiryTimeStart', - 'in' => 'query', + 'name' => 'SubscriptionType', + 'in' => 'formData', + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'Subscription'], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => ['description' => 'The product code. To obtain this value, call the QueryProductList operation to query product information or the DescribeResourcePackageProduct operation to query information about a resource plan.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'ProductDetail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the product.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'CostUnitCode', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the cost center.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123#'."\n"], + ], + [ + 'name' => 'BillUserIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The start time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", - 'type' => 'string', + 'description' => 'The filter conditions for the IDs of bill purchasers.'."\n" + .'This is the ID of a RAM user. Set this parameter to view the bills of a RAM user. If you do not set this parameter, the bills of the current account and all its RAM users are returned.'."\n" + .'Maximum number of elements: 10.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the bill purchaser.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123'], 'required' => false, - 'example' => '2018-08-01T00:00:00Z', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EffectiveOrNot', - 'in' => 'query', + 'name' => 'BillOwnerIdList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether the voucher takes effect. Valid values:'."\n" - ."\n" - .'* true: The voucher takes effect.'."\n" - .'* false: The voucher does not take effect.'."\n", - 'type' => 'boolean', + 'description' => 'The filter conditions for the IDs of resource owners.'."\n" + .'The resource owner is the account that actually uses the resources.'."\n" + .'Maximum number of elements: 10.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource owner.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'title' => '', 'example' => '123'], 'required' => false, - 'example' => 'true', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The token that marks the position from which to start the query. If you leave this parameter empty, the query starts from the beginning. If you specify this parameter, set it to the value of `NextToken` that is returned in the last call.', 'type' => 'string', 'required' => false, 'maxLength' => 2560, 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n"], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data records to return in this call. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '147B566E-DB4C-4E43-BDBB-5DB1D9D268DB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'."\n"], 'Data' => [ + 'description' => 'The data returned.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'CashCoupon' => [ - 'description' => 'The data returned.'."\n", + 'NextToken' => ['description' => 'The token that marks the position of the next query.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185766xxxx'], + 'AccountName' => ['description' => 'The user account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'MaxResults' => ['description' => 'The maximum number of entries returned for the current request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Items' => [ + 'description' => 'The data entries.', 'type' => 'array', 'items' => [ + 'description' => 'The data item.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The state of the voucher. Valid values:'."\n" - ."\n" - .'* Available: The voucher is valid.'."\n" - .'* Expired: The voucher has expired.'."\n" - .'* Cancelled: The voucher is canceled.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'ExpiryTime' => [ - 'description' => 'The time when the voucher expired.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T15:15:50Z', - ], - 'GrantedTime' => [ - 'description' => 'The time when the voucher was released.'."\n", - 'type' => 'string', - 'example' => '2018-08-02T15:15:50Z', - ], - 'NominalValue' => [ - 'description' => 'The denomination of the voucher.'."\n", - 'type' => 'string', - 'example' => '100.00', - ], - 'EffectiveTime' => [ - 'description' => 'The time when the voucher took effect.'."\n", - 'type' => 'string', - 'example' => '2018-08-02T15:15:50Z', - ], - 'ApplicableScenarios' => [ - 'description' => 'The scenario to which the voucher is applicable.'."\n", - 'type' => 'string', - 'example' => 'Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service'."\n", - ], - 'CashCouponId' => [ - 'description' => 'The ID of the voucher.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34534253254325', - ], - 'ApplicableProducts' => [ - 'description' => 'The service to which the voucher is applicable.'."\n", - 'type' => 'string', - 'example' => 'All Alibaba Cloud services'."\n", - ], - 'CashCouponNo' => [ - 'description' => 'The code of the voucher.'."\n", - 'type' => 'string', - 'example' => 'Q-b1485def8f04a', - ], - 'Balance' => [ - 'description' => 'The remaining quota of the voucher.'."\n", - 'type' => 'string', - 'example' => '100.00', - ], - 'Description' => [ - 'description' => 'The description of the voucher.', - 'type' => 'string', - 'example' => 'This voucher is used for testing product function', - ], + 'ConsumePeriod' => ['description' => 'The billing cycle.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'title' => '', 'example' => '202210'], + 'AmortizationStatus' => ['description' => 'The amortization status. Valid values:'."\n" + ."\n" + .'- amortized: The cost is amortized.'."\n" + ."\n" + .'- unAmortized: The cost is not amortized.', 'type' => 'string', 'title' => '', 'example' => 'amortized'], + 'AmortizationPeriod' => ['description' => 'The amortization month.'."\n" + .'Format: YYYYMM.', 'type' => 'string', 'title' => '', 'example' => '202210'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'BillOwnerID' => ['description' => 'The ID of the resource owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '185xxxxx489'], + 'BillOwnerName' => ['description' => 'The name of the resource owner.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'."\n"], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'."\n"], + 'ProductDetailCode' => ['description' => 'The code of the product details.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'."\n"], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'PretaxGrossAmount' => ['description' => 'The list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'InvoiceDiscount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RoundDownDiscount' => ['description' => 'The amount deducted by rounding down.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'DeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'ExpenditureAmount' => ['description' => 'The expenditure amount (which can be invoiced).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxGrossAmount' => ['description' => 'The previously amortized list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedInvoiceDiscount' => ['description' => 'The previously amortized discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedRoundDownDiscount' => ['description' => 'The previously amortized amount deducted by rounding down.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedPretaxAmount' => ['description' => 'The previously amortized pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCashCoupons' => ['description' => 'The previously amortized amount deducted by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByCoupons' => ['description' => 'The previously amortized amount deducted by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedDeductedByPrepaidCard' => ['description' => 'The previously amortized amount paid with a prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedExpenditureAmount' => ['description' => 'The previously amortized expenditure amount (which can be invoiced).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxGrossAmount' => ['description' => 'The list price amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationInvoiceDiscount' => ['description' => 'The discount amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationRoundDownDiscount' => ['description' => 'The amount deducted by rounding down that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationPretaxAmount' => ['description' => 'The pretax amount amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCashCoupons' => ['description' => 'The amount deducted by cash coupons that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByCoupons' => ['description' => 'The amount deducted by coupons that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationDeductedByPrepaidCard' => ['description' => 'The amount paid with a prepaid card that is amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'CurrentAmortizationExpenditureAmount' => ['description' => 'The expenditure amount (which can be invoiced) amortized in the current period.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxGrossAmount' => ['description' => 'The remaining unamortized list price.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationInvoiceDiscount' => ['description' => 'The remaining unamortized discount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationRoundDownDiscount' => ['description' => 'The remaining unamortized amount deducted by rounding down.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationPretaxAmount' => ['description' => 'The remaining unamortized pretax amount.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCashCoupons' => ['description' => 'The remaining unamortized amount deducted by cash coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByCoupons' => ['description' => 'The remaining unamortized amount deducted by coupons.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationDeductedByPrepaidCard' => ['description' => 'The remaining unamortized amount paid with a prepaid card.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'RemainingAmortizationExpenditureAmount' => ['description' => 'The remaining unamortized expenditure amount (which can be invoiced).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amount after discount.', 'title' => '', 'example' => '0'], + 'PreviouslyAmortizedAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The previously amortized amount after discount.', 'title' => '', 'example' => '0'], + 'CurrentAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The amortized amount for the current period after discount.', 'title' => '', 'example' => '0'], + 'RemainingAmortizationAfterDiscountAmount' => ['type' => 'number', 'format' => 'double', 'description' => 'The remaining unamortized amount after discount.', 'title' => '', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => ' Some parameters arte mandatoryfor this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Some parameter sare not valid.', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specifiedowner doesn’t belong to caller', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + ['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\\",\\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' => 'DescribeProductAmortizedCostByConsumePeriod', + 'description' => '- Amortized costs are used for cost allocation and cannot be used for settlement or reconciliation. This feature allocates your cloud expenses, including both subscription and pay-as-you-go fees, based on specified rules.'."\n" + ."\n" + .'- The final data for a given month is available after 12:00 on the sixth day of the following month. This delay ensures that potential mid-month events, such as delayed billing, refunds, bill adjustments, and overdue payment write-offs, are included. Data for the current month does not include unsettled pay-as-you-go fees that have not yet been billed or are still accumulating.'."\n" + ."\n" + .'- Amortized cost data for the past 12 months is available.'."\n" + ."\n" + .'- Data related to attached resources is updated in the amortized costs 48 hours after the corresponding split bill is generated. To view the costs of attached resources, you must first enable [split bills](https://usercenter2.aliyun.com/finance/split-bill). Data that is not related to attached resources is updated 48 hours after the detailed bill is generated.'."\n" + ."\n" + .'- For months before August 2021, amortized costs were not updated mid-month and were only updated after 12:00 on the sixth day of the following month. Additionally, for this period, specific costs for attached resources, such as domain names, buckets, and EIPs, for products such as CDN, OSS, and Internet Shared Bandwidth are not available.'."\n" + ."\n" + .'- Amortized cost data is provided only after you enable the [Amortized Cost](https://usercenter2.aliyun.com/finance/amortized-costs) feature. The data is available 48 hours after you enable it.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => 'QueryCashCoupons', - ], - 'QuerySavingsPlansInstance' => [ - 'summary' => 'Queries the information about the savings plans of the current user.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProductAmortizedCostByConsumePeriod'], + ], ], + ], + 'DescribeResourceCoverageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3194,403 +3239,463 @@ ], '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' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ - 'name' => 'Locale', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the return data. Valid values:'."\n" - ."\n" - .'* ZH: Chinese'."\n" - .'* EN: English'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ZH', - ], + 'schema' => ['description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The time granularity at which coverage details are queried. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the savings plan instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn-xxxxxxx', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2020-01-01 00:00:00', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The ID of the account for which you want to query coverage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'ResourceType', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The type of deduction plans whose coverage details are queried. Valid values: RI and SCU.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RI', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - 'Value' => [ - 'description' => 'The value of the tag to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '001', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token of the next page.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Items' => [ + 'description' => 'The data entries.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => ['description' => 'The code of the service.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'ProductName' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => '云服务器 ECS', 'title' => ''], + 'TotalQuantity' => ['description' => 'The total amount of resources consumed.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'RegionNo' => ['description' => 'The code of the region.', 'type' => 'string', 'example' => 'cn-hangzhou-dg-a01', 'title' => ''], + 'UserId' => ['description' => 'The ID of the account.', 'type' => 'string', 'example' => '123745698925000', 'title' => ''], + 'CommodityName' => ['description' => 'The name and billing method of the service.', 'type' => 'string', 'example' => '云服务器ECS-按量付费', 'title' => ''], + 'CapacityUnit' => ['description' => 'The unit that is used to measure the resources deducted from deduction plans.', 'type' => 'string', 'example' => '算力*小时', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of a pay-as-you-go instance.', 'type' => 'string', 'example' => 'i-bp1d9x623987rlj0dx4xx', 'title' => ''], + 'Currency' => ['description' => 'The currency in which deduction plans were priced.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'ZoneName' => ['description' => 'The zone.', 'type' => 'string', 'example' => '杭州 可用区I', 'title' => ''], + 'InstanceSpec' => ['description' => 'The specifications of a deduction plan.', 'type' => 'string', 'example' => 'ecs.t5-lc2m1.nano', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range in which the coverage details were queried.', 'type' => 'string', 'example' => '2021-04-01 01:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range in which the coverage details were queried.', 'type' => 'string', 'example' => '2021-04-01 00:00:00', 'title' => ''], + 'PaymentAmount' => ['description' => 'The amount of the bill.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'CoveragePercentage' => ['description' => 'The coverage rate of a deduction plan.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + 'DeductQuantity' => ['description' => 'The amount of the resources deducted from a deduction plan.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Zone' => ['description' => 'The code of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'UserName' => ['description' => 'The username of the account.', 'type' => 'string', 'example' => 'test13@test.aliyun.com', 'title' => ''], + 'ProductCode' => ['description' => 'The code of the service.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'title' => 'DescribeResourceCoverageDetail', + 'summary' => 'Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs).', + 'description' => '1\\. The queried coverage details are the same as those displayed in the table on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" + ."\n" + .'2\\. You can call this operation to query the coverage details of RIs or SCUs.'."\n" + ."\n" + .'3\\. You can call this operation to query coverage details at an hourly, daily, or monthly granularity.', + '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' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeResourceCoverageTotal' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the Instance. '."\n" - ."\n" - .'* NORMAL'."\n" - .'* RELEASE', - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ - 'name' => 'CommodityCode', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], + ], + [ + 'name' => 'PeriodType', + 'in' => 'query', + 'schema' => ['description' => 'The time granularity at which total coverage data is queried. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the account for which you want to query total coverage data. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of deduction plans whose total coverage data is queried. Valid values: RI and SCU.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RI', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Items' => [ - 'description' => 'The details about the instances.'."\n", + 'PeriodCoverage' => [ + 'description' => 'The information about the coverage rate of deduction plans within a period.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NORMAL: normal'."\n" - .'* LIMIT: stopped due to overdue payment'."\n" - .'* RELEASE: released'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'Cycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1:Year', - ], - 'StartTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1663135741039', - ], - 'SavingsType' => [ - 'description' => 'The type of the savings plan. Valid values:'."\n" - ."\n" - .'* universal: general-purpose'."\n" - .'* ecs: ECS compute'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'Utilization' => [ - 'description' => 'The total usage.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'PrepayFee' => [ - 'description' => 'The prepaid amount.'."\n", - 'type' => 'string', - 'example' => '8760.00', - ], - 'InstanceId' => [ - 'description' => 'The ID of the savings plan instance.'."\n", - 'type' => 'string', - 'example' => 'spn-xxxxxxxx', - ], - 'Currency' => [ - 'description' => 'The currency. Valid values: CNY and USD.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'EndTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1663135741039', - ], - 'EndTime' => [ - 'description' => 'The time when the instance expires. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'example' => '2021-01-01 00:00:00', - ], - 'StartTime' => [ - 'description' => 'The time when the instance takes effect. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'example' => '2020-01-01 00:00:00', - ], - 'AllocationStatus' => [ - 'description' => 'The allocation status. Valid values:'."\n" - ."\n" - .'* unallocated'."\n" - .'* allocated'."\n" - .'* beAllocated'."\n", - 'type' => 'string', - 'example' => 'unallocated', - ], - 'InstanceFamily' => [ - 'description' => 'The instance family information. For an instance of the Elastic Compute Service (ECS) compute type, the value indicates the ECS instance family or the ECS instance family package.'."\n", - 'type' => 'string', - 'example' => 'ecs.g6', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou-na62-a01', - ], - 'LastBillTotalUsage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100.0', - ], - 'LastBillUtilization' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.8', - ], - 'TotalSave' => [ - 'description' => 'The total amount that is saved.'."\n", - 'type' => 'string', - 'example' => '20.00', - ], - 'PoolValue' => [ - 'description' => 'The commitment.'."\n", - 'type' => 'string', - 'example' => '1.00', - ], - 'PayMode' => [ - 'description' => 'The payment type. Valid values:'."\n" - ."\n" - .'* total: All Upfront'."\n" - .'* half: Partial Upfront'."\n" - .'* zero: No Upfront'."\n", - 'type' => 'string', - 'example' => 'total', - ], - 'Tags' => [ - 'description' => 'The details about the tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '', + 'CoveragePercentage' => ['description' => 'The coverage rate of deduction plans within the specified period.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], + 'Period' => ['description' => 'The period.'."\n" + ."\n" + .'The value is in the format of yyyyMMddHH.', 'type' => 'string', 'example' => '2020110100', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCoverage' => [ + 'description' => 'The information about the total coverage data of deduction plans.', + 'type' => 'object', + 'properties' => [ + 'CapacityUnit' => ['description' => 'The unit that is used to measure the resources deducted from deduction plans.', 'type' => 'string', 'example' => '算力*小时', 'title' => ''], + 'DeductQuantity' => ['description' => 'The total amount of the resources deducted from deduction plans.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'CoveragePercentage' => ['description' => 'The total coverage rate of deduction plans.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'TotalQuantity' => ['description' => 'The total amount of resources consumed.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'title' => 'DescribeResourceCoverageTotal', + 'summary' => 'Queries the total coverage data of reserved instances (RIs) or storage capacity units (SCUs).', + 'description' => 'The queried total coverage data is the same as the aggregated data displayed on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" + ."\n" + .'You can call this operation to query the total coverage data of RIs or SCUs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceCoverageTotal'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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 \\"CoveragePercentage\\": 0.1,\\n \\"Period\\": \\"2020110100\\"\\n }\\n ],\\n \\"TotalCoverage\\": {\\n \\"CapacityUnit\\": \\"算力*小时\\",\\n \\"DeductQuantity\\": 1,\\n \\"CoveragePercentage\\": 1,\\n \\"TotalQuantity\\": 1\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeResourcePackageProduct' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ossbag', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '72353765387', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourcePackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourcePackage' => [ + 'description' => 'The details about the resource plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductType' => ['description' => 'The type of the service.'."\n", 'type' => 'string', 'example' => 'ossbag', 'title' => ''], + 'Name' => ['description' => 'The name of the resource plan.'."\n", 'type' => 'string', 'example' => 'Object Storage Service (OSS) resource plan (monthly)'."\n", 'title' => ''], + 'ProductCode' => ['description' => 'The code of the service.'."\n", 'type' => 'string', 'example' => 'ossbag', 'title' => ''], + 'PackageTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PackageType' => [ + 'description' => 'The types of the resource plans.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the resource plan.'."\n", 'type' => 'string', 'example' => 'FPT_ossbag_deadlineAcc_CdnOut_common_sz', 'title' => ''], + 'Name' => ['description' => 'The name of the resource plan type.'."\n", 'type' => 'string', 'example' => 'Back-to-origin traffic plan - China (Shenzhen)'."\n", 'title' => ''], + 'Properties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Property' => [ + 'description' => 'The properties of the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the property.'."\n", 'type' => 'string', 'example' => 'region', 'title' => ''], + 'Value' => ['description' => 'The value of the property.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'Specifications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Specification' => [ + 'description' => 'The specifications of the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the specification.'."\n", 'type' => 'string', 'example' => '1TB', 'title' => ''], + 'Value' => ['description' => 'The value of the specification.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''], + 'AvailableDurations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableDuration' => [ + 'description' => 'The validity periods available for the resource plan.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the validity period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'Name' => ['description' => 'The name of the validity period.'."\n", 'type' => 'string', 'example' => '6 Month', 'title' => ''], + 'Unit' => ['description' => 'The unit of the validity period for the resource plan. Valid values:'."\n" + ."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'Default value: Month.'."\n", 'type' => 'string', 'example' => 'Month', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], ], + 'description' => '', + 'title' => '', ], ], - ], - 'DeductCycleType' => [ 'description' => '', - 'type' => 'string', - 'example' => 'HOUR', - ], - 'RestPoolValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100.0', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'savingplan_common_public_cn', - ], - 'CurrentPoolValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100.0', + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], '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' => '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' => 'Invalid user identity.'], + ['errorCode' => 'ProductCodeMissing', 'errorMessage' => 'Parameter ProductCode is missing.', 'description' => ''], + ['errorCode' => 'ProductNotSupported', 'errorMessage' => 'Product currently is not supported.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', '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":"<Message>Successful</Message>\\n<RequestId>61293E7A-3406-4447-8620-EC88B0AA66AD</RequestId>\\n<Data>\\n <TotalCount>100</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Status>NORMAL</Status>\\n <AllocationStatus>unallocated</AllocationStatus>\\n <EndTime>2021-01-01 00:00:00</EndTime>\\n <InstanceFamily>ecs.g6</InstanceFamily>\\n <InstanceId>spn-xxxxxxxx</InstanceId>\\n <StartTime>2020-01-01 00:00:00</StartTime>\\n <TotalSave>20.00</TotalSave>\\n <PrepayFee>8760.00</PrepayFee>\\n <PayMode>total</PayMode>\\n <Utilization>1.0</Utilization>\\n <Currency>CNY</Currency>\\n <PoolValue>1.00</PoolValue>\\n <Region>cn-zhangjiakou-na62-a01</Region>\\n <SavingsType>ECS</SavingsType>\\n <Tags>\\n <Value>标签1</Value>\\n <Key>标签1</Key>\\n </Tags>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'QuerySavingsPlansInstance', + '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\\": \\"Object Storage Service (OSS) resource plan (monthly)\\\\n\\",\\n \\"ProductCode\\": \\"ossbag\\",\\n \\"PackageTypes\\": {\\n \\"PackageType\\": [\\n {\\n \\"Code\\": \\"FPT_ossbag_deadlineAcc_CdnOut_common_sz\\",\\n \\"Name\\": \\"Back-to-origin traffic plan - China (Shenzhen)\\\\n\\",\\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":"","errorExample":""}]', + 'title' => 'DescribeResourcePackageProduct', + 'summary' => 'Queries the information about resource plans of an Alibaba Cloud service.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QuerySavingsPlansDeductLog' => [ - 'summary' => 'Queries the deduction details of savings plans.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-04-19T03:45:42.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourcePackageProduct'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeResourceUsageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3598,295 +3703,139 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceType', + 'name' => 'StartPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instance ID based on which the data is queried. Valid values:'."\n" - ."\n" - .'* spn: queries data based on the ID of the savings plan instance.'."\n" - .'* product: queries data based on the ID of the cloud service instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], ], [ - 'name' => 'Locale', + 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the return data. Valid values:'."\n" - ."\n" - .'* ZH: Chinese'."\n" - .'* EN: English'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ZH', - ], + 'schema' => ['description' => 'The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. If NextToken is empty, no next page exists.', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'spn-XXXXXXX', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 20. The maximum value is 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-01-01 00:00:00', - ], + 'schema' => ['description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current Alibaba Cloud account and its Resource Access Management (RAM) users is queried. To query the data of a RAM user, specify the ID of the RAM user.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-01-05 00:00:00', - ], + 'schema' => ['description' => 'The type of deduction plan whose usage details are queried. Valid values: RI and SCU.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RI', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Items' => [ - 'description' => 'The deduction details.'."\n", + 'description' => 'The data entries.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end of the billing cycle for which the fee is deducted.'."\n", - 'type' => 'string', - 'example' => '2020-12-01 01:00:00', - ], - 'StartTime' => [ - 'description' => 'The beginning of the billing cycle for which the fee is deducted. The time is in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'example' => '2020-12-01 00:00:00', - ], - 'SavingsType' => [ - 'description' => 'The type of the savings plan. Valid values:'."\n" - ."\n" - .'* universal: general-purpose'."\n" - .'* ecs: ECS compute'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1906589291020438', - ], - 'DiscountRate' => [ - 'description' => 'The discount used for the current deduction.'."\n", - 'type' => 'string', - 'example' => '0.069', - ], - 'BillModule' => [ - 'description' => 'The billable item for which the fee is deducted.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'InstanceId' => [ - 'description' => 'The ID of the savings plan instance.'."\n", - 'type' => 'string', - 'example' => 'spn-xxxxxxx', - ], - 'DeductInstanceId' => [ - 'description' => 'The ID of the instance for which the fee is deducted.'."\n", - 'type' => 'string', - 'example' => 'i-XXXXXXXXX', - ], - 'DeductCommodity' => [ - 'description' => 'The service for which the fee is deducted.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DeductRate' => [ - 'description' => 'The deduction rate.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'DeductFee' => [ - 'description' => 'The deducted amount.'."\n", - 'type' => 'string', - 'example' => '0.52', - ], - 'OwnerId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1906589291020438', - ], - 'BillingCycle' => [ - 'title' => '账期', - 'type' => 'string', - ], - 'Region' => [ - 'title' => '被抵扣实例地域', - 'type' => 'string', - ], - 'InstanceSpec' => [ - 'title' => '被抵扣实例规格', - 'type' => 'string', - ], - 'InstanceTypeFamily' => [ - 'title' => '被抵扣实例规格族', - 'type' => 'string', - ], - 'BillingOfficialPrice' => [ - 'title' => '被抵扣账单的官网价', - 'type' => 'string', - ], - 'DeductedOfficialPrice' => [ - 'title' => '被抵扣部分官网价', - 'type' => 'string', - ], + 'Status' => ['description' => 'The status of the deduction plan.', 'type' => 'string', 'example' => 'Valid', 'title' => ''], + 'UsagePercentage' => ['description' => 'The usage rate of the deduction plan.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'ResourceInstanceId' => ['description' => 'The ID of the deduction plan.', 'type' => 'string', 'example' => 'ecsri-bp147nnfz21225k9mpix00', 'title' => ''], + 'TotalQuantity' => ['description' => 'The total capacity of the deduction plan.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'ReservationCost' => ['description' => 'The fee of the deduction plan.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'RegionNo' => ['description' => 'The code of the region.', 'type' => 'string', 'example' => 'cn-hangzhou-dg-a01', 'title' => ''], + 'UserId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '123745698925000', 'title' => ''], + 'StatusName' => ['description' => 'The name of the status.', 'type' => 'string', 'example' => '生效', 'title' => ''], + 'CapacityUnit' => ['description' => 'The unit that is used to measure the resources that are deducted.', 'type' => 'string', 'example' => '算力*小时', 'title' => ''], + 'PotentialSavedCost' => ['description' => 'The potential net savings.', 'type' => 'string', 'example' => '0.13', 'title' => ''], + 'Currency' => ['description' => 'The type of the currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'ZoneName' => ['description' => 'The code of the zone.', 'type' => 'string', 'example' => '杭州 可用区I', 'title' => ''], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'ecs.t5-lc2m1.nano', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range in which the usage details were queried.', 'type' => 'string', 'example' => '2021-04-01 01:00:00', 'title' => ''], + 'PostpaidCost' => ['description' => 'The equivalent of pay-as-you-go costs.', 'type' => 'string', 'example' => '0.06', 'title' => ''], + 'ImageType' => ['description' => 'The operating system.', 'type' => 'string', 'example' => 'linux', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range in which the usage details were queried.', 'type' => 'string', 'example' => '2021-04-01 00:00:00', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + 'DeductQuantity' => ['description' => 'The amount of the deducted resources.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'SavedCost' => ['description' => 'The net savings.', 'type' => 'string', 'example' => '0.06', 'title' => ''], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'UserName' => ['description' => 'The username of the account.', 'type' => 'string', 'example' => 'test@aliyun.com', 'title' => ''], + 'Quantity' => ['description' => 'The number of deduction plans.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'title' => 'DescribeResourceUsageDetail', + 'summary' => 'Queries the usage details of reserved instances (RIs) or storage capacity units (SCUs).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageDetail'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => 'QuerySavingsPlansDeductLog', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'DescribeSavingsPlansUsageTotal' => [ - 'summary' => 'Queries the usage summary of savings plans.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeResourceUsageTotal' => [ + 'summary' => 'Queries the total usage data of reserved instances or storage capacity units (SCUs).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3894,209 +3843,129 @@ ], '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' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is included in the time range.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is excluded from the time range. If you do not specify this parameter, this parameter is set to the current time.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], ], [ 'name' => 'PeriodType', 'in' => 'query', 'schema' => [ - 'description' => 'The time granularity at which usage summary are queried. Valid values: MONTH, DAY, and HOUR.'."\n", + 'description' => 'The time granularity at which the data is queried. Valid values: MONTH, DAY, and HOUR.', + 'enumValueTitles' => ['MONTH' => 'MONTH', 'HOUR' => 'HOUR', 'DAY' => 'DAY'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', + 'title' => '', ], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query usage summary. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current account and its linked accounts is queried. To query the data of a linked account, specify the ID of the linked account. You can specify only one account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ - 'name' => 'FilterParam', + 'name' => 'ResourceType', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Dimensions' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Values' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'SelectType' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Values' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'SelectType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], + 'description' => 'The type of the resource plan. Valid values: RI and SCU.', + 'enumValueTitles' => ['SCU' => 'SCU', 'RI' => 'RI'], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RI', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '364C7C81-5E5E-51A0-B738-1969D2671B05', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'The queried data.', 'type' => 'object', 'properties' => [ 'PeriodCoverage' => [ - 'description' => 'The usage in different periods.'."\n", + 'description' => 'The usage of resource plans in the specified period.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Percentage' => [ - 'description' => 'The usage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Period' => [ - 'description' => 'The period.'."\n" - ."\n" - .'The value is in the format of yyyyMMddHH.'."\n", - 'type' => 'string', - 'example' => '2021041500', - ], + 'UsagePercentage' => ['description' => 'The usage of resource plans.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], + 'Period' => ['description' => 'The period.', 'type' => 'string', 'example' => '2021071500', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'TotalUsage' => [ - 'description' => 'The usage summary.'."\n", + 'description' => 'The total usage of resource plans.', 'type' => 'object', 'properties' => [ - 'PostpaidCost' => [ - 'description' => 'The pay-as-you-go cost.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'SavedCost' => [ - 'description' => 'The amount that is saved.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'UsagePercentage' => [ - 'description' => 'The total usage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'PoolValue' => [ - 'description' => 'The total amount of the savings plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], + 'PostpaidCost' => ['description' => 'The total costs of pay-as-you-go instances.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'SavedCost' => ['description' => 'The total savings.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'UsagePercentage' => ['description' => 'The total usage of resource plans.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'PotentialSavedCost' => ['description' => 'The total potential savings.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'ReservationCost' => ['description' => 'The fee of purchased resource plans.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"Percentage\\": 1,\\n \\"Period\\": \\"2021041500\\"\\n }\\n ],\\n \\"TotalUsage\\": {\\n \\"PostpaidCost\\": 200,\\n \\"SavedCost\\": 100,\\n \\"UsagePercentage\\": 1,\\n \\"PoolValue\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSavingsPlansUsageTotalResponse>\\n <Code>success</Code>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PeriodCoverage>\\n <Percentage>1</Percentage>\\n <Period>2021041500</Period>\\n </PeriodCoverage>\\n <TotalUsage>\\n <PostpaidCost>200</PostpaidCost>\\n <SavedCost>100</SavedCost>\\n <UsagePercentage>1</UsagePercentage>\\n <PoolValue>100</PoolValue>\\n </TotalUsage>\\n </Data>\\n</DescribeSavingsPlansUsageTotalResponse>","errorExample":""}]', - 'title' => 'DescribeSavingsPlansUsageTotal', - ], - 'DescribeSavingsPlansUsageDetail' => [ - 'summary' => 'Queries the usage details of savings plans.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeResourceUsageTotal', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeResourceUsageTotal'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSavingsPlansCoverageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4104,77 +3973,37 @@ ], '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' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The start time is inclusive. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => 'The end of the time range to query. The end time is exclusive. If you do not set this parameter, the current time is used as the end time. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The time granularity for the usage summary. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query usage details within a specific time range for the first time. The response returns a token that you can use to query usage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'schema' => ['description' => 'The token for paging. Leave this empty for the first query. The response includes a token for the next page. An empty token means all data has been returned.', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - ], + 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query usage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The ID of the account that owns the resource. The resource owner is the account that uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ 'name' => 'FilterParam', @@ -4188,42 +4017,51 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -4232,146 +4070,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The message returned for the call.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'NextToken' => [ - 'description' => 'The token of the next page.'."\n", - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9', - ], + 'TotalCount' => ['description' => 'The total number of data entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], 'Items' => [ - 'description' => 'The data entries.'."\n", + 'description' => 'The data items.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance.'."\n" - ."\n" - .'A value of -1 indicates that the payment is overdue. A value of 1 indicates that the instance is active.'."\n", - 'type' => 'string', - 'example' => '-1', - ], - 'Type' => [ - 'description' => 'The type of the savings plan. Valid values: universal and ECS compute.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'UsagePercentage' => [ - 'description' => 'The usage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', - ], - 'UserId' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123745698925000', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'spn-a1fhs54c243hP22', - ], - 'Currency' => [ - 'description' => 'The currency.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'PostpaidCost' => [ - 'description' => 'The pay-as-you-go cost.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '4.2', - ], - 'DeductValue' => [ - 'description' => 'The used amount of the savings plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '3.94', - ], - 'StartPeriod' => [ - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '2021-08-01 00:00:00', - ], - 'SavedCost' => [ - 'description' => 'The amount that is saved.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.08', - ], - 'PoolValue' => [ - 'description' => 'The total amount of the savings plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '29.84', - ], - 'UserName' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'test13@test.aliyun.com', - ], - 'EndPeriod' => [ - 'description' => 'The end time.'."\n", - 'type' => 'string', - 'example' => '2021-08-09 00:00:00', - ], + 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1906589291020438', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the owner of the resource for which costs were deducted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1906589291020438', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp1d9x623987rlj0dx4xx', 'title' => ''], + 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'ecs.sn1ne.3xlarge', 'title' => ''], + 'PostpaidCost' => ['description' => 'The pay-as-you-go cost.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'CoveragePercentage' => ['description' => 'The coverage percentage.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + 'DeductAmount' => ['description' => 'The deducted amount.', 'type' => 'number', 'format' => 'float', 'example' => '5.5', 'title' => ''], + 'StartPeriod' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2023-04-01 00:00:00', 'title' => ''], + 'TotalAmount' => ['description' => 'The total cost.', 'type' => 'number', 'format' => 'float', 'example' => '6.11', 'title' => ''], + 'UserName' => ['description' => 'The username of the account.', 'type' => 'string', 'example' => 'xxx@test.aliyunid.com', 'title' => ''], + 'EndPeriod' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2023-05-01 00:00:00', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSavingsPlansUsageDetail', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'title' => 'DescribeSavingsPlansCoverageDetail', + 'summary' => 'Queries detailed information about savings plan coverage.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageDetail'], + ], + ], + 'ramActions' => [], + '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' => [ - 'summary' => 'Queries the coverage summary of savings plans.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4379,56 +4139,27 @@ ], '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' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-07-15 00:00:00', - ], + 'schema' => ['description' => 'The start time of the savings plan. Format: yyyy-MM-dd HH:mm:ss. The query includes this time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-07-15 00:00:00', 'title' => ''], ], [ 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-07-20 00:00:00', - ], + 'schema' => ['description' => 'The end time of the savings plan. Format: yyyy-MM-dd HH:mm:ss. The query excludes this time. If empty, the query ends at the current time.', 'type' => 'string', 'required' => false, 'example' => '2021-07-20 00:00:00', 'title' => ''], ], [ 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which coverage summary are queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The time dimension of the savings plan. MONTH: monthly. DAY: daily. HOUR: hourly.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query coverage summary. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The ID of the resource ownership account. This is the account that actually uses the resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ 'name' => 'FilterParam', @@ -4442,42 +4173,51 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -4486,93 +4226,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'Request identifier', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ 'PeriodCoverage' => [ - 'description' => 'The coverage in different periods.'."\n", + 'description' => 'Coverage by period', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Percentage' => [ - 'description' => 'The coverage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Period' => [ - 'description' => 'The period.'."\n" - ."\n" - .'The value is in the format of yyyyMMddHH.'."\n", - 'type' => 'string', - 'example' => '2021071500', - ], + 'Percentage' => ['description' => 'Coverage percentage', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Period' => ['description' => 'Time period in the format yyyyMMddHH', 'type' => 'string', 'example' => '2021071500', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'TotalCoverage' => [ - 'description' => 'The coverage summary.'."\n", + 'description' => 'Total coverage', 'type' => 'object', 'properties' => [ - 'CoveragePercentage' => [ - 'description' => 'The total coverage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'DeductAmount' => [ - 'description' => 'The total deducted amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], + 'CoveragePercentage' => ['description' => 'Total coverage percentage', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'DeductAmount' => ['description' => 'Total deduction amount', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"Percentage\\": 1,\\n \\"Period\\": \\"2021071500\\"\\n }\\n ],\\n \\"TotalCoverage\\": {\\n \\"CoveragePercentage\\": 1,\\n \\"DeductAmount\\": 100\\n }\\n }\\n}","type":"json"}]', 'title' => 'DescribeSavingsPlansCoverageTotal', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSavingsPlansCoverageDetail' => [ - 'summary' => 'Queries the coverage details of savings plans.', - 'methods' => [ - 'post', - 'get', + 'summary' => 'Queries the total coverage of savings plans.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansCoverageTotal'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'extraInfo' => ' ', + ], + 'DescribeSavingsPlansUsageDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4580,77 +4306,37 @@ ], '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' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-07-15 13:40:45', - ], + 'schema' => ['description' => 'The start of the time range to query. The format is yyyy-MM-dd HH:mm:ss. The query includes data from this time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-08-09 00:00:00', - ], + 'schema' => ['description' => 'The end of the time range to query. The format is yyyy-MM-dd HH:mm:ss. The query does not include data from this time. If you leave this parameter empty, the query ends at the current time.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], ], [ 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which coverage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DAY', - ], + 'schema' => ['description' => 'The time granularity of the usage summary. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'schema' => ['description' => 'The pagination token. For the first query, leave this parameter empty. The response returns a token for the next page. If the returned token is empty, all data has been retrieved.', 'type' => 'string', 'required' => false, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - ], + 'schema' => ['description' => 'The maximum number of data records to return on each page. The default value is 20. The maximum value is 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query coverage details.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The ID of the account for which you want to query usage details. If you leave this parameter empty, the system queries data for the current account and its trusteeship linked accounts. Specify the ID of a trusteeship linked account to query data for that account only.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ 'name' => 'FilterParam', @@ -4664,42 +4350,51 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'SelectType' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Values' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -4708,139 +4403,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'NextToken' => [ - 'description' => 'The token of the next page.'."\n", - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'TotalCount' => ['description' => 'The total number of data entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9', 'title' => ''], 'Items' => [ - 'description' => 'The data entries.'."\n", + 'description' => 'The data items.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2831685687844416', - ], - 'OwnerId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1906589291020438', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'spn-a1fhs54c243hP22', - ], - 'Currency' => [ - 'description' => 'The currency.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'InstanceSpec' => [ - 'description' => 'The specifications.'."\n", - 'type' => 'string', - 'example' => '7th_generation_X86_group', - ], - 'PostpaidCost' => [ - 'description' => 'The pay-as-you-go cost.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'CoveragePercentage' => [ - 'description' => 'The coverage.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DeductAmount' => [ - 'description' => 'The deducted amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'StartPeriod' => [ - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '2021-05-05 14:00:00', - ], - 'TotalAmount' => [ - 'description' => 'The total expenditure.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'UserName' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'tester1@test.aliyun.com', - ], - 'EndPeriod' => [ - 'description' => 'The end time.'."\n", - 'type' => 'string', - 'example' => '2021-05-05 15:00:00', - ], + 'Status' => ['description' => 'The current status.'."\n" + ."\n" + .'A value of -1 indicates an overdue payment. A value of 1 indicates that the plan is active.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'Type' => ['description' => 'The type of the savings plan, such as General-purpose or ECS compute-optimized.', 'type' => 'string', 'example' => '通用型', 'title' => ''], + 'UsagePercentage' => ['description' => 'The usage percentage.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], + 'UserId' => ['description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123745698925000', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'spn-a1fhs54c243hP22', 'title' => ''], + 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'PostpaidCost' => ['description' => 'The standard pay-as-you-go cost.', 'type' => 'number', 'format' => 'float', 'example' => '4.2', 'title' => ''], + 'DeductValue' => ['description' => 'The amount deducted from the savings plan. This is the used commitment.', 'type' => 'number', 'format' => 'float', 'example' => '3.94', 'title' => ''], + 'StartPeriod' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2021-08-01 00:00:00', 'title' => ''], + 'SavedCost' => ['description' => 'The net amount saved.', 'type' => 'number', 'format' => 'float', 'example' => '0.08', 'title' => ''], + 'PoolValue' => ['description' => 'The total commitment of the savings plan.', 'type' => 'number', 'format' => 'float', 'example' => '29.84', 'title' => ''], + 'UserName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test13@test.aliyun.com', 'title' => ''], + 'EndPeriod' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2021-08-09 00:00:00', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeSavingsPlansCoverageDetail', - ], - 'QuerySavingsPlansDiscount' => [ - 'summary' => 'Queries discounts on savings plans.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'title' => 'DescribeSavingsPlansUsageDetail', + 'summary' => 'Queries the usage details of savings plans.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageDetail'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSavingsPlansUsageTotal' => [ + 'summary' => 'Queries the total usage of savings plans.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4848,817 +4479,299 @@ ], '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' => 'The code of the pricing module.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'instance_type', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The beginning of the time range is included in the query. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-01 00:00:00', 'title' => ''], ], [ - 'name' => 'PayMode', + 'name' => 'EndPeriod', 'in' => 'query', - 'schema' => [ - 'title' => 'payMode', - 'description' => 'The payment mode. Valid values: total: all upfront. half: half upfront. zero: no upfront.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'zero' => '', - 'total' => '', - 'half' => '', - ], - 'example' => 'total', - ], + 'schema' => ['description' => 'The end of the time range to query. The end of the time range is not included in the query. If you do not specify this parameter, the current time is used. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '2021-01-02 00:00:00', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PeriodType', 'in' => 'query', - 'schema' => [ - 'title' => 'pageSize', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The time granularity of the usage summary to query. Valid values: MONTH, DAY, and HOUR.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HOUR', 'title' => ''], ], [ - 'name' => 'SpnType', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'title' => 'spnType', - 'description' => 'The type of the savings plan. Valid values: ecs: Elastic Compute Service (ECS) compute type. universal: general-purpose type.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'ecs' => '', - 'universal' => '', - ], - 'example' => 'universal', - ], + 'schema' => ['description' => 'The ID of the account that owns the resource. The resource owner is the account that uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123745698925000', 'title' => ''], ], [ - 'name' => 'Locale', + 'name' => 'FilterParam', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'locale', - 'description' => 'The identifier of the language.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EN: English.'."\n" - .'* ZH: Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EN' => '', - 'ZH' => '', + 'type' => 'object', + 'properties' => [ + 'Dimensions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Values' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], - 'example' => 'ZH', - ], - ], - [ - 'name' => 'Cycle', - 'in' => 'query', - 'schema' => [ - 'title' => 'cycle', - 'description' => 'The cycle based on which queries are performed.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1:Year', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'title' => 'pageNum', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'query', - 'schema' => [ - 'title' => 'spec', - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.g6', - ], - ], - [ - 'name' => 'CommodityCode', - 'in' => 'query', - 'schema' => [ - 'title' => 'commodityCode', - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SpnCommodityCode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The message returned for the call.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => 'data', - 'description' => 'data'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'title' => 'hostId', - 'description' => 'The IP address of the request.'."\n", - 'type' => 'string', - 'example' => '100.104.180.109', - ], - 'Items' => [ - 'description' => 'The information about the discounts on saving plans.'."\n", + 'PeriodCoverage' => [ + 'description' => 'The usage data for each time period.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the discount.'."\n", 'type' => 'object', 'properties' => [ - 'CommodityName' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'Pay-as-you-go Elastic Compute Service (ECS) instance'."\n", - ], - 'ModuleName' => [ - 'description' => 'The name of the pricing module.'."\n", - 'type' => 'string', - 'example' => 'Instance'."\n", - ], - 'SpnType' => [ - 'description' => 'The type of the savings plan.'."\n", - 'type' => 'string', - 'example' => 'universal', - ], - 'PayMode' => [ - 'description' => 'The payment mode. Valid values:'."\n" - ."\n" - .'* total: all upfront'."\n" - .'* half: half upfront'."\n" - .'* zero: no upfront'."\n", - 'type' => 'string', - 'example' => 'total', - ], - 'Cycle' => [ - 'description' => 'The cycle based on which queries were performed.'."\n", - 'type' => 'string', - 'example' => '1:Year', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou-na62-a01', - ], - 'RegionCode' => [ - 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation to query the region ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Spec' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'ecs.g6', - ], - 'DiscountRate' => [ - 'description' => 'The discount provided by the official website.'."\n", - 'type' => 'string', - 'example' => '0.85', - ], - 'ContractDiscountRate' => [ - 'description' => 'The contracted discount.'."\n", - 'type' => 'string', - 'example' => '0.85', - ], + 'Percentage' => ['description' => 'The usage rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Period' => ['description' => 'The time period of the data. The format is yyyyMMddHH.', 'type' => 'string', 'example' => '2021041500', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'TotalUsage' => [ + 'description' => 'The summary of the total usage.', + 'type' => 'object', + 'properties' => [ + 'PostpaidCost' => ['description' => 'The pay-as-you-go cost.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'SavedCost' => ['description' => 'The savings.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'UsagePercentage' => ['description' => 'The total usage rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'PoolValue' => ['description' => 'The total pool value of the savings plan.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'PARAM_ERROR', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'title' => 'DescribeSavingsPlansUsageTotal', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSavingsPlansUsageTotal'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"This API is not applicable for caller.\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"100.104.180.109\\",\\n \\"Items\\": [\\n {\\n \\"CommodityName\\": \\"云服务器ECS-按量付费\\",\\n \\"ModuleName\\": \\"实例\\",\\n \\"SpnType\\": \\"universal\\",\\n \\"PayMode\\": \\"total\\",\\n \\"Cycle\\": \\"1:Year\\",\\n \\"Region\\": \\"张家口\\",\\n \\"RegionCode\\": \\"cn-hangzhou\\",\\n \\"Spec\\": \\"ecs.g6\\",\\n \\"DiscountRate\\": \\"0.85\\",\\n \\"ContractDiscountRate\\": \\"0.85\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'QuerySavingsPlansDiscount', + 'ramActions' => [], + '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\\": \\"2021041500\\"\\n }\\n ],\\n \\"TotalUsage\\": {\\n \\"PostpaidCost\\": 200,\\n \\"SavedCost\\": 100,\\n \\"UsagePercentage\\": 1,\\n \\"PoolValue\\": 100\\n }\\n }\\n}","type":"json"}]', ], - 'CreateResellerUserQuota' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSplitItemBill' => [ + 'summary' => 'Queries split bills.', + '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', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'Currency', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CNY', - ], + 'schema' => ['description' => 'The billing cycle. Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2020-03'], ], [ - 'name' => 'OutBizId', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7ed0bedc-056e-4a71-9249-4581615c028f', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], - [ - 'errorCode' => '-303', - 'errorMessage' => 'Record is exists already.', - ], - [ - 'errorCode' => 'CreditInnerError', - 'errorMessage' => 'This interface has some error. Please try again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'summary' => 'Creates a quota ledger and a consumption ledger.', - ], - 'SetResellerUserQuota' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'Amount', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The quota of a quota ledger. Unit: CNY.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '750', - ], + 'schema' => ['description' => 'The type of the product.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'Currency', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'You do not need to set the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'N/A'."\n", - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.'."\n" + ."\n" + .'> This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PayAsYouGo'], ], [ - 'name' => 'OutBizId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the business.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OD2022040818295234777795624764689', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. The value is the NextToken value that is returned in the previous API call. If a value is specified, the new query starts from the next page. If you leave this parameter empty, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CAESEgoQCg4KCmd'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of this topic.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'Data' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], - ], - 500 => [ - [ - 'errorCode' => 'CreditInnerError', - 'errorMessage' => 'This interface has some error. Please try again.', - ], - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'Modify the quota ledger and consumption ledger.', - 'summary' => 'Modify the quota ledger and consumption ledger.', - ], - 'ChangeResellerConsumeAmount' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'AdjustType', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the consumption amount adjustment. Valid values: increase: The consumption amount increases because new consumption occurs. decrease: The consumption amount decreases because funds are added to the account. This parameter is required.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'increase/decrease', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ - 'name' => 'Amount', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The amount to be adjusted. Unit: CNY'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10.00', - ], + 'schema' => ['description' => 'The ID of the account that owns the resource. The account that owns the resource is the account that actually uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '123'], ], [ - 'name' => 'Currency', + 'name' => 'InstanceID', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the currency.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CNY', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], ], [ - 'name' => 'BusinessType', + 'name' => 'SplitItemID', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the business.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'quota_amount_adjust', - ], + 'schema' => ['description' => 'The ID of the split item.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], ], [ - 'name' => 'Source', + 'name' => 'Granularity', 'in' => 'query', - 'schema' => [ - 'description' => 'The source of the request. Specify the system name for the parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'system', - ], + 'schema' => ['description' => 'The granularity to query bills. Valid values:'."\n" + ."\n" + .'- MONTHLY: queries bills by month. The data is consistent with the data on the Billing Cycle tab of the Split Bill page in User Center.'."\n" + ."\n" + .'- DAILY: queries bills by day. The data is consistent with the data on the By Day tab of the Split Bill page in User Center.'."\n" + ."\n" + .'> If you set this parameter to DAILY, you must specify the BillingDate parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Monthly'], ], [ - 'name' => 'OutBizId', + 'name' => 'BillingDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the primary key for external business. The ID is used for idempotence verification.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1647396865', - ], + 'schema' => ['description' => 'The billing date. This parameter is required only when the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2020-03-02'], ], [ - 'name' => 'ExtendMap', + 'name' => 'TagFilter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The extended field of a message.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of the topic.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'Data' => [ - 'description' => 'The consumption quota for the quota ledger after adjustment.'."\n", - 'type' => 'string', - 'example' => '300.00', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The tag filter. You can specify multiple tag values for the TagValues parameter. The relationship between multiple tag values is OR.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag filter.', + 'type' => 'object', + 'properties' => [ + 'TagValues' => [ + 'description' => 'The tag values. A list of strings. TagValues.N can be 1 to 20, and 1 to 128 characters in length.'."\n" + ."\n" + .'- If you specify the TagValues.N parameter, you must also specify TagFilter.N.TagKey. Otherwise, an InvalidParameter.TagValues error is reported.'."\n" + ."\n" + .'- If you specify multiple tag values, bills that match any of the tag values are queried.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestValue'], + 'required' => false, + 'example' => 'TestValue', + 'maxItems' => 20, + 'title' => '', + ], + 'TagKey' => ['description' => 'Specifies the tag key for filtering cost allocation or billing data.'."\n" + ."\n" + .'- Valid range for N: 1 to 20 (you can define up to 20 tag filters).'."\n" + ."\n" + .'- Length: 1 to 128 characters.'."\n" + ."\n" + .'Behavior:'."\n" + ."\n" + .'- If you specify only TagKey (without TagValue), the system returns bills for all resources that have that tag key assigned (regardless of value).'."\n" + ."\n" + .'- If you specify multiple TagKey+TagValue pairs, the system uses OR logic: bills are returned if any of the key-value pairs match.'."\n" + ."\n" + .'- Billing data reflects the tags as they existed during the billing period. If a tag is removed or changed, past bills are not re-evaluated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'TestKey'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], - [ - 'errorCode' => '-1101', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"300.00\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryResellerAvailableQuota' => [ - 'summary' => 'Queries the remaining quota that can be used in the current account to make payments for other accounts.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ItemCodes', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', 'required' => false, + 'maxItems' => 20, + 'title' => '', 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Successful!', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '300', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], - [ - 'errorCode' => '-304', - 'errorMessage' => 'Record is not exists.', - ], - [ - 'errorCode' => 'CreditInnerError', - 'errorMessage' => 'This interface has some error. Please try again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": \\"300\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'SetResellerUserAlarmThreshold' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'AlarmType', + 'name' => 'IsHideZeroCharge', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'quota_low_balance', + 'description' => 'Specifies whether to filter out bills for which the PretaxGrossAmount and PretaxAmount are both 0. Valid values:'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'- true', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'false', ], ], [ - 'name' => 'AlarmThresholds', + 'name' => 'PipCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"denominator\\":100,\\"numerator\\":30,\\"thresholdType\\":1}]', - ], + 'schema' => ['description' => 'The code of the product. This code is consistent with the product code on the bill in User Center.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], ], 'responses' => [ @@ -5666,77 +4779,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Successful!', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. If this parameter is empty, all the results are returned. For the next query, pass the value of this parameter as the NextToken request parameter.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4K'], + 'BillingCycle' => ['description' => 'The billing cycle. Format: YYYY-MM.', 'type' => 'string', 'title' => '', 'example' => '2020-03'], + 'MaxResults' => ['description' => 'The maximum number of entries returned for the current request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountID' => ['description' => 'The ID of the account.', 'type' => 'string', 'title' => '', 'example' => '185xxxx3489'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'Items' => [ + 'description' => 'The details of the bill.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => ['description' => 'The ID of the account to which the split item belongs.', 'type' => 'string', 'title' => '', 'example' => '12**122'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'SubscriptionType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'title' => '', 'example' => 'ecs.sn1ne.3xlarge'], + 'DeductedByCoupons' => ['description' => 'The amount deducted with coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => '杭州'], + 'PipCode' => ['description' => 'The code of the product. This code is consistent with the product code on the bill in User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'CommodityCode' => ['description' => 'The code of the commodity. This code is consistent with the product detail code in User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'NickName' => ['description' => 'The nickname of the instance.', 'type' => 'string', 'title' => '', 'example' => 'nick'], + 'ProductDetail' => ['description' => 'The details of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'Usage' => ['description' => 'The usage.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'IntranetIP' => ['description' => 'The private IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'], + 'UsageUnit' => ['description' => 'The unit of the usage.', 'type' => 'string', 'title' => '', 'example' => 'GB'], + 'SplitCommodityCode' => ['description' => 'The commodity code of the split item.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => '185xxxx3489'], + 'ProductType' => ['description' => 'The type of the product.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'DeductedByResourcePackage' => ['description' => 'The amount deducted with resource plans.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'SplitBillingCycle' => ['description' => 'The month of the split bill.', 'type' => 'string', 'title' => '', 'example' => '2021-06'], + 'ServicePeriod' => ['description' => 'The service duration.', 'type' => 'string', 'title' => '', 'example' => '20'], + 'SplitItemName' => ['description' => 'The name of the split item.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'], + 'ListPrice' => ['description' => 'The unit price.', 'type' => 'string', 'title' => '', 'example' => '0.12'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => '华北1'], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'InstanceConfig' => ['description' => 'The instance configuration details.', 'type' => 'string', 'title' => '', 'example' => 'CPU:12'], + 'BillingDate' => ['description' => 'The billing date. Format: YYYY-MM-DD. This parameter is not supported.', 'type' => 'string', 'title' => '', 'example' => '2020-01-20'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x'], + 'Item' => ['description' => 'The type of the bill. Valid values:'."\n" + ."\n" + .'- SubscriptionOrder: subscription order.'."\n" + ."\n" + .'- PayAsYouGoBill: pay-as-you-go bill.'."\n" + ."\n" + .'- Refund: refund.'."\n" + ."\n" + .'- Adjustment: adjustment.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGoBill'], + 'SplitItemID' => ['description' => 'The ID of the split item.', 'type' => 'string', 'title' => '', 'example' => 'i-28bycvyb4'], + 'InstanceID' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], + 'Tag' => ['description' => 'The tag of the resource. If the tag of a resource is changed, the bill generated for the resource during the lifecycle of the tag contains the tag.', 'type' => 'string', 'title' => '', 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1'], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'BillingItem' => ['description' => 'The billable item.', 'type' => 'string', 'title' => '', 'example' => '带宽'], + 'BillingItemCode' => ['description' => 'The code of the billable item.', 'type' => 'string', 'title' => '', 'example' => 'disk'], + 'CostUnit' => ['description' => 'The cost center.', 'type' => 'string', 'title' => '', 'example' => '未分配'], + 'ListPriceUnit' => ['description' => 'The unit of the unit price.', 'type' => 'string', 'title' => '', 'example' => '元/GB'], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ServicePeriodUnit' => ['description' => 'The unit of the service duration.', 'type' => 'string', 'title' => '', 'example' => '小时'], + 'SplitBillingDate' => ['description' => 'The day of the split bill.', 'type' => 'string', 'title' => '', 'example' => '2021-06-01'], + 'ProductName' => ['description' => 'The name of the product.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'SplitProductDetail' => ['description' => 'The name of the split item\'s product detail.', 'type' => 'string', 'title' => '', 'example' => '云数据库'], + 'OwnerID' => ['description' => 'The ID of the account that owns the resource. This parameter is returned in multi-account payment scenarios.', 'type' => 'string', 'title' => '', 'example' => '169***013'], + 'InvoiceDiscount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'SplitAccountName' => ['description' => 'The name of the account to which the split item belongs.', 'type' => 'string', 'title' => '', 'example' => 'test**1122'], + 'BillingType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => '其它'], + 'ProductCode' => ['description' => 'The code of the product.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ItemName' => ['description' => 'The name of the item.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'], + 'AfterDiscountAmount' => ['type' => 'number', 'format' => 'float', 'description' => 'The amount after a discount. This is the amount payable after a discount is applied. Formula: Amount after discount = List price - Discount.', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter', - ], - ], - 500 => [ - [ - 'errorCode' => 'CreditInnerError', - 'errorMessage' => 'This interface has some error. Please try again.', - ], - [ - 'errorCode' => 'UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"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 \\"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 \\"SplitBillingCycle\\": \\"2021-06\\",\\n \\"ServicePeriod\\": \\"20\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"ListPrice\\": \\"0.12\\",\\n \\"Zone\\": \\"华北1\\",\\n \\"PretaxGrossAmount\\": 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 \\"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 \\"OwnerID\\": \\"169***013\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"SplitAccountName\\": \\"test**1122\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"AfterDiscountAmount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSplitItemBill', + 'description' => '- Split bill data for the current month is for reference only and cannot be used for reconciliation. The final bill for the current month is available for query after 12:00 (UTC+8) on the fourth day of the next month. The split bill data for the current month does not include unsettled pay-as-you-go data.'."\n" + ."\n" + .'- You can query split bill data from the past 12 months.'."\n" + ."\n" + .'- Split bill data is updated with a 48-hour delay from the actual resource consumption. For products that support split billing, such as CDN, OSS, and Internet Shared Bandwidth, the costs of individual billable items, such as domain names, buckets, and EIPs, are updated with a 72-hour delay.'."\n" + ."\n" + .'- Split bill data is available only after you enable the split bill feature on the <props="china">[Split Bill](https://usercenter2.aliyun.com/finance/split-bill)</props><props="intl">[Split Bill](https://usercenter2-intl.aliyun.com/finance/split-bill)</props> page in the console. The data becomes available 24 hours after you enable the feature.'."\n" + ."\n" + .'- A single user can perform a maximum of 10 queries per second (QPS). If a timeout error occurs, retry the request.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSplitItemBill'], ], ], - '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"}]', + 'ramActions' => [], + 'translator' => 'machine', ], - 'QueryResellerUserAlarmThreshold' => [ - 'summary' => '查询用户的信控预警阀值,该接口暂未测试启用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAccountRelation' => [ + 'summary' => 'Queries the details of a financial relationship.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5744,452 +4919,159 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AlarmType', + 'name' => 'RelationId', 'in' => 'query', - 'schema' => [ - 'title' => '预警类型 [必填,quota_low_balance:Quota低额预警 month_consume_high:月消费高额预警', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'quota_low_balance' => 'quota_low_balance', - ], - 'example' => 'quota_low_balance', - ], + 'schema' => ['title' => 'relationId', 'description' => 'The ID of the financial relationship. Value returned by calling the AddAccountRelation operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['title' => 'requestId', 'description' => 'The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.'."\n", 'type' => 'string', 'required' => false, 'example' => 'requestId'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListResult<AlarmThresholdPop>', - 'description' => 'ListResult<AlarmThresholdPop>', + 'title' => 'result', + 'description' => 'result'."\n", 'type' => 'object', 'properties' => [ + 'Message' => ['title' => 'message', 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Message returned'."\n"], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'RequestId'], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ThresholdType' => [ - 'title' => '报警类型 0 数值 1比例 其他默认为 数值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ThresholdAmount' => [ - 'title' => '预警额度 为0有效', - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'Numerator' => [ - 'title' => '预警百分比_分子 为1有效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Denominator' => [ - 'title' => '预警百分比_分母 为1有效', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], + 'title' => 'data', + 'description' => 'data'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'id', 'description' => 'The ID of the financial relationship.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'ID of the financial relationship'."\n"], + 'ParentUserId' => ['title' => 'parentUserId', 'description' => 'The ID of the Alibaba Cloud account that is used as the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'ID of the Alibaba Cloud account that is used as the management account'."\n"], + 'ChildUserId' => ['description' => 'The ID of the Alibaba Cloud account that is used as a member.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'ID of the Alibaba Cloud account that is used as a member'."\n", 'title' => ''], + 'StartTime' => ['description' => 'The time when the financial relationship between the management account and the member was established.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-11-01', 'title' => ''], + 'EndTime' => ['description' => 'The time when the financial relationship between the management account and the member was terminated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-12-01', 'title' => ''], + 'Type' => ['title' => 'type', 'description' => 'The type of the financial relationship.'."\n", 'type' => 'string', 'example' => 'enterprise_group'], + 'Status' => ['description' => 'The status of the financial relationship between the management account and the member.'."\n" + ."\n" + .'- RELATED [Association established]'."\n" + .'- CONFIRMING [To be confirmed by the other party]'."\n" + .'- REJECTED [Refused by the other party]'."\n" + .'- CONNECTION_CANCELED [Financial sub-account cancel request]'."\n" + .'- CONNECTION_MASTER_CANCEL [Financial master account cancel invitation]'."\n" + .'- CHANGE_CONFIRMING [Relationship change to be confirmed]'."\n" + .'- INITIAL [Initial new relationship status]', 'type' => 'string', 'example' => 'RELATED', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the financial relationship between the management account and the member was modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-12-01', 'title' => ''], ], ], - 'Count' => [ - 'title' => '根据查询', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'title' => '标识本次调用是否返回', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'title' => '本次调用返回code，一般为错误代码', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'title' => '本次调用返回的消息，一般为错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => '请求Id', - 'description' => '', - 'type' => 'string', - 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', - ], + 'Code' => ['title' => 'code', 'description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200'], + 'Success' => ['title' => 'success', 'description' => 'Indicates whether the call is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - '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 ', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Message returned\\\\n\\",\\n \\"RequestId\\": \\"RequestId\\",\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"ParentUserId\\": 0,\\n \\"ChildUserId\\": 0,\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"Type\\": \\"enterprise_group\\",\\n \\"Status\\": \\"RELATED\\",\\n \\"GmtModified\\": 0\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetAccountRelation', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountRelation'], ], ], - '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"}]', + 'ramActions' => [], ], - 'SetResellerUserStatus' => [ - 'summary' => '设置生态终端客户状态', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCustomerAccountInfo' => [ + 'summary' => 'Queries the account information of a customer.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The account status that you want to set. Valid values: Freeze: The account is frozen. Thaw: The account is unfrozen. Trusteeship: The account is hosted. TrusteeshipCancel: The account is not hosted.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Freeze', - ], - ], - [ - 'name' => 'BusinessType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the business. Valid values: FREEZE: the frozen business of the account. TRUSTEESHIP: the hosted business of the account.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FREEZE', - ], - ], - [ - 'name' => 'StopMode', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '停机模式'."\n" - .'取值：'."\n" - .' 0：普通停机'."\n" - .' 1：立即停机', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of this topic.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '94017C56-1725-5DD9-AB41-B3BAE791D600'], + 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates that the request was successful. A value of `false` indicates that the request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Mpk' => ['description' => 'The MPK of the master account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1051360339779133'], + 'LoginEmail' => ['description' => 'The email address of the customer.', 'type' => 'string', 'title' => '', 'example' => 'xxxx@aliyun.com'], + 'HostingStatus' => ['description' => 'Valid values:'."\n" + ."\n" + .'FREEZE: The service is frozen.'."\n" + ."\n" + .'TRUSTEESHIP: The service is hosted.', 'type' => 'string', 'title' => '', 'example' => 'FREEZE'], + 'AccountType' => ['description' => '0: individual', 'type' => 'string', 'title' => '', 'example' => '1'], + 'CreditLimitStatus' => ['description' => 'Valid values:'."\n" + ."\n" + .'- Freeze: The user\'s account is frozen.'."\n" + ."\n" + .'- Thaw: The user\'s account is restored.'."\n" + ."\n" + .'- Trusteeship: The user\'s account is hosted.'."\n" + ."\n" + .'- TrusteeshipCancel: The user\'s account is not hosted.', 'type' => 'string', 'title' => '', 'example' => 'Freeze'], + 'IsCertified' => ['description' => 'The real-name verification status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 200 => [ - [ - 'errorCode' => '-116', - 'errorMessage' => 'Fail to modify Enduser status, Quota is less than 0.', - ], - ], 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - [ - 'errorCode' => 'ParameterError', - 'errorMessage' => 'Missing the must parameter.', - ], - [ - 'errorCode' => 'SYSTEM_ERROR', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'CreditInnerError', - 'errorMessage' => 'This interface has some error. Please try again.', - ], - [ - 'errorCode' => 'NOT_ALLOW_CANCEL_TRUSTSHIP', - 'errorMessage' => 'Only supports setting to trusteeship.', - ], - ], - 500 => [ - [ - 'errorCode' => ' UndefinedError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CreateAgAccount' => [ - 'summary' => 'Creates an account to establish a financial relationship.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'LoginEmail', - 'in' => 'query', - 'schema' => [ - 'description' => 'The email address used to log on to the account.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'email', - ], - ], - [ - 'name' => 'AccountAttr', - 'in' => 'query', - 'schema' => [ - 'description' => 'The attribute of the account. To view the attribute of the account, use the account to log on to the Alibaba Cloud Management Console, move the pointer over the profile picture in the upper-right corner, and then click **Security Settings**.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'EnterpriseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Dongguan ChuangNeng Electric Appliance Co., Ltd'."\n", - ], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], ], [ - 'name' => 'FirstName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The first name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Zhicheng'."\n", - ], + ['errorCode' => 'VnoNoDataError', 'errorMessage' => 'There is no data by this request.', 'description' => ''], ], - [ - 'name' => 'LastName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The last name.'."\n" - ."\n" - .'The last name can be up to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Wu'."\n", - ], - ], - [ - 'name' => 'NationCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The country code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CN', - ], - ], - [ - 'name' => 'ProvinceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the province. This parameter is optional.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Beijing'."\n", - ], - ], - [ - 'name' => 'CityName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the city.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Beijing'."\n", - ], + 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' => 'GetCustomerAccountInfo', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Postcode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The zip code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '350000', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'LOGIN_EMAIL_HAS_BEEN_USED', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'loginEmail=685741089H@chinaunicom.cn,has used', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AgRelationDto' => [ - 'description' => 'The relationship between the account that is used to call the CreateAgAccount operation and the account that is created.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the relationship.'."\n", - 'type' => 'string', - 'example' => 'FINACE_CLOUD', - ], - 'Pk' => [ - 'description' => 'The ID of the account that is created.'."\n", - 'type' => 'string', - 'example' => '1728240534507590', - ], - 'RamAdminRoleName' => [ - 'description' => 'The role of the account that is created.'."\n", - 'type' => 'string', - 'example' => 'admin-role', - ], - 'Mpk' => [ - 'description' => 'The ID of the account that is used to call the CreateAgAccount operation.'."\n", - 'type' => 'string', - 'example' => '1785287436011964', - ], - ], - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerAccountInfo'], ], ], - '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"}]', - 'description' => 'You can call this operation to create an account so as to establish a master-member financial relationship.'."\n", ], - 'GetCustomerAccountInfo' => [ - 'summary' => 'Queries the account information about a customer of a virtual network operator (VNO).', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCustomerList' => [ + 'summary' => 'Queries the IDs of customers of a virtual network operator (VNO).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6197,9 +5079,7 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -6207,918 +5087,750 @@ 'description' => 'The object returned.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '94017C56-1725-5DD9-AB41-B3BAE791D600', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'* **true**: The call is successful.'."\n" + .'* **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Mpk' => [ - 'description' => 'The ID of the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1051360339779133', - ], - 'LoginEmail' => [ - 'description' => 'The email address of the customer.'."\n", - 'type' => 'string', - 'example' => 'xxxx@aliyun.com', - ], - 'HostingStatus' => [ - 'description' => 'The hosting status of the credit information and instances of the customer. If the credit information and instances of the customer are managed on Alibaba Cloud, Alibaba Cloud suspends a customer service upon overdue payment. Valid values:'."\n" - ."\n" - .'FREEZE: The business of the customer is frozen.'."\n" - ."\n" - .'TRUSTEESHIP: The business of the customer is hosted.'."\n", - 'type' => 'string', - 'example' => 'FREEZE', - ], - 'AccountType' => [ - 'description' => 'The type of the account. A value of 1 indicates an enterprise account. A value of 0 indicates an individual account.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CreditLimitStatus' => [ - 'description' => 'The business status of the customer. Valid values:'."\n" - ."\n" - .'Freeze: The business is frozen.'."\n" - ."\n" - .'Thaw: The business is unfrozen.'."\n" - ."\n" - .'Trusteeship: The business is hosted.'."\n" - ."\n" - .'TrusteeshipCancel: The business is not hosted.'."\n", - 'type' => 'string', - 'example' => 'Freeze', - ], - 'IsCertified' => [ - 'description' => 'Indicates whether the account passes the real-name verification.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'UidList' => [ + 'description' => 'The list of customer IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the customer.'."\n", 'type' => 'string', 'example' => '6210322125051645960', 'title' => ''], + 'title' => '', ], ], + 'title' => '', ], ], + 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], + ['errorCode' => 'NotAuthorized', 'errorMessage' => 'This API is not authorized for caller.', 'description' => ''], ], [ - [ - 'errorCode' => 'VnoNoDataError', - 'errorMessage' => 'There is no data by this request.', - ], + ['errorCode' => 'VnoNoDataError', 'errorMessage' => 'There is no data by this request.', 'description' => ''], + ], + [ + ['errorCode' => 'NotFoundRamAction', 'errorMessage' => 'Not found ramAction for apiActon: GetCustomerList', '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"}]', - ], - 'GetCustomerList' => [ - 'summary' => 'Queries the IDs of customers of a virtual network operator (VNO).', - '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' => 'GetCustomerList', + 'description' => 'The system queries the IDs of customers of a VNO based on the AccessKey pair used in the request.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-12-26T12:12:10.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetOrderDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '32453453', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object returned.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* **true**: The call is successful.'."\n" - .'* **false**: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'UidList' => [ - 'description' => 'The list of customer IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the customer.'."\n", - 'type' => 'string', - 'example' => '6210322125051645960', + 'HostName' => ['description' => 'The hostname.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'PageNum' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => 'The orders returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the order.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrderSubType' => ['description' => 'The type of the suborder. A value of productsuborder indicates service suborder. A value of refundsuborder indicates refund suborder.'."\n", 'type' => 'string', 'example' => 'ProductSubOrder', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the order was created.'."\n", 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values: CNY, USD, and JPY.'."\n", 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'Config' => ['description' => 'The configurations of the main service.'."\n", 'type' => 'string', 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', 'title' => ''], + 'SubscriptionType' => ['title' => '', 'description' => 'The billing method. Valid values: Subscription and PayAsYouGo.'."\n", 'type' => 'string', 'example' => 'PayAsYouGo'], + 'UsageStartTime' => ['description' => 'The time when the service starts.'."\n", 'type' => 'string', 'example' => '2017-06-08T16:00:00Z', 'title' => ''], + 'UsageEndTime' => ['description' => 'The time when the service ends.'."\n", 'type' => 'string', 'example' => '2117-06-08T16:00:00Z', 'title' => ''], + 'SubOrderId' => ['description' => 'The ID of the suborder.'."\n", 'type' => 'string', 'example' => '234343', 'title' => ''], + 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AfterTaxAmount' => ['description' => 'The aftertaxt amount of the order.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'PaymentTime' => ['description' => 'The time of payment.'."\n", 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''], + 'Operator' => ['description' => 'The ID of the Resource Access Management (RAM) user that performs operations on the order. If no RAM user is involved, this parameter is empty.'."\n", 'type' => 'string', 'example' => '23424243432', 'title' => ''], + 'OrderType' => ['description' => 'The type of the order. Valid values: new, renew, upgrade, and refund.'."\n", 'type' => 'string', 'example' => 'New', 'title' => ''], + 'PaymentStatus' => ['description' => 'The payment state. Valid values: unpaid, paid, and canceled.'."\n", 'type' => 'string', 'example' => 'Paid', 'title' => ''], + 'Quantity' => ['description' => 'The number of main services.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PretaxAmountLocal' => ['description' => 'The pretax amount of the order in local currency.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Tax' => ['description' => 'The tax of the order.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'OriginalConfig' => ['description' => 'The configuration information that is not formatted.'."\n", 'type' => 'string', 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', 'title' => ''], + 'PretaxAmount' => ['description' => 'The pretax amount of the order.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'RelatedOrderId' => ['description' => 'The ID of the associated order.'."\n", 'type' => 'string', 'example' => '4353453534543', 'title' => ''], + 'PaymentCurrency' => ['description' => 'The currency used for payment. Valid values: CNY, USD, and JPY.'."\n", 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'ProductType' => ['description' => 'The type of the main service.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'InstanceIDs' => ['description' => 'The instance IDs.'."\n", 'type' => 'string', 'example' => '["rm-bp1a2vsr018313t6o"]', 'title' => ''], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount of the order.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '3453425324', 'title' => ''], + 'ProductCode' => ['description' => 'The code of the main service.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'ExtendInfos' => [ + 'description' => 'The additional information about the order.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The additional information about the order.'."\n" + ."\n" + .'* A value of true for isAutoRenew indicates that automatic renewal is enabled. If automatic renewal is disabled, this parameter is not returned.'."\n" + .'* couponNo indicates the coupon number.'."\n" + .'* couponAmount indicates the amount deducted by using the coupon.'."\n" + .'* discountAmount indicates the amount deducted.'."\n", 'example' => '{"key":"Order extension information"}', 'title' => ''], + 'title' => '', + ], + 'BillModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleConfig' => [ + 'description' => 'The billing information about the configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the configuration item.'."\n", 'type' => 'string', 'example' => 'Data disk'."\n", 'title' => ''], + 'Code' => ['description' => 'The code of the configuration item.'."\n", 'type' => 'string', 'example' => 'datadisk', 'title' => ''], + 'ApiCode' => ['description' => 'The API code of the configuration item.'."\n", 'type' => 'string', 'example' => 'datadisk', 'title' => ''], + 'BillModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'billModuleProperties' => [ + 'description' => 'The attributes of the configured item.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleApiCode' => ['description' => 'The API code of the configured item.'."\n", 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'AttrApiCode' => ['description' => 'The attribute code of the configured item.'."\n", 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'Value' => ['description' => 'The attribute value of the configuration item.'."\n", 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'OriginalModuleConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'originalModuleConfig' => [ + 'description' => 'The information about the configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the configuration item.'."\n", 'type' => 'string', 'example' => 'System disk'."\n", 'title' => ''], + 'Code' => ['description' => 'The code of the configuration item.'."\n", 'type' => 'string', 'example' => 'systemdisk', 'title' => ''], + 'ModuleProperties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleProperties' => [ + 'description' => 'The attributes of the configured item.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The attribute code of the configured item.'."\n", 'type' => 'string', 'example' => 'cloud_efficiency'."\n", 'title' => ''], + 'Name' => ['description' => 'The attribute name of the configured item.'."\n", 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + 'Value' => ['description' => 'The attribute value of the configured item.'."\n", 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'title' => '', + ], + 'title' => '', + ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'], ], - [ - [ - 'errorCode' => 'VnoNoDataError', - 'errorMessage' => 'There is no data by this request.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - [ - 'errorCode' => 'NotFoundRamAction', - 'errorMessage' => 'Not found ramAction for apiActon: GetCustomerList', - ], + ], + '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\\": \\"ProductSubOrder\\",\\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\\": \\"PayAsYouGo\\",\\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\\": \\"{\\\\\\"key\\\\\\":\\\\\\"Order extension information\\\\\\"}\\"\\n },\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"Name\\": \\"Data disk\\\\n\\",\\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\\": \\"System disk\\\\n\\",\\n \\"Code\\": \\"systemdisk\\",\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Code\\": \\"cloud_efficiency\\\\n\\",\\n \\"Name\\": \\"cloud_efficiency\\",\\n \\"Value\\": \\"cloud_efficiency\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetOrderDetail', + 'summary' => 'Queries the details of an order that belongs to your Alibaba Cloud account or distributors.', + 'changeSet' => [ + ['createdAt' => '2024-07-10T08:53:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-14T11:48:07.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrderDetail'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"UidList\\": [\\n \\"6210322125051645960\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetCustomerList', - 'description' => 'The system queries the IDs of customers of a VNO based on the AccessKey pair used in the request.'."\n", ], - 'QueryResourcePackageInstances' => [ - 'summary' => 'Queries the instances of a resource plan. You can query the resource plans that are valid.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetPayAsYouGoPrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'ExpiryTimeStart', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'ecs'], ], [ - 'name' => 'ExpiryTimeEnd', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T13:00:00Z', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ecs'], ], [ - 'name' => 'PageNum', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The subscription type. Valid value: PayAsYouGo.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'PayAsYouGo'], ], [ - 'name' => 'PageSize', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'IncludePartner', + 'name' => 'ModuleList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether partners are involved.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The list of pricing modules.', + 'type' => 'array', + 'items' => [ + 'description' => 'A pricing module.', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => ['description' => 'The code of the Nth pricing module.'."\n" + ."\n" + .'> Obtain the module code by calling the [DescribePricingModule](~~96469~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'InstanceType'], + 'PriceType' => ['description' => 'The price type of the Nth pricing module. Valid values:'."\n" + ."\n" + .'- Hour: hourly price.'."\n" + ."\n" + .'- Usage: usage.'."\n" + ."\n" + .'- Month: monthly price.'."\n" + ."\n" + .'- Year: yearly price.'."\n" + ."\n" + .'> Obtain the price type by calling the [DescribePricingModule](~~96469~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Hour'], + 'Config' => ['description' => 'The configuration of the Nth pricing module. The value of N can be an integer from 1 to 50. The configuration is in the "AA:aa,BB:bb" format. In this format, AA and BB are the property codes of the pricing module, and aa and bb are the property values.'."\n" + ."\n" + .'> Obtain the configuration by calling the [DescribePricingModule](~~96469~~) operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Page' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1537A007-72D7-4165-8A26-8694A38E219A'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'HostId' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'example' => 'cn', + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY: Chinese Yuan'."\n" + ."\n" + .'- USD: US Dollar'."\n" + ."\n" + .'- JPY: Japanese Yen', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => 'The price details of the pricing module.', + 'type' => 'array', + 'items' => [ + 'description' => 'The price details of the pricing module.', + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100'], + 'InvoiceDiscount' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '20'], + 'UnitPrice' => ['description' => 'The unit price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'OriginalCost' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '1.77'], + 'ModuleCode' => ['description' => 'The code of the pricing module.', 'type' => 'string', 'title' => '', 'example' => 'InstanceType'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Instances' => [ + 'PromotionDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Instance' => [ - 'description' => 'The details of the instances.'."\n", + 'PromotionDetail' => [ + 'description' => 'The discount details.', 'type' => 'array', 'items' => [ + 'description' => 'The discount details.', 'type' => 'object', 'properties' => [ - 'ExpiryTime' => [ - 'description' => 'The time when the resource plan expired.'."\n", - 'type' => 'string', - 'example' => '2019-03-12T16:00:00Z', - ], - 'Status' => [ - 'description' => 'The status of the resource plan. Valid values:'."\n" - ."\n" - .'* Available'."\n" - .'* Expired'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'Remark' => [ - 'description' => 'The remarks on the resource plan. The remarks must be made in Chinese.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RemainingAmountUnit' => [ - 'description' => 'The unit of the remaining quota.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-v0h1s4hma01', - ], - 'PackageType' => [ - 'description' => 'The type of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'FPT_ossbag_absolute_Storage_sh', - ], - 'EffectiveTime' => [ - 'description' => 'The time when the resource plan took effect.'."\n", - 'type' => 'string', - 'example' => '2018-09-12T09:51:56Z', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TotalAmount' => [ - 'description' => 'The total quota of the resource plan.'."\n", - 'type' => 'string', - 'example' => '40.000', - ], - 'DeductType' => [ - 'description' => 'The deduction type. Example: Absolute.'."\n", - 'type' => 'string', - 'example' => 'Absolute', - ], - 'TotalAmountUnit' => [ - 'description' => 'The unit of the total quota.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'RemainingAmount' => [ - 'description' => 'The remaining quota.'."\n", - 'type' => 'string', - 'example' => '40.000', - ], - 'ApplicableProducts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Product' => [ - 'description' => 'The services to which the resource plan is applicable.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The service to which the resource plan is applicable.'."\n", - 'type' => 'string', - 'example' => '{"Product": ["oss"] }', - ], - ], - ], - ], - 'CommodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], + 'PromotionDesc' => ['description' => 'The description of the discount.', 'type' => 'string', 'title' => '', 'example' => '仅提供测试使用的1分钱活动'], + 'PromotionId' => ['description' => 'The ID of the discount.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10200210'], + 'PromotionName' => ['description' => 'The name of the discount.', 'type' => 'string', 'title' => '', 'example' => '仅提供测试使用的1分钱活动'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Absent some mandatory parameter for this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'This request contain some invalid parameter', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'OwnerIdInvalid', - 'errorMessage' => 'Parameter ownerId is invalid.', - ], - [ - 'errorCode' => 'OwnerIdMissing', - 'errorMessage' => 'Paramter ownerId is missing.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"PageSize\\": 20,\\n \\"Total\\": 12,\\n \\"Page\\": 1,\\n \\"Data\\": {\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"TotalCount\\": \\"12\\",\\n \\"HostId\\": \\"cn\\",\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"ExpiryTime\\": \\"2019-03-12T16:00:00Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"Remark\\": \\"标准存储包(华东2)\\",\\n \\"RemainingAmountUnit\\": \\"GB\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-v0h1s4hma01\\",\\n \\"PackageType\\": \\"FPT_ossbag_absolute_Storage_sh\\",\\n \\"EffectiveTime\\": \\"2018-09-12T09:51:56Z\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"TotalAmount\\": \\"40.000\\",\\n \\"DeductType\\": \\"Absolute\\",\\n \\"TotalAmountUnit\\": \\"GB\\",\\n \\"RemainingAmount\\": \\"40.000\\",\\n \\"ApplicableProducts\\": {\\n \\"Product\\": [\\n \\"{\\\\\\"Product\\\\\\": [\\\\\\"oss\\\\\\"] }\\"\\n ]\\n },\\n \\"CommodityCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryResourcePackageInstancesResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <Instances>\\n <Instance>\\n <RemainingAmountUnit>GB</RemainingAmountUnit>\\n <ApplicableProducts>\\n <Product>oss</Product>\\n </ApplicableProducts>\\n <InstanceId>OSSBAG-cn-v0h1s4hma018</InstanceId>\\n <DeductType>Absolute</DeductType>\\n <RemainingAmount>40.000</RemainingAmount>\\n <Status>Available</Status>\\n <Region>cn-shanghai</Region>\\n <TotalAmountUnit>GB</TotalAmountUnit>\\n <PackageType>FPT_ossbag_absolute_Storage_sh</PackageType>\\n <TotalAmount>40.000</TotalAmount>\\n <Remark>标准存储包(华东2)</Remark>\\n <EffectiveTime>2018-09-12T09:51:56Z</EffectiveTime>\\n <ExpiryTime>2019-03-12T16:00:00Z</ExpiryTime>\\n </Instance>\\n </Instances>\\n <HostId>cn</HostId>\\n <PageNum>1</PageNum>\\n </Data>\\n</QueryResourcePackageInstancesResponse>","errorExample":""}]', - 'title' => 'QueryResourcePackageInstances', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'GetPayAsYouGoPrice', + 'summary' => 'Queries the prices of pay-as-you-go products.', + 'description' => '### API description'."\n" + ."\n" + .'1. Call the QueryProductList operation to obtain the product code. For more information, see [Query product information](~~95984~~).'."\n" + ."\n" + .'2. Call the DescribePricingModule operation to obtain the configuration parameters of the product. For more information, see [Query product module information](~~96469~~).'."\n" + ."\n" + .'3. Call this operation with the obtained configuration parameters to query the prices of pay-as-you-go products.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDPUtilizationDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPayAsYouGoPrice'], + ], ], + ], + 'GetResourcePackagePrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance to query. If this parameter is not specified, the details of all used instances are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss-123123', - ], - ], - [ - 'name' => 'InstanceSpec', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance type of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Instancetyp', - ], - ], - [ - 'name' => 'CommodityCode', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the resource, such as ecsRi and scu_bag. If this parameter is specified, the ProdCode parameter does not take effect for the request.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ecsRi', - ], + 'schema' => ['description' => 'The code of service. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.', 'type' => 'string', 'required' => true, 'example' => 'ossbag', 'title' => ''], ], [ - 'name' => 'DeductedInstanceId', + 'name' => 'PackageType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the deducted instance. If this parameter is not specified, the details of all instances are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss-123123', - ], + 'schema' => ['description' => 'The type of the resource plan. The value must be the same as the value of the **ProductCode** parameter that is returned when you call the **DescribeResourcePackageProduct** operation.', 'type' => 'string', 'required' => true, 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'EffectiveDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => 'The time when the resource plan takes effect. If you do not specify this parameter, the resource plan immediately takes effect by default.'."\n" + .'When the **OrderType** is **BUY**, resource packs with the **EffectiveDate longer than the current time of 6 months** are not supported.'."\n" + .'If the **OrderType** is **UPGRADE**, the **EffectiveDate** **must be less than or equal to** the actual expiration time of the upgraded instance.'."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2020-02-10T12:00:00Z', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => 'The specifications of the resource plan.', 'type' => 'string', 'required' => true, 'example' => '500', 'title' => ''], ], [ - 'name' => 'LastToken', + 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to retrieve the next page of results. For the first query, set the value to null. For subsequent queries, set the value to the token that is obtained from the NextToken parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAESF***zNTAw', - ], + 'schema' => ['description' => 'The validity period of the resource plan. The value must be the same as the duration of the resource plan specified in the specifications.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '6', 'title' => ''], ], [ - 'name' => 'Limit', + 'name' => 'PricingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The unit of validity period of the resource plan. Valid values:'."\n" + ."\n" + .'- Month'."\n" + ."\n" + .'- Year', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'IncludeShare', + 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query the resource plan usage of linked accounts. Valid values:'."\n" - ."\n" - .'* true: queries the resource plan usage of linked accounts.'."\n" - .'* false: does not query the resource plan usage of linked accounts.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'- BUY: You place the order to purchase an instance.'."\n" + ."\n" + .'- UPGRADE: You place the order to upgrade an instance.'."\n" + ."\n" + .'- RENEW: You place the order to renew an instance.'."\n" + ."\n" + .'Default value: BUY.', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''], ], [ - 'name' => 'ProdCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service. Example: ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'oss', - ], + 'schema' => ['description' => 'The ID of the instance. **This parameter is required when the order type is renewal or upgrade.**', 'type' => 'string', 'required' => false, 'example' => 'OSSBAG-cn-0xl0002', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to retrieve the next page of results. You can set the LastToken parameter to this value in the next request. If null is returned, all results are queried.'."\n", - 'type' => 'string', - 'example' => 'CAESF***zNTAw', - ], - 'DetailList' => [ + 'OriginalPrice' => ['description' => 'The original price. Unit: CNY.', 'type' => 'number', 'format' => 'float', 'example' => '1290240', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discounted amount. Unit: CNY.', 'type' => 'number', 'format' => 'float', 'example' => '215040', 'title' => ''], + 'Currency' => ['description' => 'The type of the currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TradePrice' => ['description' => 'The price at which the transaction is made. Unit: CNY.', 'type' => 'number', 'format' => 'float', 'example' => '1075200', 'title' => ''], + 'Promotions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DetailList' => [ - 'description' => 'The detailed resource plan usage.'."\n", + 'Promotion' => [ + 'description' => 'The details of the discount.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeductedInstanceId' => [ - 'description' => 'The ID of the deducted instance.'."\n", - 'type' => 'string', - 'example' => 'oss-123123', - ], - 'InstanceId' => [ - 'description' => 'The ID of the RI.'."\n", - 'type' => 'string', - 'example' => 'oss-123123', - ], - 'DeductHours' => [ - 'description' => 'The deduct factor. This parameter is returned only if the CommodityCode parameter is set to ecsRi.', - 'type' => 'number', - 'format' => 'float', - 'example' => '24', - ], - 'ShareUid' => [ - 'description' => 'The UID of the deducted instance.'."\n" - ."\n" - .'* If the deduction is shared, the value of this parameter indicates the UID of the deducted instance.'."\n" - .'* If the deduction is not shared, the value of this parameter is the same as that of the uid parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111111111', - ], - 'DeductDate' => [ - 'description' => 'The deduction date.'."\n", - 'type' => 'string', - 'example' => '2019/5/23 12:00', - ], - 'InstanceSpec' => [ - 'description' => 'The instance type of the deducted instance.'."\n", - 'type' => 'string', - 'example' => 'rds.mysql.s3.large', - ], - 'DeductedCommodityCode' => [ - 'description' => 'The code of the deducted service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'DeductedProductDetail' => [ - 'description' => 'The name of the deducted service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'DeductMeasure' => [ - 'description' => 'The original measured amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Region' => [ - 'description' => 'The region in which the instance resides. This parameter can be left empty.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou ', - ], - 'DeductQuantity' => [ - 'description' => 'The computing capacity or storage capacity that is deducted in a pay-as-you-go instance.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'DeductFactorTotal' => [ - 'description' => 'The total computing capacity or storage capacity of the RI or SCU during the deduction.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'ResCode' => [ - 'description' => 'The billable item.'."\n", - 'type' => 'string', - 'example' => 'PutRequest', - ], - 'Uid' => [ - 'description' => 'The UID of the deducted instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111111111', - ], + 'Name' => ['description' => 'The description of the discount.', 'type' => 'string', 'example' => '购买半年，立享8.3折优惠', 'title' => ''], + 'Id' => ['description' => 'The ID of the promotion.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000680914', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => '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' => 'Invalid user identity.'], + ['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.', '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":"<Message>Successful！</Message>\\n<RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n<Data>\\n <TotalCount/>\\n <PageSize/>\\n <PageNum/>\\n <DetailList>\\n <DetailList>\\n <ResCode/>\\n <Uid/>\\n <DeductDate/>\\n <InstanceSpec/>\\n <DeductMeasure/>\\n <InstanceId/>\\n <DeductFactorTotal/>\\n <DeductedProductDetail/>\\n <Region/>\\n <DeductedCommodityCode/>\\n <DeductedInstanceId/>\\n <DeductHours/>\\n <DeductQuantity/>\\n </DetailList>\\n </DetailList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'QueryDPUtilizationDetail', - 'summary' => 'Queries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs).', - 'description' => 'Limits:'."\n" - ."\n" - .'* Only the usage records within the past year can be queried.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'GetResourcePackagePrice', + 'summary' => 'Queries the price of a resource plan.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRIUtilizationDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResourcePackagePrice'], + ], ], + ], + 'GetSubscriptionPrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RIInstanceId', + 'name' => 'ServicePeriodUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the RI. If this parameter is left empty, the usage details of all RIs are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dsudfgdsjh', - ], + 'schema' => ['description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'- Year'."\n" + ."\n" + .'- Month', 'type' => 'string', 'required' => false, 'example' => 'Year', 'title' => ''], ], [ - 'name' => 'InstanceSpec', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance type of the RI.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Instancetyp', - ], + 'schema' => ['description' => 'The subscription type. The value is fixed as `Subscription`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Subscription', 'title' => ''], ], [ - 'name' => 'RICommodityCode', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service to which the RI is applied. Default value: ecsRi. Valid values:'."\n" - ."\n" - .'* ecsRi: ECS RI.'."\n" - .'* scu_bag: storage capacity unit (SCU).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecsRi', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'DeductedInstanceId', + 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance whose fees are deducted by using the RI. If this parameter is left empty, the usage details of all instances are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jsdgfsdhgsdjh', - ], + 'schema' => ['description' => 'The order type. Valid values:'."\n" + ."\n" + .'- `NewOrder`: a new purchase.'."\n" + ."\n" + .'- `Renewal`: a renewal.'."\n" + ."\n" + .'- `Upgrade`: an upgrade.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NewOrder', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ServicePeriodQuantity', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the RI was created. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the RI expires. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-05-23 12:00:00', - ], + 'schema' => ['description' => 'The product type. Whether this parameter is required depends on the pricing documentation of the specific product.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The instance ID for which you want to query the price. This parameter is required for upgrades (when `OrderType` is set to `Upgrade`) to obtain the pre-upgrade configuration of the instance.', 'type' => 'string', 'required' => false, 'example' => 'i-khkjhxxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'description' => 'The list of pricing modules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleStatus' => ['description' => 'This parameter is required only when `OrderType` is set to `Upgrade`. It specifies the change status of the pricing module. Valid values:'."\n" + ."\n" + .'- 1: Added.'."\n" + ."\n" + .'- 2: Changed. If the configuration of a pricing module changes in an upgrade scenario, you must explicitly set this parameter to this value.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'ModuleCode' => ['description' => 'The pricing module code.', 'type' => 'string', 'required' => true, 'example' => 'PackageCode', 'title' => ''], + 'Tag' => ['description' => 'This parameter is required only for upgrades or downgrades of some products. It specifies the identifier of a specific resource. For example, if you change disk specifications, you can use this parameter to specify the disk ID.', 'type' => 'string', 'required' => false, 'example' => '213213123', 'title' => ''], + 'Config' => ['description' => 'The configuration of the pricing module. n is an integer from 1 to 50. The value must be in the "AA:aa,BB:bb" format. In this format, `AA` and `BB` are property identifiers of the pricing module, and `aa` and `bb` are their corresponding property values.', 'type' => 'string', 'required' => true, 'example' => 'PackageCode:version_1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], ], @@ -7127,173 +5839,130 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'InvalidConfigCod', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30E7066E-AE6F-4E59-AFE6-11386CE3AFA7', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The subscription price details.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '900', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY: Chinese Yuan.'."\n" + ."\n" + .'- USD: US Dollar.'."\n" + ."\n" + .'- JPY: Japanese Yen.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'Quantity' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TradePrice' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'ModuleDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleDetail' => [ + 'description' => 'A list of price details for each pricing module.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CostAfterDiscount' => ['description' => 'The discounted price of the module.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'InvoiceDiscount' => ['description' => 'The discount amount for the module.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'UnitPrice' => ['description' => 'The unit price. This field is deprecated.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'OriginalCost' => ['description' => 'The original price of the module.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'ModuleCode' => ['description' => 'The pricing module code.', 'type' => 'string', 'example' => 'PackageCode', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'DetailList' => [ + 'PromotionDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DetailList' => [ - 'description' => 'The usage details of the RI.'."\n", + 'PromotionDetail' => [ + 'description' => 'A list of details for each applied promotion.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeductedCommodityCode' => [ - 'description' => 'The code of the service whose fees are deducted by using the RI.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'DeductedProductDetail' => [ - 'description' => 'The name of the service whose fees are deducted by using the RI.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'DeductedInstanceId' => [ - 'description' => 'The ID of the instance whose fees are deducted by using the RI.'."\n", - 'type' => 'string', - 'example' => 'safdffghfgh', - ], - 'DeductFactorTotal' => [ - 'description' => 'The total amount of computing power of the RI or capacity of SCU in the time period.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'DeductQuantity' => [ - 'description' => 'The computing power or capacity of the pay-as-you-go instance whose fees are deducted by using the RI.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'DeductHours' => [ - 'description' => 'The deduct factor. This parameter is returned only if the RICommodityCode parameter is set to ecsRi.', - 'type' => 'string', - 'example' => '24', - ], - 'DeductDate' => [ - 'description' => 'The time when the fees are deducted by using the RI.'."\n", - 'type' => 'string', - 'example' => '2019-05-23 12:00:00', - ], - 'RIInstanceId' => [ - 'description' => 'The ID of the RI.'."\n", - 'type' => 'string', - 'example' => '324253645', - ], - 'InstanceSpec' => [ - 'description' => 'The instance type of the instance whose fees are deducted by using the RI.'."\n", - 'type' => 'string', - 'example' => 'rds.mysql.s3.large', - ], + 'PromotionDesc' => ['description' => 'The promotion description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1021199213', 'title' => ''], + 'PromotionName' => ['description' => 'The promotion name.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Absent some mandatory parameter for this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'This request contain some invalid parameter', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => 'InvalidQueryTime', - 'errorMessage' => 'The specified start time and end time are incorrect', - ], - [ - 'errorCode' => 'InvalidInstanceSpec', - 'errorMessage' => 'The specified Instance specification is not valid.', - ], - [ - 'errorCode' => 'CommodityNotSupported', - 'errorMessage' => 'The specified RI commodity is not supported.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 0,\\n \\"DetailList\\": {\\n \\"DetailList\\": [\\n {\\n \\"DeductedCommodityCode\\": \\"rds\\",\\n \\"DeductedProductDetail\\": \\"云数据库RDS\\",\\n \\"DeductedInstanceId\\": \\"safdffghfgh\\",\\n \\"DeductFactorTotal\\": 1,\\n \\"DeductQuantity\\": 1,\\n \\"DeductHours\\": \\"24\\",\\n \\"DeductDate\\": \\"2019-05-23 12:00:00\\",\\n \\"RIInstanceId\\": \\"324253645\\",\\n \\"InstanceSpec\\": \\"rds.mysql.s3.large\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRIUtilizationDetailResponse>\\n <RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <DetailList>\\n </DetailList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRIUtilizationDetailResponse>","errorExample":""}]', - 'title' => 'QueryRIUtilizationDetail', - 'summary' => 'Queries the usage details of a reserved instance (RI).', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'GetSubscriptionPrice', + 'summary' => 'This operation queries the price of a subscription product.', + 'description' => '1. Call QueryProductList to get the product code. For more information, see [Query product information](~~95984~~).'."\n" + ."\n" + .'2. Call DescribePricingModule to get the configuration parameters for the product. For more information, see [Query product module information](~~96469~~).'."\n" + ."\n" + .'3. Call this operation with the retrieved configuration parameters to query the price of the subscription product.'."\n" + ."\n" + .'4. Use the configuration returned by DescribePricingModule to build the Config parameter within ModuleList. You must include all values; otherwise, the price query will fail.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeResourceUsageTotal' => [ - 'summary' => 'Queries the total usage data of reserved instances or storage capacity units (SCUs).', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubscriptionPrice'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InquiryPriceRefundInstance' => [ + 'summary' => 'Queries the refundable amount for an instance from which you want to unsubscribe.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7301,273 +5970,280 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'StartPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is included in the time range.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], - ], - [ - 'name' => 'EndPeriod', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. The specified time is excluded from the time range. If you do not specify this parameter, this parameter is set to the current time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['title' => 'clientToken', 'description' => 'This parameter is required for scenarios that need idempotence. The UUID that is used to ensure the idempotence of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '793F021C-B589-1225-82A9-99232AEBE494'], ], [ - 'name' => 'PeriodType', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which the data is queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'MONTH' => 'MONTH', - 'HOUR' => 'HOUR', - 'DAY' => 'DAY', - ], - 'example' => 'HOUR', - ], + 'schema' => ['title' => 'productCode', 'description' => 'The code of the service. This parameter is required for unsubscription scenarios.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current account and its linked accounts is queried. To query the data of a linked account, specify the ID of the linked account. You can specify only one account ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['title' => 'instanceId', 'description' => 'The ID of the instance. This parameter is required for unsubscription scenarios.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp1etb69sqxgl4*******'], ], [ - 'name' => 'ResourceType', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource plan. Valid values: RI and SCU.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'SCU' => 'SCU', - 'RI' => 'RI', - ], - 'example' => 'RI', - ], + 'schema' => ['title' => 'productType', 'description' => 'The type of the service. This parameter is required for unsubscription scenarios. Unless otherwise specified, set this parameter to an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => '”“'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'result', + 'description' => 'The result of the request.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '364C7C81-5E5E-51A0-B738-1969D2671B05', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'Message' => ['title' => 'message', 'description' => 'The description of the execution result.'."\n", 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'UUID'], 'Data' => [ - 'description' => 'The queried data.'."\n", + 'title' => 'data', + 'description' => 'data'."\n", 'type' => 'object', 'properties' => [ - 'PeriodCoverage' => [ - 'description' => 'The usage of resource plans in the specified period.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UsagePercentage' => [ - 'description' => 'The usage of resource plans.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'Period' => [ - 'description' => 'The period.'."\n", - 'type' => 'string', - 'example' => '2021071500', - ], - ], - ], - ], - 'TotalUsage' => [ - 'description' => 'The total usage of resource plans.'."\n", - 'type' => 'object', - 'properties' => [ - 'PostpaidCost' => [ - 'description' => 'The total costs of pay-as-you-go instances.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'SavedCost' => [ - 'description' => 'The total savings.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'UsagePercentage' => [ - 'description' => 'The total usage of resource plans.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'PotentialSavedCost' => [ - 'description' => 'The total potential savings.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'ReservationCost' => [ - 'description' => 'The fee of purchased resource plans.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - ], - ], + 'HostId' => ['title' => 'hostId', 'description' => 'The site of the execution host.'."\n", 'type' => 'string', 'example' => 'cn'], + 'InstanceId' => ['title' => 'instanceId', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'i-bp1etb69sqxgl4*******'], + 'Currency' => ['title' => 'currency', 'description' => 'The currency.'."\n", 'type' => 'string', 'example' => 'CNY. CNY: Chinese Yuan. USD: United States dollar. JPY: Japanese Yen.'], + 'RefundAmount' => ['title' => 'refundAmount', 'description' => 'The refundable amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '12.34'], ], ], + 'Code' => ['title' => 'code', 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], + 'Success' => ['title' => 'success', 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"364C7C81-5E5E-51A0-B738-1969D2671B05\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"UsagePercentage\\": 0.1,\\n \\"Period\\": \\"2021071500\\"\\n }\\n ],\\n \\"TotalUsage\\": {\\n \\"PostpaidCost\\": 200,\\n \\"SavedCost\\": 100,\\n \\"UsagePercentage\\": 1,\\n \\"PotentialSavedCost\\": 100,\\n \\"ReservationCost\\": 10\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourceUsageTotalResponse>\\n <RequestId>BD1DC347-905C-1D6E-8BA1-D724266842D2</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalUsage>\\n <ReservationCost>0</ReservationCost>\\n <PostpaidCost>0</PostpaidCost>\\n <PotentialSavedCost>0</PotentialSavedCost>\\n <UsagePercentage>0</UsagePercentage>\\n </TotalUsage>\\n <PeriodCoverage>\\n <Period>2021050100</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050200</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050300</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050400</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050500</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050600</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050700</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050800</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021050900</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n <PeriodCoverage>\\n <Period>2021051000</Period>\\n <UsagePercentage>0</UsagePercentage>\\n </PeriodCoverage>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribeResourceUsageTotalResponse>","errorExample":""}]', - 'title' => 'DescribeResourceUsageTotal', - ], - 'DescribeResourceUsageDetail' => [ - 'summary' => 'Queries the usage details of reserved instances (RIs) or storage capacity units (SCUs).', - 'methods' => [ - 'post', - 'get', + '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' => 'System exception, please try again'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\",\\n \\"InstanceId\\": \\"i-bp1etb69sqxgl4*******\\",\\n \\"Currency\\": \\"CNY. CNY: Chinese Yuan. USD: United States dollar. JPY: Japanese Yen.\\",\\n \\"RefundAmount\\": 12.34\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'InquiryPriceRefundInstance', + 'description' => '1. **Check the information about unsubscription and confirm the unsubscription terms and refundable amount. The resource that is unsubscribed cannot be restored.**'."\n" + .'2. Refunds are applicable only for the actual paid amount. Vouchers used for the purchase are non-refundable.'."\n" + .'3. For more information, see [Rules for unsubscribing from resources](https://www.alibabacloud.com/help/en/user-center/user-guide/refund-rules).', + 'extraInfo' => '**Error codes that are returned if a request is blocked**'."\n" + ."\n" + .'* ResourceNotExists: The instance does not exist.'."\n" + .'* ResourceStatusError: The instance is not in the expected state.'."\n" + .'* BindMirrorInstanceError: The ECS instance is bound to a paid image.'."\n" + .'* ExceedRefundQuotaError: The number of times that you unsubscribe from the instance exceeds the quota.'."\n" + .'* ExistUnPaidOrderError: An order that is not paid exists in the instance.'."\n" + .'* ExistRefundingOrderError: The ID of the instance is invalid because the instance expires, the instance is released, or the instance is refunded.'."\n" + .'* NoRestValueError: The refundable amount is 0.'."\n" + .'* AmbassadorOrderLimitError: The instance has an ambassador order that may raise risks.'."\n" + .'* ActivityForbiddenError: You cannot request a refund for an instance that is purchased during the marketing campaigns.'."\n" + .'* ProductCheckError: The instance does not pass the precheck.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InquiryPriceRefundInstance'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:RefundQueryRemainAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyAccountRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StartPeriod', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The relationship type. Currently, only enterprise\\_group is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'enterprise_group'], ], [ - 'name' => 'EndPeriod', + 'name' => 'RelationOperation', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => 'The action to perform. Valid values:'."\n" + ."\n" + .'- ADD: Adds the permission.'."\n" + ."\n" + .'- DELETE: Deletes the permission.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'ADD'], ], [ - 'name' => 'PeriodType', + 'name' => 'ParentUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1738376485192612'], ], [ - 'name' => 'NextToken', + 'name' => 'ChildNick', + 'in' => 'query', + 'schema' => ['description' => 'The display name. This name is shown on the page to help you identify the use case of the account.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '用户昵称'], + ], + [ + 'name' => 'ChildUserId', 'in' => 'query', + 'schema' => ['description' => 'The UID of the member account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1512996702208737'], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the request. This ID is used to mark a request and troubleshoot issues.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'request_id'], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', + 'description' => 'Modifying roles is not supported.', + 'type' => 'array', + 'items' => ['description' => 'The role code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'trusteeship'], 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', + 'example' => 'trusteeship', + 'maxItems' => 200, + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'PermissionCodes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. The maximum value is 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The permissions that can be modified. Valid values:'."\n" + ."\n" + .'- SYNCHRONIZE\\_FINANCE\\_IDENTITY: Allow synchronizing the credit control identity with the linked account.'."\n" + ."\n" + .'- SYNCHRONIZE\\_FINANCE\\_DISCOUNT\\_POLICY\\_TO\\_TARGET: Allow synchronizing discounts with the linked account.'."\n" + ."\n" + .'- FORBID\\_WITHDRAW\\_CASH: Prohibit the linked account from withdrawing its balance.'."\n" + ."\n" + .'- FORBID\\_MANAGE\\_INVOICE: Prohibit the linked account from managing invoices.'."\n" + ."\n" + .'- CHECK\\_FINANCE\\_INFO: View information about the account linking relationship.'."\n" + ."\n" + .'- MANAGE\\_TARGET\\_INVOICE: Manage invoices for the linked account.'."\n" + ."\n" + .'- CHECK\\_TARGET\\_CONSUMPTION: View the consumption details of the linked account.', + 'type' => 'array', + 'items' => ['description' => 'The permission.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY'], 'required' => false, - 'example' => '200', + 'example' => 'SYNCHRONIZE_FINANCE_IDENTITY', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'BillOwnerId', + 'name' => 'RelationId', 'in' => 'query', + 'schema' => ['description' => 'The relationship ID. Obtain this value from the relationId field returned by the QueryRelationList operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '51463'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current Alibaba Cloud account and its Resource Access Management (RAM) users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => '返回消息'], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => '48602faf-abbe-4d46-8029-654cc5aead5d'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'HostId' => ['description' => 'The source IP address of the request.', 'type' => 'string', 'title' => '', 'example' => '127.0.0.1'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'ModifyAccountRelation', + 'summary' => 'Adds or deletes permissions for an account linking relationship.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ModifyCostUnit' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceType', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'UnitEntityList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of deduction plan whose usage details are queried. Valid values: RI and SCU.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RI', + 'description' => 'A list of cost centers.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UnitId' => ['description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '2524352'], + 'NewUnitName' => ['description' => 'The new name of the cost center.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'newTest'], + 'OwnerUid' => ['description' => 'The user ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1321312312'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -7576,267 +6252,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'MaxResults' => [ - 'description' => 'The number of entries returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Items' => [ - 'description' => 'The data entries.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the deduction plan.'."\n", - 'type' => 'string', - 'example' => 'Valid', - ], - 'UsagePercentage' => [ - 'description' => 'The usage rate of the deduction plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'ResourceInstanceId' => [ - 'description' => 'The ID of the deduction plan.'."\n", - 'type' => 'string', - 'example' => 'ecsri-bp147nnfz21225k9mpix00', - ], - 'TotalQuantity' => [ - 'description' => 'The total capacity of the deduction plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'ReservationCost' => [ - 'description' => 'The fee of the deduction plan.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'RegionNo' => [ - 'description' => 'The code of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-dg-a01', - ], - 'UserId' => [ - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => '123745698925000', - ], - 'StatusName' => [ - 'description' => 'The name of the status.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CapacityUnit' => [ - 'description' => 'The unit that is used to measure the resources that are deducted.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'PotentialSavedCost' => [ - 'description' => 'The potential net savings.'."\n", - 'type' => 'string', - 'example' => '0.13', - ], - 'Currency' => [ - 'description' => 'The type of the currency.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ZoneName' => [ - 'description' => 'The code of the zone.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'InstanceSpec' => [ - 'description' => 'The instance type.'."\n", - 'type' => 'string', - 'example' => 'ecs.t5-lc2m1.nano', - ], - 'EndTime' => [ - 'description' => 'The end of the time range in which the usage details were queried.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 01:00:00', - ], - 'PostpaidCost' => [ - 'description' => 'The equivalent of pay-as-you-go costs.'."\n", - 'type' => 'string', - 'example' => '0.06', - ], - 'ImageType' => [ - 'description' => 'The operating system.'."\n", - 'type' => 'string', - 'example' => 'linux', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range in which the usage details were queried.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 00:00:00', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DeductQuantity' => [ - 'description' => 'The amount of the deducted resources.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'SavedCost' => [ - 'description' => 'The net savings.'."\n", - 'type' => 'string', - 'example' => '0.06', - ], - 'Zone' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'UserName' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'test@aliyun.com', - ], - 'Quantity' => [ - 'description' => 'The number of deduction plans.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - 'description' => '', - ], + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'UnitId' => ['description' => 'The ID of the new cost center.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '356349875'], + 'OwnerUid' => ['description' => 'The user ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '823756287'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeResourceUsageDetail', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'ModifyCostUnit', + 'summary' => 'Modifies one or more cost centers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeResourceCoverageTotal' => [ - 'summary' => 'Queries the total coverage data of reserved instances (RIs) or storage capacity units (SCUs).', - 'methods' => [ - 'post', - 'get', + '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' => 'All Resource', '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' => 'The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'EndPeriod', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'PeriodType', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which total coverage data is queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Subscription'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'ModifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query total coverage data. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The type of configuration change. Valid values:'."\n" + ."\n" + .'- Upgrade'."\n" + ."\n" + .'- Downgrade', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Upgrade'], ], [ - 'name' => 'ResourceType', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance whose configuration you want to change.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rm-akjhkdsjhfskjfhd'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'JAKSJFHFAKJSF'], + ], + [ + 'name' => 'Parameter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of deduction plans whose total coverage data is queried. Valid values: RI and SCU.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RI', + 'description' => 'The list of parameters. You can specify up to 100 parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the module property.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], + 'Code' => ['description' => 'The code of the module property.'."\n" + ."\n" + .'> Specify only the module properties that you want to change. For example, if you have two properties, A and B, and you only want to change property A, pass only the information related to property A.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -7845,107 +6387,155 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PeriodCoverage' => [ - 'description' => 'The information about the coverage rate of deduction plans within a period.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CoveragePercentage' => [ - 'description' => 'The coverage rate of deduction plans within the specified period.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'Period' => [ - 'description' => 'The period.'."\n" - ."\n" - .'The value is in the format of yyyyMMddHH.'."\n", - 'type' => 'string', - 'example' => '2020110100', - ], - ], - ], - ], - 'TotalCoverage' => [ - 'description' => 'The information about the total coverage data of deduction plans.'."\n", - 'type' => 'object', - 'properties' => [ - 'CapacityUnit' => [ - 'description' => 'The unit that is used to measure the resources deducted from deduction plans.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DeductQuantity' => [ - 'description' => 'The total amount of the resources deducted from deduction plans.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CoveragePercentage' => [ - 'description' => 'The total coverage rate of deduction plans.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'TotalQuantity' => [ - 'description' => 'The total amount of resources consumed.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - ], - ], + 'OrderId' => ['description' => 'The ID of the order that was created.', 'type' => 'string', 'title' => '', 'example' => '202653252354351'], + 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'title' => '', 'example' => 'testId'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PeriodCoverage\\": [\\n {\\n \\"CoveragePercentage\\": 0.1,\\n \\"Period\\": \\"2020110100\\"\\n }\\n ],\\n \\"TotalCoverage\\": {\\n \\"CapacityUnit\\": \\"算力*小时\\",\\n \\"DeductQuantity\\": 1,\\n \\"CoveragePercentage\\": 1,\\n \\"TotalQuantity\\": 1\\n }\\n }\\n}","errorExample":""}]', - 'title' => 'DescribeResourceCoverageTotal', - 'description' => 'The queried total coverage data is the same as the aggregated data displayed on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" - ."\n" - .'You can call this operation to query the total coverage data of RIs or SCUs.'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'], + ['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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'ModifyInstance', + 'summary' => 'Modifies the configuration of an instance resource. Calling this operation creates an order to modify the instance configuration and automatically completes the payment. This operation does not support configuration changes for ECS or RDS products. To do so, call the product-specific API operation instead.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], + ], + ], ], - 'DescribeResourceCoverageDetail' => [ - 'summary' => 'Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs).', - 'methods' => [ - 'post', - 'get', + 'QueryAccountBalance' => [ + 'summary' => 'Queries the user\'s account balance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '16176743-6DC7-4CB3-BB25-A13982D8DFAD'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'AvailableAmount' => ['description' => 'The available credit.', 'type' => 'string', 'title' => '', 'example' => '10000.00'], + 'CreditAmount' => ['description' => 'The credit limit.', 'type' => 'string', 'title' => '', 'example' => '0.00'], + 'MybankCreditAmount' => ['description' => 'The credit limit granted by MYbank.', 'type' => 'string', 'title' => '', 'example' => '0.00'], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY: Chinese Yuan'."\n" + ."\n" + .'- USD: US Dollar'."\n" + ."\n" + .'- JPY: Japanese Yen', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'AvailableCashAmount' => ['description' => 'The available cash balance.', 'type' => 'string', 'title' => '', 'example' => '10000.00'], + 'QuotaLimit' => ['description' => 'The quota limit for ecosystem customers.', 'type' => 'string', 'title' => '', 'example' => '10000.00'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'You do not have permissions to perform the operation.'], + ['errorCode' => 'AuthSiteFail', 'errorMessage' => 'auth site failed.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'QueryAccountBalance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'QueryAccountBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7953,1035 +6543,676 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'StartPeriod', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'The beginning is included in the time range. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-01 00:00:00', - ], + 'schema' => ['description' => 'The billing date. Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07', 'title' => ''], ], [ - 'name' => 'EndPeriod', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-01-02 00:00:00', - ], + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PeriodType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity at which coverage details are queried. Valid values: MONTH, DAY, and HOUR.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The number of entries per page. The default value is 20. The maximum value is 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'IsGroupByProduct', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to retrieve the next page of results. You do not need to set this parameter if you query coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], + 'schema' => ['description' => 'Specifies whether to aggregate the results by product code.'."\n" + ."\n" + .'- true: Results are aggregated by product code.'."\n" + ."\n" + .'- false: Results are not aggregated by product code.'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the account for which you want to query coverage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123745698925000', - ], + 'schema' => ['description' => 'The ID of the account that owns and actually uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '122', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'Granularity', 'in' => 'query', 'schema' => [ - 'description' => 'The type of deduction plans whose coverage details are queried. Valid values: RI and SCU.'."\n", + 'description' => 'The granularity for querying the bill. Valid values:'."\n" + ."\n" + .'- MONTHLY: Queries bills on a monthly basis. Corresponds to the monthly bills in **Expenses & Costs
**> **Bills
**> **Bill Details
**.'."\n" + ."\n" + .'- DAILY: Queries bills on a daily basis. Corresponds to the daily bills in **Expenses & Costs
**> **Bills
**> **Bill Details
**.'."\n" + ."\n" + .'> If you set `Granularity` to `DAILY`, you must also specify the `BillingDate` parameter.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RI', + 'required' => false, + 'example' => 'MONTHLY', + 'title' => '', ], ], + [ + 'name' => 'BillingDate', + 'in' => 'query', + 'schema' => ['description' => 'The billing date. This parameter is required only when you set Granularity to DAILY. Format: YYYY-MM-DD.', 'type' => 'string', 'required' => false, 'example' => '2021-06-01', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token of the next page.'."\n", - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'MaxResults' => [ - 'description' => 'The number of entries returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BillingCycle' => ['description' => 'The billing cycle. Format: YYYY-MM.', 'type' => 'string', 'example' => '2020-03', 'title' => ''], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '1857xxxxx489', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], 'Items' => [ - 'description' => 'The data entries.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CommodityCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TotalQuantity' => [ - 'description' => 'The total amount of resources consumed.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'RegionNo' => [ - 'description' => 'The code of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-dg-a01', - ], - 'UserId' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '123745698925000', - ], - 'CommodityName' => [ - 'description' => 'The name and billing method of the service.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CapacityUnit' => [ - 'description' => 'The unit that is used to measure the resources deducted from deduction plans.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'InstanceId' => [ - 'description' => 'The ID of a pay-as-you-go instance.'."\n", - 'type' => 'string', - 'example' => 'i-bp1d9x623987rlj0dx4xx', - ], - 'Currency' => [ - 'description' => 'The currency in which deduction plans were priced.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ZoneName' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'InstanceSpec' => [ - 'description' => 'The specifications of a deduction plan.'."\n", - 'type' => 'string', - 'example' => 'ecs.t5-lc2m1.nano', - ], - 'EndTime' => [ - 'description' => 'The end of the time range in which the coverage details were queried.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 01:00:00', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range in which the coverage details were queried.'."\n", - 'type' => 'string', - 'example' => '2021-04-01 00:00:00', - ], - 'PaymentAmount' => [ - 'description' => 'The amount of the bill.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CoveragePercentage' => [ - 'description' => 'The coverage rate of a deduction plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PipCode' => ['description' => 'The product code. This is the same as the product code in the User Center.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'BillingDate' => ['description' => 'The billing date.', 'type' => 'string', 'example' => '2021-03-01', 'title' => ''], + 'ProductName' => ['description' => 'The product name.'."\n" + ."\n" + .'> This parameter is returned only when **IsGroupByProduct** is set to true.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'OwnerName' => ['description' => 'The AccountName of the resource owner. This is used in multi-account payment scenarios.', 'type' => 'string', 'example' => 'aligzncloudtest2', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], + 'SubscriptionType' => ['description' => 'The subscription type of the product.'."\n" + ."\n" + .'- Subscription: subscription'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go'."\n" + ."\n" + .'> This parameter is returned only when IsGroupByProduct is set to true.', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'trusteeship', 'title' => ''], + 'OwnerID' => ['description' => 'The AccountID of the resource owner. This is used in multi-account payment scenarios.', 'type' => 'string', 'example' => '325434254', 'title' => ''], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'string', 'example' => '1857xxxxx489', 'title' => ''], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'CostUnit' => ['description' => 'The cost center.', 'type' => 'string', 'example' => '未分配', 'title' => ''], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.'."\n" + ."\n" + .'> This parameter is returned only when **IsGroupByProduct** is set to true.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + ], + 'description' => '', + 'title' => '', 'example' => '', ], - 'DeductQuantity' => [ - 'description' => 'The amount of the resources deducted from a deduction plan.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Zone' => [ - 'description' => 'The code of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'UserName' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'test13@test.aliyun.com', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeResourceCoverageDetail', - 'description' => '1\\. The queried coverage details are the same as those displayed in the table on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.'."\n" + 'title' => 'QueryAccountBill', + 'summary' => 'Queries account spending within a billing cycle and aggregates the data by resource owner.', + 'description' => '- Data for the current month is for reference only. Do not use it for reconciliation. The final bill for the current month is available to view or export after 12:00 on the third day of the next month. This delay accounts for mid-month events such as delayed billing, refunds, bill adjustments, and overdue payment write-offs.'."\n" ."\n" - .'2\\. You can call this operation to query the coverage details of RIs or SCUs.'."\n" + .'- Data from the last 18 months is available.'."\n" + ."\n" + .'- Billing data is updated 24 hours after actual resource consumption. Information related to instance IDs, such as instance configurations, instance types, instance nicknames, resource groups, public IP addresses, private IP addresses, and zones, is updated with a 48-hour delay.'."\n" + ."\n" + .'- Billing data does not include the costs of attached resources, such as domain names, buckets, and elastic IP addresses (EIPs), for products such as CDN, OSS, and Internet Shared Bandwidth. To view statistics that include data for attached resources, go to Split Bill.'."\n" + ."\n" + .'- For Alibaba Cloud Communications products, detailed data is available only from June 2020 onwards. For HiChina products, such as Domain Names and trademarks, detailed data is available only from November 2020 onwards.'."\n" ."\n" - .'3\\. You can call this operation to query coverage details at an hourly, daily, or monthly granularity.'."\n", + .'- Each account is limited to 10 queries per second. If a timeout occurs, retry the request.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeResourcePackageProduct' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountBill'], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 \\"BillingDate\\": \\"2021-03-01\\",\\n \\"ProductName\\": \\"rds\\",\\n \\"OwnerName\\": \\"aligzncloudtest2\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"BillAccountName\\": \\"test@test.aliyunid.com\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"BizType\\": \\"trusteeship\\",\\n \\"OwnerID\\": \\"325434254\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"BillAccountID\\": \\"1857xxxxx489\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"CostUnit\\": \\"未分配\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'QueryAccountTransactionDetails' => [ + 'summary' => 'Queries the details of account transactions (income and expenditure).', + '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' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ossbag', - ], + 'schema' => ['description' => 'The transaction number.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '410874027490089'], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => ['description' => 'The order number or bill number.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022120336190912'], + ], + [ + 'name' => 'TransactionChannelSN', + 'in' => 'query', + 'schema' => ['description' => 'The transaction serial number (SN) assigned by the payment channel.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022112122001470591458665933'], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The start of the creation time range.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-01-20'], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end of the creation time range.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-12-20'], + ], + [ + 'name' => 'TransactionType', + 'in' => 'query', + 'schema' => ['description' => 'Valid values:'."\n" + ."\n" + .'- Payment'."\n" + ."\n" + .'- Withdraw'."\n" + ."\n" + .'- Refund'."\n" + ."\n" + .'- Consumption'."\n" + ."\n" + .'- Transfer'."\n" + ."\n" + .'- Adjust', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Payment'], + ], + [ + 'name' => 'TransactionChannel', + 'in' => 'query', + 'schema' => ['description' => 'Valid values:'."\n" + ."\n" + .'- AccountBalance: Account balance'."\n" + ."\n" + .'- BankTransfer: Bank transfer'."\n" + ."\n" + .'- Alipay: Alipay'."\n" + ."\n" + .'- AntCreditPay: Ant Credit Pay'."\n" + ."\n" + .'- OfflineRemittance: Offline remittance'."\n" + ."\n" + .'- RegularBankCreditRefund: Credit control refund'."\n" + ."\n" + .'- CreditCard: Credit card'."\n" + ."\n" + .'- MyBankCredit: MYbank Trust Pay'."\n" + ."\n" + .'- HuaxiaBankCInstallment: Huaxia Bank installment'."\n" + ."\n" + .'- ApplePay: Apple Pay', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AccountBalance'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for a paged query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ABEDSDS124DASA'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not in use.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72353765387', - ], + 'Code' => ['description' => 'The status code of the response.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The description of the result.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'asadadad-edafafafaasd'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The content of the result.', 'type' => 'object', 'properties' => [ - 'ResourcePackages' => [ + 'NextToken' => ['description' => 'The paging token.', 'type' => 'string', 'title' => '', 'example' => 'ASHDADS'], + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'MaxResults' => ['description' => 'This parameter is not in use.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'title' => '', 'example' => 'yidi'], + 'AccountTransactionsList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ResourcePackage' => [ - 'description' => 'The details about the resource plans.'."\n", + 'AccountTransactionsList' => [ + 'description' => 'The list of details.', 'type' => 'array', 'items' => [ + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'ossbag', - ], - 'Name' => [ - 'description' => 'The name of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'Object Storage Service (OSS) resource plan (monthly)'."\n", - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'ossbag', - ], - 'PackageTypes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PackageType' => [ - 'description' => 'The types of the resource plans.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'FPT_ossbag_deadlineAcc_CdnOut_common_sz', - ], - 'Name' => [ - 'description' => 'The name of the resource plan type.'."\n", - 'type' => 'string', - 'example' => 'Back-to-origin traffic plan - China (Shenzhen)'."\n", - ], - 'Properties' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Property' => [ - 'description' => 'The properties of the resource plan.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the property.'."\n", - 'type' => 'string', - 'example' => 'region', - ], - 'Value' => [ - 'description' => 'The value of the property.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - ], - ], - ], - ], - ], - 'Specifications' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Specification' => [ - 'description' => 'The specifications of the resource plan.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the specification.'."\n", - 'type' => 'string', - 'example' => '1TB', - ], - 'Value' => [ - 'description' => 'The value of the specification.'."\n", - 'type' => 'string', - 'example' => '1024', - ], - 'AvailableDurations' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AvailableDuration' => [ - 'description' => 'The validity periods available for the resource plan.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value of the validity period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Name' => [ - 'description' => 'The name of the validity period.'."\n", - 'type' => 'string', - 'example' => '6 Month', - ], - 'Unit' => [ - 'description' => 'The unit of the validity period for the resource plan. Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n" - ."\n" - .'Default value: Month.'."\n", - 'type' => 'string', - 'example' => 'Month', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'BillingCycle' => ['description' => 'The billing cycle.', 'type' => 'string', 'title' => '', 'example' => '2022-10'], + 'TransactionChannel' => ['description' => 'The transaction channel.', 'type' => 'string', 'title' => '', 'example' => 'Alipay'], + 'RecordID' => ['description' => 'The order number or bill number.', 'type' => 'string', 'title' => '', 'example' => '2022120336190912'], + 'Remarks' => ['description' => 'The remarks.', 'type' => 'string', 'title' => '', 'example' => '测试'], + 'Amount' => ['description' => 'The amount.', 'type' => 'string', 'title' => '', 'example' => '1.00'], + 'TransactionAccount' => ['description' => 'The transaction account.', 'type' => 'string', 'title' => '', 'example' => 'fortune_test@xxx.com'], + 'TransactionTime' => ['description' => 'The transaction time.', 'type' => 'string', 'title' => '', 'example' => '2022-10-01'], + 'TransactionType' => ['description' => 'Transfer'."\n" + ."\n" + .'Adjust', 'type' => 'string', 'title' => '', 'example' => 'Consumption'], + 'TransactionFlow' => ['description' => 'Income'."\n" + ."\n" + .'Expense', 'type' => 'string', 'title' => '', 'example' => 'Income'], + 'FundType' => ['description' => 'RegularBankCreditRefund: Credit control refund'."\n" + ."\n" + .'DirectPay: Direct pay', 'type' => 'string', 'title' => '', 'example' => 'Cash'], + 'TransactionChannelSN' => ['description' => 'The payment reference No. of the transaction channel.', 'type' => 'string', 'title' => '', 'example' => '123232434343532'], + 'TransactionNumber' => ['description' => 'The transaction number.', 'type' => 'string', 'title' => '', 'example' => '43342334'], + 'Balance' => ['description' => 'The balance.', 'type' => 'string', 'title' => '', 'example' => '0'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '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.', + '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' => 'QueryAccountTransactionDetails', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryAccountTransactionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountTransactionDetails'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 72353765387,\\n \\"Data\\": {\\n \\"ResourcePackages\\": {\\n \\"ResourcePackage\\": [\\n {\\n \\"ProductType\\": \\"ossbag\\",\\n \\"Name\\": \\"对象存储OSS资源包(包月)\\",\\n \\"ProductCode\\": \\"ossbag\\",\\n \\"PackageTypes\\": {\\n \\"PackageType\\": [\\n {\\n \\"Code\\": \\"FPT_ossbag_deadlineAcc_CdnOut_common_sz\\",\\n \\"Name\\": \\"回源流量包(华南1)\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Name\\": \\"region\\",\\n \\"Value\\": \\"cn-shenzhen\\"\\n }\\n ]\\n },\\n \\"Specifications\\": {\\n \\"Specification\\": [\\n {\\n \\"Name\\": \\"1TB\\",\\n \\"Value\\": \\"1024\\",\\n \\"AvailableDurations\\": {\\n \\"AvailableDuration\\": [\\n {\\n \\"Value\\": 6,\\n \\"Name\\": \\"6 Month\\",\\n \\"Unit\\": \\"Month\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeResourcePackageProductResponse>>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <ResourcePackages>\\n <ResourcePackage>\\n <Name>对象存储OSS资源包(包月)</Name>\\n <ProductCode>ossbag</ProductCode>\\n <PackageTypes>\\n <PackageType>\\n <Name>回源流量包(华南1)</Name>\\n <Specifications>\\n <Specification>\\n <Name>1TB</Name>\\n <Value>1024</Value>\\n <AvailableDurations>\\n <AvailableDuration>\\n <Name>6 Month</Name>\\n <Value>6</Value>\\n <Unit>Month</Unit>\\n </AvailableDuration>\\n </AvailableDurations>\\n </Specification>\\n </Specifications>\\n <Code>FPT_ossbag_deadlineAcc_CdnOut_common_sz</Code>\\n <Properties>\\n <Property>\\n <Name>region</Name>\\n <Value>cn-shenzhen</Value>\\n </Property>\\n <Property>\\n <Name>ossbag_type</Name>\\n <Value>cdn2oss_flow_out</Value>\\n </Property>\\n </Properties>\\n </PackageType>\\n <PackageType>\\n <Name>标准存储包(华北2)</Name>\\n <Specifications>\\n <Specification>\\n <Name>40GB</Name>\\n <Value>40</Value>\\n <AvailableDurations>\\n <AvailableDuration>\\n <Name>6 Month</Name>\\n <Value>6</Value>\\n <Unit>Month</Unit>\\n </AvailableDuration>\\n </AvailableDurations>\\n </Specification>\\n </Specifications>\\n <Code>FPT_ossbag_absolute_Storage_bj</Code>\\n <Properties>\\n <Property>\\n <Name>region</Name>\\n <Value>cn-beijing</Value>\\n </Property>\\n <Property>\\n <Name>ossbag_type</Name>\\n <Value>storage</Value>\\n </Property>\\n </Properties>\\n </PackageType>\\n </PackageTypes>\\n </ResourcePackage>\\n </ResourcePackages>\\n </Data>\\n</DescribeResourcePackageProductResponse>","errorExample":""}]', - 'title' => 'DescribeResourcePackageProduct', - 'summary' => 'Queries the information about resource plans of an Alibaba Cloud service.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetResourcePackagePrice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'The code of service. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ossbag', - ], + 'schema' => ['description' => 'The number of the transaction.'."\n", 'type' => 'string', 'required' => false, 'example' => '133314076', 'title' => ''], ], [ - 'name' => 'PackageType', + 'name' => 'RecordID', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource plan. The value must be the same as the value of the **ProductCode** parameter that is returned when you call the **DescribeResourcePackageProduct** operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'FPT_ossbag_periodMonthlyAcc_NetworkOut_finance_common', - ], + 'schema' => ['description' => 'The ID of the order or bill.'."\n", 'type' => 'string', 'required' => false, 'example' => '20200302', 'title' => ''], ], [ - 'name' => 'EffectiveDate', + 'name' => 'TransactionChannelSN', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the resource plan takes effect. If you do not specify this parameter, the resource plan immediately takes effect by default. '."\n" - .'When the **OrderType** is **BUY**, resource packs with the **EffectiveDate longer than the current time of 6 months** are not supported. '."\n" - .'If the **OrderType** is **UPGRADE**, the **EffectiveDate** **must be less than or equal to** the actual expiration time of the upgraded instance.'."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-10T12:00:00Z', - ], + 'schema' => ['description' => 'The serial number of the transaction channel.'."\n", 'type' => 'string', 'required' => false, 'example' => '12342134', 'title' => ''], ], [ - 'name' => 'Specification', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the resource plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '500', - ], + 'schema' => ['description' => 'The beginning of the creation time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-03-05T01:46:09Z', 'title' => ''], ], [ - 'name' => 'Duration', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The validity period of the resource plan. The value must be the same as the duration of the resource plan specified in the specifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '6', - ], + 'schema' => ['description' => 'The end of the creation time range to query. By default, the transactions in the last month are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-03-06T01:55:00Z', 'title' => ''], ], [ - 'name' => 'PricingCycle', + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TransactionType', 'in' => 'query', 'schema' => [ - 'description' => 'The unit of validity period of the resource plan. Valid values:'."\n" + 'description' => 'The type of the transaction. If you specify one of the following transaction types for this parameter, the results for the specified transaction type are returned. If the transaction type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for all the following transaction types are returned by default. Valid values:'."\n" ."\n" - .'* Month'."\n" - .'* Year'."\n", + .'* Payment'."\n" + .'* Withdraw'."\n" + .'* Refund'."\n" + .'* Consumption'."\n" + .'* Transfer'."\n" + .'* Adjust'."\n", 'type' => 'string', 'required' => false, - 'example' => 'Month', + 'example' => 'Payment', + 'enum' => ['Adjust', 'Payment', 'Refund', 'Withdraw', 'Consumption', 'Pay_Fail_Refund', 'Transfer'], + 'title' => '', ], ], [ - 'name' => 'OrderType', + 'name' => 'TransactionFlow', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the order. Valid values:'."\n" - ."\n" - .'* BUY: You place the order to purchase an instance.'."\n" - .'* UPGRADE: You place the order to upgrade an instance.'."\n" - .'* RENEW: You place the order to renew an instance.'."\n" + 'description' => 'The type of the transaction flow. If you specify one of the following types for this parameter, the results for the specified type are returned. If the type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for the following two types are returned by default. Valid values:'."\n" ."\n" - .'Default value: BUY.'."\n", + .'* Income'."\n" + .'* Expense'."\n", 'type' => 'string', 'required' => false, - 'example' => 'BUY', + 'example' => 'Income', + 'enum' => ['Income', 'Expense'], + 'title' => '', ], ], [ - 'name' => 'InstanceId', + 'name' => 'TransactionChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the instance. **This parameter is required when the order type is renewal or upgrade.**', + 'description' => 'The transaction channel. If you specify one of the following transaction channels for this parameter, the results for the specified transaction channel are returned. If the transaction channel that you specify does not belong to the following transaction channels, no result is returned. If you leave this parameter empty, the results for all the following transaction channels are returned by default. Valid values:'."\n" + ."\n" + .'* AccountBalance'."\n" + .'* BankTransfer'."\n" + .'* Alipay'."\n" + .'* AntCreditPay'."\n" + .'* OfflineRemittance'."\n" + .'* RegularBankCreditRefund'."\n" + .'* CreditCard'."\n" + .'* MyBankCredit'."\n" + .'* HuaxiaBankCInstallment'."\n" + .'* ApplePay'."\n", 'type' => 'string', 'required' => false, - 'example' => 'OSSBAG-cn-0xl0002', + 'example' => 'AccountBalance', + 'enum' => ['Alipay', 'AntCreditPay', 'MyBankCredit', 'HuaxiaBankCInstallment', 'BankTransfer', 'OfflineRemittance', 'CreditCard', 'AccountBalance', 'RegularBankCreditRefund', 'ApplePay'], + 'title' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8634E02D-0942-4B1D-8295-5352FE9A1F39', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'OriginalPrice' => [ - 'description' => 'The original price. Unit: CNY.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1290240', - ], - 'DiscountPrice' => [ - 'description' => 'The discounted amount. Unit: CNY.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '215040', - ], - 'Currency' => [ - 'description' => 'The type of the currency.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'TradePrice' => [ - 'description' => 'The price at which the transaction is made. Unit: CNY.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1075200', - ], - 'Promotions' => [ + 'PageNum' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'AccountName' => ['description' => 'The name of your Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], + 'AccountTransactionsList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Promotion' => [ - 'description' => 'The details of the discount.'."\n", + 'AccountTransactionsList' => [ + 'description' => 'The information about transactions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The description of the discount.'."\n", - 'type' => 'string', - 'example' => 'A discount of 17% is offered if you purchase a resource plan for six months.'."\n", - ], - 'Id' => [ - 'description' => 'The ID of the promotion.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000680914', - ], + 'BillingCycle' => ['description' => 'The billing cycle. Format: YYYY-MM.'."\n", 'type' => 'string', 'example' => '2020-03', 'title' => ''], + 'TransactionChannel' => ['description' => 'The transaction channel.'."\n" + ."\n" + .'* AccountBalance'."\n" + .'* BankTransfer'."\n" + .'* Alipay'."\n" + .'* AntCreditPay'."\n" + .'* OfflineRemittance'."\n" + .'* RegularBankCreditRefund'."\n" + .'* CreditCard'."\n" + .'* MyBankCredit'."\n" + .'* HuaxiaBankCInstallment'."\n" + .'* ApplePay'."\n", 'type' => 'string', 'example' => 'AccountBalance', 'title' => ''], + 'RecordID' => ['description' => 'The number of the order or bill.'."\n", 'type' => 'string', 'example' => '2020030242', 'title' => ''], + 'Remarks' => ['description' => 'The remarks on the transaction.'."\n", 'type' => 'string', 'example' => 'NAT_GW', 'title' => ''], + 'Amount' => ['description' => 'The amount.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'TransactionAccount' => ['description' => 'The transaction account. For example, the account is a recharge account in Alipay or a transfer account.'."\n", 'type' => 'string', 'example' => '213562146', 'title' => ''], + 'TransactionTime' => ['description' => 'The time when the transaction was made.'."\n", 'type' => 'string', 'example' => '2020-03-10T02:03:20Z', 'title' => ''], + 'TransactionType' => ['description' => 'The type of the transaction.'."\n" + ."\n" + .'* Payment'."\n" + .'* Withdraw'."\n" + .'* Refund'."\n" + .'* Consumption'."\n" + .'* Transfer'."\n" + .'* Adjust'."\n", 'type' => 'string', 'example' => 'Consumption', 'title' => ''], + 'TransactionFlow' => ['description' => 'The type of the transaction flow.'."\n" + ."\n" + .'* Income'."\n" + .'* Expense'."\n", 'type' => 'string', 'example' => 'Expense', 'title' => ''], + 'FundType' => ['description' => 'The type of transaction payment. Valid values:'."\n" + ."\n" + .'* Cash: pay for the transaction in cash.'."\n" + .'* Deposit: pay for the transaction with deposit.'."\n" + .'* RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank.'."\n" + .'* DirectPay: directly pay for the transaction.'."\n", 'type' => 'string', 'example' => 'Cash', 'title' => ''], + 'TransactionChannelSN' => ['description' => 'The serial number of the transaction channel.'."\n", 'type' => 'string', 'example' => '1234354325', 'title' => ''], + 'TransactionNumber' => ['description' => 'The number of the transaction.'."\n", 'type' => 'string', 'example' => '43342334', 'title' => ''], + 'Balance' => ['description' => 'The balance of the account.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Absent some mandatory parameter for this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'This request contain some invalid parameter', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'DurationInvalid', - 'errorMessage' => 'Parameter duration can only be positive integer.', - ], - [ - 'errorCode' => 'ProductNotFound', - 'errorMessage' => 'Product not found.', - ], - [ - 'errorCode' => 'PackageTypeNotFound', - 'errorMessage' => 'No such resource package type found.', - ], - [ - 'errorCode' => 'SpecificationInvalid', - 'errorMessage' => 'Parameter specification can only be positive integer.', - ], - [ - 'errorCode' => 'IdInvalid', - 'errorMessage' => 'Parameter ownerId is invalid.', - ], - [ - 'errorCode' => 'EffectiveDateInvalid', - 'errorMessage' => 'Parameter effectiveDate is invalid.', - ], - [ - 'errorCode' => 'IdMissing', - 'errorMessage' => 'Paramter ownerId is missing.', - ], - [ - 'errorCode' => 'PackageTypeNotSupported', - 'errorMessage' => 'Package type currently is not supported.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OriginalPrice\\": 1290240,\\n \\"DiscountPrice\\": 215040,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 1075200,\\n \\"Promotions\\": {\\n \\"Promotion\\": [\\n {\\n \\"Name\\": \\"购买半年，立享8.3折优惠\\",\\n \\"Id\\": 1000680914\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResourcePackagePriceResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <DiscountPrice>215040</DiscountPrice>\\n <Promotions>\\n <Promotion>\\n <Name>购买半年，立享8.3折优惠</Name>\\n <Id>1000680914</Id>\\n </Promotion>\\n </Promotions>\\n <OriginalPrice>1290240</OriginalPrice>\\n <TradePrice>1075200</TradePrice>\\n <Currency>CNY</Currency>\\n </Data>\\n</GetResourcePackagePriceResponse>","errorExample":""}]', - 'title' => 'GetResourcePackagePrice', - 'summary' => 'Queries the price of a resource plan.', + '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":"<QueryAccountTransactionsResponse>\\n <Message>Successful!</Message>\\n <RequestId>8C451EDE-8F92-4896-B4E6-68159A27B0F5</RequestId>\\n <Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <AccountTransactionsList>\\n <AccountTransactionsList>\\n <TransactionType>Consumption</TransactionType>\\n <BillingCycle>2020-03</BillingCycle>\\n <TransactionNumber>133xxxxxx90112</TransactionNumber>\\n <Amount>0.81</Amount>\\n <TransactionAccount/>\\n <TransactionTime>2020-03-10T02:03:20Z</TransactionTime>\\n <TransactionChannelSN/>\\n <Remarks>NAT_GW</Remarks>\\n <FundType>Cash</FundType>\\n <TransactionFlow>Expense</TransactionFlow>\\n <RecordID>2020xxxxx706693</RecordID>\\n <Balance>0.00</Balance>\\n <TransactionChannel>AccountBalance</TransactionChannel>\\n </AccountTransactionsList>\\n </AccountTransactionsList>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryAccountTransactionsResponse>","errorExample":""}]', + 'title' => 'QueryAccountTransactions', + 'summary' => 'Queries transactions within your Alibaba Cloud account.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RenewResourcePackage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-04-11T06:41:43.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAccountTransactions'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccountTran', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lskd****sljhsdj', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EffectiveDate', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'Duration', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The renewal period of the resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page. The default value is 20. The maximum value is 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ - 'name' => 'PricingCycle', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the validity period for the resource plan. Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n" - ."\n" - .'Default value: Month.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Month', - ], + 'schema' => ['description' => 'The product code. You can call the **QueryProductList** operation to query the product code.'."\n" + ."\n" + .'> Required when you specify the Region parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204322301110333', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204322560333', - ], - 'InstanceId' => [ - 'description' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-0xl0n****003', - ], - ], - ], - ], - ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Absent some mandatory parameter for this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'This request contain some invalid parameter', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'DurationInvalid', - 'errorMessage' => 'Parameter duration can only be positive integer.', - ], - [ - 'errorCode' => 'ProductNotFound', - 'errorMessage' => 'Product not found.', - ], - [ - 'errorCode' => '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.', - ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => 'The subscription type.'."\n" + ."\n" + .'- Subscription: subscription'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Subscription'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'InstanceIDs', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can specify up to 100 instance IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rm-xxxxxxxxxxxx'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 204322301110333,\\n \\"Data\\": {\\n \\"OrderId\\": 204322560333,\\n \\"InstanceId\\": \\"OSSBAG-cn-0xl0n****003\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewResourcePackageResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InstanceId>OSSBAG-cn-0xl0****d003</InstanceId>\\n <OrderId>204322301110333</OrderId>\\n </Data>\\n</RenewResourcePackageResponse>","errorExample":""}]', - 'summary' => 'Renews a resource plan.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpgradeResourcePackage' => [ - 'summary' => 'Upgrades a resource plan.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the end time range. The time must be in UTC and in the ISO 8601 format. For example, 2016-05-23T12:00:00Z.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T12:00:00Z'], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'EndTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OSSBAG-cn-0xl*****x002', - ], + 'schema' => ['description' => 'The end of the end time range. The time must be in UTC and in the ISO 8601 format. For example, 2016-05-23T12:00:00Z.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T12:00:00Z'], ], [ - 'name' => 'EffectiveDate', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02T12:00:00Z', - ], + 'schema' => ['description' => 'The beginning of the creation time range. The time must be in UTC and in the ISO 8601 format.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T12:00:00Z'], ], [ - 'name' => 'Specification', + 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications to which you want to upgrade the resource plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '51200', - ], + 'schema' => ['description' => 'The end of the creation time range. The time must be in UTC and in the ISO 8601 format.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T12:00:00Z'], + ], + [ + 'name' => 'RenewStatus', + 'in' => 'query', + 'schema' => ['description' => 'The renewal status. Valid values:'."\n" + ."\n" + .'- AutoRenewal: auto-renewal'."\n" + ."\n" + .'- ManualRenewal: manual renewal'."\n" + ."\n" + .'- NotRenewal: no renewal', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'AutoRenewal'], ], ], 'responses' => [ @@ -8989,237 +7220,180 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73387246238746', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73387246238746', - ], - 'InstanceId' => [ - 'description' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-0xl*****002', + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '11'], + 'InstanceList' => [ + 'description' => 'The list of instance information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubStatus' => ['description' => 'The sub-status.', 'type' => 'string', 'title' => '', 'example' => 'Normal-后付费模块正常'."\n" + .'WaitForLimit-后付费模块即将欠费受限'."\n" + .'BandwidthLimited-后付费模块欠费受限'], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'Creating-资源创建中'."\n" + .'WaitForExpire-即将停服'."\n" + .'Normal-正常'."\n" + .'Expired-停服'], + 'ExpectedReleaseTime' => ['description' => 'The expected release time.', 'type' => 'string', 'title' => '', 'example' => '2019-09-08T16:00:00Z'], + 'RenewStatus' => ['description' => 'The renewal status. Valid values:'."\n" + ."\n" + .'- AutoRenewal: auto-renewal'."\n" + ."\n" + .'- ManualRenewal: manual renewal'."\n" + ."\n" + .'- NotRenewal: no renewal', 'type' => 'string', 'title' => '', 'example' => 'ManualRenewal'], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2019-09-08T16:00:00Z'], + 'SellerId' => ['description' => 'The seller ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123123123'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '1049056'], + 'Seller' => ['description' => 'The seller.', 'type' => 'string', 'title' => '', 'example' => '123123123'], + 'StopTime' => ['description' => 'The stop time.', 'type' => 'string', 'title' => '', 'example' => '2019-09-08T16:00:00Z'], + 'RenewalDurationUnit' => ['description' => 'The unit of the auto-renewal period. Valid values:'."\n" + ."\n" + .'- M: Month'."\n" + ."\n" + .'- Y: Year', 'type' => 'string', 'title' => '', 'example' => 'M'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go', 'type' => 'string', 'title' => '', 'example' => 'Subscription'], + 'OwnerId' => ['description' => 'The owner ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '325352345'], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'title' => '', 'example' => '2019-09-08T16:00:00Z'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'ReleaseTime' => ['description' => 'The release time.', 'type' => 'string', 'title' => '', 'example' => '2019-09-08T16:00:00Z'], + 'RenewalDuration' => ['description' => 'The auto-renewal duration.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Absent some mandatory parameter for this request.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'This request contain some invalid parameter', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'DurationInvalid', - 'errorMessage' => 'Parameter duration can only be positive integer.', - ], - [ - 'errorCode' => 'ProductNotFound', - 'errorMessage' => 'Product not found.', - ], - [ - 'errorCode' => 'PackageTypeNotFound', - 'errorMessage' => 'No such resource package type found.', - ], - [ - 'errorCode' => 'SpecificationInvalid', - 'errorMessage' => 'Parameter specification can only be positive integer.', - ], - [ - 'errorCode' => 'IdInvalid', - 'errorMessage' => 'Parameter ownerId is invalid.', - ], - [ - 'errorCode' => 'EffectiveDateInvalid', - 'errorMessage' => 'Parameter effectiveDate is invalid.', - ], - [ - 'errorCode' => 'IdMissing', - 'errorMessage' => 'Paramter ownerId is missing.', - ], - [ - 'errorCode' => 'PackageTypeNotSupported', - 'errorMessage' => 'Package type currently is not supported.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"OrderId\\": 73387246238746,\\n \\"Data\\": {\\n \\"OrderId\\": 73387246238746,\\n \\"InstanceId\\": \\"OSSBAG-cn-0xl*****002\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpgradeResourcePackageResponse>\\r\\n <Message>Successful!</Message>\\r\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>Success</Code>\\r\\n <Data>\\r\\n <InstanceId>OSSBAG-cn-0xl*****d003</InstanceId>\\r\\n <OrderId>204322301110333</OrderId>\\r\\n </Data>\\r\\n</UpgradeResourcePackageResponse>","errorExample":""}]', - 'title' => 'UpgradeResourcePackage', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryAvailableInstances', + 'summary' => 'Queries available instances.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SubscribeBillToOSS' => [ - 'summary' => 'Subscribes to the bills that are stored in Object Storage Service (OSS) buckets.', - '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryBill' => [ + 'summary' => 'Queries the settlement bills for an account in a specified billing cycle.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'SubscribeBucket', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The OSS bucket that stores the bills to which you want to subscribe.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxxxxx-bucket', - ], + 'schema' => ['description' => 'The billing cycle. The format is YYYY-MM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2018-07'], ], [ - 'name' => 'SubscribeType', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the bill to which you want to subscribe. Valid values:'."\n" - ."\n" - .'* BillingItemDetailForBillingPeriod: detailed bills of billable items'."\n" - .'* InstanceDetailForBillingPeriod: detailed bills of instances'."\n" - .'* BillingItemDetailMonthly: billable item-based bills summarized by billing cycle'."\n" - .'* InstanceDetailMonthly: instance-based bills summarized by billing cycle'."\n" - .'* SplitItemDetailDaily: split bills summarized by day'."\n" - .'* MonthBill: monthly bills in the PDF format. You can subscribe to the monthly PDF bills only of the master account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BillingItemDetailForBillingPeriod', - ], + 'schema' => ['description' => 'The type. Valid values:'."\n" + ."\n" + .'- SubscriptionOrder'."\n" + ."\n" + .'- PayAsYouGoBill'."\n" + ."\n" + .'- Refund'."\n" + ."\n" + .'- Adjustment', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SubscriptionOrder'], ], [ - 'name' => 'MultAccountRelSubscribe', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the account whose bills are to be pushed if multi-tier accounts are involved. Valid values:'."\n" - ."\n" - .'* MA: the master account and a non-managed member account in Finance Cloud'."\n" - .'* ACP1: a member account of a virtual network operator (VNO)'."\n" - ."\n" - .'Default value: MA.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MA', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'BucketOwnerId', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The owner ID of the OSS bucket that stores the bills. This parameter is required if you are a bidder or reseller and want to push data to an OSS bucket of a member account. In this case, you must specify this account as the account used to call this operation and grant the AliyunConsumeDump2OSSRole permission to this account. If you are a regular user, you do not need to set this parameter. By default, your account is used to call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12341324', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'BeginBillingCycle', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The initial billing cycle from which bills start to be pushed. After you subscribe to the bills, the system automatically pushes the data that is generated from the initial billing cycle to the current time. If the SubscribeType parameter is set to MonthBill, this parameter is invalid. Historical data is not pushed again. The data generated within the last year can be pushed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-03', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription'."\n" + ."\n" + .'- PayAsYouGo'."\n" + ."\n" + .'> This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Subscription'], ], [ - 'name' => 'BucketPath', + 'name' => 'IsHideZeroCharge', 'in' => 'query', - 'schema' => [ - 'title' => 'OSS Bucket存储路径', - 'description' => 'The path of the OSS bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testpath', - ], + 'schema' => ['description' => 'Specifies whether to exclude bills with a pretax gross amount (PretaxGrossAmount) of 0. The default value is false. This ensures backward compatibility.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'RowLimitPerFile', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The upper limit of the number of lines in a single file. When the bill file exceeds the upper limit, it will be split into multiple files and merged into a compressed package.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300000', - ], + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'UsingSsl', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to protect network communications through the SSL (Secure Sockets Layer) encryption protocol. When this parameter is set to true, it means that SSL encryption is enabled to ensure the security and integrity of data transmission.', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the account that owns the resource. This is the account that actually uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '123'], ], ], 'responses' => [ @@ -9227,129 +7401,165 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F61FCE4B-9B56-4FD9-A17E-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'BillingCycle' => ['description' => 'The billing cycle in YYYY-MM format.', 'type' => 'string', 'title' => '', 'example' => '2020-02'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185xxxxx489'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountName' => ['description' => 'The account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The payment status. Valid values:'."\n" + ."\n" + .'- PayFinish: Paid'."\n" + ."\n" + .'- PayUnclear: Outstanding'."\n" + ."\n" + .'- PayUnsettle: Unsettled'."\n" + ."\n" + .'- NoSettle: Settlement-free', 'type' => 'string', 'title' => '', 'example' => 'PayFinish'], + 'RoundDownDiscount' => ['description' => 'The discount amount due to rounding.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'Item' => ['description' => 'The bill type:'."\n" + ."\n" + .'- SubscriptionOrder'."\n" + ."\n" + .'- PayAsYouGoBill'."\n" + ."\n" + .'- Refund'."\n" + ."\n" + .'- Adjustment', 'type' => 'string', 'title' => '', 'example' => 'SubscriptionOrder'], + 'Currency' => ['description' => 'The currency.'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'UsageStartTime' => ['description' => 'The start time of the bill.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 07:00:00'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription'."\n" + ."\n" + .'- PayAsYouGo', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'UsageEndTime' => ['description' => 'The end time of the bill.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 08:00:00'], + 'DeductedByCoupons' => ['description' => 'The amount deducted using coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'SubOrderId' => ['description' => 'The ID of the order details that correspond to the bill.', 'type' => 'string', 'title' => '', 'example' => '325345254353'], + 'OutstandingAmount' => ['description' => 'The outstanding amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'AfterTaxAmount' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentTime' => ['description' => 'The time the order was paid.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 08:00:00'], + 'PretaxAmountLocal' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'Tax' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'PipCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'PaymentTransactionID' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PretaxAmount' => ['description' => 'The amount payable.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100'], + 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'RecordID' => ['description' => 'The order number or bill number.', 'type' => 'string', 'title' => '', 'example' => '2020xxxx5912'], + 'AdjustAmount' => ['description' => 'The amount deducted from a credit refund.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '关系型数据库RDS（包月）'], + 'PaymentCurrency' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OwnerID' => ['description' => 'The **AccountID** of the RAM user. This applies to scenarios where a management account pays for member accounts.', 'type' => 'string', 'title' => '', 'example' => '3532535235'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'PaymentAmount' => ['description' => 'The cash payment, including deductions from credit refunds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'CashAmount' => ['description' => 'The cash payment, excluding deductions from credit refunds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + 'title' => '', + 'example' => '', + 'description' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + 'description' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + '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":"<SubscribeBillToOSSResponse>\\n <Message>Successful!</Message>\\n <RequestId>F61FCE4B-9B56-4FD9-A17E-******</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</SubscribeBillToOSSResponse>","errorExample":""}]', - 'title' => 'SubscribeBillToOSS', - 'description' => 'Before you call this operation, take note of the following items:'."\n" - ."\n" - .'* You can subscribe to only one type of bill at a time.'."\n" - .'* The bills generated on the previous day are pushed on a daily basis the next day after you subscribe to the bills. The full-data bills for the previous month are pushed on the fourth day of each month. The monthly bills in the PDF format for the previous month are pushed on the fourth day of each month.'."\n" - .'* The daily bills may be delayed. The delayed bills are pushed the next day after they are generated. The delayed bills may include the bills that should have been pushed on the previous day. We recommend that you query the full-data bills for the previous month at the beginning of each month.'."\n" - .'* The bill subscriber must have the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission.'."\n" - .'* The SubscribeBillToOSS operation has the same functionality as the Save Expense Details to OSS Bucket feature in User Center.'."\n" - .'* To subscribe to the bills stored in an OSS bucket, make sure that the directory name specified for the OSS bucket conforms to the following naming rules:'."\n" - ."\n" - .'1. 1. The directory name can contain only UTF-8 characters and cannot contain emoticons.'."\n" - .'2. 2. Forward slashes (/) are used to separate paths and can be used to create subdirectories with ease. The directory name cannot start with a forward slash (/), a backslash (\\\\), or consecutive forward slashes (/).'."\n" - .'3. 3. The name of a subdirectory cannot be set to two consecutive periods (..).'."\n" - .'4. 4. The directory name must be 1 to 254 characters in length.'."\n" - ."\n" - .'* File names:'."\n" - ."\n" - .' * **BillingItemDetailForBillingPeriod** (Detailed bills of billable items)'."\n" - ."\n" - .' * File name format for a daily push: `UID_BillingItemDetail_YYYYMMDD`. Example: `169**_BillingItemDetail_20190310`.'."\n" - .' * File name format for a full-data push at the beginning of the next month: `UID_BillingItemDetail_YYYYMM`. Example: `169**_BillingItemDetail_201903`.'."\n" - ."\n" - .' * **InstanceDetailForBillingPeriod** (Detailed bills of instances)'."\n" - ."\n" - .' * File name format for a daily push: `UID_InstanceDetail_YYYYMMDD`. Example: `169**_InstanceDetail_20190310`.'."\n" - .' * File name format for a full-data push at the beginning of the next month: `UID_InstanceDetail_YYYYMM`. Example: `169**_InstanceDetail_201903`.'."\n" - ."\n" - .' * **InstanceDetailMonthly** (Instance-based bills summarized by billing cycle)'."\n" - ."\n" - .' * File name format for a daily push: `UID_InstanceDetailMonthly_YYYYMM`. Example: `169**_InstanceDetailMonthly_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" - ."\n" - .' * **BillingItemDetailMonthly** (Billable item-based bills summarized by billing cycle)'."\n" - ."\n" - .' * File name format for a daily push: `UID_BillingItemDetailMonthly_YYYYMM`. Example: `169**_BillingItemDetailMonthly_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" - ."\n" - .' * **SplitItemDetailDaily** (Split bills summarized by day)'."\n" - ."\n" - .' * File name format for a daily push: `UID_SplitItemDetailDaily_YYYYMM`. Example: `169**_SplitItemDetailDaily_201903`. A bill of this type contains the full data generated from the beginning of the month to the current day, and is updated every day until the fourth day of the next month.'."\n" - ."\n" - .' * **MonthBill** (Monthly bill in the PDF format)'."\n" - ."\n" - .' * File name format for a monthly push: `UID_MonthBill_YYYYMM`. Example: `169**_MonthBill_201903`. The bill for the previous month is pushed on the fourth day of each month.'."\n" - ."\n" - .'* The bills of the MonthBill type are PDF files, whereas the bills of other types are CSV files. If the number of data rows in a bill exceeds a threshold, the bill is automatically split into multiple CSV files. Then, the multiple CSV files are automatically merged and compressed into a ZIP file that has the same name format as the original file.'."\n", + 'responseDemo' => '[{"errorExample":"","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 \\"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\\": \\"\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\n \\"PaymentCurrency\\": \\"\\",\\n \\"OwnerID\\": \\"3532535235\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"PaymentAmount\\": 0,\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'QueryBill', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnsubscribeBillToOSS' => [ - 'summary' => 'Unsubscribes from the bills that are stored in Object Storage Service (OSS) buckets.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBill'], + ], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'QueryBillOverview' => [ + 'summary' => 'Retrieves the bill overview for an account for a specified billing cycle.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'SubscribeType', + 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the bill to which you want to subscribe. Valid values:'."\n" - ."\n" - .'* BillingItemDetailForBillingPeriod: bills of billable items'."\n" - .'* InstanceDetailForBillingPeriod: bills of instances'."\n" - .'* BillingItemDetailMonthly: billable item-based bills summarized by billing cycle'."\n" - .'* InstanceDetailMonthly: instance-based bills summarized by billing cycle'."\n" - .'* SplitItemDetailDaily: split bills summarized by day'."\n" - .'* MonthBill: monthly bills in the PDF format You can subscribe to the monthly PDF bills only of the master account.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'BillingItemDetailForBillingPeriod', - ], + 'schema' => ['description' => 'The billing cycle in `YYYY-MM` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-07', 'title' => ''], ], [ - 'name' => 'MultAccountRelSubscribe', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of accounts whose bills are to be pushed if multi-tier accounts are involved. Valid values:'."\n" - ."\n" - .'* MA: management account.'."\n" - .'* ACP1: member account of a virtual network operator (VNO).'."\n" - ."\n" - .'Default value: MA.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MA', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `Subscription`: The subscription billing method.'."\n" + ."\n" + .'- `PayAsYouGo`: The pay-as-you-go billing method.', 'type' => 'string', 'required' => false, 'example' => 'Subscription', 'title' => ''], + ], + [ + 'name' => 'BillOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource owner account. This refers to the account that uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1234', 'title' => ''], ], ], 'responses' => [ @@ -9357,54 +7567,134 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D23FE74C-742F-4624-A82B-******', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BCB1E1BC-05BF-4217-80EE-BF09A29407BA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'BillingCycle' => ['description' => 'The billing cycle in YYYY-MM format.', 'type' => 'string', 'example' => '2020-03', 'title' => ''], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '185766xxxx', 'title' => ''], + 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RoundDownDiscount' => ['description' => 'The round-down discount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Item' => ['description' => 'The bill type. Valid values:'."\n" + ."\n" + .'- `SubscriptionOrder`: subscription bill'."\n" + ."\n" + .'- `PayAsYouGoBill`: pay-as-you-go bill'."\n" + ."\n" + .'- `Refund`: refund'."\n" + ."\n" + .'- `Adjustment`: adjustment', 'type' => 'string', 'example' => 'PayAsYouGoBill', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- `Subscription`: subscription'."\n" + ."\n" + .'- `PayAsYouGo`: pay-as-you-go', 'type' => 'string', 'example' => 'Subscription', 'title' => ''], + 'BillAccountName' => ['description' => 'The bill\'s account name.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'example' => 'trusteeship', 'title' => ''], + 'DeductedByCoupons' => ['description' => 'The amount deducted by coupons.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'OutstandingAmount' => ['description' => 'The outstanding amount, which includes overdue payments and amounts settled by using a credit limit.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'AfterTaxAmount' => ['description' => 'The amount after tax is applied. This is the final billable amount including any applicable tax charges.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => ''], + 'PretaxAmountLocal' => ['description' => 'The pretax amount in the local currency. This represents the billing amount before tax is applied, converted to the account\'s local currency setting.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => ''], + 'Tax' => ['description' => 'The tax amount charged for the billing cycle. This is the difference between the after-tax amount and the pretax amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => ''], + 'PipCode' => ['description' => 'The product code, which is the same as the one shown on bills in Billing Management.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => 'NAT Gateway', 'title' => ''], + 'CommodityCode' => ['description' => 'The commodity code, which is the same as the one shown for product details in Billing Management.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'AdjustAmount' => ['description' => 'The amount paid using refund credit.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'example' => 'NAT Gateway (Pay-As-You-Go)', 'title' => ''], + 'PaymentCurrency' => ['description' => 'The currency used for payment settlement. This field indicates the actual currency in which the payment was processed, which may differ from the billing currency (Currency) in cases of currency conversion or cross-border transactions.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OwnerID' => ['description' => 'The bill owner\'s ID.', 'type' => 'string', 'example' => '1222', 'title' => ''], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'PaymentAmount' => ['description' => 'The payment amount, including any amount paid using refund credit.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'BillAccountID' => ['description' => 'The bill\'s account ID.', 'type' => 'string', 'example' => '185766xxxx', 'title' => ''], + 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'CashAmount' => ['description' => 'The amount paid in cash. This excludes any amount paid using refund credit.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D23FE74C-742F-4624-A82B-******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnsubscribeBillToOSSResponse>\\n <Message>Successful!</Message>\\n <RequestId>D23FE74C-742F-4624-A82B-******</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</UnsubscribeBillToOSSResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","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 \\"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 Gateway\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"NAT Gateway (Pay-As-You-Go)\\",\\n \\"PaymentCurrency\\": \\"\\",\\n \\"OwnerID\\": \\"1222\\",\\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}","type":"json"}]', + 'title' => 'QueryBillOverview', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryBillOverview'], + ], + ], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryBillToOSSSubscription' => [ 'summary' => 'Queries the subscribed bills that are stored in Object Storage Service (OSS) bucket.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ @@ -9412,40 +7702,16 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9EEAE43F-1E4D-4734-AE93-5049878AC103', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9EEAE43F-1E4D-4734-AE93-5049878AC103', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'AccountName' => [ - 'description' => 'The name of the account used to perform the query.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'AccountID' => [ - 'description' => 'The ID of the account used to perform the query.'."\n", - 'type' => 'string', - 'example' => '185xxxxx03489', - ], + 'AccountName' => ['description' => 'The name of the account used to perform the query.'."\n", 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''], + 'AccountID' => ['description' => 'The ID of the account used to perform the query.'."\n", 'type' => 'string', 'example' => '185xxxxx03489', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, @@ -9457,30 +7723,13 @@ 'description' => 'The details of the subscribed bill.'."\n", 'type' => 'object', 'properties' => [ - 'BucketOwnerId' => [ - 'description' => 'The owner ID of the Object Storage Service (OSS) bucket.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1369168081849304', - ], - 'SubscribeType' => [ - 'description' => 'The type of the subscribed bill. Valid values:'."\n" - ."\n" - .'* BillingItemDetailForBillingPeriod: the bill of a billable item.'."\n" - .'* InstanceDetailForBillingPeriod: the bill of an instance.'."\n", - 'type' => 'string', - 'example' => 'BillingItemDetailForBillingPeriod', - ], - 'SubscribeBucket' => [ - 'description' => 'The ID of the OSS bucket that stores the subscribed bill.'."\n", - 'type' => 'string', - 'example' => 'billingtestbucket', - ], - 'SubscribeTime' => [ - 'description' => 'The time when the subscribed bill was stored in the OSS bucket. The time is displayed in the YYYY-MM-DD hh:mm:ss format.'."\n", - 'type' => 'string', - 'example' => '2019-10-30 15:40:11', - ], + 'BucketOwnerId' => ['description' => 'The owner ID of the Object Storage Service (OSS) bucket.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1369168081849304', 'title' => ''], + 'SubscribeType' => ['description' => 'The type of the subscribed bill. Valid values:'."\n" + ."\n" + .'* BillingItemDetailForBillingPeriod: the bill of a billable item.'."\n" + .'* InstanceDetailForBillingPeriod: the bill of an instance.'."\n", 'type' => 'string', 'example' => 'BillingItemDetailForBillingPeriod', 'title' => ''], + 'SubscribeBucket' => ['description' => 'The ID of the OSS bucket that stores the subscribed bill.'."\n", 'type' => 'string', 'example' => 'billingtestbucket', 'title' => ''], + 'SubscribeTime' => ['description' => 'The time when the subscribed bill was stored in the OSS bucket. The time is displayed in the YYYY-MM-DD hh:mm:ss format.'."\n", 'type' => 'string', 'example' => '2019-10-30 15:40:11', 'title' => ''], 'SubscribeLanguage' => [ 'description' => 'The code of the language.'."\n" ."\n" @@ -9489,32 +7738,27 @@ .'* en: English'."\n" .'* zh: Chinese', 'type' => 'string', - 'enumValueTitles' => [ - 'en' => '', - 'zh' => '', - ], + 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'], 'example' => 'zh', + 'title' => '', ], - 'BucketPath' => [ - 'description' => 'The path in the OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'Billing/BillingItemDetailMonthly/', - ], - 'RowLimitPerFile' => [ - 'description' => 'The maximum number of data rows in a single file. If the number of data rows in a bill exceeds the upper limit, the bill is split into multiple files. Then, multiple files are merged and compressed into a package.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300000', - ], + 'BucketPath' => ['description' => 'The path in the OSS bucket.'."\n", 'type' => 'string', 'example' => 'Billing/BillingItemDetailMonthly/', 'title' => ''], + 'RowLimitPerFile' => ['description' => 'The maximum number of data rows in a single file. If the number of data rows in a bill exceeds the upper limit, the bill is split into multiple files. Then, multiple files are merged and compressed into a package.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300000', 'title' => ''], ], + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], 'description' => '', + 'title' => '', ], ], ], @@ -9523,728 +7767,578 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryBillOverview' => [ - 'summary' => 'Queries the bill overview information in a billing cycle.', - '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryCashCoupons' => [ + 'summary' => 'Queries the information about vouchers.', + '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', + 'name' => 'ExpiryTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + 'schema' => ['description' => 'The end time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", 'type' => 'string', 'required' => false, 'example' => '2018-08-01T00:00:00Z', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'ExpiryTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The start time of the validity period of the voucher. Specify the parameter in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-08-01T00:00:00Z.'."\n", 'type' => 'string', 'required' => false, 'example' => '2018-08-01T00:00:00Z', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'EffectiveOrNot', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the voucher takes effect. Valid values:'."\n" + ."\n" + .'* true: The voucher takes effect.'."\n" + .'* false: The voucher does not take effect.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '147B566E-DB4C-4E43-BDBB-5DB1D9D268DB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CashCoupon' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The state of the voucher. Valid values:'."\n" + ."\n" + .'* Available: The voucher is valid.'."\n" + .'* Expired: The voucher has expired.'."\n" + .'* Cancelled: The voucher is canceled.'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'ExpiryTime' => ['description' => 'The time when the voucher expired.'."\n", 'type' => 'string', 'example' => '2019-01-29T15:15:50Z', 'title' => ''], + 'GrantedTime' => ['description' => 'The time when the voucher was released.'."\n", 'type' => 'string', 'example' => '2018-08-02T15:15:50Z', 'title' => ''], + 'NominalValue' => ['description' => 'The denomination of the voucher.'."\n", 'type' => 'string', 'example' => '100.00', 'title' => ''], + 'EffectiveTime' => ['description' => 'The time when the voucher took effect.'."\n", 'type' => 'string', 'example' => '2018-08-02T15:15:50Z', 'title' => ''], + 'ApplicableScenarios' => ['description' => 'The scenario to which the voucher is applicable.'."\n", 'type' => 'string', 'example' => 'Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service'."\n", 'title' => ''], + 'CashCouponId' => ['description' => 'The ID of the voucher.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34534253254325', 'title' => ''], + 'ApplicableProducts' => ['description' => 'The service to which the voucher is applicable.'."\n", 'type' => 'string', 'example' => 'All Alibaba Cloud services'."\n", 'title' => ''], + 'CashCouponNo' => ['description' => 'The code of the voucher.'."\n", 'type' => 'string', 'example' => 'Q-b1485def8f04a', 'title' => ''], + 'Balance' => ['description' => 'The remaining quota of the voucher.'."\n", 'type' => 'string', 'example' => '100.00', 'title' => ''], + 'Description' => ['description' => 'The description of the voucher.', 'type' => 'string', 'example' => 'This voucher is used for testing product function', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', ], ], + ], + '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' => ''], + ], + ], + 'title' => 'QueryCashCoupons', + 'changeSet' => [ + ['createdAt' => '2023-07-19T02:26:52.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCoupons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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\\": \\"2019-01-29T15:15:50Z\\",\\n \\"GrantedTime\\": \\"2018-08-02T15:15:50Z\\",\\n \\"NominalValue\\": \\"100.00\\",\\n \\"EffectiveTime\\": \\"2018-08-02T15:15:50Z\\",\\n \\"ApplicableScenarios\\": \\"Pay for the pay-as-you-go bills of Alibaba Cloud services or purchase an instance of an Alibaba Cloud service\\\\n\\",\\n \\"CashCouponId\\": 34534253254325,\\n \\"ApplicableProducts\\": \\"All Alibaba Cloud services\\\\n\\",\\n \\"CashCouponNo\\": \\"Q-b1485def8f04a\\",\\n \\"Balance\\": \\"100.00\\",\\n \\"Description\\": \\"This voucher is used for testing product function\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryCommodityList' => [ + 'summary' => 'Retrieves a list of commodity information based on a product code.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BillOwnerId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'Lang', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The language. Default value: zh.', + 'enumValueTitles' => ['en' => 'English.', 'zh' => 'Chinese.'], + 'type' => 'string', 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '1234', + 'example' => 'en', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BCB1E1BC-05BF-4217-80EE-BF09A29407BA', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655'], + 'Message' => ['description' => 'The additional information about the call result.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NotApplicable', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'BillingCycle' => [ - 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185766xxxx', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Item' => [ - 'description' => 'The details of the bills.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RoundDownDiscount' => [ - 'description' => 'The round down discount.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Item' => [ - 'description' => 'The type of the bill. Valid values:'."\n" - ."\n" - .'* SubscriptionOrder'."\n" - .'* PayAsYouGoBill'."\n" - .'* Refund'."\n" - .'* Adjustment'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGoBill', - ], - 'Currency' => [ - 'description' => 'The type of the currency. Valid values:'."\n" - ."\n" - .'* CNY'."\n" - .'* USD'."\n" - .'* JPY'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'example' => 'Subscription', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'BizType' => [ - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'OutstandingAmount' => [ - 'description' => 'The unsettled amount or the amount deducted by using credits. This may be an unsettled amount of a regular user or credits consumed by a credit user.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AfterTaxAmount' => [ - 'description' => 'The amount paid after the tax is deducted.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PretaxAmountLocal' => [ - 'description' => 'The pretax amount paid in local currency.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'Tax' => [ - 'description' => 'The tax.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PipCode' => [ - 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'NAT Gateway'."\n", - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'AdjustAmount' => [ - 'description' => 'The amount deducted by using credit refunds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'NAT Gateway (Pay-As-You-Go)', - ], - 'PaymentCurrency' => [ - 'description' => 'The currency used for payment.'."\n", - 'type' => 'string', - 'example' => 'USD', - ], - 'OwnerID' => [ - 'description' => 'The ID of the bill owner.'."\n", - 'type' => 'string', - 'example' => '1222', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PaymentAmount' => [ - 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is included.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => '185766xxxx', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CashAmount' => [ - 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is not included.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - ], + 'CommodityList' => [ + 'description' => 'The commodity list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The commodity list.', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => ['description' => 'The commodity code, which is the same as the product detail code in User Center.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'CommodityName' => ['description' => 'The commodity name.', 'type' => 'string', 'example' => '云服务器（按量付费）', 'title' => ''], + 'ChargeType' => [ + 'description' => 'The billing type. Valid values:'."\n" + .'- POSTPAY: pay-as-you-go'."\n" + .'- PREPAY: subscription', + 'enumValueTitles' => ['PREPAY' => 'Subscription.', 'POSTPAY' => 'Pay-as-you-go.'], + 'type' => 'string', + 'example' => 'POSTPAY', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<RequestId>BCB1E1BC-05BF-4217-80EE-BF09A29407BA</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>185766xxxx</AccountID>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n <Items>\\n <Item>\\n <AfterTaxAmount>0</AfterTaxAmount>\\n <ProductName>Nat网关</ProductName>\\n <BillAccountID>185766xxxx</BillAccountID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <PaymentCurrency>USD</PaymentCurrency>\\n <Tax>0</Tax>\\n <PaymentAmount>100</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>100</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <AdjustAmount>0</AdjustAmount>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductDetail>NAT Gateway (Pay-As-You-Go)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <PipCode>rds</PipCode>\\n <OwnerID>1222</OwnerID>\\n <PretaxAmount>100</PretaxAmount>\\n <BillAccountName>test@test.aliyunid.com</BillAccountName>\\n <CashAmount>0</CashAmount>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'QueryBillOverview', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryBill' => [ - 'summary' => 'Queries the bills in a billing cycle.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query commodity information list by product code', + 'description' => 'Retrieves a list of commodity information based on a product code.', + 'changeSet' => [], + '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' => 'All Resource', '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' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + 'schema' => ['description' => 'The user ID of the cost center owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '28394563429587', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'ParentUnitId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the bill. Valid values:'."\n" - ."\n" - .'* SubscriptionOrder'."\n" - .'* PayAsYouGoBill'."\n" - .'* Refund'."\n" - .'* Adjustment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SubscriptionOrder', - ], + 'schema' => ['description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '-1', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The page number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. A maximum of 300 entries can be returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CostUnitDtoList' => [ + 'description' => 'The cost centers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => ['description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'UnitName' => ['description' => 'The name of the cost center.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UnitId' => ['description' => 'The ID of the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '23534', 'title' => ''], + 'OwnerUid' => ['description' => 'The user ID of the cost center owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2343464', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CostUnitDtoList\\": [\\n {\\n \\"ParentUnitId\\": -1,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 23534,\\n \\"OwnerUid\\": 2343464\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCostUnitResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <PageNum/>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n </Data>\\n</QueryCostUnitResponse>","errorExample":""}]', + 'title' => 'QueryCostUnit', + 'summary' => 'Queries all cost centers within the current node of the cost center tree. If the ParentUnitId parameter is set to -1, all cost centers are queried.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-17T06:23:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription'."\n" - .'* PayAsYouGo'."\n" - ."\n" - .'This parameter must be used together with the ProductCode parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryCostUnitResource' => [ + 'summary' => 'Queries the resource instances that are allocated to a cost center. If the unitId parameter is set to 0, the unallocated primary resource instances and sub-resource instances are queried.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsHideZeroCharge', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'OwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to filter out a bill whose pretax gross amount is 0. By default, a bill whose pretax gross amount is 0 is not filtered out. Valid values:'."\n" - ."\n" - .'* true: filters out a bill whose pretax gross amount is 0.'."\n" - .'* false: does not filter out a bill whose pretax gross amount is 0.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The user ID of the cost center owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23453245', 'title' => ''], ], [ - 'name' => 'IsDisplayLocalCurrency', + 'name' => 'UnitId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display local currency information in bills. The parameter will be discontinued.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '235325', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '04332CB7-9A57-4461-97E0-02821D044414', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'ResourceInstanceDtoList' => [ + 'description' => 'The resource instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => ['description' => 'The product code of the resource.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'ResourceUserName' => ['description' => 'The username of the resource owner.'."\n", 'type' => 'string', 'example' => 'test@test.aliyun.com', 'title' => ''], + 'CommodityName' => ['description' => 'The commodity name of the resource.'."\n", 'type' => 'string', 'example' => 'ApsaraDB'."\n", 'title' => ''], + 'ResourceUserId' => ['description' => 'The user ID of the resource owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2424242134', 'title' => ''], + 'ApportionName' => ['description' => 'The split name of the resource.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ApportionCode' => ['description' => 'The split code of the resource.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ResourceType' => ['description' => 'The type of the resource.'."\n", 'type' => 'string', 'example' => 'FPT_ossbag_absolute_Storage_bj', 'title' => ''], + 'ResourceNick' => ['description' => 'The custom name of the resource.'."\n", 'type' => 'string', 'example' => 'testResource', 'title' => ''], + 'ResourceTag' => ['description' => 'The tags of the resource.'."\n", 'type' => 'string', 'example' => 'testResource', 'title' => ''], + 'ResourceId' => ['description' => 'The instance ID of the resource.'."\n", 'type' => 'string', 'example' => 'OSSBAG-cn-v0h1s4hma018', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource group to which the resource belongs.'."\n", 'type' => 'string', 'example' => 'Default Resource Group'."\n", 'title' => ''], + 'RelatedResources' => ['description' => 'The resources related to the resource instance.'."\n", 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'ResourceStatus' => ['description' => 'The status of the resource.'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'PipCode' => ['description' => 'The code of the service. The code is the same as that in Cost Center.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'ResourceSource' => ['description' => 'The source of the resource. Value:'."\n" + .'- AUTO_ALLOCATE'."\n" + .'- MANUAL_ALLOCATE', 'type' => 'string', 'example' => 'MANUAL_ALLOCATE', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + 'title' => '', + ], + 'CostUnit' => [ + 'description' => 'The information about the cost center.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParentUnitId' => ['description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '23421', 'title' => ''], + 'UnitName' => ['description' => 'The name of the cost center.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UnitId' => ['description' => 'The ID of the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123412', 'title' => ''], + 'OwnerUid' => ['description' => 'The user ID of the cost center owner.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '321432', 'title' => ''], + ], + 'title' => '', + ], + 'CostUnitStatisInfo' => [ + 'description' => 'The statistical information about the cost center.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalResourceCount' => ['description' => 'The total number of resource instances, including resource instances of sub-cost centers, in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ResourceCount' => ['description' => 'The number of resource instances in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalUserCount' => ['description' => 'The total number of the associated accounts, including associated accounts of sub-cost centers, in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'SubUnitCount' => ['description' => 'The number of sub-cost centers in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ResourceGroupCount' => ['description' => 'The number of resource groups in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalResourceGroupCount' => ['description' => 'The total number of resource groups, including resource groups of sub-cost centers, in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'UserCount' => ['description' => 'The number of sub-cost centers in the cost center.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + ], + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', ], ], + ], + '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\\": \\"ApsaraDB\\\\n\\",\\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\\": \\"Default Resource Group\\\\n\\",\\n \\"RelatedResources\\": \\"oss\\",\\n \\"ResourceStatus\\": \\"Available\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\"\\n }\\n ],\\n \\"CostUnit\\": {\\n \\"ParentUnitId\\": 23421,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 123412,\\n \\"OwnerUid\\": 321432\\n },\\n \\"CostUnitStatisInfo\\": {\\n \\"TotalResourceCount\\": 3,\\n \\"ResourceCount\\": 1,\\n \\"TotalUserCount\\": 2,\\n \\"SubUnitCount\\": 2,\\n \\"ResourceGroupCount\\": 1,\\n \\"TotalResourceGroupCount\\": 2,\\n \\"UserCount\\": 0\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCostUnitResourceResponse>\\n <Message>Successful!</Message>\\n <RequestId>04332CB7-9A57-4461-97E0-02821D044414</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <CostUnit>\\n <UnitId>-1</UnitId>\\n <OwnerUid>1857xxxxx89</OwnerUid>\\n </CostUnit>\\n <CostUnitStatisInfo>\\n <SubUnitCount>0</SubUnitCount>\\n <TotalResourceCount>0</TotalResourceCount>\\n <TotalResourceGroupCount>0</TotalResourceGroupCount>\\n <UserCount>0</UserCount>\\n <ResourceCount>0</ResourceCount>\\n <TotalUserCount>0</TotalUserCount>\\n <ResourceGroupCount>0</ResourceGroupCount>\\n </CostUnitStatisInfo>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryCostUnitResourceResponse>","errorExample":""}]', + 'title' => 'QueryCostUnitResource', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T07:37:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-17T06:23:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'BillOwnerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'QueryCustomerAddressList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80'], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'example' => '2020-02', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185xxxxx489', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ + 'CustomerInvoiceAddressList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Item' => [ - 'description' => 'The details of the bills.'."\n", + 'CustomerInvoiceAddress' => [ + 'description' => 'The details of addresses to which invoices are mailed.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The payment status of the bill. Valid values:'."\n" - ."\n" - .'* PayFinish: The bill is paid.'."\n" - .'* PayUnclear: The bill is not cleared.'."\n" - .'* PayUnsettle: The bill is not settled.'."\n" - .'* NoSettle: The bill is free of settlement.'."\n", - 'type' => 'string', - 'example' => 'PayFinish', - ], - 'RoundDownDiscount' => [ - 'description' => 'The round down discount.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Item' => [ - 'description' => 'The type of the bill.'."\n" - ."\n" - .'* SubscriptionOrder'."\n" - .'* PayAsYouGoBill'."\n" - .'* Refund'."\n" - .'* Adjustment'."\n", - 'type' => 'string', - 'example' => 'SubscriptionOrder', - ], - 'Currency' => [ - 'description' => 'The type of the currency.'."\n" - ."\n" - .'* CNY'."\n" - .'* USD'."\n" - .'* JPY'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'UsageStartTime' => [ - 'description' => 'The time when the bill starts.'."\n", - 'type' => 'string', - 'example' => '2020-03-11 07:00:00', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription'."\n" - .'* PayAsYouGo'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'UsageEndTime' => [ - 'description' => 'The time when the bill ends.'."\n", - 'type' => 'string', - 'example' => '2020-03-11 08:00:00', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SubOrderId' => [ - 'description' => 'The ID of the order corresponding to the bill.'."\n", - 'type' => 'string', - 'example' => '325345254353', - ], - 'OutstandingAmount' => [ - 'description' => 'The unsettled amount of the bill.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AfterTaxAmount' => [ - 'description' => 'The amount paid after tax is deducted.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PaymentTime' => [ - 'description' => 'The time when the order was paid.'."\n", - 'type' => 'string', - 'example' => '2020-03-11 08:00:00', - ], - 'PretaxAmountLocal' => [ - 'description' => 'The pretax amount paid in local currency.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'Tax' => [ - 'description' => 'The tax.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PipCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'PaymentTransactionID' => [ - 'description' => 'The ID of the transaction.'."\n", - 'type' => 'string', - 'example' => '2O3AADJFEAF2PDKSFAMFCB11918', - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'RecordID' => [ - 'description' => 'The ID of the order or bill.'."\n", - 'type' => 'string', - 'example' => '2020xxxx5912', - ], - 'AdjustAmount' => [ - 'description' => 'The amount deducted by using credit refunds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS (subscription)'."\n", - ], - 'PaymentCurrency' => [ - 'description' => 'The currency used for payment.'."\n", - 'type' => 'string', - 'example' => 'USD', - ], - 'OwnerID' => [ - 'description' => 'The ID of the member. This parameter is returned in a multi-account payment scenario.'."\n", - 'type' => 'string', - 'example' => '3532535235', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PaymentAmount' => [ - 'description' => 'The amount paid with cash.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CashAmount' => [ - 'description' => 'The amount paid in cash. The amount that was deducted by using credit refunds is not included.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], + 'Addressee' => ['description' => 'The addressee.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'PostalCode' => ['description' => 'The postcode.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'City' => ['description' => 'The city to which the invoice is mailed.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'UserNick' => ['description' => 'The nickname of the user.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'Street' => ['description' => 'The name of the street to which the invoice is mailed.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'Phone' => ['description' => 'The phone number of the addressee.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'County' => ['description' => 'The name of the district to which the invoice is mailed.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'BizType' => ['description' => 'The business type.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'DeliveryAddress' => ['description' => 'The detailed address to which the invoice is mailed. This parameter is returned after fields are concatenated.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'Id' => ['description' => 'The ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Province' => ['description' => 'The province to which the invoice is mailed.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<QueryBillResponse>\\n <Message>Successful!</Message>\\n <RequestId>347A769E-CA83-4213-964D-41A974DE0F3D</RequestId>\\n <Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>47</TotalCount>\\n <AccountID>185xxxxx489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Item>\\n <Status>PayFinish</Status>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductName>云数据库RDS</ProductName>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <SubOrderId/>\\n <ProductType>rds</ProductType>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <OutstandingAmount>0</OutstandingAmount>\\n <PaymentTime/>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <UsageEndTime>2020-03-11 08:00:00</UsageEndTime>\\n <Item>PayAsYouGoBill</Item>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <OwnerID/>\\n <PretaxAmount>0</PretaxAmount>\\n <Currency>CNY</Currency>\\n <UsageStartTime>2020-03-11 07:00:00</UsageStartTime>\\n <RecordID>2020xxxx5912</RecordID>\\n </Item>\\n </Items>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryBillResponse>","errorExample":""}]', - 'title' => 'QueryBill', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryAccountBill' => [ - 'summary' => 'Queries the bills of your Alibaba Cloud account within a billing cycle. You can summarize the bills by resource owner.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryCustomerAddressList', + 'summary' => 'Queries the mailing addresses for Alibaba Cloud invoices.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'extraInfo' => ' ', + ], + 'QueryDPUtilizationDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10252,115 +8346,60 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + 'schema' => ['description' => 'The ID of the instance to query. If this parameter is not specified, the details of all used instances are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss-123123', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instancetyp', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The code of the resource, such as ecsRi and scu_bag. If this parameter is specified, the ProdCode parameter does not take effect for the request.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecsRi', 'title' => ''], ], [ - 'name' => 'OwnerID', + 'name' => 'DeductedInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the deducted instance. If this parameter is not specified, the details of all instances are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss-123123', 'title' => ''], ], [ - 'name' => 'IsGroupByProduct', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to summarize bills based on service codes. Valid values:'."\n" - ."\n" - .'* true: summarizes bills based on service codes.'."\n" - .'* false: does not summarize bills based on service codes.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00', 'title' => ''], ], [ - 'name' => 'BillOwnerId', + 'name' => 'LastToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '122', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results. For the first query, set the value to null. For subsequent queries, set the value to the token that is obtained from the NextToken parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CAESF***zNTAw', 'title' => ''], ], [ - 'name' => 'Granularity', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => 'The granularity at which bills are queried. Valid values:'."\n" - ."\n" - .'* MONTHLY: queries bills by month. The data queried is consistent with the data that is displayed for the specified billing cycle on the Billing Details tab of the Bill Details page in User Center.'."\n" - .'* DAILY: queries bills by day. The data queried is consistent with the data that is displayed for the specified day on the Billing Details tab of the Bill Details page in User Center.'."\n" - ."\n" - .'You must set the BillingDate parameter before you can set the Granularity parameter to DAILY.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Monthly', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'BillingDate', + 'name' => 'IncludeShare', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing date. This parameter is required only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-06-01', - ], + 'schema' => ['description' => 'Specifies whether to query the resource plan usage of linked accounts. Valid values:'."\n" + ."\n" + .'* true: queries the resource plan usage of linked accounts.'."\n" + .'* false: does not query the resource plan usage of linked accounts.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the service. Example: ecs.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'oss', 'title' => ''], ], ], 'responses' => [ @@ -10368,196 +8407,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'AccountID' => [ - 'description' => 'The ID of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1857xxxxx489', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AccountName' => [ - 'description' => 'The name of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ + 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. You can set the LastToken parameter to this value in the next request. If null is returned, all results are queried.'."\n", 'type' => 'string', 'example' => 'CAESF***zNTAw', 'title' => ''], + 'DetailList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Item' => [ - 'description' => 'The details of the bills.'."\n", + 'DetailList' => [ + 'description' => 'The detailed resource plan usage.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PipCode' => [ - 'description' => 'The code of the service. The service code is consistent with that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'BillingDate' => [ - 'description' => 'The billing date.'."\n", - 'type' => 'string', - 'example' => '2021-03-01', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n" - ."\n" - .'> A value is returned only if the **IsGroupByProduct** parameter is set to true.', - 'type' => 'string', - 'example' => 'rds', - ], - 'OwnerName' => [ - 'description' => 'The name of the member.'."\n", - 'type' => 'string', - 'example' => 'aligzncloudtest2', - ], - 'Currency' => [ - 'description' => 'The type of the currency. Valid values:'."\n" - ."\n" - .'* CNY'."\n" - .'* USD'."\n" - .'* JPY'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n" - ."\n" - .'> A value is returned only if the IsGroupByProduct parameter is set to true.', - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'BizType' => [ - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'OwnerID' => [ - 'description' => 'The ID of the member.'."\n", - 'type' => 'string', - 'example' => '325434254', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => '1857xxxxx489', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CostUnit' => [ - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n" - ."\n" - .'> A value is returned only if the **IsGroupByProduct** parameter is set to true.', - 'type' => 'string', - 'example' => 'rds', - ], + 'DeductedInstanceId' => ['description' => 'The ID of the deducted instance.'."\n", 'type' => 'string', 'example' => 'oss-123123', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the RI.'."\n", 'type' => 'string', 'example' => 'oss-123123', 'title' => ''], + 'DeductHours' => ['description' => 'The deduct factor. This parameter is returned only if the CommodityCode parameter is set to ecsRi.', 'type' => 'number', 'format' => 'float', 'example' => '24', 'title' => ''], + 'ShareUid' => ['description' => 'The UID of the deducted instance.'."\n" + ."\n" + .'* If the deduction is shared, the value of this parameter indicates the UID of the deducted instance.'."\n" + .'* If the deduction is not shared, the value of this parameter is the same as that of the uid parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', 'title' => ''], + 'DeductDate' => ['description' => 'The deduction date.'."\n", 'type' => 'string', 'example' => '2019/5/23 12:00', 'title' => ''], + 'InstanceSpec' => ['description' => 'The instance type of the deducted instance.'."\n", 'type' => 'string', 'example' => 'rds.mysql.s3.large', 'title' => ''], + 'DeductedCommodityCode' => ['description' => 'The code of the deducted service.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'DeductedProductDetail' => ['description' => 'The name of the deducted service.'."\n", 'type' => 'string', 'example' => 'ApsaraDB RDS'."\n", 'title' => ''], + 'DeductMeasure' => ['description' => 'The original measured amount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The region in which the instance resides. This parameter can be left empty.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou ', 'title' => ''], + 'DeductQuantity' => ['description' => 'The computing capacity or storage capacity that is deducted in a pay-as-you-go instance.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'DeductFactorTotal' => ['description' => 'The total computing capacity or storage capacity of the RI or SCU during the deduction.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'ResCode' => ['description' => 'The billable item.'."\n", 'type' => 'string', 'example' => 'PutRequest', 'title' => ''], + 'Uid' => ['description' => 'The UID of the deducted instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', 'title' => ''], ], 'description' => '', + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], 'description' => '', + 'title' => '', ], ], ], - '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":"<RequestId>3BFC23FE-A182-4D96-A1E4-7521B30B8E43</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>1857xxxxx489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n <Items>\\n <Item>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <OwnerName>aligzncloudtest2</OwnerName>\\n <ProductName>rds</ProductName>\\n <ProductCode>rds</ProductCode>\\n <BillAccountID>1857xxxxx489</BillAccountID>\\n <OutstandingAmount>0</OutstandingAmount>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <BizType>trusteeship</BizType>\\n <BillingDate>2021-03-01</BillingDate>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <PipCode>rds</PipCode>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <OwnerID>325434254</OwnerID>\\n <PretaxAmount>0</PretaxAmount>\\n <Currency>CNY</Currency>\\n <BillAccountName>test@test.aliyunid.com</BillAccountName>\\n <CostUnit>未分配</CostUnit>\\n <CashAmount>0</CashAmount>\\n <AdjustAmount>0</AdjustAmount>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'QueryAccountBill', - 'description' => 'Before you call this operation, take note of the following items:'."\n" + '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\\": \\"ApsaraDB RDS\\\\n\\",\\n \\"DeductMeasure\\": 1,\\n \\"Region\\": \\"cn-hangzhou \\",\\n \\"DeductQuantity\\": 1,\\n \\"DeductFactorTotal\\": 1,\\n \\"ResCode\\": \\"PutRequest\\",\\n \\"Uid\\": 1111111111\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful！</Message>\\n<RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n<Data>\\n <TotalCount/>\\n <PageSize/>\\n <PageNum/>\\n <DetailList>\\n <DetailList>\\n <ResCode/>\\n <Uid/>\\n <DeductDate/>\\n <InstanceSpec/>\\n <DeductMeasure/>\\n <InstanceId/>\\n <DeductFactorTotal/>\\n <DeductedProductDetail/>\\n <Region/>\\n <DeductedCommodityCode/>\\n <DeductedInstanceId/>\\n <DeductHours/>\\n <DeductQuantity/>\\n </DetailList>\\n </DetailList>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => 'QueryDPUtilizationDetail', + 'summary' => 'Queries the usage of resource plans, including reserved instances (RIs) and storage capacity units (SCUs).', + 'description' => 'Limits:'."\n" ."\n" - .'* Account bills are summarized based on instance bills. In most cases, the account bills do not include the data generated on the last day of the specified period.'."\n" - .'* You can query the data generated in June 2020 or later for Cloud Communications services. However, the query results do not include the data of Alibaba Cloud Domains.', + .'* Only the usage records within the past year can be queried.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QuerySettleBill' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryDPUtilizationDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:FrDeductLogQueryRequest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEvaluateList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10565,123 +8514,100 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-07', - ], + 'schema' => ['description' => 'The type. Valid values:'."\n" + ."\n" + .'- 1: queries objects with a negative invoiceable amount.'."\n" + ."\n" + .'- 2: queries objects with a positive invoiceable amount.'."\n" + ."\n" + .'- 3: queries all objects with a non-zero invoiceable amount.'."\n" + ."\n" + .'- 4: queries objects with an invoiced amount greater than 0.'."\n" + ."\n" + .'> If you leave this parameter empty, all objects are queried.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'Type', + 'name' => 'OutBizId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SubscriptionOrder', - ], + 'schema' => ['description' => 'The order ID, bill ID, or contract ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2387432832696'], ], [ - 'name' => 'ProductCode', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'ProductType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'StartAmount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + 'schema' => ['description' => 'The minimum amount for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '100'], ], [ - 'name' => 'IsHideZeroCharge', + 'name' => 'EndAmount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The maximum amount for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1000'], ], [ - 'name' => 'IsDisplayLocalCurrency', + 'name' => 'StartBizTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The beginning of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-02-01 00:00:00'], ], [ - 'name' => 'NextToken', + 'name' => 'EndBizTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - ], + 'schema' => ['description' => 'The end of the time range to query based on the successful payment time. The format is yyyy-mm-dd hh:mm:ss.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-03-01 00:00:00'], ], [ - 'name' => 'MaxResults', + 'name' => 'SortType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The sorting type. Valid values:'."\n" + ."\n" + .'- 1: sorts the results by ID in descending order.'."\n" + ."\n" + .'- 2: sorts the results by type in descending order, and then by ID in descending order.'."\n" + ."\n" + .'- 3: sorts the results by type in ascending order, and then by ID in descending order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'BillOwnerId', + 'name' => 'StartSearchTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', - ], + 'schema' => ['description' => 'The start of the time range to query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-02-01 00:00:00'], ], [ - 'name' => 'RecordID', + 'name' => 'EndSearchTime', 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-03-01 00:00:00'], + ], + [ + 'name' => 'BillCycle', + 'in' => 'query', + 'schema' => ['description' => 'The billing cycle.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '202502'], + ], + [ + 'name' => 'BizTypeList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of invoicing entities to which the invoiceable objects belong.', + 'type' => 'array', + 'items' => ['description' => 'The invoicing entity to which the invoiceable object belongs. Examples:'."\n" + ."\n" + .'- ALIYUN\\_SERVICE: Alibaba Cloud Computing Co., Ltd. (Service)'."\n" + ."\n" + .'- ALICOM\\_SERVICE: Alibaba Cloud Computing (Beijing) Co., Ltd. (Service)', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ALIYUN_SERVICE'], 'required' => false, - 'example' => '12233', + 'example' => 'ALIYUN', + 'maxItems' => 100, + 'title' => '', ], ], ], @@ -10690,276 +8616,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D35FF10E-1B2E-4ABA-8401-0AE17725F50B'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - ], - 'BillingCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-02', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '185xxxxx489', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'AccountName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'TotalUnAppliedInvoiceAmount' => ['description' => 'The total invoiceable amount that meets the filter criteria. Unit: cents.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12344'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'TotalInvoiceAmount' => ['description' => 'The total invoiced amount that meets the filter criteria. Unit: cents.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000'], + 'HostId' => ['description' => 'The ID of the host.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'EvaluateList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Item' => [ - 'description' => '', + 'Evaluate' => [ + 'description' => 'The list of returned data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PayFinish', - ], - 'RoundDownDiscount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Item' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SubscriptionOrder', - ], - 'Currency' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CNY', - ], - 'BillAccountName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'SubscriptionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'UsageStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-03-11 07:00:00', - ], - 'BizType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'UsageEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-03-11 08:00:00', - ], - 'DeductedByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SubOrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '325345254353', - ], - 'AfterTaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'OutstandingAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PaymentTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-03-11 08:00:00', - ], - 'Tax' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PretaxAmountLocal' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'PipCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], - 'PaymentTransactionID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2O3AADJFEAF2PDKSFAMFCB11918', - ], - 'PretaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CommodityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RecordID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020xxxx5912', - ], - 'AdjustAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'PaymentCurrency' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'USD', - ], - 'OwnerID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3532535235', - ], - 'BillAccountID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '185xxxxx489', - ], - 'PaymentAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'InvoiceDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], - 'PretaxGrossAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CashAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], + 'Type' => ['description' => 'The type. Valid values:'."\n" + ."\n" + .'- 1: queries objects with a negative invoiceable amount.'."\n" + ."\n" + .'- 2: queries objects with a positive invoiceable amount.'."\n" + ."\n" + .'- 3: queries all objects with a non-zero invoiceable amount.'."\n" + ."\n" + .'- 4: queries objects with an invoiced amount greater than 0.'."\n" + ."\n" + .'> If you leave this parameter empty, all objects are queried.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Status' => ['description' => 'The status of the invoiceable object.'."\n" + ."\n" + .'- 0: Invoiced'."\n" + ."\n" + .'- 1: Not invoiced (invoiceable)'."\n" + ."\n" + .'- 2: Partially invoiced'."\n" + ."\n" + .'- 3: The invoicing request is being processed and the object is locked.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'BillId' => ['description' => 'The ID of the bill.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2738543'], + 'BillCycle' => ['description' => 'The billing cycle.', 'type' => 'string', 'title' => '', 'example' => '202502'], + 'CanInvoiceAmount' => ['description' => 'The remaining invoiceable amount.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5000'], + 'OffsetAcceptAmount' => ['description' => 'The accepted offset amount. Refunds from other orders, such as unsubscribes or downgrades, can offset the amount for this invoicing record. This parameter corresponds to the **OffsetCostAmount** parameter in the refund data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-5000'], + 'ItemId' => ['description' => 'The ID of the item.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'OutBizId' => ['description' => 'The order ID, bill ID, or contract ID.', 'type' => 'string', 'title' => '', 'example' => '124324213421'], + 'UserNick' => ['description' => 'The user nickname.', 'type' => 'string', 'title' => '', 'example' => 'HelloWorld'], + 'GmtModified' => ['description' => 'The time when the record was last modified.', 'type' => 'string', 'title' => '', 'example' => '2025-01-01 00:00:00'], + 'OpId' => ['description' => 'The ID of the external object.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'BizType' => ['description' => 'The invoicing entity to which the invoiceable object belongs. Examples:'."\n" + ."\n" + .'- ALIYUN\\_SERVICE: Alibaba Cloud Computing Co., Ltd. (Service)'."\n" + ."\n" + .'- ALICOM\\_SERVICE: Alibaba Cloud Computing (Beijing) Co., Ltd. (Service)', 'type' => 'string', 'title' => '', 'example' => 'ALIYUN'], + 'OriginalAmount' => ['description' => 'The total invoiceable amount.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000'], + 'InvoicedAmount' => ['description' => 'The amount that has been invoiced.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000'], + 'GmtCreate' => ['description' => 'The time when the record was created.', 'type' => 'string', 'title' => '', 'example' => '2025-02-01 00:00:00'], + 'PresentAmount' => ['description' => 'The total invoiceable amount.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000'], + 'BizTime' => ['description' => 'The consumption time.', 'type' => 'string', 'title' => '', 'example' => '2025-02-01 00:00:00'], + 'Name' => ['description' => 'The name of the invoiceable object.', 'type' => 'string', 'title' => '', 'example' => '云服务器ECS(包月)'], + 'OffsetCostAmount' => ['description' => 'The offset amount. Refunds from other orders, such as unsubscribes or downgrades, can offset the amount for this invoicing record. This parameter corresponds to the **OffsetAcceptAmount** parameter in the refund data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5000'], + 'Id' => ['description' => 'The ID of the invoiceable object.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1325321532'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":"<RequestId>AE3F4057-DFC9-4B81-8858-F620651010C9</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>200</TotalCount>\\n <BillingCycle>2020-02</BillingCycle>\\n <AccountID>185xxxxx489</AccountID>\\n <NextToken>CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U</NextToken>\\n <MaxResults>20</MaxResults>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n <Items>\\n <Item>\\n <AfterTaxAmount>0</AfterTaxAmount>\\n <ProductName>云数据库RDS</ProductName>\\n <BillAccountID>185xxxxx489</BillAccountID>\\n <SubOrderId>325345254353</SubOrderId>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <PaymentCurrency>USD</PaymentCurrency>\\n <Tax>0</Tax>\\n <PaymentTime>2020-03-11 08:00:00</PaymentTime>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <UsageEndTime>2020-03-11 08:00:00</UsageEndTime>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>SubscriptionOrder</Item>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <UsageStartTime>2020-03-11 07:00:00</UsageStartTime>\\n <AdjustAmount>0</AdjustAmount>\\n <PaymentTransactionID>2O3AADJFEAF2PDKSFAMFCB11918</PaymentTransactionID>\\n <Status>PayFinish</Status>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <RoundDownDiscount>0</RoundDownDiscount>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <PipCode>rds</PipCode>\\n <OwnerID>3532535235</OwnerID>\\n <PretaxAmount>100</PretaxAmount>\\n <BillAccountName>test@test.aliyunid.com</BillAccountName>\\n <RecordID>2020xxxx5912</RecordID>\\n <CashAmount>0</CashAmount>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n </Item>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'summary' => 'Queries the bills in a billing cycle. You can call this operation to query a bill that contains more than 50,000 entries in an account that is created on the Alibaba Cloud China site.', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryEvaluateList', + 'summary' => 'Queries a list of objects that are eligible for invoicing.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryInstanceBill' => [ - 'summary' => 'Queries the bills of instances or billable items in a billing cycle.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryEvaluate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEvaluateList'], + ], ], + ], + 'QueryFinancialAccountInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10967,145 +8744,166 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', + 'name' => 'UserId', 'in' => 'query', + 'schema' => ['description' => 'The user ID (UID) of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1990699401005016'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '97426BC2-792E-41F5-92B8-73C710DA7779'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'MemberNickName' => ['description' => 'The display name of the member account.', 'type' => 'string', 'title' => '', 'example' => '测试'], + 'IsFinancialAccount' => ['description' => 'Indicates whether the account is an enterprise financial account. Valid values: true and false.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'MemberGroupName' => ['description' => 'The name of the group to which the member account belongs.', 'type' => 'string', 'title' => '', 'example' => '测试组'], + 'UserName' => ['description' => 'The logon name of the account.', 'type' => 'string', 'title' => '', 'example' => 'killortop3'], + 'AccountType' => ['description' => 'The type of the enterprise financial account. Valid values: MASTER: management account. MEMBER: member account.', 'type' => 'string', 'title' => '', 'example' => 'MEMBER'], + 'MemberGroupId' => ['description' => 'The ID of the group to which the member account belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '124'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'System exception, please try again'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryFinancialAccountInfo', + 'summary' => 'Queries the financial information of an enterprise account that is part of a management-member relationship.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryFinancialAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'QueryInstanceBill' => [ + 'summary' => 'Queries the usage summary of all product instances or billable items for an account in a billing cycle. This operation has been upgraded to DescribeInstanceBill. This operation no longer queries data beyond the 50,000th row.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => ['description' => 'The billing cycle in YYYY-MM format. Data from the last 18 months is supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2020-03'], + ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service. This parameter is required if the ProductCode parameter is set to the service code of Alibaba Cloud Marketplace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The type of the product. Required when the ProductCode parameter is set to the code of an Alibaba Cloud Marketplace product.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****This parameter must be used together with the **ProductCode** parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.'."\n" + ."\n" + .'> This parameter must be used with the **ProductCode** parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PayAsYouGo'], ], [ 'name' => 'IsBillingItem', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query data by billable item. Valid values:'."\n" - ."\n" - .'* false: does not query data by billable item. The data queried is consistent with the data that is displayed for the specified instance on the Billing Details tab of the Bill Details page in User Center.'."\n" - .'* true: queries data by billable item. The data queried is consistent with the data that is displayed for the specified billable item on the Billing Details tab of the Bill Details page in User Center.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to query data by billable item.'."\n" + ."\n" + .'- false: The data is consistent with the bill details on the Instance tab of the Bills page in the User Center.'."\n" + ."\n" + .'- true: The data is consistent with the bill details on the Billable Item tab of the Bills page in the User Center.'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ 'name' => 'IsHideZeroCharge', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to filter out a bill whose pretax gross amount and pretax amount are 0. Default value: false.******** Valid values:'."\n" - ."\n" - .'* false: does not filter the bill.'."\n" - .'* true: filters the bill.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to filter out bills for which the pretax gross amount (**PretaxGrossAmount**) and pretax amount (**PretaxAmount**) are both 0. Valid values:'."\n" + ."\n" + .'- false.'."\n" + ."\n" + .'- true.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'BillingDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing date. This parameter is required only if the **Granularity** parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-03', - ], + 'schema' => ['description' => 'The billing date. This parameter is required only when the **Granularity** parameter is set to DAILY. The value must be in the YYYY-MM-DD format.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2020-03-03'], ], [ 'name' => 'Granularity', 'in' => 'query', - 'schema' => [ - 'description' => 'The granularity at which bills are queried. Valid values:'."\n" - ."\n" - .'* MONTHLY: queries bills by month. The data queried is consistent with the data that is displayed for the specified billing cycle on the Billing Details tab of the Bill Details page in User Center.'."\n" - .'* DAILY: queries bills by day. The data queried is consistent with the data that is displayed for the specified day on the Billing Details tab of the Bill Details page in User Center.'."\n" - ."\n" - .'You must set the **BillingDate** parameter before you can set the Granularity parameter to DAILY.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MONTHLY', - ], + 'schema' => ['description' => 'The granularity at which to query bills. Valid values:'."\n" + ."\n" + .'- MONTHLY: queries bills by month. The data is consistent with the bill details on the Billing Cycle tab of the Bills page in the User Center.'."\n" + ."\n" + .'- DAILY: queries bills by day. The data is consistent with the bill details on the By Day tab of the Bills page in the User Center.'."\n" + ."\n" + .'If you set this parameter to DAILY, you must also specify the **BillingDate** parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MONTHLY'], ], [ 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '122', - ], + 'schema' => ['description' => 'The ID of the account that owns the resources. This account is the actual user of the resources.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '122'], ], ], 'responses' => [ @@ -11113,854 +8911,326 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle in the YYYY-MM format.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185xxxx3489', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'BillingCycle' => ['description' => 'The billing cycle in YYYY-MM format.', 'type' => 'string', 'title' => '', 'example' => '2020-03'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185xxxx3489'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'AccountName' => ['description' => 'The user account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ - 'description' => 'The details of the bill.'."\n", + 'description' => 'The bill details.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'BillingDate' => [ - 'description' => 'The billing date. This parameter is returned only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'InstanceConfig' => [ - 'description' => 'The configurations of the instance.'."\n", - 'type' => 'string', - 'example' => 'CPU:12', - ], - 'InternetIP' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '34.xx.x.x', - ], - 'Item' => [ - 'description' => 'The type of the bill.'."\n" - ."\n" - .'* SubscriptionOrder: subscription order'."\n" - .'* PayAsYouGoBill: pay-as-you-go bill'."\n" - .'* Refund: refund'."\n" - .'* Adjustment: reconciliation'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGoBill', - ], - 'Tag' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'tag', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], - 'Currency' => [ - 'description' => 'The type of the currency. Valid values:'."\n" - ."\n" - .'* CNY'."\n" - .'* USD'."\n" - .'* JPY'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****This parameter is returned together with the ProductCode parameter.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'InstanceSpec' => [ - 'description' => 'The instance type of the instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.sn1ne.3xlarge', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'BillingItem' => [ - 'description' => 'The billable item. This parameter is returned only if the IsBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)'."\n", - ], - 'CostUnit' => [ - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'ListPriceUnit' => [ - 'description' => 'The unit of the unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'CNY'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The resource group.'."\n", - 'type' => 'string', - 'example' => 'Default resource group'."\n", - ], - 'PipCode' => [ - 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ServicePeriodUnit' => [ - 'description' => 'The unit of the validity period.'."\n", - 'type' => 'string', - 'example' => 'Seconds'."\n", - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'NickName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'Usage' => [ - 'description' => 'The usage of the billable item. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'IntranetIP' => [ - 'description' => 'The private IP address.'."\n", - 'type' => 'string', - 'example' => '192.xx.xx.xx', - ], - 'OwnerID' => [ - 'description' => 'The ID of the member account. This parameter is returned in a multi-account payment scenario.'."\n", - 'type' => 'string', - 'example' => '169***013', - ], - 'UsageUnit' => [ - 'description' => 'The unit of usage. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'DeductedByResourcePackage' => [ - 'description' => 'The amount deducted by using resource plans.'."\n", - 'type' => 'string', - 'example' => 'NULL', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ServicePeriod' => [ - 'description' => 'The validity period.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Zone' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'ListPrice' => [ - 'description' => 'The unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'BillingType' => [ - 'description' => 'The billing type.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], + 'BillingDate' => ['description' => 'The billing date. This parameter is returned only when the Granularity parameter is set to DAILY. The value is in the YYYY-MM-DD format.', 'type' => 'string', 'title' => '', 'example' => '2020-03'], + 'InstanceConfig' => ['description' => 'The detailed configuration of the instance.', 'type' => 'string', 'title' => '', 'example' => 'CPU:12'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x'], + 'Item' => ['description' => 'The type of the bill. Valid values:'."\n" + ."\n" + .'- SubscriptionOrder'."\n" + ."\n" + .'- PayAsYouGoBill'."\n" + ."\n" + .'- Refund'."\n" + ."\n" + .'- Adjustment', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGoBill'], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'title' => '', 'example' => 'tag'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- CNY.'."\n" + ."\n" + .'- USD.'."\n" + ."\n" + .'- JPY.', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.'."\n" + ."\n" + .'> This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'title' => '', 'example' => 'ecs.sn1ne.3xlarge'], + 'DeductedByCoupons' => ['description' => 'The amount deducted using coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'BillingItem' => ['description' => 'The billable item. This parameter is returned only when IsBillingItem is set to true.', 'type' => 'string', 'title' => '', 'example' => '其他'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => '杭州'], + 'CostUnit' => ['description' => 'The cost center.', 'type' => 'string', 'title' => '', 'example' => '未分配'], + 'ListPriceUnit' => ['description' => 'The unit of the list price. This parameter is valid only when isBillingItem is set to true.', 'type' => 'string', 'title' => '', 'example' => '元'], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组'], + 'PipCode' => ['description' => 'The product code. This is the same as the product code in the bills in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ServicePeriodUnit' => ['description' => 'The unit of the service duration.', 'type' => 'string', 'title' => '', 'example' => '秒'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'CommodityCode' => ['description' => 'The commodity code. This is the same as the product detail code in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'NickName' => ['description' => 'The instance nickname.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'Usage' => ['description' => 'The usage. This parameter is valid only when isBillingItem is set to true.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'IntranetIP' => ['description' => 'The internal IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'], + 'OwnerID' => ['description' => 'The account ID of the RAM user. This parameter is returned in a multi-account payment scenario.', 'type' => 'string', 'title' => '', 'example' => '169***013'], + 'UsageUnit' => ['description' => 'The unit of the usage. This parameter is valid only when isBillingItem is set to true.', 'type' => 'string', 'title' => '', 'example' => 'GB'], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'DeductedByResourcePackage' => ['description' => 'The amount deducted using resource packages.', 'type' => 'string', 'title' => '', 'example' => 'NULL'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ServicePeriod' => ['description' => 'The service duration.', 'type' => 'string', 'title' => '', 'example' => '10'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'], + 'ListPrice' => ['description' => 'The list price. This parameter is valid only when isBillingItem is set to true.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'BillingType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => '其它'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"BillingCycle\\": \\"2020-03\\",\\n \\"AccountID\\": \\"185xxxx3489\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"AccountName\\": \\"test@test.aliyunid.com\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"BillingDate\\": \\"2020-03\\",\\n \\"InstanceConfig\\": \\"CPU:12\\",\\n \\"InternetIP\\": \\"34.xx.x.x\\",\\n \\"Item\\": \\"PayAsYouGoBill\\",\\n \\"Tag\\": \\"tag\\",\\n \\"InstanceID\\": \\"i-kjhdskjgshfdlkjfdh\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"DeductedByCashCoupons\\": 0,\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"BillingItem\\": \\"其他\\",\\n \\"Region\\": \\"杭州\\",\\n \\"OutstandingAmount\\": 0,\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"PretaxAmount\\": 0,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"AdjustAmount\\": 0,\\n \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"OwnerID\\": \\"169***013\\",\\n \\"DeductedByPrepaidCard\\": 0,\\n \\"UsageUnit\\": \\"GB\\",\\n \\"PaymentAmount\\": 0,\\n \\"InvoiceDiscount\\": 0,\\n \\"DeductedByResourcePackage\\": \\"NULL\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"ServicePeriod\\": \\"10\\",\\n \\"Zone\\": \\"cn-hangzhou-h\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"CashAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\",\\n \\"BillingType\\": \\"其它\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryInstanceBillResponse>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>2</TotalCount>\\n <AccountID>18xxxxx3489</AccountID>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <Items>\\n <Item>\\n <InstanceSpec>rds.mysql.s3.large</InstanceSpec>\\n <ProductName>云数据库RDS</ProductName>\\n <InstanceID>rm-bp1xxxxxxxe</InstanceID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <ListPriceUnit/>\\n <BillingDate/>\\n <ListPrice/>\\n <PaymentAmount>0.01</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>11447.99</InvoiceDiscount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <Item>SubscriptionOrder</Item>\\n <PretaxGrossAmount>11448</PretaxGrossAmount>\\n <InstanceConfig>数据库类型:MySQL;实例规格:rds.mysql.s3.large;存储:5;内存:8192</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CostUnit>未分配</CostUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage/>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <ProductDetail>关系型数据库RDS(包月)</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>cn-hangzhou-b</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BillingItem/>\\n <NickName/>\\n <IntranetIP/>\\n <ServicePeriod>31583763</ServicePeriod>\\n <ServicePeriodUnit>秒</ServicePeriodUnit> \\n <DeductedByResourcePackage/>\\n <UsageUnit/>\\n <OwnerID>18576xxxxx489</OwnerID>\\n <PretaxAmount>0.01</PretaxAmount>\\n <InternetIP/>\\n <Region>华东1（杭州）</Region>\\n <Tag/>\\n </Item>\\n </Items>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryInstanceBillResponse>","errorExample":""}]', - 'description' => '##'."\n" + 'responseDemo' => '[{"errorExample":"","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 \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"InstanceSpec\\": \\"ecs.sn1ne.3xlarge\\",\\n \\"DeductedByCoupons\\": 0,\\n \\"BillingItem\\": \\"其他\\",\\n \\"Region\\": \\"杭州\\",\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"PretaxAmount\\": 0,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"NickName\\": \\"test\\",\\n \\"ProductDetail\\": \\"云数据库RDS\\",\\n \\"Usage\\": \\"100\\",\\n \\"IntranetIP\\": \\"192.xx.xx.xx\\",\\n \\"OwnerID\\": \\"169***013\\",\\n \\"UsageUnit\\": \\"GB\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"DeductedByResourcePackage\\": \\"NULL\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"ServicePeriod\\": \\"10\\",\\n \\"Zone\\": \\"cn-hangzhou-h\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"PretaxGrossAmount\\": 0,\\n \\"ProductCode\\": \\"rds\\",\\n \\"BillingType\\": \\"其它\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'QueryInstanceBill', + 'description' => '## API description'."\n" + ."\n" + .'Note the following when you call this operation:'."\n" + ."\n" + .'- The API for instance bills has been upgraded. We recommend that you use the new operation [DescribeInstanceBill](~~209402~~). This operation no longer supports querying data beyond the 50,000th row.'."\n" + ."\n" + .'- Instance bills are generated based on split billing data. A delay of about one day may occur.'."\n" + ."\n" + .'- Instance information may change within a billing cycle. The instance Config and Spec in the monthly summary reflect the information at the time the record was generated. For more information, see the corresponding detailed bill.'."\n" + ."\n" + .'- Data for Alibaba Cloud Communications products is available from June 2020. Data for HiChina products is available from November 2020.'."\n" ."\n" - .'* This API operation has been upgraded to DescribeInstanceBill. We recommend that you call the [DescribeInstanceBill](~~209402~~) operation to query the bills of instances or billable items in a billing cycle. You can call the QueryInstanceBill operation to query a maximum of 50,000 data rows in a bill.'."\n" - .'* Instance bills are generated after bills are split. In most cases, the instance bills do not include data generated on the last day of the specified period.'."\n" - .'* The instance information changes within a billing cycle. The instance configurations and specifications and the time when the instance was used in the billing cycle are all recorded. For more information, see the corresponding bill details.'."\n" - .'* You can query the data generated in June 2020 or later for Cloud Communications services, and the data generated in November 2020 or later for Alibaba Cloud Domains.'."\n", + .'<props="intl">'."\n" + ."\n" + .'- For the international site (alibabacloud.com), select Singapore as the endpoint.'."\n" + ."\n" + .'</props>', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeInstanceBill' => [ - 'summary' => 'Queries the billing information about instances or billable items in a billing cycle.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryInstanceByTag' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle. Specify the parameter in the YYYY-MM format.'."\n" - .'Only the latest 18 month billing cycle is supported.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], - ], - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method.'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], - ], - [ - 'name' => 'IsBillingItem', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query data by billable items. Valid values:'."\n" - ."\n" - .'* false: The data that you query is the same as the data searched by instances on the Billing Details tab of the Bill Details page in the User Center console.'."\n" - .'* true: The data that you query is the same as the data searched by billable items on the Billing Details tab of the Bill Details page in the User Center console.'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to indicate the position where the results for the current call start. The parameter must be left empty or set to the value of the NextToken parameter that is returned from the last call. Otherwise, an error is returned. If the parameter is left empty, data is queried from the first item.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCm', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'IsHideZeroCharge', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to filter bills if both the pretax gross amount and pretax amount are 0. Valid values:'."\n" - ."\n" - .'* false: does not filter bills.'."\n" - .'* true: filters bills.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'BillingDate', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing date. This parameter is required only when the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-02', - ], - ], - [ - 'name' => 'Granularity', - 'in' => 'query', - 'schema' => [ - 'description' => 'The granularity at which bills are queried. Valid values:'."\n" - ."\n" - .'* MONTHLY: queries bills on a monthly basis. The data that you query is the same as the data searched by instances on the Billing Details tab of the Bill Details page in the User Center console.'."\n" - .'* DAILY: queries bills on a daily basis. The data that you query is the same as the data searched by days on the Billing Details tab of the Bill Details page in the User Center console.'."\n" - ."\n" - .'The BillingDate parameter is required if you set the Granularity parameter to DAILY.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MONTHLY', - ], - ], - [ - 'name' => 'BillOwnerId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member. If you specify this parameter, the bills of the member are queried. If you do not specify this parameter, the bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '122', - ], + 'schema' => ['description' => 'The type of the resource. Set this parameter to `instance` to query savings plan instances.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'instance'], ], [ - 'name' => 'InstanceID', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', + 'description' => 'A list of resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spn-XXXXXX'], 'required' => false, - 'example' => 'abc', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PipCode', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The code of the service. The code is the same as that in Cost Center.', - 'type' => 'string', + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A key-value pair of a tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ecs'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '001'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'rds', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The position where the query stopped. If this parameter is left empty, all the results are returned. If you perform another call, you must set the NextToken parameter to the value of this parameter.'."\n", - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCm', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle in the YYYY-MM format.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '122', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ - 'description' => 'The details of the bill.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BillingDate' => [ - 'description' => 'The billing date. This parameter is returned only if the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'example' => '2020-03-20', - ], - 'InstanceConfig' => [ - 'description' => 'The configurations of the instance.'."\n", - 'type' => 'string', - 'example' => 'CPU:12', - ], - 'InternetIP' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '34.xx.x.x ', - ], - 'Item' => [ - 'description' => 'The type of the bill.'."\n" - ."\n" - .'* SubscriptionOrder: the subscription bill.'."\n" - .'* PayAsYouGoBill: the pay-as-you-go bill,'."\n" - .'* Refund: the refund.'."\n" - .'* Adjustment: the adjustment bill.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGoBill', - ], - 'Tag' => [ - 'description' => 'The tag of the resource.'."\n", - 'type' => 'string', - 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-dadada', - ], - 'Currency' => [ - 'description' => 'The type of currency. Valid values:'."\n" - ."\n" - .'* CNY'."\n" - .'* USD'."\n" - .'* JPY'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method.'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'BizType' => [ - 'description' => 'The type of business.'."\n", - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'InstanceSpec' => [ - 'description' => 'The type of the instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.sn1ne.3xlarge ', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted with coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'BillingItem' => [ - 'description' => 'The billable item. A value is returned only if the IsBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'Bandwidth'."\n", - ], - 'BillingItemCode' => [ - 'description' => 'The code of the billable item.'."\n", - 'type' => 'string', - 'example' => 'disk', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)'."\n", - ], - 'CostUnit' => [ - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'ListPriceUnit' => [ - 'description' => 'The unit of the unit price. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'CNY'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Default resource group'."\n", - ], - 'PipCode' => [ - 'description' => 'The code of the service. The code is the same as that in Cost Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ServicePeriodUnit' => [ - 'description' => 'The unit of the service duration.'."\n", - 'type' => 'string', - 'example' => 'Second'."\n", - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity. The code is the same as that in Cost Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'NickName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'Usage' => [ - 'description' => 'The usage of the service. This parameter is valid only when the isBillingItem parameter is set to true. The usage is the total usage in all bills in the billing cycle, not the amount that you purchase. For example, if 1 GB of storage is used and bills are generated every hour, the usage is 1 GB per hour. In this case, the usage is 24 GB per day.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'IntranetIP' => [ - 'description' => 'The private IP address.'."\n", - 'type' => 'string', - 'example' => '192.xx.xx.xx', - ], - 'OwnerID' => [ - 'description' => 'The ID of the account that owns the resource. This parameter is returned in multi-account payment scenario.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'UsageUnit' => [ - 'description' => 'The unit of usage. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => '122', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'DeductedByResourcePackage' => [ - 'description' => 'The amount deducted with resource plans. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '0.1', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ServicePeriod' => [ - 'description' => 'The service duration.'."\n", - 'type' => 'string', - 'example' => '3600', - ], - 'Zone' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'Hangzhou Zone B'."\n", - ], - 'ListPrice' => [ - 'description' => 'The unit price of the service. This parameter is valid only when the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'BillingType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], - 'ItemName' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'example' => 'iZ28bycvyb4Z', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'float', + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'PARAM_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'param is null'], + 'NextToken' => ['description' => 'The token used to query the next page of results. This is the `NextToken` value returned from the previous API call.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCm'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '9EC6C0B7-3397-5FAE-9915-8972CDDB1211'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'TagResource' => [ + 'description' => 'A list of instance information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'title' => '', 'example' => 'spn-xxxxx'], + 'ResourceType' => ['description' => 'The type of the resource. `instance` indicates a savings plan instance.', 'type' => 'string', 'title' => '', 'example' => 'instance'], + 'Tag' => [ + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A key-value pair of a tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'tag1'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '10'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"<RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <TotalCount>20</TotalCount>\\n <BillingCycle>2020-03</BillingCycle>\\n <AccountID>122</AccountID>\\n <NextToken>CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U</NextToken>\\n <MaxResults>20</MaxResults>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n <Items>\\n <InstanceSpec>ecs.sn1ne.3xlarge\\t</InstanceSpec>\\n <ProductName>云数据库RDS\\t</ProductName>\\n <InstanceID>i-dadada</InstanceID>\\n <BillAccountID>122</BillAccountID>\\n <DeductedByCashCoupons>0.1</DeductedByCashCoupons>\\n <ListPriceUnit>元</ListPriceUnit>\\n <BillingDate>2020-03-20</BillingDate>\\n <ListPrice>100</ListPrice>\\n <PaymentAmount>0.1</PaymentAmount>\\n <DeductedByPrepaidCard>0.1</DeductedByPrepaidCard>\\n <InvoiceDiscount>0.1</InvoiceDiscount>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>0.1</PretaxGrossAmount>\\n <InstanceConfig>CPU：12</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CommodityCode>rds</CommodityCode>\\n <CostUnit>未分配\\t</CostUnit>\\n <AdjustAmount>0</AdjustAmount>\\n <ResourceGroup>默认资源组\\t</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage>100</Usage>\\n <DeductedByCoupons>0.1</DeductedByCoupons>\\n <ProductDetail>云数据库RDS\\t</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>杭州1</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0.1</OutstandingAmount>\\n <BizType>trusteeship</BizType>\\n <BillingItem>带宽</BillingItem>\\n <NickName>test</NickName>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <PipCode>rds</PipCode>\\n <ServicePeriodUnit>秒</ServicePeriodUnit>\\n <ServicePeriod>3600</ServicePeriod>\\n <DeductedByResourcePackage>0.1</DeductedByResourcePackage>\\n <UsageUnit>GB</UsageUnit>\\n <OwnerID>123</OwnerID>\\n <PretaxAmount>0.1</PretaxAmount>\\n <InternetIP>34.xx.x.x\\t</InternetIP>\\n <Region>杭州</Region>\\n <BillAccountName>test@test.aliyunid.com</BillAccountName>\\n <Tag>key:testKey value:testValue; key:testKey1 value:testValues1</Tag>\\n <CashAmount>0</CashAmount>\\n </Items>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'DescribeInstanceBill', - 'description' => '* Instance bills are generated after the total bill is split. In most cases, the instance bills do not include data generated on the last day of the specified billing cycle.'."\n" - .'* The instance information may change during the billing cycle. The instance configurations and types in monthly bills are subject to the point in time when you query bills. For more information, see the corresponding bill details.'."\n" - .'* You can query data generated after June 2020 for Cloud Communications services. You can query data generated after November 2020 for Alibaba Cloud Domains.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryInstanceGaapCost' => [ - 'summary' => 'Queries the monthly allocated costs of instances. The AccessKey pair of the management account is required for queries. You can query the full generally accepted accounting principles (GAAP) bills of the previous month after 12:00 on the fourth day of each month. If you query the GAAP bills before 12:00 on the fourth day of each month, the bills returned may be incomplete.', - 'methods' => [ - 'post', - 'get', + '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' => 'QueryInstanceByTag', + 'summary' => 'Queries a list of instances by tags.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryInstanceByTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryInstanceGaapCost' => [ + 'summary' => 'This API is deprecated. Use the following APIs to retrieve the amortized cost: `DescribeInstanceAmortizedCostByAmortizationPeriod` - retrieves instance costs by amortization period; `DescribeProductAmortizedCostByAmortizationPeriod` - retrieves product costs by amortization period; `DescribeInstanceAmortizedCostByConsumePeriod` - retrieves instance costs by consume period; `DescribeProductAmortizedCostByConsumePeriod` - retrieves product costs by consume period.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'BillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], + 'schema' => ['description' => 'The billing cycle, in the YYYY-MM format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-03', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `Subscription`: subscription'."\n" + ."\n" + .'- `PayAsYouGo`: pay-as-you-go', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo', 'title' => ''], ], ], 'responses' => [ @@ -11968,1019 +9238,312 @@ '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' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CCBB1BB9-22F1-4177-867B-7A75D665B488', 'title' => ''], + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'HostId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'HostId' => ['description' => 'The ID of the host.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], 'Modules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Module' => [ - 'description' => '', + 'description' => 'The list of cost information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GaapDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'SubscriptionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'MonthGaapPretaxAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DeductedByCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'SubOrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12434345', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'OrderType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'New', - ], - 'MonthGaapDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UnallocatedDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'PretaxAmountLocal' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'BillingCycle' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-03', - ], - 'PayerAccount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23534534', - ], - 'MonthGaapPretaxAmountLocal' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.99', - ], - 'AccountingUnit' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GaapPretaxAmountLocal' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UnallocatedDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ProductType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], - 'PaymentAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'MonthGaapPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.99', - ], - 'BillType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SubscriptionOrder', - ], - 'PayTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-06-15 15:59:57', - ], - 'PretaxGrossAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '213123213123', - ], - 'UnallocatedPricingDiscount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'MonthGaapDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.75', - ], - 'UnallocatedPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'InstanceID' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSSBAG-cn-0xl0xxxxxx', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tag', - ], - 'Currency' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CNY', - ], - 'GaapDeductedByCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'GaapDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'GaapPaymentAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UnallocatedPretaxAmountLocal' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'MonthGaapPricingDiscount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0,.25', - ], - 'PricingDiscount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GaapPricingDiscount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'ResourceGroup' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'UnallocatedDeductedByCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'PretaxAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UnallocatedPretaxAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'GaapPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UnallocatedPaymentAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'PaymentCurrency' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CNY', - ], - 'OwnerID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123213123123', - ], - 'DeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'GaapPretaxAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'MonthGaapDeductedByCoupons' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'MonthGaapPaymentAmount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'UsageEndDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-05-01 00:00:00', - ], - 'UsageStartDate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-04-01 00:00:00', - ], - 'ProductCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], + 'GaapDeductedByCashCoupons' => ['description' => 'The amortized deduction from cash coupons.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'SubscriptionType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `Subscription`: subscription'."\n" + ."\n" + .'- `PayAsYouGo`: pay-as-you-go', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''], + 'MonthGaapPretaxAmount' => ['description' => 'The monthly amortized pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DeductedByCoupons' => ['description' => 'The coupon deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'SubOrderId' => ['description' => 'The suborder ID.', 'type' => 'string', 'example' => '12434345', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'OrderType' => ['description' => 'The order type. Valid values:'."\n" + ."\n" + .'- `New`: A new purchase.'."\n" + ."\n" + .'- `Renewal`: A renewal.'."\n" + ."\n" + .'- `Upgrade`: An upgrade.'."\n" + ."\n" + .'- `Degrade`: A downgrade.', 'type' => 'string', 'example' => 'New', 'title' => ''], + 'MonthGaapDeductedByPrepaidCard' => ['description' => 'The monthly amortized deduction from prepaid cards.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UnallocatedDeductedByCashCoupons' => ['description' => 'The unallocated deduction from cash coupons.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PretaxAmountLocal' => ['description' => 'The amortized pretax amount in your local currency (available for international accounts only).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'BillingCycle' => ['description' => 'The billing cycle in YYYY-MM format.', 'type' => 'string', 'example' => '2020-03', 'title' => ''], + 'PayerAccount' => ['description' => 'The payer\'s account.', 'type' => 'string', 'example' => '23534534', 'title' => ''], + 'MonthGaapPretaxAmountLocal' => ['description' => 'The monthly amortized pretax amount in your local currency (available for international accounts only).', 'type' => 'string', 'example' => '0.99', 'title' => ''], + 'AccountingUnit' => ['description' => 'The financial accounting unit. This field is reserved and not supported.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'GaapPretaxAmountLocal' => ['description' => 'The amortized pretax amount in the local currency (available for international accounts only).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UnallocatedDeductedByPrepaidCard' => ['description' => 'The unallocated deduction from prepaid cards.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'PaymentAmount' => ['description' => 'The cash payment amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MonthGaapPretaxGrossAmount' => ['description' => 'The monthly amortized gross pretax amount.', 'type' => 'string', 'example' => '0.99', 'title' => ''], + 'BillType' => ['description' => 'The bill type. Valid values:'."\n" + ."\n" + .'- `SubscriptionOrder`: A subscription order.'."\n" + ."\n" + .'- `PayAsYouGoBill`: A pay-as-you-go bill.'."\n" + ."\n" + .'- `Refund`: A refund.'."\n" + ."\n" + .'- `Adjustment`: A billing adjustment.', 'type' => 'string', 'example' => 'SubscriptionOrder', 'title' => ''], + 'PayTime' => ['description' => 'The payment time.', 'type' => 'string', 'example' => '2018-06-15 15:59:57', 'title' => ''], + 'PretaxGrossAmount' => ['description' => 'The gross pretax amount.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '213123213123', 'title' => ''], + 'UnallocatedPricingDiscount' => ['description' => 'The unallocated negotiated discount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MonthGaapDeductedByCashCoupons' => ['description' => 'The monthly amortized deduction from cash coupons.', 'type' => 'string', 'example' => '0.75', 'title' => ''], + 'UnallocatedPretaxGrossAmount' => ['description' => 'The unallocated gross pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'OSSBAG-cn-0xl0xxxxxx', 'title' => ''], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'tag', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- `CNY`'."\n" + ."\n" + .'- `USD`'."\n" + ."\n" + .'- `JPY`', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'GaapDeductedByCoupons' => ['description' => 'The amortized coupon deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DeductedByCashCoupons' => ['description' => 'The cash coupon deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GaapDeductedByPrepaidCard' => ['description' => 'The amortized deduction from prepaid cards.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GaapPaymentAmount' => ['description' => 'The amortized cash payment amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UnallocatedPretaxAmountLocal' => ['description' => 'The unallocated pretax amount in the local currency (available for international accounts only).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MonthGaapPricingDiscount' => ['description' => 'The monthly amortized negotiated discount.', 'type' => 'string', 'example' => '0,.25', 'title' => ''], + 'PricingDiscount' => ['description' => 'The negotiated discount.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GaapPricingDiscount' => ['description' => 'The amortized negotiated discount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'example' => '默认资源组', 'title' => ''], + 'UnallocatedDeductedByCoupons' => ['description' => 'The unallocated coupon deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UnallocatedPretaxAmount' => ['description' => 'The unallocated pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GaapPretaxGrossAmount' => ['description' => 'The amortized gross pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UnallocatedPaymentAmount' => ['description' => 'The unallocated cash payment amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'PaymentCurrency' => ['description' => 'The payment currency (available for international accounts only).', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'OwnerID' => ['description' => 'The owner ID.', 'type' => 'string', 'example' => '123213123123', 'title' => ''], + 'DeductedByPrepaidCard' => ['description' => 'The prepaid card deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GaapPretaxAmount' => ['description' => 'The amortized pretax amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MonthGaapDeductedByCoupons' => ['description' => 'The monthly amortized coupon deduction.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'MonthGaapPaymentAmount' => ['description' => 'The monthly amortized cash payment amount.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UsageEndDate' => ['description' => 'The service end time.', 'type' => 'string', 'example' => '2019-05-01 00:00:00', 'title' => ''], + 'UsageStartDate' => ['description' => 'The service start time.', 'type' => 'string', 'example' => '2019-04-01 00:00:00', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'rds', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'A container for cost details.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => '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' => 'Invalid user identity.'], + ['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":"<QueryInstanceGaapCostResponse>\\n <Data>\\n <TotalCount>2</TotalCount>\\n <Modules>\\n <Module>\\n <PayerAccount>null</PayerAccount>\\n <GaapDeductedByCashCoupons>0</GaapDeductedByCashCoupons>\\n <PricingDiscount>0</PricingDiscount>\\n <MonthGaapPretaxAmount>0.74</MonthGaapPretaxAmount>\\n <MonthGaapDeductedByCoupons>0</MonthGaapDeductedByCoupons>\\n <PretaxAmount>0</PretaxAmount>\\n <UnallocatedPaymentAmount>0</UnallocatedPaymentAmount>\\n <UnallocatedPretaxGrossAmount>0</UnallocatedPretaxGrossAmount>\\n <UnallocatedPretaxAmount>0</UnallocatedPretaxAmount>\\n <UnallocatedPricingDiscount>0</UnallocatedPricingDiscount>\\n <PayTime>2018-06-15 14:06:53</PayTime>\\n <PaymentCurrency>CNY</PaymentCurrency>\\n <ProductType>ossbag</ProductType>\\n <UnallocatedDeductedByCoupons>0</UnallocatedDeductedByCoupons>\\n <OrderType>Renewal</OrderType>\\n <UnallocatedPretaxAmountLocal>0</UnallocatedPretaxAmountLocal>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <Currency>CNY</Currency>\\n <GaapPretaxAmountLocal>0</GaapPretaxAmountLocal>\\n <GaapPaymentAmount>0</GaapPaymentAmount>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <BillingCycle>2019-04</BillingCycle>\\n <ProductCode>flowpack</ProductCode>\\n <InstanceID>OSSBAG-cn-0xl0njdtx002</InstanceID>\\n <PretaxAmountLocal>0</PretaxAmountLocal>\\n <GaapDeductedByCoupons>0</GaapDeductedByCoupons>\\n <GaapPretaxAmount>0</GaapPretaxAmount>\\n <OrderId>202143356070333</OrderId>\\n <GaapDeductedByPrepaidCard>0</GaapDeductedByPrepaidCard>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <GaapPretaxGrossAmount>0</GaapPretaxGrossAmount>\\n <SubOrderId>202143356070333</SubOrderId>\\n <MonthGaapPaymentAmount>0</MonthGaapPaymentAmount>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <UsageEndDate>2019-05-01 00:00:00</UsageEndDate>\\n <UnallocatedDeductedByPrepaidCard>0</UnallocatedDeductedByPrepaidCard>\\n <MonthGaapDeductedByPrepaidCard>0</MonthGaapDeductedByPrepaidCard>\\n <UsageStartDate>2019-04-01 00:00:00</UsageStartDate>\\n <MonthGaapPretaxGrossAmount>0.99</MonthGaapPretaxGrossAmount>\\n <PaymentAmount>0</PaymentAmount>\\n <MonthGaapPricingDiscount>0.25</MonthGaapPricingDiscount>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <OwnerID>1028728862215453</OwnerID>\\n <MonthGaapDeductedByCashCoupons>0.74</MonthGaapDeductedByCashCoupons>\\n <UnallocatedDeductedByCashCoupons>0</UnallocatedDeductedByCashCoupons>\\n <MonthGaapPretaxAmountLocal>0.74</MonthGaapPretaxAmountLocal>\\n <GaapPricingDiscount>0</GaapPricingDiscount>\\n <BillType>SubscriptionOrder</BillType>\\n </Module>\\n </Modules>\\n <PageSize>20</PageSize>\\n <HostId>cn</HostId>\\n <PageNum>1</PageNum>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>AEAA504C-FCCA-4FB9-9E05-162CABC6EB40</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</QueryInstanceGaapCostResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query monthly cost allocation service', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeInstanceAmortizedCostByAmortizationPeriod' => [ - 'summary' => 'Queries the monthly allocated costs of instances by allocation month.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'title' => '账期月、摊销月', - 'description' => 'The allocation month. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-10', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ConsumePeriodFilter', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '账期月筛选条件', - 'description' => 'The billing cycle that is used to filter bills. You can specify a maximum of 10 billing cycles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-09', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'title' => '订阅类型', - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the service. You can obtain the value of this parameter by calling the QueryProductList operation or the DescribeResourcePackageProduct operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The specific service resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'title' => '财务单元code', - 'description' => 'The code of the cost center.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123#', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'BillUserIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the member that needs to settle the bill. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member account. If you leave this parameter empty, the bills of the current account and all members of the current account are queried by default. You can specify a maximum of 10 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the member that needs to settle the bill.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'BillOwnerIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the member to which the bill belongs. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account and all members of the current account are queried. You can specify a maximum of 10 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the member to which the bill belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], + 'ramActions' => [ [ - 'name' => 'InstanceIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The instance ID that is used to filter bills. You can specify multiple instance IDs to query bills of multiple instances. If you leave this parameter empty, the bills of all instances are queried by default. You can specify a maximum of 10 instance IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - 'maxLength' => 256, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeGaapBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The position from which the query starts. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - 'maxLength' => 2560, ], ], + ], + ], + 'QueryInvoicingCustomerList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BssResult<BssCostBillBaseResponse>', - 'description' => 'BssResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The position from which the results started to return. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185766xxxx', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Items' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data entry.'."\n", - 'type' => 'object', - 'properties' => [ - 'CostUnit' => [ - 'title' => '财务单元', - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'CostUnitCode' => [ - 'title' => '财务单元code', - 'description' => 'The code of the cost center.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], - 'ResourceGroup' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Default resource group'."\n", - ], - 'Tag' => [ - 'description' => 'The tag of the instance.'."\n", - 'type' => 'string', - 'example' => 'tag', - ], - 'InternetIP' => [ - 'description' => 'The public IP address of the instance.'."\n", - 'type' => 'string', - 'example' => '34.xx.x.x', - ], - 'IntranetIP' => [ - 'description' => 'The private IP address of the instance.'."\n", - 'type' => 'string', - 'example' => '192.xx.xx.xx', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)'."\n", - ], - 'Zone' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou'."\n", - ], - 'SplitAccountName' => [ - 'description' => 'The name of the account to which the split item belongs.'."\n", - 'type' => 'string', - 'example' => 'test**1122', - ], - 'SplitProductDetail' => [ - 'description' => 'The name of the specific service resource to which the split item belongs.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'SplitItemID' => [ - 'description' => 'The ID of the split item.'."\n", - 'type' => 'string', - 'example' => 'i-28bycvyb4', - ], - 'SplitItemName' => [ - 'description' => 'The name of the split item.'."\n", - 'type' => 'string', - 'example' => 'iZ28bycvyb4Z', - ], - 'ConsumePeriod' => [ - 'title' => '账期', - 'description' => 'The billing cycle. Format: YYYYMM.'."\n", - 'type' => 'string', - 'example' => '202210', - ], - 'AmortizationStatus' => [ - 'title' => '摊销状态', - 'description' => 'The allocation status. Valid values:'."\n" - ."\n" - .'* amortized: allocated'."\n" - .'* unAmortized: not allocated'."\n", - 'type' => 'string', - 'example' => 'amortized', - ], - 'AmortizationPeriod' => [ - 'title' => '摊销月', - 'description' => 'The allocation month. Format: YYYYMM.'."\n", - 'type' => 'string', - 'example' => '202210', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '185xxxxx489', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'BillOwnerID' => [ - 'description' => 'The ID of the account to which the resource belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '185xxxxx489', - ], - 'BillOwnerName' => [ - 'description' => 'The name of the account to which the resource belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'ProductDetailCode' => [ - 'description' => 'The code of the specific service resource.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductDetail' => [ - 'description' => 'The specific service resource.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'BizType' => [ - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'PretaxGrossAmount' => [ - 'title' => '官网价', - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'InvoiceDiscount' => [ - 'title' => '优惠金额', - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RoundDownDiscount' => [ - 'title' => '抹零金额', - 'description' => 'The round-off amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PretaxAmount' => [ - 'title' => '应付金额', - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCashCoupons' => [ - 'title' => '代金券抵扣', - 'description' => 'The amount deducted by using vouchers.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCoupons' => [ - 'title' => '优惠券抵扣', - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByPrepaidCard' => [ - 'title' => '储值卡支付金额', - 'description' => 'The amount deducted by using prepaid cards.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'ExpenditureAmount' => [ - 'title' => '消费金额（可开票）', - 'description' => 'The expenditure amount. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedInvoiceDiscount' => [ - 'description' => 'The discount amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedRoundDownDiscount' => [ - 'description' => 'The round-off amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxAmount' => [ - 'description' => 'The pretax amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedExpenditureAmount' => [ - 'description' => 'The expenditure amount allocated before the allocation month. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationInvoiceDiscount' => [ - 'description' => 'The discount amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationRoundDownDiscount' => [ - 'description' => 'The round-off amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxAmount' => [ - 'description' => 'The pretax amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationExpenditureAmount' => [ - 'description' => 'The expenditure amount allocated to the current allocation month. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationInvoiceDiscount' => [ - 'description' => 'The discount amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationRoundDownDiscount' => [ - 'description' => 'The round-off amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxAmount' => [ - 'description' => 'The pretax amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationExpenditureAmount' => [ - 'description' => 'The expenditure amount to be allocated to one or more future allocation months. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'PreviouslyAmortizedAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'CurrentAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'RemainingAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', + 'CustomerInvoiceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomerInvoice' => [ + 'description' => 'The list of invoice information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The default invoice type. Valid values:'."\n" + ."\n" + .'- 0: General value-added tax (VAT) invoice.'."\n" + ."\n" + .'- 1: Special VAT invoice.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Status' => ['description' => 'The status of the invoice title. Valid values:'."\n" + ."\n" + .'- 1: Pending'."\n" + ."\n" + .'- 2: Approved'."\n" + ."\n" + .'- 3: Rejected'."\n" + ."\n" + .'- 4: Invalid'."\n" + ."\n" + .'- 5: Revoked', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], + 'AdjustType' => ['description' => 'The title change type. Valid values:'."\n" + ."\n" + .'- 1: Information other than the title name is modified.'."\n" + ."\n" + .'- 4: A title of another type is modified.'."\n" + ."\n" + .'- 5: A title is modified based on identity verification.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Bank' => ['description' => 'The name of the bank where the account was opened.', 'type' => 'string', 'title' => '', 'example' => '测试银行'], + 'StartCycle' => ['description' => 'The start month of the validity period.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '202002'], + 'TitleChangeInstructions' => ['description' => 'The statement of invoice title change.', 'type' => 'string', 'title' => '', 'example' => 'instruction.doc'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '34565465675'], + 'OperatingLicenseAddress' => ['description' => 'The registered address.', 'type' => 'string', 'title' => '', 'example' => '某某省某某市某某区某地址'], + 'InvoiceTitle' => ['description' => 'The invoice title.', 'type' => 'string', 'title' => '', 'example' => '测试公司'], + 'UserNick' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'title' => '', 'example' => 'testNick'], + 'OperatingLicensePhone' => ['description' => 'The registered landline number.', 'type' => 'string', 'title' => '', 'example' => '138xxxxxxxx'], + 'EndCycle' => ['description' => 'The end month of the validity period.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '202003'], + 'DefaultRemark' => ['description' => 'The default remarks for the invoice. When this title is used for invoicing, the remarks are added to the invoice.', 'type' => 'string', 'title' => '', 'example' => 'PO代码：12984554'], + 'TaxationLicense' => ['description' => 'The path and file name of the scanned tax registration certificate.', 'type' => 'string', 'title' => '', 'example' => 'taxationLicense.jpg'], + 'RegisterNo' => ['description' => 'The Unified Social Credit Code.', 'type' => 'string', 'title' => '', 'example' => '21343245342534'], + 'GmtCreate' => ['description' => 'The creation time. The format is yyyy-mm-dd hh:mm:ss.', 'type' => 'string', 'title' => '', 'example' => '2025-02-01 00:00:00'], + 'TaxpayerType' => ['description' => 'The taxpayer type. Valid values:'."\n" + ."\n" + .'- 1: General taxpayer'."\n" + ."\n" + .'- 2: Small-scale taxpayer', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'CustomerType' => ['description' => 'The customer\'s Alipay authentication type. Valid values:'."\n" + ."\n" + .'- 1: Individual.'."\n" + ."\n" + .'- 2: Company.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'IssueType' => ['description' => 'The title type. Valid values:'."\n" + ."\n" + .'- 0: Individual'."\n" + ."\n" + .'- 1: Enterprise'."\n" + ."\n" + .'- 2: Public institution', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Id' => ['description' => 'The ID of the invoice title record.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '239875502738'], + 'BankNo' => ['description' => 'The primary bank account number.', 'type' => 'string', 'title' => '', 'example' => '389576348573296349853476'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryInvoicingCustomerList', + 'summary' => 'Queries the invoicing information of an Alibaba Cloud user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryInvoicingCustomerList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerInvoiceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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"}]', - 'description' => 'You can view and export the allocated costs of the current month after 10:00 on the fourth day of the next month. The allocated costs of a single allocation month may involve orders or bills in different billing cycles. If a historical allocated amount is incorrect, the historical allocated costs need to be adjusted. As a result, the allocated costs displayed for a single allocation month may be different at different time points.'."\n", ], - 'DescribeProductAmortizedCostByAmortizationPeriod' => [ - 'summary' => 'Queries the allocated costs of services by allocation month.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryOrders' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12988,523 +9551,231 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The allocation month. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2022-10', - 'maxLength' => 256, - ], + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. If you do not set this parameter, orders created within the past hour are queried. The format is YYYY-MM-ddTHH:mm:ssZ. The time zone is UTC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T12:00:00Z'], ], [ - 'name' => 'ConsumePeriodFilter', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The billing cycle that is used to filter bills. You can specify a maximum of 10 billing cycles.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-09', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the service. You can obtain the value of this parameter by calling the QueryProductList operation or the DescribeResourcePackageProduct operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The specific service resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], + 'in' => 'query', + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the cost center.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123#'."\n", - 'maxLength' => 256, - ], + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'BillUserIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the member that needs to settle the bill. The member ID is used to filter bills. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account and all members of the current account are queried by default. You can specify a maximum of 10 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the member that needs to settle the bill.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Subscription'], ], [ - 'name' => 'BillOwnerIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The instance ID that is used to filter bills. You can specify multiple instance IDs to query bills of multiple instances. If you leave this parameter empty, the bills of all instances are queried by default. You can specify a maximum of 10 instance IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['description' => 'The order type. Valid values:'."\n" + ."\n" + .'- New: a new purchase'."\n" + ."\n" + .'- Renew: a renewal'."\n" + ."\n" + .'- Upgrade: an upgrade'."\n" + ."\n" + .'- TempUpgrade: a temporary upgrade'."\n" + ."\n" + .'- Downgrade: a downgrade'."\n" + ."\n" + .'- Refund: a refund'."\n" + ."\n" + .'- Convert: a billing method change'."\n" + ."\n" + .'- ResizeDisk: a disk resize'."\n" + ."\n" + .'- CompensatoryRenew: a compensatory renewal'."\n" + ."\n" + .'- IncreaseUpgrade: a bandwidth upgrade'."\n" + ."\n" + .'- Exchange: an exchange'."\n" + ."\n" + .'- ChangeOperatingSystem: an operating system change', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'New'], ], [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The position from which the query starts. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - 'maxLength' => 2560, - ], + 'name' => 'PaymentStatus', + 'in' => 'query', + 'schema' => ['description' => 'The payment status. For orders that are not refunds, valid values are:'."\n" + ."\n" + .'- Unpaid: The order is unpaid.'."\n" + ."\n" + .'- Paid: The order is paid.'."\n" + ."\n" + .'- Cancelled: The order is canceled.'."\n" + ."\n" + .'> For refund orders, you can leave this parameter empty.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Paid'], ], [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. If you do not set this parameter, orders created within the last hour are queried. The format is YYYY-MM-ddTHH:mm:ssZ. The time zone is UTC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2016-05-23T13:00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', - 'description' => 'BssResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200'."\n", - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！'."\n", - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The position from which the results started to return. The parameter must be left empty or set to the value of the NextToken parameter returned from the last call. Otherwise, an error is returned. If this parameter is left empty, data is queried from the beginning.'."\n", - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185766xxxx', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com'."\n", - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Items' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data entry.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConsumePeriod' => [ - 'description' => 'The billing cycle. Format: YYYYMM.'."\n", - 'type' => 'string', - 'example' => '202210', - ], - 'AmortizationStatus' => [ - 'description' => 'The allocation status. Valid values:'."\n" - ."\n" - .'* amortized: allocated'."\n" - .'* unAmortized: not allocated'."\n", - 'type' => 'string', - 'example' => 'amortized', - ], - 'AmortizationPeriod' => [ - 'description' => 'The allocation month. Format: YYYYMM.'."\n", - 'type' => 'string', - 'example' => '202210', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '185xxxxx489', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com'."\n", - ], - 'BillOwnerID' => [ - 'description' => 'The ID of the account to which the resource belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '185xxxxx489', - ], - 'BillOwnerName' => [ - 'description' => 'The name of the account to which the resource belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com'."\n", - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'ProductDetailCode' => [ - 'description' => 'The code of the specific service resource.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductDetail' => [ - 'description' => 'The specific service resource.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'BizType' => [ - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'trusteeship'."\n", - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RoundDownDiscount' => [ - 'description' => 'The round-off amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'ExpenditureAmount' => [ - 'description' => 'The expenditure amount. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedInvoiceDiscount' => [ - 'description' => 'The discount amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedRoundDownDiscount' => [ - 'description' => 'The round-off amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxAmount' => [ - 'description' => 'The pretax amount allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and allocated before the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedExpenditureAmount' => [ - 'description' => 'The expenditure amount allocated before the current allocation month. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationInvoiceDiscount' => [ - 'description' => 'The discount amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationRoundDownDiscount' => [ - 'description' => 'The round-off amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxAmount' => [ - 'description' => 'The pretax amount allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and allocated to the current allocation month.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationExpenditureAmount' => [ - 'description' => 'The expenditure amount allocated to the current allocation month. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxGrossAmount' => [ - 'description' => 'The pretax gross amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationInvoiceDiscount' => [ - 'description' => 'The discount amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationRoundDownDiscount' => [ - 'description' => 'The round-off amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxAmount' => [ - 'description' => 'The pretax amount to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCashCoupons' => [ - 'description' => 'The amount deducted by using vouchers and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByPrepaidCard' => [ - 'description' => 'The amount deducted by using prepaid cards and to be allocated to one or more future allocation months.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationExpenditureAmount' => [ - 'description' => 'The expenditure amount to be allocated to one or more future allocation months. Invoicing is supported.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'PreviouslyAmortizedAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'CurrentAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'RemainingAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', + 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries on each page. Many entries can cause a timeout. We recommend a maximum of 20 entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'OrderList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Order' => [ + 'description' => 'A list of orders.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PretaxAmount' => ['description' => 'The pre-tax amount of the order.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'ecs'], + 'RelatedOrderId' => ['description' => 'The associated order ID.', 'type' => 'string', 'title' => '', 'example' => '234535345345342'], + 'CreateTime' => ['description' => 'The time when the order was created.', 'type' => 'string', 'title' => '', 'example' => '2017-06-08T09:41:30Z'], + 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'PaymentCurrency' => ['description' => 'The payment currency.', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'AfterTaxAmount' => ['description' => 'The amount after tax.', 'type' => 'string', 'title' => '', 'example' => '66'], + 'PaymentTime' => ['description' => 'The payment time.', 'type' => 'string', 'title' => '', 'example' => '2017-06-08T09:41:30Z'], + 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'OrderType' => ['description' => 'The type of the order. Valid values:'."\n" + ."\n" + .'- New: A new purchase.'."\n" + ."\n" + .'- Renew: A renewal.'."\n" + ."\n" + .'- Upgrade: An upgrade.'."\n" + ."\n" + .'- TempUpgrade: A temporary upgrade.'."\n" + ."\n" + .'- Downgrade: A downgrade.'."\n" + ."\n" + .'- Refund: A refund.'."\n" + ."\n" + .'- Convert: A billing method change.'."\n" + ."\n" + .'- ResizeDisk: A disk resize.'."\n" + ."\n" + .'- CompensatoryRenew: A compensatory renewal.'."\n" + ."\n" + .'- IncreaseUpgrade: A bandwidth upgrade.'."\n" + ."\n" + .'- Exchange: An exchange.'."\n" + ."\n" + .'- ChangeOperatingSystem: An operating system change.', 'type' => 'string', 'title' => '', 'example' => 'New'], + 'PaymentStatus' => ['description' => 'The payment status. For non-refund orders, valid values:'."\n" + ."\n" + .'- Unpaid: The order has not been paid.'."\n" + ."\n" + .'- Paid: The order has been paid.'."\n" + ."\n" + .'- Canceled: The order has been canceled.'."\n" + ."\n" + .'> This parameter can be NULL for refund orders.', 'type' => 'string', 'title' => '', 'example' => 'Paid'], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '34532532'], + 'Tax' => ['description' => 'The tax amount.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'PretaxAmountLocal' => ['description' => 'The amount in local currency.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', - ], + ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - '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"}]', - 'description' => 'You can view and export the allocated costs of the current month after 10:00 on the fourth day of the next month. The allocated costs of a single allocation month may involve orders or bills in different billing cycles. If a historical allocated amount is incorrect, the historical allocated costs need to be adjusted. As a result, the allocated costs displayed for a single allocation month may be different at different time points.'."\n", - ], - 'DescribeInstanceAmortizedCostByConsumePeriod' => [ - 'summary' => '实例账期月摊销成本', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryOrders', + 'summary' => 'Queries the orders of a user or a distribution customer. By default, the query returns orders created within the last hour. To query orders over a longer period, set the CreateTimeStart and CreateTimeEnd parameters.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryOrders'], + ], ], + ], + 'QueryPermissionList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13512,613 +9783,229 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2022-10', - 'maxLength' => 256, - 'required' => true, - 'title' => '账期月、摊销月', - 'type' => 'string', - ], + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => ['description' => 'The relationship ID. Obtain this ID from the RelationId parameter in the response of the QueryRelationList operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '51463'], ], - [ - 'name' => 'AmortizationPeriodFilter', - 'in' => 'formData', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '2022-09'."\n", - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F6E29451-A3CD-4705-806D-0112D08F5C49'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The time when the relationship expires. If this parameter is empty, the relationship has not expired.', 'type' => 'string', 'title' => '', 'example' => '2021-03-06T15:12Z'], + 'RelationType' => ['description' => 'The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.', 'type' => 'string', 'title' => '', 'example' => 'FinancialManagement'], + 'StartTime' => ['description' => 'The time when the relationship takes effect. The time is in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-05-23T12:00:00Z is 20:00:00 on May 23, 2016 in UTC+8.', 'type' => 'string', 'title' => '', 'example' => '2021-03-02T15:12Z'], + 'State' => ['description' => 'The status of the relationship. The value is an enumeration member of RelationshipStatusEnum.', 'type' => 'string', 'title' => '', 'example' => 'RELATED'], + 'MasterId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1990699401005016'], + 'MemberId' => ['description' => 'The ID of the member account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1851253838840762'], + 'SetupTime' => ['description' => 'The time when the relationship was established. The time is in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-05-23T12:00:00Z is 20:00:00 on May 23, 2016 in UTC+8.', 'type' => 'string', 'title' => '', 'example' => '2021-03-02T15:12Z'], + 'PermissionList' => [ + 'description' => 'The list of permissions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The time when the permission expires. If this parameter is empty, the permission is still valid. The time is in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-05-23T12:00:00Z is 20:00:00 on May 23, 2016 in UTC+8.', 'type' => 'string', 'title' => '', 'example' => '2021-03-05T15:12Z'], + 'StartTime' => ['description' => 'The time when the permission takes effect. The time is in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-05-23T12:00:00Z is 20:00:00 on May 23, 2016 in UTC+8.', 'type' => 'string', 'title' => '', 'example' => '2021-03-02T15:12Z'], + 'PermissionCode' => ['description' => 'The permission code.', 'type' => 'string', 'title' => '', 'example' => 'allow_synchronize_finance_identity'], + 'PermissionName' => ['description' => 'The permission name.', 'type' => 'string', 'title' => '', 'example' => '主账号 子账号共享主账号信控身份'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], ], - 'maxItems' => 10, - 'required' => false, - 'title' => '摊销月筛选条件', - 'type' => 'array', - ], - ], - [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ 'description' => '', - 'example' => 'Subscription', - 'maxLength' => 256, - 'required' => false, - 'title' => '订阅类型', - 'type' => 'string', - ], - ], - [ - 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'rds', - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'rds', - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''], ], - [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123#'."\n", - 'maxLength' => 256, - 'required' => false, - 'title' => '财务单元code', - 'type' => 'string', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => 'System exception, please try again'], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryPermissionList', + 'summary' => 'Queries the permissions for a master-member relationship based on the relationship ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'Description of the RelationshipStatusEnum type:'."\n" + ."\n" + .'| **Value** | **Description** | **Notes** |'."\n" + .'| -------------------------- | --------------------------- | ---------------------------------- |'."\n" + .'| INITIAL | Initial | The relationship is not in effect. |'."\n" + .'| CONFIRMING | Invitation pending | The relationship is not in effect. |'."\n" + .'| REJECTED | Rejected | The relationship is not in effect. |'."\n" + .'| CONNECTION\\_CANCELED | Canceled | The relationship is not in effect. |'."\n" + .'| RELATED | Associated | The relationship is in effect. |'."\n" + .'| CHANGE\\_CONFIRMING | Change pending confirmation | The relationship is in effect. |'."\n" + .'| CONNECTION\\_MASTER\\_CANCEL | Confirmation canceled | The relationship is not in effect. |', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'BillUserIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryPermissionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'QueryPrepaidCards' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BillOwnerIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'InstanceIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => 'abc', - 'maxLength' => 256, - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'ExpiryTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end of the expiration time range to query. The format is `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2018-08-01 00:00:00'], ], [ - 'name' => 'NextToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - 'maxLength' => 2560, - 'required' => false, - 'type' => 'string', - ], + 'name' => 'ExpiryTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The start of the expiration time range to query. The format is `YYYY-MM-DDThh:mm:ssZ`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2018-08-01 00:00:00'], ], [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'name' => 'EffectiveOrNot', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query for prepaid cards that are in effect. Valid values: `true` and `false`.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'BssResult<BssCostBillBaseResponse>', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Successful！'."\n", - 'type' => 'string', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7EA6C02D-06D0-4213-9C3B-E67910F7D1EB'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => '', + 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - 'type' => 'string', - ], - 'AccountID' => [ - 'description' => '', - 'example' => '185766xxxx'."\n", - 'type' => 'string', - ], - 'AccountName' => [ - 'description' => '', - 'example' => 'test@test.aliyunid.com'."\n", - 'type' => 'string', - ], - 'MaxResults' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Items' => [ - 'description' => '', + 'PrepaidCard' => [ + 'description' => 'The details of the prepaid cards.', + 'type' => 'array', 'items' => [ - 'description' => '', + 'type' => 'object', 'properties' => [ - 'CostUnit' => [ - 'description' => '', - 'example' => '', - 'title' => '财务单元', - 'type' => 'string', - ], - 'CostUnitCode' => [ - 'description' => '', - 'example' => '1234', - 'title' => '财务单元code', - 'type' => 'string', - ], - 'InstanceID' => [ - 'description' => '', - 'example' => 'i-kjhdskjgshfdlkjfdh'."\n", - 'type' => 'string', - ], - 'ResourceGroup' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Tag' => [ - 'description' => '', - 'example' => 'tag', - 'type' => 'string', - ], - 'InternetIP' => [ - 'description' => '', - 'example' => '34.xx.x.x'."\n", - 'type' => 'string', - ], - 'IntranetIP' => [ - 'description' => '', - 'example' => '192.xx.xx.xx'."\n", - 'type' => 'string', - ], - 'Region' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Zone' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'SplitAccountName' => [ - 'description' => '', - 'example' => 'test**1122'."\n", - 'type' => 'string', - ], - 'SplitProductDetail' => [ - 'description' => '', - 'example' => 'rds', - 'type' => 'string', - ], - 'SplitItemID' => [ - 'description' => '', - 'example' => 'i-28bycvyb4'."\n", - 'type' => 'string', - ], - 'SplitItemName' => [ - 'description' => '', - 'example' => 'iZ28bycvyb4Z'."\n", - 'type' => 'string', - ], - 'ConsumePeriod' => [ - 'description' => '', - 'example' => '202210', - 'title' => '账期', - 'type' => 'string', - ], - 'AmortizationStatus' => [ - 'description' => '', - 'example' => 'amortized', - 'title' => '摊销状态', - 'type' => 'string', - ], - 'AmortizationPeriod' => [ - 'description' => '', - 'example' => '202210', - 'title' => '摊销月', - 'type' => 'string', - ], - 'BillAccountID' => [ - 'description' => '', - 'example' => '185xxxxx489', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BillAccountName' => [ - 'description' => '', - 'example' => 'test@test.aliyunid.com'."\n", - 'type' => 'string', - ], - 'BillOwnerID' => [ - 'description' => '', - 'example' => '185xxxxx489', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BillOwnerName' => [ - 'description' => '', - 'example' => 'test@test.aliyunid.com'."\n", - 'type' => 'string', - ], - 'ProductCode' => [ - 'description' => '', - 'example' => 'rds', - 'type' => 'string', - ], - 'ProductName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'ProductDetailCode' => [ - 'description' => '', - 'example' => 'rds'."\n", - 'type' => 'string', - ], - 'ProductDetail' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'BizType' => [ - 'description' => '', - 'example' => 'trusteeship', - 'type' => 'string', - ], - 'SubscriptionType' => [ - 'description' => '', - 'example' => 'PayAsYouGo', - 'type' => 'string', - ], - 'PretaxGrossAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '官网价', - 'type' => 'number', - ], - 'InvoiceDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '优惠金额', - 'type' => 'number', - ], - 'RoundDownDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '抹零金额', - 'type' => 'number', - ], - 'PretaxAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '应付金额', - 'type' => 'number', - ], - 'DeductedByCashCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '代金券抵扣', - 'type' => 'number', - ], - 'DeductedByCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '优惠券抵扣', - 'type' => 'number', - ], - 'DeductedByPrepaidCard' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '储值卡支付金额', - 'type' => 'number', - ], - 'ExpenditureAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'title' => '消费金额（可开票）', - 'type' => 'number', - ], - 'PreviouslyAmortizedPretaxGrossAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedInvoiceDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedRoundDownDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedPretaxAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedDeductedByCashCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedDeductedByCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedDeductedByPrepaidCard' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'PreviouslyAmortizedExpenditureAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationPretaxGrossAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationInvoiceDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationRoundDownDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationPretaxAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationDeductedByCashCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationDeductedByCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationDeductedByPrepaidCard' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'CurrentAmortizationExpenditureAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationPretaxGrossAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationInvoiceDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationRoundDownDiscount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationPretaxAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationDeductedByCashCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationDeductedByCoupons' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationDeductedByPrepaidCard' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'RemainingAmortizationExpenditureAmount' => [ - 'description' => '', - 'example' => '0', - 'format' => 'double', - 'type' => 'number', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'PreviouslyAmortizedAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'CurrentAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'RemainingAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], + 'Status' => ['description' => 'The status of the prepaid card. Valid values:'."\n" + ."\n" + .'- Available: The prepaid card is valid.'."\n" + ."\n" + .'- Expired: The prepaid card has expired.'."\n" + ."\n" + .'- Cancelled: The prepaid card is canceled.', 'type' => 'string', 'title' => '', 'example' => 'Available'], + 'ExpiryTime' => ['description' => 'The time when the prepaid card expires.', 'type' => 'string', 'title' => '', 'example' => '2019-08-04 01:39:11'], + 'GrantedTime' => ['description' => 'The time when the prepaid card was issued.', 'type' => 'string', 'title' => '', 'example' => '2019-08-04 01:39:11'], + 'NominalValue' => ['description' => 'The nominal value (face value) value of the prepaid card.', 'type' => 'string', 'title' => '', 'example' => '100.00'], + 'EffectiveTime' => ['description' => 'The time when the prepaid card took effect.', 'type' => 'string', 'title' => '', 'example' => '2019-08-04 01:39:11'], + 'PrepaidCardNo' => ['description' => 'The number of the prepaid card.', 'type' => 'string', 'title' => '', 'example' => 'Q-7edaab979fc9'], + 'ApplicableScenarios' => ['description' => 'The applicable scenarios.', 'type' => 'string', 'title' => '', 'example' => '阿里云按量付费账单,阿里云新购'], + 'PrepaidCardId' => ['description' => 'The ID of the prepaid card.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '213432432'], + 'ApplicableProducts' => ['description' => 'The applicable products.', 'type' => 'string', 'title' => '', 'example' => '通用'], + 'Balance' => ['description' => 'The remaining balance of the prepaid card.', 'type' => 'string', 'title' => '', 'example' => '100.00'], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'title' => 'BssResult<BssCostBillBaseResponse>', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => ' 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' => ''], + ], + 500 => [ + ['errorCode' => 'UndefinedError', 'errorMessage' => 'The request processing has failed due to some unknown error.', '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\\",\\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"}]', - ], - 'DescribeProductAmortizedCostByConsumePeriod' => [ - 'summary' => '产品账期月摊销成本', - 'methods' => [ - 'post', - 'get', + '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' => 'QueryPrepaidCards', + 'summary' => 'Queries information about a user\'s prepaid cards.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescrbePrepaidCards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPrepaidCards'], + ], ], + ], + 'QueryPriceEntityList' => [ + 'summary' => 'Queries the pricing entities under a commodity. A pricing entity is the smallest product capability used for metering and cost calculation.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14126,714 +10013,276 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2022-10'."\n", - 'maxLength' => 256, - ], - ], - [ - 'name' => 'AmortizationPeriodFilter', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '摊销月筛选条件', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-09'."\n", - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'SubscriptionType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ProductCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'ProductDetail', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - 'maxLength' => 256, - ], - ], - [ - 'name' => 'CostUnitCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123#'."\n", - 'maxLength' => 256, - ], - ], - [ - 'name' => 'BillUserIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'BillOwnerIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 256, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => ['description' => 'The commodity code. You can call the **QueryCommodityList** operation to query the commodity code.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'formData', + 'name' => 'Lang', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The language. Default value: zh.', + 'enumValueTitles' => ['en' => 'English.', 'zh' => 'Chinese.'], 'type' => 'string', 'required' => false, - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'."\n", - 'maxLength' => 2560, - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'example' => 'en', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BssResult<BssCostBillBaseResponse<BssCostBillProductResponse>>', - 'description' => 'BssResult', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Successful！'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U', - ], - 'AccountID' => [ - 'description' => '', - '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' => 'The list of pricing entities.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The pricing entity.', 'type' => 'object', 'properties' => [ - 'ConsumePeriod' => [ - 'description' => '', - 'type' => 'string', - 'example' => '202210', - ], - 'AmortizationStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'amortized', - ], - 'AmortizationPeriod' => [ - 'description' => '', - 'type' => 'string', - 'example' => '202210', - ], - 'BillAccountID' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '185xxxxx489', - ], - 'BillAccountName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test@test.aliyunid.com'."\n", - ], - 'BillOwnerID' => [ - 'description' => '', - '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' => '', - ], - 'ProductDetailCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductDetail' => [ - 'description' => '', - 'type' => 'string', + 'PriceEntityCode' => ['description' => 'The code of the pricing entity.', 'type' => 'string', 'example' => 'instance_type', 'title' => ''], + 'PriceEntityName' => ['description' => 'The name of the pricing entity.', 'type' => 'string', 'example' => '云服务器实例', 'title' => ''], + 'PriceFactorList' => [ + 'description' => 'The list of pricing factors for the pricing entity.', + 'type' => 'array', + 'items' => [ + 'description' => 'The pricing factor.', + 'type' => 'object', + 'properties' => [ + 'PriceFactorCode' => ['description' => 'The code of the pricing factor.', 'type' => 'string', 'example' => 'vm_region_no', 'title' => ''], + 'PriceFactorName' => ['description' => 'The name of the pricing factor.', 'type' => 'string', 'example' => '地域', 'title' => ''], + 'PriceFactorValueList' => [ + 'description' => 'The list of pricing factor values.', + 'type' => 'array', + 'items' => ['description' => 'The pricing factor value.', 'type' => 'string', 'example' => 'cn-shiwei-shenshu', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'BizType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'SubscriptionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'PretaxGrossAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'InvoiceDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RoundDownDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PretaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'DeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'ExpenditureAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedInvoiceDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedRoundDownDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedPretaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'PreviouslyAmortizedExpenditureAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationInvoiceDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationRoundDownDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationPretaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'CurrentAmortizationExpenditureAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxGrossAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationInvoiceDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationRoundDownDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationPretaxAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCashCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationDeductedByPrepaidCard' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'RemainingAmortizationExpenditureAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'PreviouslyAmortizedAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'CurrentAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'RemainingAmortizationAfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'double', - ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotActiveService', - 'errorMessage' => 'You are not active Amotized Cost ，please use after activation.', + 'title' => 'List pricing entities of a commodity', + 'description' => 'Queries the pricing entities under a commodity. A pricing entity is the smallest product capability used for metering and cost calculation.', + 'responseParamsDescription' => 'A commodity has one or more pricing entities. Each pricing entity has one or more pricing factors.', + 'changeSet' => [], + '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' => 'All Resource', '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 \\"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"}]', + '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"}]', ], - 'DescribeSplitItemBill' => [ - 'summary' => 'Queries split bills.', - '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', + 'name' => 'QueryTotalCount', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle. Specify the parameter in the YYYY-MM format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], + 'schema' => ['description' => 'Specifies whether to return the total number of products. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of records per page. Maximum value: 300. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The billing method. Valid values: Subscription: the subscription billing method. PayAsYouGo: the pay-as-you-go billing method. This parameter must be used with the ProductCode parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'This API is not applicable for caller.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94858229-2758-4663-A7D0-99490D541F15', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The Alibaba Cloud product information.', + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of product records.', 'type' => 'integer', 'format' => 'int32', 'example' => '449', 'title' => ''], + 'ProductList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => 'The product definition list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '内容分发网络CDN（按量付费）', 'title' => ''], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'example' => 'CDN', 'title' => ''], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + .'- Subscription: subscription.'."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'cdn', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query product information', + 'summary' => 'Queries the list of products available for the current account to order. The response includes the product code, product name, and subscription type (subscription or pay-as-you-go).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryProductList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used for the next query. The parameter must be left empty or set to the value of the NextToken parameter returned in the last call. Otherwise, an error is returned. If the parameter is left empty, the data is queried from the first entry.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAESEgoQCg4KCmd', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryProductList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'QueryRIUtilizationDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to query. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'BillOwnerId', + 'name' => 'RIInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member. If you specify this parameter, the bills of the member are queried. If you do not specify this parameter, the bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the RI. If this parameter is left empty, the usage details of all RIs are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dsudfgdsjh', 'title' => ''], ], [ - 'name' => 'InstanceID', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], + 'schema' => ['description' => 'The instance type of the RI.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instancetyp', 'title' => ''], ], [ - 'name' => 'SplitItemID', + 'name' => 'RICommodityCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the split item.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], + 'schema' => ['description' => 'The code of the service to which the RI is applied. Default value: ecsRi. Valid values:'."\n" + ."\n" + .'* ecsRi: ECS RI.'."\n" + .'* scu_bag: storage capacity unit (SCU).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecsRi', 'title' => ''], ], [ - 'name' => 'Granularity', + 'name' => 'DeductedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The granularity at which bills are queried. Valid values:'."\n" - ."\n" - .'* MONTHLY: queries bills on a monthly basis. The data that you query is the same as the data that is queried by billing cycles in the Split Bill module of the User Center console.'."\n" - .'* DAILY: queries bills on a daily basis. The data that you query is the same as the data that is queried by days in the Split Bill module of the User Center console.'."\n" - ."\n" - .'If you specify DAILY for this parameter, the BillingDate parameter is required.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Monthly', - ], + 'schema' => ['description' => 'The ID of the instance whose fees are deducted by using the RI. If this parameter is left empty, the usage details of all instances are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jsdgfsdhgsdjh', 'title' => ''], ], [ - 'name' => 'BillingDate', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing date. This parameter is required only when the Granularity parameter is set to DAILY. Format: YYYY-MM-DD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-02', - ], + 'schema' => ['description' => 'The time when the RI was created. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00', 'title' => ''], ], [ - 'name' => 'TagFilter', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that are used to filter split bills. You can specify multiple tag values. If you specify multiple tag values, split bills that match one of the tag values are queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about tags that are used to filter split bills'."\n", - 'type' => 'object', - 'properties' => [ - 'TagValues' => [ - 'description' => 'You can specify the TagValues.N parameter to query bills that match the specified tag value. The value of the TagValues.N parameter must be a string. The tag value must be 1 to 128 characters in length. Valid values of N: 1 to 20.'."\n" - ."\n" - .'* If you specify the TagValues.N parameter, the TagFilter.N.TagKey parameter is required. Otherwise, the error message InvalidParameter.TagValues is returned.'."\n" - .'* If you specify multiple tag values, split bills that match one of the tag values are queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about tag keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - 'required' => false, - 'example' => 'TestValue', - 'maxItems' => 20, - ], - 'TagKey' => [ - 'description' => 'The TagFilter.N parameter is used to query bills that match a specified tag. The value of the TagFilter.N parameter must be a key-value pair. The tag key must be 1 to 128 characters in length. Valid values of N: 1 to 20.'."\n" - ."\n" - .'* If only the TagFilter.N.TagKey parameter is specified, all bills associated with the tag key are queried.'."\n" - .'* If you specify multiple tag key-value pairs at the same time, bills that meet any one of the tag key-value pairs are queried.'."\n" - .'* If the tags added to resources change, you can query only the bills that are generated within the period in which the tags and resources are associated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The time when the RI expires. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-23 12:00:00', 'title' => ''], ], [ - 'name' => 'IsHideZeroCharge', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to filter bills if both the pretax gross amount and pretax amount are 0. Valid values:'."\n" - ."\n" - .'* false: does not filter bills.'."\n" - .'* true: filters bills.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'false', - ], + 'schema' => ['description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PipCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service. The code is the same as that in Cost Center.', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -14841,431 +10290,135 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token used for the next query. If this parameter is empty, all the results are returned. When you perform the next query, you must set the NextToken parameter to this value.'."\n", - 'type' => 'string', - 'example' => 'CAESEgoQCg4K', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle. Format: YYYY-MM.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185xxxx3489', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'AccountName' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ - 'description' => 'The details of the bill.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SplitAccountID' => [ - 'description' => 'The ID of the account to which the split bill belongs.'."\n", - 'type' => 'string', - 'example' => '12**122', - ], - 'BillAccountName' => [ - 'description' => 'The name of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values: Subscription: the subscription billing method. PayAsYouGo: the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'InstanceSpec' => [ - 'description' => 'The type of the instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.sn1ne.3xlarge', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted with coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou)'."\n", - ], - 'PipCode' => [ - 'description' => 'The code of the service. The code is the same as that displayed in the Split Bill module of the User Center console.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity. The code is the same as that displayed in the Split Bill module of the User Center console.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'NickName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'nick', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'Usage' => [ - 'description' => 'The amount of resource usage.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'IntranetIP' => [ - 'description' => 'The private IP address.'."\n", - 'type' => 'string', - 'example' => '192.xx.xx.xx', - ], - 'UsageUnit' => [ - 'description' => 'The unit of usage.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'SplitCommodityCode' => [ - 'description' => 'The code of the split item.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'BillAccountID' => [ - 'description' => 'The ID of the account to which the bill belongs.'."\n", - 'type' => 'string', - 'example' => '185xxxx3489', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'DeductedByResourcePackage' => [ - 'description' => 'The amount deducted with resource plans.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'SplitBillingCycle' => [ - 'description' => 'The billing cycle in which the bill is split.'."\n", - 'type' => 'string', - 'example' => '2021-06', - ], - 'ServicePeriod' => [ - 'description' => 'The duration of the service.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'SplitItemName' => [ - 'description' => 'The name of the split item.'."\n", - 'type' => 'string', - 'example' => 'iZ28bycvyb4Z', - ], - 'ListPrice' => [ - 'description' => 'The unit price.'."\n", - 'type' => 'string', - 'example' => '0.12', - ], - 'Zone' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'Qingdao Zone B'."\n", - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'InstanceConfig' => [ - 'description' => 'The configurations of the instance.'."\n", - 'type' => 'string', - 'example' => 'CPU:12', - ], - 'BillingDate' => [ - 'description' => 'The billing date. Format: YYYY-MM-DD. This parameter is not supported.'."\n", - 'type' => 'string', - 'example' => '2020-01-20', - ], - 'InternetIP' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '34.xx.x.x', - ], - 'Item' => [ - 'description' => 'The type of the bill. Valid values: SubscriptionOrder: the subscription bill. PayAsYouGoBill: the pay-as-you-go bill. Refund: the refund. Adjustment: the adjustment bill.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGoBill', - ], - 'SplitItemID' => [ - 'description' => 'The ID of the split item.'."\n", - 'type' => 'string', - 'example' => 'i-28bycvyb4', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], - 'Tag' => [ - 'description' => 'The tag of the resource. If tags added to resources change, the bills generated during the period in which resources and tags are associated are returned.'."\n", - 'type' => 'string', - 'example' => 'key:testKey value:testValue; key:testKey1 value:testValues1', - ], - 'Currency' => [ - 'description' => 'The type of currency. Valid values: CNY, USD, and JPY.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'BizType' => [ - 'description' => 'The type of the business.'."\n", - 'type' => 'string', - 'example' => 'trusteeship', - ], - 'BillingItem' => [ - 'description' => 'The billable item.'."\n", - 'type' => 'string', - 'example' => 'Bandwidth'."\n", - ], - 'BillingItemCode' => [ - 'description' => 'The code of the billable item.'."\n", - 'type' => 'string', - 'example' => 'disk', - ], - 'CostUnit' => [ - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'ListPriceUnit' => [ - 'description' => 'The unit of the unit price.'."\n", - 'type' => 'string', - 'example' => 'CNY/GB'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Default resource group'."\n", - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ServicePeriodUnit' => [ - 'description' => 'The unit of the service duration.'."\n", - 'type' => 'string', - 'example' => 'Hour'."\n", - ], - 'SplitBillingDate' => [ - 'description' => 'The day on which the bill is split.'."\n", - 'type' => 'string', - 'example' => '2021-06-01', - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'SplitProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'OwnerID' => [ - 'description' => 'The ID of the account that owns the resource. This parameter is returned in multi-account scenario.'."\n", - 'type' => 'string', - 'example' => '169***013', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SplitAccountName' => [ - 'description' => 'The name of the account to which the split item belongs.'."\n", - 'type' => 'string', - 'example' => 'test**1122', - ], - 'BillingType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ItemName' => [ - 'description' => 'The name of the split item.'."\n", - 'type' => 'string', - 'example' => 'iZ28bycvyb4Z', - ], - 'AfterDiscountAmount' => [ - 'type' => 'number', - 'format' => 'float', + 'PageNum' => ['description' => 'The number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DetailList' => [ + 'description' => 'The usage details of the RI.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeductedCommodityCode' => ['description' => 'The code of the service whose fees are deducted by using the RI.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'DeductedProductDetail' => ['description' => 'The name of the service whose fees are deducted by using the RI.'."\n", 'type' => 'string', 'example' => 'ApsaraDB RDS'."\n", 'title' => ''], + 'DeductedInstanceId' => ['description' => 'The ID of the instance whose fees are deducted by using the RI.'."\n", 'type' => 'string', 'example' => 'safdffghfgh', 'title' => ''], + 'DeductFactorTotal' => ['description' => 'The total amount of computing power of the RI or capacity of SCU in the time period.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'DeductQuantity' => ['description' => 'The computing power or capacity of the pay-as-you-go instance whose fees are deducted by using the RI.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'DeductHours' => ['description' => 'The deduct factor. This parameter is returned only if the RICommodityCode parameter is set to ecsRi.', 'type' => 'string', 'example' => '24', 'title' => ''], + 'DeductDate' => ['description' => 'The time when the fees are deducted by using the RI.'."\n", 'type' => 'string', 'example' => '2019-05-23 12:00:00', 'title' => ''], + 'RIInstanceId' => ['description' => 'The ID of the RI.'."\n", 'type' => 'string', 'example' => '324253645', 'title' => ''], + 'InstanceSpec' => ['description' => 'The instance type of the instance whose fees are deducted by using the RI.'."\n", 'type' => 'string', 'example' => 'rds.mysql.s3.large', 'title' => ''], + ], + 'description' => '', + 'title' => '', ], + 'title' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], 'description' => '', + '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\\": \\"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":"<DescribeSplitItemBillResponse>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n <RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n <Success>true</Success>\\n <Data>\\n <NextToken>CAESEgoQCg4K</NextToken>\\n <BillingCycle>2020-03</BillingCycle>\\n <MaxResults>20</MaxResults>\\n <AccountID>185xxxx3489</AccountID>\\n <TotalCount>20</TotalCount>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n <Items>\\n <SplitAccountID>12**122</SplitAccountID>\\n <BillAccountName>test@test.aliyunid.com</BillAccountName>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceSpec>ecs.sn1ne.3xlarge</InstanceSpec>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <Region>杭州</Region>\\n <OutstandingAmount>0.1</OutstandingAmount>\\n <PipCode>rds</PipCode>\\n <CommodityCode>rds</CommodityCode>\\n <NickName>nick</NickName>\\n <ProductDetail>云数据库RDS</ProductDetail>\\n <Usage>100</Usage>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <UsageUnit>GB</UsageUnit>\\n <SplitCommodityCode>rds</SplitCommodityCode>\\n <BillAccountID>185xxxx3489</BillAccountID>\\n <ProductType>rds</ProductType>\\n <DeductedByResourcePackage>0</DeductedByResourcePackage>\\n <PaymentAmount>0</PaymentAmount>\\n <SplitBillingCycle>2021-06</SplitBillingCycle>\\n <ServicePeriod>20</ServicePeriod>\\n <SplitItemName>iZ28bycvyb4Z</SplitItemName>\\n <ListPrice>0.12</ListPrice>\\n <Zone>华北1</Zone>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <CashAmount>0</CashAmount>\\n <InstanceConfig>CPU:12</InstanceConfig>\\n <BillingDate>2020-01-20</BillingDate>\\n <InternetIP>34.xx.x.x</InternetIP>\\n <Item>PayAsYouGoBill</Item>\\n <SplitItemID>i-28bycvyb4</SplitItemID>\\n <InstanceID>i-kjhdskjgshfdlkjfdh</InstanceID>\\n <Tag>key:testKey value:testValue; key:testKey1 value:testValues1</Tag>\\n <Currency>CNY</Currency>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <BizType>trusteeship</BizType>\\n <BillingItem>带宽</BillingItem>\\n <BillingItemCode>disk</BillingItemCode>\\n <CostUnit>未分配</CostUnit>\\n <ListPriceUnit>元/GB</ListPriceUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <PretaxAmount>0</PretaxAmount>\\n <ServicePeriodUnit>小时</ServicePeriodUnit>\\n <SplitBillingDate>2021-06-01</SplitBillingDate>\\n <ProductName>云数据库RDS</ProductName>\\n <SplitProductDetail>云数据库</SplitProductDetail>\\n <AdjustAmount>0</AdjustAmount>\\n <OwnerID>169***013</OwnerID>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SplitAccountName>test**1122</SplitAccountName>\\n <BillingType>其它</BillingType>\\n <ProductCode>rds</ProductCode>\\n <ItemName>iZ28bycvyb4Z</ItemName>\\n </Items>\\n </Data>\\n</DescribeSplitItemBillResponse>","errorExample":""}]', - 'title' => 'DescribeSplitItemBill', - 'description' => '* The data that you query by calling this operation is the same as the data that is queried by billing cycles in the Split Bill module of Cost Allocation.'."\n" - .'* You can query split bills that were generated within the last 12 months by calling this operation.'."\n" - .'* You can query split bills only after you enable the [Split Bill](https://usercenter2-intl.aliyun.com/finance/split-bill) service in the User Center console.', + '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' => 'Invalid user identity.'], + ['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\\": \\"ApsaraDB RDS\\\\n\\",\\n \\"DeductedInstanceId\\": \\"safdffghfgh\\",\\n \\"DeductFactorTotal\\": 1,\\n \\"DeductQuantity\\": 1,\\n \\"DeductHours\\": \\"24\\",\\n \\"DeductDate\\": \\"2019-05-23 12:00:00\\",\\n \\"RIInstanceId\\": \\"324253645\\",\\n \\"InstanceSpec\\": \\"rds.mysql.s3.large\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRIUtilizationDetailResponse>\\n <RequestId>DF58589C-A06C-4224-8615-7797E6474FA3</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <DetailList>\\n </DetailList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRIUtilizationDetailResponse>","errorExample":""}]', + 'title' => 'QueryRIUtilizationDetail', + 'summary' => 'Queries the usage details of a reserved instance (RI).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QuerySplitItemBill' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryRIUtilizationDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryRiUtilizationDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRedeem' => [ + 'summary' => 'Queries the information about a voucher.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BillingCycle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-03', - ], - ], - [ - 'name' => 'ProductCode', + 'name' => 'ExpiryTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The start time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2018-08-01T00:00:00Z', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'ExpiryTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The end time when the redemption coupon expires. The value must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2018-08-01T00:00:00Z', 'title' => ''], ], [ - 'name' => 'SubscriptionType', + 'name' => 'EffectiveOrNot', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go This parameter must be used together with the ProductCode parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PayAsYouGo', - ], + 'schema' => ['description' => 'Specifies whether the redemption coupon takes effect. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'BillOwnerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the member. If you specify a value for this parameter, you can query the split bills of the specified member. If you leave this parameter empty, the split bills of the current account are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -15273,319 +10426,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BillingCycle' => [ - 'description' => 'The billing cycle, in the YYYY-MM format.'."\n", - 'type' => 'string', - 'example' => '2020-03', - ], - 'AccountID' => [ - 'description' => 'The ID of the account.'."\n", - 'type' => 'string', - 'example' => '185xxxx3489', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page. Default value: 20. Maximum value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AccountName' => [ - 'description' => 'The name of the account.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyunid.com', - ], - 'Items' => [ + 'PageNum' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Redeem' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Item' => [ - 'description' => 'The details of the bills.'."\n", + 'Redeem' => [ + 'description' => 'The details of the redemption coupon.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SplitAccountID' => [ - 'description' => 'The ID of the account to which the split bill belongs.'."\n", - 'type' => 'string', - 'example' => '122', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go This parameter is returned together with the ProductCode parameter.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'InstanceSpec' => [ - 'description' => 'The instance type of the instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.sn1ne.3xlarge', - ], - 'DeductedByCoupons' => [ - 'description' => 'The amount deducted by using coupons.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'PipCode' => [ - 'description' => 'The code of the service. The service code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'CommodityCode' => [ - 'description' => 'The code of the commodity. The commodity code is the same as that displayed in User Center.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'NickName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProductDetail' => [ - 'description' => 'The details of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'Usage' => [ - 'description' => 'The usage of the split item. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'IntranetIP' => [ - 'description' => 'The private IP address.'."\n", - 'type' => 'string', - 'example' => '192.xx.xx.xx', - ], - 'UsageUnit' => [ - 'description' => 'The unit of usage. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'SplitCommodityCode' => [ - 'description' => 'The commodity code of the split item.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'DeductedByResourcePackage' => [ - 'description' => 'The amount deducted by using resource plans.'."\n", - 'type' => 'string', - 'example' => 'NULL', - ], - 'SplitBillingCycle' => [ - 'description' => 'The month in which the split item is used.'."\n", - 'type' => 'string', - 'example' => '2020-06', - ], - 'ServicePeriod' => [ - 'description' => 'The validity period.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'SplitItemName' => [ - 'description' => 'The name of the split item.'."\n", - 'type' => 'string', - 'example' => 'iZ28bycvyb4Z', - ], - 'ListPrice' => [ - 'description' => 'The unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'Zone' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'InstanceConfig' => [ - 'description' => 'The configurations of the instance.'."\n", - 'type' => 'string', - 'example' => 'CPU:12', - ], - 'BillingDate' => [ - 'description' => 'The billing date, in the YYYY-MM-DD format.'."\n", - 'type' => 'string', - 'example' => '2020-01-20', - ], - 'InternetIP' => [ - 'description' => 'The public IP address.'."\n", - 'type' => 'string', - 'example' => '34.xx.x.x', - ], - 'Item' => [ - 'description' => 'The type of the bill. Valid values: SubscriptionOrder: subscription order PayAsYouGoBill: pay-as-you-go bill Refund: refund Adjustment: reconciliation'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGoBill', - ], - 'SplitItemID' => [ - 'description' => 'The ID of the split item.'."\n", - 'type' => 'string', - 'example' => 'i-28bycvyb4', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-kjhdskjgshfdlkjfdh', - ], - 'Tag' => [ - 'description' => 'The tag.'."\n", - 'type' => 'string', - 'example' => 'tag', - ], - 'Currency' => [ - 'description' => 'The type of the currency. Valid values: CNY, USD, and JPY.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'BillingItem' => [ - 'description' => 'The billable item.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], - 'CostUnit' => [ - 'description' => 'The cost center.'."\n", - 'type' => 'string', - 'example' => 'Not allocated'."\n", - ], - 'ListPriceUnit' => [ - 'description' => 'The unit of the unit price. This parameter is returned only if the isBillingItem parameter is set to true.'."\n", - 'type' => 'string', - 'example' => 'CNY'."\n", - ], - 'ResourceGroup' => [ - 'description' => 'The resource group.'."\n", - 'type' => 'string', - 'example' => 'Default resource group'."\n", - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ServicePeriodUnit' => [ - 'description' => 'The unit of the validity period.'."\n", - 'type' => 'string', - 'example' => 'Seconds'."\n", - ], - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB RDS'."\n", - ], - 'SplitProductDetail' => [ - 'description' => 'The name of the service to which the split item belongs.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'OwnerID' => [ - 'description' => 'The ID of the member. This parameter is returned in a multi-account payment scenario.'."\n", - 'type' => 'string', - 'example' => '169***013', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SplitAccountName' => [ - 'description' => 'The name of the account to which the split item belongs.'."\n", - 'type' => 'string', - 'example' => '12@test.com', - ], - 'BillingType' => [ - 'description' => 'The billing type.'."\n", - 'type' => 'string', - 'example' => 'Other'."\n", - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], + 'ExpiryTime' => ['description' => 'The time when the redemption coupon expired.'."\n", 'type' => 'string', 'example' => '2018-06-13 20:25:00', 'title' => ''], + 'GrantedTime' => ['description' => 'The time when the redemption coupon was issued.'."\n", 'type' => 'string', 'example' => '2018-05-14 20:25:00', 'title' => ''], + 'Status' => ['description' => 'The status of the redemption coupon. Valid values:'."\n" + ."\n" + .'* Generated'."\n" + .'* CallBack'."\n" + .'* RefundPending'."\n" + .'* Canceled'."\n" + .'* Order_Canceled'."\n" + .'* ActivePending'."\n" + .'* ActiveSuccess'."\n" + .'* ExchangePending'."\n" + .'* ExchangeSuccess'."\n" + .'* Expired'."\n", 'type' => 'string', 'example' => 'Generated', 'title' => ''], + 'Specification' => ['description' => 'The specifications of the redemption coupon.'."\n", 'type' => 'string', 'example' => 'N/A'."\n", 'title' => ''], + 'NominalValue' => ['description' => 'The nominal value of the redemption coupon.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'EffectiveTime' => ['description' => 'The time when the redemption coupon took effect.'."\n", 'type' => 'string', 'example' => '2018-05-14 20:25:00', 'title' => ''], + 'RedeemId' => ['description' => 'The ID of the redemption coupon.'."\n", 'type' => 'string', 'example' => '1342', 'title' => ''], + 'RedeemNo' => ['description' => 'The number of the redemption coupon.'."\n", 'type' => 'string', 'example' => '4889*****1610', 'title' => ''], + 'ApplicableProducts' => ['description' => 'The services to which the redemption coupon is applicable.'."\n", 'type' => 'string', 'example' => 'Elastic Compute Service (ECS)'."\n", 'title' => ''], + 'Balance' => ['description' => 'The balance of the redemption coupon.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], ], - '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":"<RequestId>79EE7556-0CFD-44EB-9CD6-B3B526E3A85F</RequestId>\\n<Message>Successful!</Message>\\n<Data>\\n <BillingCycle>2020-03</BillingCycle>\\n <TotalCount>2</TotalCount>\\n <AccountID>185xxxx3489</AccountID>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Items>\\n <Item>\\n <InstanceSpec>ecs.sn1ne.3xlarge</InstanceSpec>\\n <ProductName>云数据库RDS</ProductName>\\n <InstanceID>i-kjhdskjgshfdlkjfdh</InstanceID>\\n <DeductedByCashCoupons>0</DeductedByCashCoupons>\\n <ListPriceUnit>元</ListPriceUnit>\\n <BillingDate/>\\n <ListPrice>100</ListPrice>\\n <PaymentAmount>0</PaymentAmount>\\n <DeductedByPrepaidCard>0</DeductedByPrepaidCard>\\n <InvoiceDiscount>0</InvoiceDiscount>\\n <SplitItemName>iZ28bycvyb4Z</SplitItemName>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <Item>PayAsYouGoBill</Item>\\n <PretaxGrossAmount>0</PretaxGrossAmount>\\n <InstanceConfig>CPU:12</InstanceConfig>\\n <Currency>CNY</Currency>\\n <CostUnit>未分配</CostUnit>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <BillingType>其它</BillingType>\\n <Usage>100</Usage>\\n <DeductedByCoupons>0</DeductedByCoupons>\\n <ProductDetail>云数据库RDS</ProductDetail>\\n <ProductCode>rds</ProductCode>\\n <Zone>cn-hangzhou-h</Zone>\\n <ProductType>rds</ProductType>\\n <OutstandingAmount>0</OutstandingAmount>\\n <BillingItem>其他</BillingItem>\\n <NickName>test</NickName>\\n <IntranetIP>192.xx.xx.xx</IntranetIP>\\n <ServicePeriod>10</ServicePeriod>\\n <SplitItemID>i-28bycvyb4</SplitItemID>\\n <DeductedByResourcePackage>NULL</DeductedByResourcePackage>\\n <UsageUnit>GB</UsageUnit>\\n <OwnerID>169***013</OwnerID>\\n <PretaxAmount>0</PretaxAmount>\\n <InternetIP>34.xx.x.x</InternetIP>\\n <Region>cn-hangzhou</Region>\\n <Tag>tag</Tag>\\n </Item>\\n </Items>\\n <AccountName>test@test.aliyunid.com</AccountName>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'summary' => 'Queries split bills.', - 'description' => '* This API operation has been upgraded to DescribeSplitItemBill. We recommend that you call the [DescribeSplitItemBill](~~208169~~) operation to query split bills. You can call the QuerySplitItemBill operation to query a maximum of 50,000 data rows in a bill.'."\n" - .'* The data queried by calling the QuerySplitItemBill operation is consistent with the data that is displayed for the specified billing cycle on the Split Bill page in User Center.'."\n" - .'* You can call this operation to query split bills generated within the last 12 months.'."\n" - .'* This operation returns split bills only after you activate the [Split Bill](https://usercenter2.aliyun.com/finance/split-bill) service in User Center.'."\n", + '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/A\\\\n\\",\\n \\"NominalValue\\": \\"0\\",\\n \\"EffectiveTime\\": \\"2018-05-14 20:25:00\\",\\n \\"RedeemId\\": \\"1342\\",\\n \\"RedeemNo\\": \\"4889*****1610\\",\\n \\"ApplicableProducts\\": \\"Elastic Compute Service (ECS)\\\\n\\",\\n \\"Balance\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRedeemResponse>\\n <Message>Successful!</Message>\\n <RequestId>E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNum>1</PageNum>\\n <Redeem>\\n </Redeem>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryRedeemResponse>","errorExample":""}]', + 'title' => 'QueryRedeem', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InquiryPriceRefundInstance' => [ - 'summary' => 'Queries the refundable amount for an instance from which you want to unsubscribe.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2023-08-08T08:23:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-08T03:58:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRedeem'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRedeem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRelationList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15593,625 +10535,344 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'description' => 'This parameter is required for scenarios that need idempotence. The UUID that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '793F021C-B589-1225-82A9-99232AEBE494', - ], + 'schema' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1990699401005016'], ], [ - 'name' => 'ProductCode', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => 'The code of the service. This parameter is required for unsubscription scenarios.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => 'instanceId', - 'description' => 'The ID of the instance. This parameter is required for unsubscription scenarios.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1etb69sqxgl4*******', - ], + 'schema' => ['description' => 'The number of entries per page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ - 'name' => 'ProductType', + 'name' => 'StatusList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'productType', - 'description' => 'The type of the service. This parameter is required for unsubscription scenarios. Unless otherwise specified, set this parameter to an empty string.'."\n", - 'type' => 'string', + 'description' => 'A list of relationship statuses. The value is an enumeration of RelationshipStatusEnum. If you do not specify this parameter, only relationships that are in effect are queried.', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => 'RELATED'], 'required' => false, - 'example' => '”“', + 'example' => 'RELATED', + 'maxItems' => 8, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => 'The result of the request.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => 'The description of the execution result.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'UUID', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '7FC5D662-37FD-40A6-85B1-33442D815184'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'title' => 'data', - 'description' => 'data'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'title' => 'hostId', - 'description' => 'The site of the execution host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'InstanceId' => [ - 'title' => 'instanceId', - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-bp1etb69sqxgl4*******', - ], - 'Currency' => [ - 'title' => 'currency', - 'description' => 'The currency.'."\n", - 'type' => 'string', - 'example' => 'CNY. CNY: Chinese Yuan. USD: United States dollar. JPY: Japanese Yen.', - ], - 'RefundAmount' => [ - 'title' => 'refundAmount', - 'description' => 'The refundable amount.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '12.34', + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'FinancialRelationInfoList' => [ + 'description' => 'The list of relationships.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The time when the relationship expires. If this parameter is empty, the relationship does not expire.', 'type' => 'string', 'title' => '', 'example' => '2021-03-08T15:12Z'], + 'RelationType' => ['description' => 'The relationship type. `FinancialManagement` indicates Financial Management and `FinancialTrusteeship` indicates finance trusteeship.', 'type' => 'string', 'title' => '', 'example' => 'FinancialManagement'], + 'AccountNickName' => ['description' => 'The display name of the account.', 'type' => 'string', 'title' => '', 'example' => 'test4'], + 'StartTime' => ['description' => 'The time when the relationship takes effect. The time is in UTC and follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => '2021-03-02T15:12Z'], + 'State' => ['description' => 'The status of the relationship. The value is an enumeration of RelationshipStatusEnum.', 'type' => 'string', 'title' => '', 'example' => 'RELATED'], + 'AccountId' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1851253838840762'], + 'SetupTime' => ['description' => 'The time when the relationship was established. The time is in UTC and follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'title' => '', 'example' => '2021-03-02T15:12Z'], + 'AccountType' => ['description' => 'The type of the financial account. Valid values: MASTER and MEMBER.', 'type' => 'string', 'title' => '', 'example' => 'MEMBER'], + 'AccountName' => ['description' => 'The logon name of the Alibaba Cloud account.', 'type' => 'string', 'title' => '', 'example' => 'caiwuyun_test4'], + 'RelationId' => ['description' => 'The relationship ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '51463'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => 'System exception, please try again'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\",\\n \\"InstanceId\\": \\"i-bp1etb69sqxgl4*******\\",\\n \\"Currency\\": \\"退款金额本币币种： CNY：人民币。 USD：美元。 JPY：日元。\\",\\n \\"RefundAmount\\": 12.34\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'InquiryPriceRefundInstance', - 'description' => '1. **Check the information about unsubscription and confirm the unsubscription terms and refundable amount. The resource that is unsubscribed cannot be restored.**'."\n" - .'2. Refunds are applicable only for the actual paid amount. Vouchers used for the purchase are non-refundable.'."\n" - .'3. For more information, see [Rules for unsubscribing from resources](https://www.alibabacloud.com/help/en/user-center/user-guide/refund-rules).', - 'extraInfo' => '**Error codes that are returned if a request is blocked**'."\n" + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryRelationList', + 'summary' => 'Queries a list of the relationships of member accounts.', + 'requestParamsDescription' => 'Definition of the RelationshipStatusEnum type:'."\n" ."\n" - .'* ResourceNotExists: The instance does not exist.'."\n" - .'* ResourceStatusError: The instance is not in the expected state.'."\n" - .'* BindMirrorInstanceError: The ECS instance is bound to a paid image.'."\n" - .'* ExceedRefundQuotaError: The number of times that you unsubscribe from the instance exceeds the quota.'."\n" - .'* ExistUnPaidOrderError: An order that is not paid exists in the instance.'."\n" - .'* ExistRefundingOrderError: The ID of the instance is invalid because the instance expires, the instance is released, or the instance is refunded.'."\n" - .'* NoRestValueError: The refundable amount is 0.'."\n" - .'* AmbassadorOrderLimitError: The instance has an ambassador order that may raise risks.'."\n" - .'* ActivityForbiddenError: You cannot request a refund for an instance that is purchased during the marketing campaigns.'."\n" - .'* ProductCheckError: The instance does not pass the precheck.'."\n", - ], - 'GetPayAsYouGoPrice' => [ - 'methods' => [ - 'post', - 'get', + .'| **Value** | **Description** | **Notes** |'."\n" + .'| -------------------------- | --------------------------- | ---------------------------------- |'."\n" + .'| INITIAL | Initialized | The relationship is not in effect. |'."\n" + .'| CONFIRMING | Invitated | The relationship is not in effect. |'."\n" + .'| REJECTED | Rejected | The relationship is not in effect. |'."\n" + .'| CONNECTION\\_CANCELED | Terminated | The relationship is not in effect. |'."\n" + .'| RELATED | Linked | The relationship is in effect. |'."\n" + .'| CHANGE\\_CONFIRMING | Change confirmation pending | The relationship is in effect. |'."\n" + .'| CONNECTION\\_MASTER\\_CANCEL | Confirmation canceled | The relationship is not in effect. |', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryResellerAvailableQuota' => [ + 'summary' => 'Queries the available quota for a user in a reseller payment scenario.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'ItemCodes', 'in' => 'query', + 'schema' => ['description' => 'You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '无'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code returned if the call fails. See the "Error codes" section of this topic.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => [ + 'description' => 'Additional information about the result.', + 'type' => 'string', + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'Successful!', + ], + 'Data' => ['description' => 'The available quota balance of the user.', 'type' => 'string', 'title' => '', 'example' => '300'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of `true` indicates that the call was successful. A value of `false` indicates that the call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'QueryResellerAvailableQuota', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerAvailableQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryResellerAvailableQuota'], + ], + ], + ], + 'QueryResellerUserAlarmThreshold' => [ + 'summary' => ' ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Set the value to PayAsYouGo.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PayAsYouGo', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'AlarmType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", + 'title' => '', + 'description' => 'The type of alert. This parameter is required. Set the value to quota\\_low\\_balance, which indicates a low quota alert.', 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ModuleList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details of pricing modules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The pricing modules.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModuleCode' => [ - 'description' => 'The code of the Nth pricing module.'."\n" - ."\n" - .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the module code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'InstanceType', - ], - 'PriceType' => [ - 'description' => 'The price type of the Nth pricing module. Valid values:'."\n" - ."\n" - .'* Hour: hourly price'."\n" - .'* Usage: usage price'."\n" - .'* Month: monthly price'."\n" - .'* Year: annual price'."\n" - ."\n" - .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the configuration parameters of the pricing module.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hour', - ], - 'Config' => [ - 'description' => 'The configuration of the Nth pricing module. Valid values of N: 1 to 50. Format: AA:aa,BB:bb. The values of AA and BB are the property IDs of the pricing module. The values of aa and bb are the property values of the pricing module.'."\n" - ."\n" - .'> You can call the [DescribePricingModule](~~96469~~) operation to obtain the configuration parameters of the pricing module.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'InstanceType:ecs.g5.xlarge,IoOptimized:IoOptimized,ImageOs:linux', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 50, + 'enumValueTitles' => ['quota_low_balance' => 'quota_low_balance'], + 'example' => 'quota_low_balance', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'ListResult<AlarmThresholdPop>', + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1537A007-72D7-4165-8A26-8694A38E219A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Currency' => [ - 'description' => 'The type of the currency. Valid values:'."\n" - ."\n" - .'* CNY: Chinese Yuan'."\n" - .'* USD: US dollar'."\n" - .'* JPY: Japanese Yen'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ModuleDetails' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ModuleDetail' => [ - 'description' => 'The price details of the pricing module.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The price details of the pricing module.'."\n", - 'type' => 'object', - 'properties' => [ - 'CostAfterDiscount' => [ - 'description' => 'The discount price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount that was applied.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'UnitPrice' => [ - 'description' => 'The unit price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'OriginalCost' => [ - 'description' => 'The original price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1.77', - ], - 'ModuleCode' => [ - 'description' => 'The code of the pricing module.'."\n", - 'type' => 'string', - 'example' => 'InstanceType', - ], - ], - ], - ], - ], - ], - 'PromotionDetails' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PromotionDetail' => [ - 'description' => 'The details of the discount.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the discount.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromotionDesc' => [ - 'description' => 'The description of the discount.'."\n", - 'type' => 'string', - 'example' => 'This discount allows you to use a service at the minimum price and is provided for testing purposes only.'."\n", - ], - 'PromotionId' => [ - 'description' => 'The ID of the discount.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10200210', - ], - 'PromotionName' => [ - 'description' => 'The name of the discount.'."\n", - 'type' => 'string', - 'example' => 'This discount allows you to use a service at the minimum price and is provided for testing purposes only.'."\n", - ], - ], - ], - ], - ], + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ThresholdType' => ['title' => '', 'description' => 'The type of the alert threshold. Valid values: 0 (amount) and 1 (percentage).', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ThresholdAmount' => ['title' => '', 'description' => 'The alert threshold in amount. This parameter is valid only when ThresholdType is set to 0.', 'type' => 'string', 'example' => '100'], + 'Numerator' => ['title' => '', 'description' => 'The numerator of the alert percentage. This parameter is valid only when ThresholdType is set to 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Denominator' => ['title' => '', 'description' => 'The denominator of the alert percentage. This parameter is valid only when ThresholdType is set to 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Count' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['title' => '', 'description' => 'The status code of the request. If the call fails, an error code is returned.', 'type' => 'string', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The message returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"1537A007-72D7-4165-8A26-8694A38E219A\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"ModuleDetails\\": {\\n \\"ModuleDetail\\": [\\n {\\n \\"CostAfterDiscount\\": 100,\\n \\"InvoiceDiscount\\": 20,\\n \\"UnitPrice\\": 0,\\n \\"OriginalCost\\": 1.77,\\n \\"ModuleCode\\": \\"InstanceType\\"\\n }\\n ]\\n },\\n \\"PromotionDetails\\": {\\n \\"PromotionDetail\\": [\\n {\\n \\"PromotionDesc\\": \\"仅提供测试使用的1分钱活动\\",\\n \\"PromotionId\\": 10200210,\\n \\"PromotionName\\": \\"仅提供测试使用的1分钱活动\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPayAsYouGoPriceResponse>\\n <Message>Successful!</Message>\\n <RequestId>1537A007-72D7-4165-8A26-8694A38E219A</RequestId>\\n <Data>\\n <Currency>CNY</Currency>\\n <ModuleDetails>\\n <ModuleDetail>\\n <UnitPrice>0</UnitPrice>\\n <ModuleCode>InstanceType</ModuleCode>\\n <CostAfterDiscount>0.01</CostAfterDiscount>\\n <OriginalCost>1.77</OriginalCost>\\n <InvoiceDiscount>1.76</InvoiceDiscount>\\n </ModuleDetail>\\n </ModuleDetails>\\n <PromotionDetails>\\n <PromotionDetail>\\n <PromotionName>仅提供测试使用的1分钱活动</PromotionName>\\n <PromotionId>10200210</PromotionId>\\n </PromotionDetail>\\n </PromotionDetails>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</GetPayAsYouGoPriceResponse>","errorExample":""}]', - 'summary' => 'Queries the pay-as-you-go price of an Alibaba Cloud service.', - 'description' => '### Usage notes'."\n" - ."\n" - .'1. Call the QueryProductList operation to obtain the code of the service. For more information, see [QueryProductList](~~95984~~).'."\n" - .'2. Call the DescribePricingModule operation to obtain the configuration parameters of the service. For more information, see [DescribePricingModule](~~96469~~).'."\n" - .'3. Call the GetPayAsYouGoPrice operation to obtain the pay-as-you-go price of the service based on the returned configuration parameters.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetSubscriptionPrice' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'QueryResellerUserAlarmThreshold', + 'description' => 'Queries the alarm thresholds for low quotas.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryResourcePackageInstances' => [ + 'summary' => 'Queries the instances of a resource plan. You can query the resource plans that are valid.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ServicePeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the service duration. Valid values:'."\n" - ."\n" - .'* Year'."\n" - .'* Month'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Year', - ], - ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Set the value to Subscription.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], - ], - [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service. For more information about the service code, see **Codes of Alibaba Cloud Services**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'OrderType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the order. Valid values:'."\n" - ."\n" - .'* NewOrder: purchases an instance of an Alibaba Cloud service.'."\n" - .'* Renewal: renews an instance of an Alibaba Cloud service.'."\n" - .'* Upgrade: upgrades an instance of an Alibaba Cloud service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NewOrder', - ], - ], - [ - 'name' => 'ServicePeriodQuantity', + 'name' => 'ExpiryTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The service duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The beginning of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-02T12:00:00Z', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'ExpiryTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service. Specify the parameter based on the pricing document of the specific service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The end of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-02T13:00:00Z', 'title' => ''], ], [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance for which the price is queried. This parameter is required if you upgrade an instance. You can specify this parameter to obtain the pre-upgrade configurations of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-khkjhxxxxxxxxx', - ], + 'schema' => ['description' => 'The number of the page to return. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Quantity', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The quantity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'ModuleList', + 'name' => 'IncludePartner', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the pricing module.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModuleStatus' => [ - 'description' => 'The status of the pricing module. This parameter is required only if the order type is Upgrade. Valid values:'."\n" - ."\n" - .'* 1: adds one or more instances.'."\n" - .'* 2: modifies the configurations of an instance. In the upgrade scenario, if the configurations of the pricing module change, you must specify this value for the parameter.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'ModuleCode' => [ - 'description' => 'The identifier of the Nth pricing module.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PackageCode', - ], - 'Tag' => [ - 'description' => 'The tag of the specified resource. This parameter is required only if you upgrade or modify the configurations of an Alibaba Cloud service. For example, if you want to modify the configurations of a disk, you can use a tag to identify the ID of the disk.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '213213123', - ], - 'Config' => [ - 'description' => 'The configurations of the Nth pricing module. Valid values of N: 1 to 50. Format: AA:aa,BB:bb. The values of AA and BB are the property IDs of the pricing module. The values of aa and bb are the property values of the pricing module.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PackageCode:version_1', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'Specifies whether partners are involved.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -16219,162 +10880,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'InvalidConfigCod', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '30E7066E-AE6F-4E59-AFE6-11386CE3AFA7', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Page' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ - 'description' => 'The information about the service price.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'OriginalPrice' => [ - 'description' => 'The original price of the service.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '900', - ], - 'DiscountPrice' => [ - 'description' => 'The discount that was applied.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'Currency' => [ - 'description' => 'The type of currency. Valid values:'."\n" - ."\n" - .'* CNY: Chinese Yuan'."\n" - .'* USD: US dollar'."\n" - .'* JPY: Japanese Yen'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'Quantity' => [ - 'description' => 'The quantity.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TradePrice' => [ - 'description' => 'The discount price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ModuleDetails' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ModuleDetail' => [ - 'description' => 'The price details of the pricing module.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CostAfterDiscount' => [ - 'description' => 'The discount price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'InvoiceDiscount' => [ - 'description' => 'The discount that was applied.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'UnitPrice' => [ - 'description' => 'The unit price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'OriginalCost' => [ - 'description' => 'The original price of the service.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'ModuleCode' => [ - 'description' => 'The identifier of the pricing module.'."\n", - 'type' => 'string', - 'example' => 'PackageCode', - ], - ], - ], - ], - ], - ], - 'PromotionDetails' => [ + 'PageNum' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'string', 'example' => '12', 'title' => ''], + 'HostId' => ['description' => 'The ID of the host.'."\n", 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'PromotionDetail' => [ - 'description' => 'The details of the discount.'."\n", + 'Instance' => [ + 'description' => 'The details of the instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PromotionDesc' => [ - 'description' => 'The description of the discount.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PromotionId' => [ - 'description' => 'The ID of the discount.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1021199213', - ], - 'PromotionName' => [ - 'description' => 'The name of the discount.'."\n", - 'type' => 'string', - 'example' => 'test', + 'ExpiryTime' => ['description' => 'The time when the resource plan expired.'."\n", 'type' => 'string', 'example' => '2019-03-12T16:00:00Z', 'title' => ''], + 'Status' => ['description' => 'The status of the resource plan. Valid values:'."\n" + ."\n" + .'* Available'."\n" + .'* Expired'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'Remark' => ['description' => 'The remarks on the resource plan. The remarks must be made in Chinese.'."\n", 'type' => 'string', 'example' => '标准存储包(华东2)', 'title' => ''], + 'RemainingAmountUnit' => ['description' => 'The unit of the remaining quota.'."\n", 'type' => 'string', 'example' => 'GB', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'OSSBAG-cn-v0h1s4hma01', 'title' => ''], + 'PackageType' => ['description' => 'The type of the resource plan.'."\n", 'type' => 'string', 'example' => 'FPT_ossbag_absolute_Storage_sh', 'title' => ''], + 'EffectiveTime' => ['description' => 'The time when the resource plan took effect.'."\n", 'type' => 'string', 'example' => '2018-09-12T09:51:56Z', 'title' => ''], + 'Region' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'TotalAmount' => ['description' => 'The total quota of the resource plan.'."\n", 'type' => 'string', 'example' => '40.000', 'title' => ''], + 'DeductType' => ['description' => 'The deduction type. Example: Absolute.'."\n", 'type' => 'string', 'example' => 'Absolute', 'title' => ''], + 'TotalAmountUnit' => ['description' => 'The unit of the total quota.'."\n", 'type' => 'string', 'example' => 'GB', 'title' => ''], + 'RemainingAmount' => ['description' => 'The remaining quota.'."\n", 'type' => 'string', 'example' => '40.000', 'title' => ''], + 'ApplicableProducts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Product' => [ + 'description' => 'The services to which the resource plan is applicable.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The service to which the resource plan is applicable.'."\n", 'type' => 'string', 'example' => '{"Product": ["oss"] }', 'title' => ''], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', ], + 'CommodityCode' => ['description' => 'The commodity code.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], ], + 'description' => '', + 'title' => '', ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', ], ], + 'title' => '', ], ], + 'description' => '', + '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":"<GetSubscriptionPriceResponse>\\n <Data>\\n <Quantity>1</Quantity>\\n <DiscountPrice>900</DiscountPrice>\\n <ModuleDetails>\\n <ModuleDetail>\\n <ModuleCode>ExtBandwidth</ModuleCode>\\n <UnitPrice>0</UnitPrice>\\n <CostAfterDiscount>0</CostAfterDiscount>\\n <OriginalCost>800</OriginalCost>\\n <InvoiceDiscount>800</InvoiceDiscount>\\n </ModuleDetail>\\n <ModuleDetail>\\n <ModuleCode>PackageCode</ModuleCode>\\n <UnitPrice>0</UnitPrice>\\n <CostAfterDiscount>0</CostAfterDiscount>\\n <OriginalCost>100</OriginalCost>\\n <InvoiceDiscount>100</InvoiceDiscount>\\n </ModuleDetail>\\n </ModuleDetails>\\n <PromotionDetails>\\n <PromotionDetail>\\n <PromotionId>1021199213</PromotionId>\\n <PromotionName/>\\n </PromotionDetail>\\n </PromotionDetails>\\n <OriginalPrice>900</OriginalPrice>\\n <TradePrice>0</TradePrice>\\n <Currency>CNY</Currency>\\n </Data>\\n <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n</GetSubscriptionPriceResponse>","errorExample":""}]', - 'summary' => 'Queries the subscription price of an Alibaba Cloud service.', - 'description' => '1. Call the QueryProductList operation to obtain the code of the service. For more information, see [QueryProductList](~~95984~~).'."\n" - .'2. Call the DescribePricingModule operation to obtain the configuration parameters of the service. For more information, see [DescribePricingModule](~~96469~~).'."\n" - .'3. Call the GetSubscriptionPrice operation to obtain the pricing of the service based on the returned configuration parameters.'."\n", + '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' => 'Invalid user identity.'], + ['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":"","errorExample":""}]', + 'title' => 'QueryResourcePackageInstances', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryAvailableInstances' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-19T02:14:35.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryResourcePackageInstances'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QuerySavingsPlansDeductLog' => [ + 'summary' => 'Queries the details of savings plan deductions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16382,844 +11006,619 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PageNum', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The query type. Valid values:'."\n" + ."\n" + .'- spn: savings plan instance'."\n" + ."\n" + .'- product: deducted cloud service instance', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'spn'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud services**.'."\n" - ."\n" - .'>This parameter cannot be left empty if the region is specified.', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'title' => '', 'example' => '20'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'Locale', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + 'schema' => ['description' => 'The language of the response. Default value: ZH. Valid values: \\`ZH\\`: Chinese. \\`EN\\`: English.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'ZH'], ], [ - 'name' => 'InstanceIDs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. Separate multiple IDs with commas (,). You can specify a maximum of 100 IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rm-xxxxxxxxxxxx', - ], - ], - [ - 'name' => 'EndTimeStart', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-05-23T12:00:00Z.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ - 'name' => 'EndTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-05-23T12:00:00Z.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], - ], - [ - 'name' => 'CreateTimeStart', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'spn-XXXXXXX'], ], [ - 'name' => 'CreateTimeEnd', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time when the specified instance is created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '2022-01-01 00:00:00'], ], [ - 'name' => 'RenewStatus', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The renewal status of the specified instance. Valid values:'."\n" - ."\n" - .'* AutoRenewal: The instance is automatically renewed.'."\n" - .'* ManualRenewal: The instance is manually renewed.'."\n" - .'* NotRenewal: The instance is not renewed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AutoRenewal', - ], + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '2022-01-05 00:00:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'PARAM_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '请校验入参正确性'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'InstanceList' => [ - 'description' => 'The instances returned.'."\n", + 'PageNum' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'Items' => [ + 'description' => 'The list of deduction details.', 'type' => 'array', 'items' => [ + 'description' => 'The deduction details.', 'type' => 'object', 'properties' => [ - 'SubStatus' => [ - 'description' => 'The sub-status of the specified instance.'."\n", - 'type' => 'string', - 'example' => 'Normal: The pay-as-you-go module can properly run. WaitForLimit: The pay-as-you-go module is about to be limited due to overdue payments. BandwidthLimited: The pay-as-you-go module is limited due to overdue payments.'."\n", - ], - 'Status' => [ - 'description' => 'The status of the instance.'."\n", - 'type' => 'string', - 'example' => 'Creating: The instance is being created. WaitForExpire: The instance is about to expire. Normal: The instance can properly run. Expired: The instance is expired.'."\n", - ], - 'ExpectedReleaseTime' => [ - 'description' => 'The time when the specified instance was expected to be released.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'RenewStatus' => [ - 'description' => 'The renewal status of the specified instance. Valid values:'."\n" - ."\n" - .'* AutoRenewal: The instance is automatically renewed.'."\n" - .'* ManualRenewal: The instance is manually renewed.'."\n" - .'* NotRenewal: The instance is not renewed.'."\n", - 'type' => 'string', - 'example' => 'ManualRenewal', - ], - 'CreateTime' => [ - 'description' => 'The time when the specified instance was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'SellerId' => [ - 'description' => 'The ID of the seller.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123123', - ], - 'InstanceID' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => '1049056', - ], - 'Seller' => [ - 'description' => 'The seller.'."\n", - 'type' => 'string', - 'example' => '123123123', - ], - 'StopTime' => [ - 'description' => 'The time when the specified instance was suspended.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'RenewalDurationUnit' => [ - 'description' => 'The unit of the auto-renewal cycle. Valid values:'."\n" - ."\n" - .'* M: month'."\n" - .'* Y: year'."\n", - 'type' => 'string', - 'example' => 'M', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'Subscription', - ], - 'OwnerId' => [ - 'description' => 'The ID of the instance owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '325352345', - ], - 'EndTime' => [ - 'description' => 'The time when the instance was expired.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'Region' => [ - 'description' => 'The ID of the region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ReleaseTime' => [ - 'description' => 'The time when the instance was released.'."\n", - 'type' => 'string', - 'example' => '2019-09-08T16:00:00Z', - ], - 'RenewalDuration' => [ - 'description' => 'The number of auto-renewal cycles.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'title' => '', 'example' => '2020-12-01 01:00:00'], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'title' => '', 'example' => '2020-12-01 00:00:00'], + 'SavingsType' => ['description' => 'The type of the savings plan. Valid values:'."\n" + ."\n" + .'- universal: general-purpose'."\n" + ."\n" + .'- ecs: compute-optimized', 'type' => 'string', 'title' => '', 'example' => 'ecs'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1906589291020438'], + 'DiscountRate' => ['description' => 'The discount that is used for the deduction.', 'type' => 'string', 'title' => '', 'example' => '0.069'], + 'BillModule' => ['description' => 'The deducted billable item.', 'type' => 'string', 'title' => '', 'example' => '云服务器配置'], + 'InstanceId' => ['description' => 'The ID of the savings plan instance.', 'type' => 'string', 'title' => '', 'example' => 'spn-xxxxxxx'], + 'DeductInstanceId' => ['description' => 'The ID of the deducted cloud service instance.', 'type' => 'string', 'title' => '', 'example' => 'i-XXXXXXXXX'], + 'DeductCommodity' => ['description' => 'The deducted service.', 'type' => 'string', 'title' => '', 'example' => '云服务器ECS-按量付费'], + 'DeductRate' => ['description' => 'The deduction rate.', 'type' => 'string', 'title' => '', 'example' => '1.0'], + 'DeductFee' => ['description' => 'The deducted fee, in CNY.', 'type' => 'string', 'title' => '', 'example' => '0.52'], + 'OwnerId' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1906589291020438'], + 'BillingCycle' => ['type' => 'string', 'title' => '', 'description' => 'The billing cycle.', 'example' => '202312'], + 'Region' => ['type' => 'string', 'title' => '', 'description' => 'The region of the deducted instance.', 'example' => 'cn-shanghai-eu13-a01'], + 'InstanceSpec' => ['type' => 'string', 'title' => '', 'description' => 'The instance type of the deducted instance.', 'example' => 'ecs.g7.xlarge'], + 'InstanceTypeFamily' => ['type' => 'string', 'title' => '', 'description' => 'The instance family of the deducted instance.', 'example' => 'ecs.g7'], + 'BillingOfficialPrice' => ['type' => 'string', 'title' => '', 'description' => 'The list price of the deducted bill, in CNY.', 'example' => '375.35'], + 'DeductedOfficialPrice' => ['type' => 'string', 'title' => '', 'description' => 'The list price of the deducted amount, in CNY.', 'example' => '375.37'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"C7C15585-8349-4C62-BEE4-5A391841B9BE\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"InstanceList\\": [\\n {\\n \\"SubStatus\\": \\"Normal-后付费模块正常\\\\nWaitForLimit-后付费模块即将欠费受限\\\\nBandwidthLimited-后付费模块欠费受限\\",\\n \\"Status\\": \\"Creating-资源创建中\\\\nWaitForExpire-即将停服\\\\nNormal-正常\\\\nExpired-停服\\",\\n \\"ExpectedReleaseTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewStatus\\": \\"ManualRenewal\\",\\n \\"CreateTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"SellerId\\": 123123123,\\n \\"InstanceID\\": \\"1049056\\",\\n \\"Seller\\": \\"123123123\\",\\n \\"StopTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewalDurationUnit\\": \\"M\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"OwnerId\\": 325352345,\\n \\"EndTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ReleaseTime\\": \\"2019-09-08T16:00:00Z\\",\\n \\"RenewalDuration\\": 1,\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryAvailableInstancesResponse>\\n <Data>\\n <TotalCount>51</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-ji2gz****</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-6dyrc****</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-ne1nt5uw1</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-vj5ry82x1</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-07T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>Subscription</SubscriptionType>\\n <RenewStatus>ManualRenewal</RenewStatus>\\n <InstanceID>IFP-e6oupf251</InstanceID>\\n <ProductCode>flowpack</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2016-11-10T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988643</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988647</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988648</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988649</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>988651</InstanceID>\\n <ProductCode>cmjj011731</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>1049056</InstanceID>\\n <ProductCode>cmjj011399</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n <InstanceList>\\n <Status>Creating</Status>\\n <SubStatus>Normal</SubStatus>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <InstanceID>1049052</InstanceID>\\n <ProductCode>cmjj011399</ProductCode>\\n <CreateTime>2999-09-08T16:00:00Z</CreateTime>\\n <OwnerId>181****</OwnerId>\\n <EndTime>2999-09-08T16:00:00Z</EndTime>\\n <Seller>26888</Seller>\\n </InstanceList>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>C7C15585-8349-4C62-BEE4-5A391841B9BE</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</QueryAvailableInstancesResponse>","errorExample":""}]', - 'summary' => 'Queries available instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ReleaseInstance' => [ - 'summary' => 'Releases instances by Virtual Network Operators (VNOs).', - 'methods' => [ - 'post', + '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' => 'System exception, please try again'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"PARAM_ERROR\\",\\n \\"Message\\": \\"请校验入参正确性\\",\\n \\"RequestId\\": \\"61293E7A-3406-4447-8620-EC88B0AA66AD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Items\\": [\\n {\\n \\"EndTime\\": \\"2020-12-01 01:00:00\\",\\n \\"StartTime\\": \\"2020-12-01 00:00:00\\",\\n \\"SavingsType\\": \\"ecs\\",\\n \\"UserId\\": 1906589291020438,\\n \\"DiscountRate\\": \\"0.069\\",\\n \\"BillModule\\": \\"云服务器配置\\",\\n \\"InstanceId\\": \\"spn-xxxxxxx\\",\\n \\"DeductInstanceId\\": \\"i-XXXXXXXXX\\",\\n \\"DeductCommodity\\": \\"云服务器ECS-按量付费\\",\\n \\"DeductRate\\": \\"1.0\\",\\n \\"DeductFee\\": \\"0.52\\",\\n \\"OwnerId\\": 1906589291020438,\\n \\"BillingCycle\\": \\"202312\\",\\n \\"Region\\": \\"cn-shanghai-eu13-a01\\",\\n \\"InstanceSpec\\": \\"ecs.g7.xlarge\\",\\n \\"InstanceTypeFamily\\": \\"ecs.g7\\",\\n \\"BillingOfficialPrice\\": \\"375.35\\",\\n \\"DeductedOfficialPrice\\": \\"375.37\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QuerySavingsPlansDeductLog', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDeductLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansDeductLog'], + ], ], + ], + 'QuerySavingsPlansDiscount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProductCode', + 'name' => 'ModuleCode', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['title' => 'moduleCode', 'description' => 'The code of the module.', 'type' => 'string', 'required' => false, 'example' => 'instance_type'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'PayMode', 'in' => 'query', 'schema' => [ - 'title' => 'subscriptionType', - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'Subscription: the subscription billing method.'."\n" - ."\n" - .'PayAsYouGo: the pay-as-you-go billing method.'."\n", + 'title' => 'payMode', + 'description' => 'The payment mode. Valid values: total: all upfront. half: partial upfront. zero: no upfront.', + 'enumValueTitles' => ['zero' => '0 预付', 'total' => '全预付', 'half' => '半预付'], 'type' => 'string', 'required' => true, - 'example' => 'PayAsYouGo', + 'example' => 'total', ], ], [ - 'name' => 'InstanceIds', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => 'pageSize', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SpnType', 'in' => 'query', 'schema' => [ - 'title' => 'instanceIds', - 'description' => 'The ID of the instance. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified.'."\n", + 'title' => 'spnType', + 'description' => 'The type of the savings plan. Valid values: ecs: compute-optimized. universal: universal.', + 'enumValueTitles' => ['ecs' => '计算型', 'universal' => '通用型'], 'type' => 'string', 'required' => true, - 'example' => 'rm-xxxxxxxxxxxx', + 'example' => 'universal', ], ], [ - 'name' => 'RenewStatus', + 'name' => 'Locale', 'in' => 'query', 'schema' => [ - 'title' => 'renewStatus', - 'description' => 'The method that is used to renew the instance. Valid values:'."\n" - ."\n" - .'AutoRenewal: automatically renews the instance.'."\n" - ."\n" - .'ManualRenewal: manually renews the instance.'."\n" - ."\n" - .'NotRenewal: does not renew the instance.'."\n", + 'title' => 'locale', + 'description' => 'The language of the response.', + 'enumValueTitles' => ['EN' => '英文', 'ZH' => '中文'], 'type' => 'string', 'required' => false, - 'example' => 'AutoRenewal', + 'example' => 'ZH', ], ], [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => ['title' => 'cycle', 'description' => 'The query cycle.', 'type' => 'string', 'required' => true, 'example' => '1:Year'], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['title' => 'pageNum', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => ['title' => 'spec', 'description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'ecs.g6'], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => ['title' => 'commodityCode', 'description' => 'The commodity code.', 'type' => 'string', 'required' => true, 'example' => 'ecs'], + ], + [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => 'region', - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'region', 'description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ProductType', + 'name' => 'SpnCommodityCode', 'in' => 'query', - 'schema' => [ - 'title' => 'productType', - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The commodity code of the savings plan.', 'type' => 'string', 'required' => false, 'example' => 'savingplan_common_public_cn', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', - 'description' => 'The return result.'."\n", + 'description' => 'The result of the request.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => 'The description of the execution result.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The ID of the request, which can be used for troubleshooting.'."\n", - 'type' => 'string', - 'example' => 'UUID', - ], + 'Message' => ['title' => 'message', 'description' => 'The error message.', 'type' => 'string', 'example' => 'This API is not applicable for caller.'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4'], 'Data' => [ - 'description' => 'data'."\n", + 'title' => 'data', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'ReleaseResult' => [ - 'title' => 'releaseResult', - 'description' => 'Indicates whether the instance is released.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HostId' => [ - 'title' => 'hostId', - 'description' => 'The site of the execution host.'."\n", - 'type' => 'string', - 'example' => 'cn', + 'HostId' => ['title' => 'hostId', 'description' => 'The request IP address.', 'type' => 'string', 'example' => '100.104.180.109'], + 'Items' => [ + 'description' => 'The list of discount information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The discount details.', + 'type' => 'object', + 'properties' => [ + 'CommodityName' => ['description' => 'The product details.', 'type' => 'string', 'example' => '云服务器ECS-按量付费', 'title' => ''], + 'ModuleName' => ['description' => 'The name of the pricing module.', 'type' => 'string', 'example' => '实例', 'title' => ''], + 'SpnType' => ['description' => 'The type of the savings plan.', 'type' => 'string', 'example' => 'universal', 'title' => ''], + 'PayMode' => ['description' => 'The payment mode.'."\n" + ."\n" + .'- total: All upfront'."\n" + ."\n" + .'- half: Partial upfront'."\n" + ."\n" + .'- zero: No upfront', 'type' => 'string', 'example' => 'total', 'title' => ''], + 'Cycle' => ['description' => 'The query cycle.', 'type' => 'string', 'example' => '1:Year', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => '张家口', 'title' => ''], + 'RegionCode' => ['description' => 'The ID of the region where the instance resides. For more information, see [DescribeDBInstanceAttribute](~~26231~~).', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Spec' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ecs.g6', 'title' => ''], + 'DiscountRate' => ['description' => 'The official discount rate.', 'type' => 'string', 'example' => '0.85', 'title' => ''], + 'ContractDiscountRate' => ['description' => 'The contract discount rate.', 'type' => 'string', 'example' => '0.85', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'Invalid_Product_Code', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'A value of true indicates that the execution is complete.'."\n" - ."\n" - .'A value of false indicates that an error occurs during the execution.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => 'code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'PARAM_ERROR'], + 'Success' => ['title' => 'success', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QuerySavingsPlansDiscount', + 'summary' => 'Queries the discount information for savings plans.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySavingsPlansDiscount'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDiscount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"ReleaseResult\\": true,\\n \\"HostId\\": \\"cn\\"\\n },\\n \\"Code\\": \\"Invalid_Product_Code\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ReleaseInstance', - 'description' => 'This operation is provided for only VNOs to release instances. If a non-specific VNO calls this operation, the request is blocked.'."\n", + '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"}]', ], - 'CreateInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QuerySavingsPlansInstance' => [ + 'summary' => 'Queries information about your savings plan instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service to which the instance belongs. You can query the service code by calling the **QueryProductList** operation or viewing **Codes of Alibaba Cloud Services**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], - ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'SubscriptionType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: the subscription billing method.'."\n" - .'* PayAsYouGo: the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'minimum' => '1', 'title' => '', 'example' => '20'], ], [ - 'name' => 'Period', + 'name' => 'Locale', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration. Unit: month. The value must be an integral multiple of 12.'."\n" - ."\n" - .'> This parameter is required if you create a subscription instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => 'The language of the response.'."\n" + ."\n" + .'- EN: English'."\n" + ."\n" + .'- ZH: Chinese', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'ZH'], ], [ - 'name' => 'RenewalStatus', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The renewal method. Valid values:'."\n" - ."\n" - .'* AutoRenewal: The instance is automatically renewed.'."\n" - .'* ManualRenewal: The instance is manually renewed.'."\n" - ."\n" - .'Default value: ManualRenewal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ManualRenewal', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ - 'name' => 'RenewPeriod', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The auto-renewal period. Unit: month.'."\n" - ."\n" - .'> This parameter is required if the **RenewalStatus** parameter is set to **AutoRenewal**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['description' => 'The ID of the savings plan instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'spn-xxxxxxx'], ], [ - 'name' => 'ClientToken', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. The server checks whether a request that uses the same client token has been received. If a request that uses the same client token has been received, the server returns the same request result as the previous request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JASIOFKVNVIXXXXXX', - ], + 'schema' => ['description' => 'The start time. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '2020-01-01 00:00:00'], ], [ - 'name' => 'Logistics', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The logistics address of this order. This parameter is generally valid for physical orders.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"cityCode":"330100","cityName":"Hangzhou","contactName":"Test","countryCode":"","districtName":"Puyan Street","email":"\\*\\*@example.com","mobilePhone":"153564848844","phone":"1234567","provCode":"330000","provName":"Zhejiang","streetCode":"33010610","streetName":"Zhuantang","zipCode":"0000"}'."\n", - ], + 'schema' => ['description' => 'The end time. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '2021-01-01 00:00:00'], ], [ - 'name' => 'Parameter', + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The details of the modules.'."\n", + 'description' => 'The list of tag elements.', 'type' => 'array', 'items' => [ - 'description' => 'The modules.'."\n", + 'description' => 'The tag element.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The value property of the Nth module. Value of N: 1 to 100.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disk', - ], - 'Code' => [ - 'description' => 'The code property of the Nth module. Value of N: 1 to 100. If multiple module property parameters are involved, concatenate multiple parameters based on the value of N in sequence.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'InstanceType', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '测试标签'], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '测试标签'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PricingCycle', + 'name' => 'Status', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The cycle type of the prepaid period'."\n" - .'- PricingCycle=1 indicates that the unit of the prepaid period is in years; '."\n" - .'- PricingCycle=2 indicates that the unit of the prepaid period is in months; '."\n" - .'- PricingCycle=3 indicates that the unit of the prepaid period is in days;'."\n" - .'- Default value: PricingCycle=2'."\n" - ."\n" - .'Applicable only to certain product types (ProductType being ddos_originpre_public_cn, ddosDip, ddoscoo, ddos_originpre_public_intl, ddosDip_intl, ddoscoo_intl)', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - 'enum' => [], - ], + 'schema' => ['description' => 'The status of the instance. Valid values:'."\n" + .'NORMAL: The instance is active.'."\n" + .'RELEASE: The instance is released.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'NORMAL'], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The commodity code.', 'required' => false, 'title' => '', 'example' => 'savingplan_common_public_cn'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order that was created.'."\n", - 'type' => 'string', - 'example' => '20240xxxx21', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance for which the order was created.'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-v1hxxxxx23', + 'PageNum' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'Items' => [ + 'description' => 'The list of instance information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The current status.'."\n" + ."\n" + .'- NORMAL: The instance is active.'."\n" + ."\n" + .'- LIMIT: The instance is suspended due to an overdue payment.'."\n" + ."\n" + .'- RELEASE: The instance is released.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], + 'Cycle' => ['description' => 'The purchased duration.', 'type' => 'string', 'title' => '', 'example' => '1:Year'], + 'StartTimestamp' => ['description' => 'The start timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1663135741039'], + 'SavingsType' => ['description' => 'The type of the savings plan.'."\n" + ."\n" + .'- unversal: general-purpose'."\n" + ."\n" + .'- ecs: compute-optimized', 'type' => 'string', 'title' => '', 'example' => 'ECS'], + 'Utilization' => ['description' => 'The total utilization.', 'type' => 'string', 'title' => '', 'example' => '1.0'], + 'PrepayFee' => ['description' => 'The upfront payment. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '8760.00'], + 'InstanceId' => ['description' => 'The ID of the savings plan instance.', 'type' => 'string', 'title' => '', 'example' => 'spn-xxxxxxxx'], + 'Currency' => ['description' => 'The currency. Valid values: CNY: Chinese Yuan. USD: US Dollar.', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'EndTimestamp' => ['description' => 'The end timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1663135741039'], + 'EndTime' => ['description' => 'The expiration time of the instance. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'title' => '', 'example' => '2021-01-01 00:00:00'], + 'StartTime' => ['description' => 'The effective time of the instance. The time is in the yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'title' => '', 'example' => '2020-01-01 00:00:00'], + 'AllocationStatus' => ['description' => 'The allocation status.'."\n" + ."\n" + .'- unallocated: Not allocated.'."\n" + ."\n" + .'- allocated: Allocating.'."\n" + ."\n" + .'- beAllocated: Allocated to this account.', 'type' => 'string', 'title' => '', 'example' => 'unallocated'], + 'InstanceFamily' => ['description' => 'For a compute-optimized savings plan, this parameter indicates the corresponding instance family or instance family package.', 'type' => 'string', 'title' => '', 'example' => 'ecs.g6'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-zhangjiakou-na62-a01'], + 'LastBillTotalUsage' => ['description' => 'The total deduction amount in the previous cycle. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '100.0'], + 'LastBillUtilization' => ['description' => 'The utilization in the previous cycle.', 'type' => 'string', 'title' => '', 'example' => '0.8'], + 'TotalSave' => ['description' => 'The total savings. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '20.00'], + 'PoolValue' => ['description' => 'The commitment. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '1.00'], + 'PayMode' => ['description' => 'The payment type.'."\n" + ."\n" + .'- total: All Upfront'."\n" + ."\n" + .'- half: Partial Upfront'."\n" + ."\n" + .'- zero: No Upfront', 'type' => 'string', 'title' => '', 'example' => 'total'], + 'Tags' => [ + 'description' => 'The list of tag information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag element.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => '标签1'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '标签1'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DeductCycleType' => ['description' => 'The deduction cycle.'."\n" + .'HOUR: hourly'."\n" + .'DAY: daily'."\n" + .'ONCE: one-time (the total amount decreases over time)', 'type' => 'string', 'title' => '', 'example' => 'HOUR'], + 'RestPoolValue' => ['description' => 'For a flexible savings plan with a monthly or daily commitment, this is the remaining amount in the current cycle. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '100.0'], + 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'title' => '', 'example' => 'savingplan_common_public_cn'], + 'CurrentPoolValue' => ['description' => 'For a savings plan with a monthly cycle, this is the commitment for the current cycle. Unit: CNY.', 'type' => 'string', 'title' => '', 'example' => '100.0'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], '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' => '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' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => 'System exception, please try again'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"20240xxxx21\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-v1hxxxxx23\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InstanceId>OSSBAG-cn-v1hxxxxx23</InstanceId>\\n <OrderId>20240xxxx21</OrderId>\\n </Data>\\n</CreateInstanceResponse>","errorExample":""}]', - 'title' => 'CreateInstance', - 'summary' => 'Creates an instance. If you call this operation, an order for a new instance is created and the order is automatically paid for. You cannot create Elastic Compute Service (ECS) instances or ApsaraDB RDS instances by calling the operation.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QuerySavingsPlansInstance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'After the creation is successful, you can use the [instance query service](https://www.alibabacloud.com/help/en/boa/latest/api-bssopenapi-2017-12-14-queryavailableinstances?spm=a2c63.p38356.0.0.53aa436fJ6R68k) to query the created instances.', - 'translator' => 'machine', - ], - 'ModifyInstance' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QuerySettleBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => ['description' => 'The billing cycle, in YYYY-MM format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2018-07'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type. Valid values:'."\n" + ."\n" + .'- SubscriptionOrder: subscription order'."\n" + ."\n" + .'- PayAsYouGoBill: pay-as-you-go bill'."\n" + ."\n" + .'- Refund: refund bill'."\n" + ."\n" + .'- Adjustment: adjustment bill', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SubscriptionOrder'], + ], + [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription: subscription'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go'."\n" + ."\n" + .'> This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Subscription'], ], [ - 'name' => 'ModifyType', + 'name' => 'IsHideZeroCharge', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of configuration modifications. Valid values:'."\n" - ."\n" - .'* Upgrade: upgrades the configurations of the instance.'."\n" - .'* Downgrade: downgrades the configurations of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Upgrade', - ], + 'schema' => ['description' => 'Specifies whether to filter out bills with a pretax gross amount of 0. The default value is false to ensure backward compatibility.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'InstanceId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance for which you want to modify the configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rm-akjhkdsjhfskjfhd', - ], + 'schema' => ['description' => 'The token that specifies the position from which the query starts. If you leave this parameter empty, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], ], [ - 'name' => 'ClientToken', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'JAKSJFHFAKJSF', - ], + 'schema' => ['description' => 'The maximum number of records to return. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ - 'name' => 'Parameter', + 'name' => 'BillOwnerId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details about the parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value of the parameter n. Valid values of n: 1 to 100.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'Code' => [ - 'description' => 'The code of the parameter n. Valid values of n: 1 to 100. Multiple parameters are concatenated in the order of n.'."\n" - ."\n" - .'> Only the parameters of the attributes that you want to modify for the instance must be configured. For example, if the instance has Attribute A and Attribute B and only Attribute A must be modified, configure only the parameter of Attribute A.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the account that owns the resource. The resource owner is the account that uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '123'], + ], + [ + 'name' => 'RecordID', + 'in' => 'query', + 'schema' => ['description' => 'The order number or bill number.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '12233'], ], ], 'responses' => [ @@ -17227,306 +11626,399 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'AE3F4057-DFC9-4B81-8858-F620651010C9'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order that was created.'."\n", - 'type' => 'string', - 'example' => '202653252354351', - ], - 'HostId' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'example' => 'testId', + 'NextToken' => ['description' => 'The token that indicates the position where the current query stopped. An empty value indicates that all data has been returned.', 'type' => 'string', 'title' => '', 'example' => 'CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U'], + 'BillingCycle' => ['description' => 'The billing cycle, in YYYY-MM format.', 'type' => 'string', 'title' => '', 'example' => '2020-02'], + 'MaxResults' => ['description' => 'The maximum number of records returned for the current request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185xxxxx489'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The payment status. Valid values:'."\n" + ."\n" + .'- PayFinish: Paid'."\n" + ."\n" + .'- PayUnclear: Unpaid'."\n" + ."\n" + .'- PayUnsettle: Unsettled'."\n" + ."\n" + .'- NoSettle: Not Settled', 'type' => 'string', 'title' => '', 'example' => 'PayFinish'], + 'RoundDownDiscount' => ['description' => 'The discount from rounding down.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'Item' => ['description' => 'The bill type:'."\n" + ."\n" + .'- Subscription'."\n" + ."\n" + .'- OrderPayAsYouGoBill'."\n" + ."\n" + .'- Refund'."\n" + ."\n" + .'- Adjustment', 'type' => 'string', 'title' => '', 'example' => 'Subscription'], + 'Currency' => ['description' => 'The currency.'."\n" + ."\n" + .'- CNY'."\n" + ."\n" + .'- USD'."\n" + ."\n" + .'- JPY', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'BillAccountName' => ['description' => 'The name of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- Subscription'."\n" + ."\n" + .'- PayAsYouGo', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'UsageStartTime' => ['description' => 'The start time of the billing.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 07:00:00'], + 'BizType' => ['description' => 'The business type.', 'type' => 'string', 'title' => '', 'example' => 'trusteeship'], + 'UsageEndTime' => ['description' => 'The end time of the billing.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 08:00:00'], + 'DeductedByCoupons' => ['description' => 'The amount deducted using coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'SubOrderId' => ['description' => 'The ID of the order item that corresponds to the bill.', 'type' => 'string', 'title' => '', 'example' => '325345254353'], + 'AfterTaxAmount' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'OutstandingAmount' => ['description' => 'The outstanding amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'PaymentTime' => ['description' => 'The time when the order was paid.', 'type' => 'string', 'title' => '', 'example' => '2020-03-11 08:00:00'], + 'Tax' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'PretaxAmountLocal' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + 'PipCode' => ['description' => 'The product code. This code is the same as the product code on the Bills page in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'PaymentTransactionID' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PretaxAmount' => ['description' => 'The amount payable.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100'], + 'CommodityCode' => ['description' => 'The commodity code. This code is the same as the product detail code in the User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'RecordID' => ['description' => 'The order number or bill number.', 'type' => 'string', 'title' => '', 'example' => '2020xxxx5912'], + 'AdjustAmount' => ['description' => 'The amount deducted from a credit refund.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '关系型数据库RDS（包月）'], + 'PaymentCurrency' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OwnerID' => ['description' => 'The ID of the RAM user. This parameter is used in multi-account payment scenarios.', 'type' => 'string', 'title' => '', 'example' => '3532535235'], + 'BillAccountID' => ['description' => 'The ID of the account to which the bill belongs.', 'type' => 'string', 'title' => '', 'example' => '185xxxxx489'], + 'PaymentAmount' => ['description' => 'The amount paid in cash. This includes deductions from credit refunds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'CashAmount' => ['description' => 'The amount paid in cash. This does not include deductions from credit refunds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + 'title' => '', + 'example' => '', + 'description' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + 'description' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'ResourceNotExists', - 'errorMessage' => 'The specific resource is not exists.', - ], - [ - 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', - 'errorMessage' => 'Please complete your basic personal information first.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202653252354351\\",\\n \\"HostId\\": \\"testId\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202653252354351</OrderId>\\n </Data>\\n</ModifyInstanceResponse>","errorExample":""}]', - 'summary' => 'Modifies the configurations of an instance. When you call this operation, the system generates a modification order and automatically completes the payment. You cannot call this operation to modify the configurations of an Elastic Compute Service (ECS) instance or ApsaraDB RDS instance. To modify the configurations of an ECS or ApsaraDB RDS instance, call the dedicated operation of the corresponding service.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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 \\"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\\": \\"\\",\\n \\"PretaxAmount\\": 100,\\n \\"CommodityCode\\": \\"rds\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"RecordID\\": \\"2020xxxx5912\\",\\n \\"AdjustAmount\\": 0,\\n \\"ProductDetail\\": \\"关系型数据库RDS（包月）\\",\\n \\"PaymentCurrency\\": \\"\\",\\n \\"OwnerID\\": \\"3532535235\\",\\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}","type":"json"}]', + 'title' => 'QuerySettleBill', + 'summary' => 'Queries the settlement bills of an account for a specific billing cycle. This operation is available for accounts on the Alibaba Cloud China Website that have more than 50,000 bill entries.', + 'description' => '- Data queried for the current month is for reference only and cannot be used for reconciliation. This is because events such as delayed billing, refunds, bill adjustments, and write-offs for overdue payments may occur during the month. The final bill for the current month is available for viewing and export after 12:00 on the second day of the next month.'."\n" + ."\n" + .'- Bill data is updated about 5 hours after the actual resource consumption.'."\n" + ."\n" + .'- The status of an unpaid bill from a previous billing cycle is updated to "Paid" 5 hours after payment. The status of an unpaid bill from the current month is updated to "Paid" when the final bill is generated at 12:00 on the second day of the next month.'."\n" + ."\n" + .'- This API supports graceful backoff. The request rate is 600 requests per 60 seconds.'."\n" + ."\n" + .'- Each user is limited to 10 requests per second. If a timeout occurs, retry the request.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetRenewal' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QuerySettleBill'], + ], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'QuerySkuPriceList' => [ + 'summary' => 'Queries the SKU list and list prices under a specified pricing entity of a commodity. A product feature typically has 1 to multiple SKUs, and some products may have tens of thousands of SKUs. The request parameters support filtered queries based on specific SKU configuration conditions.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RenewalPeriod', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The auto-renewal period. Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 2'."\n" - .'* 3'."\n" - .'* 6'."\n" - .'* 12'."\n" - ."\n" - .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The commodity code. You can call the **QueryCommodityList** operation to query the commodity code.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'InstanceIDs', + 'name' => 'PriceEntityCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. You can enable auto-renewal for up to 100 subscription instances at a time. Separate multiple instance IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rm-askjdhaskfjh', - ], + 'schema' => ['description' => 'The pricing entity code. You can call the **QueryPriceEntityList** operation to query the pricing entity code.', 'type' => 'string', 'required' => true, 'example' => 'instance_type', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The pagination token. Leave this parameter empty for the first page query. The query result returns the token for the next page. An empty token in the result indicates that all data has been retrieved. You can obtain the next page token from the **NextPageToken** field in the query result.', 'type' => 'string', 'required' => false, 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', 'title' => ''], ], [ - 'name' => 'SubscriptionType', + 'name' => 'PriceFactorConditionMap', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', + 'description' => 'The collection of pricing factor conditions. You can call the **QueryPriceEntityList** operation to query pricing factor codes and pricing factor values.', + 'type' => 'object', 'required' => false, - 'example' => 'PayAsYouGo', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The pricing factor value pair.', 'type' => 'string', 'example' => '{"vm_region_no":"cn-shiwei-shenshu"}', 'title' => ''], + 'description' => 'The collection of pricing factor values.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RenewalPeriodUnit', + 'name' => 'Lang', 'in' => 'query', 'schema' => [ - 'description' => 'The unit of the auto-renewal period. Valid values:'."\n" - ."\n" - .'* M: months'."\n" - .'* Y: years'."\n" - ."\n" - .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", + 'description' => 'The language. Default value: zh (Chinese).', + 'enumValueTitles' => ['en' => 'English.', 'zh' => 'Chinese.'], 'type' => 'string', 'required' => false, - 'example' => 'M', - ], - ], - [ - 'name' => 'RenewalStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of renewal. Valid values:'."\n" - ."\n" - .'* AutoRenewal: The instance is automatically renewed.'."\n" - .'* ManualRenewal: The instance is manually renewed.'."\n" - .'* NotRenewal: The instance is not renewed.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'AutoRenewal', + 'example' => 'en', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'SkuPricePage' => [ + 'description' => 'The pricing entity SKU information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of SKUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '18732', 'title' => ''], + 'NextPageToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', 'title' => ''], + 'SkuPriceList' => [ + 'description' => 'The SKU list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The SKU object.', + 'type' => 'object', + 'properties' => [ + 'SkuCode' => ['description' => 'sku code', 'type' => 'string', 'example' => '017c15a31507bc6de22aa93777461adc', 'title' => ''], + 'CskuPriceList' => [ + 'description' => 'The SKU price list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The SKU price object.', + 'type' => 'object', + 'properties' => [ + 'CskuCode' => ['description' => 'The CSKU code, which is the unique price identifier.', 'type' => 'string', 'example' => 'ac74dd7b52ae6389ddef099283fb8275', 'title' => ''], + 'Currency' => [ + 'description' => 'The currency.', + 'enumValueTitles' => ['JPY' => 'Japanese yen.', 'SAR' => 'Saudi riyal.', 'USD' => 'US dollar.', 'CNY' => 'Chinese yuan.'], + 'type' => 'string', + 'example' => 'CNY', + 'title' => '', + ], + 'UsageUnit' => ['description' => 'The usage unit.', 'type' => 'string', 'example' => '个', 'title' => ''], + 'PriceType' => [ + 'description' => 'The price type.', + 'enumValueTitles' => ['usagePrice' => 'usage-based price.', 'monthPrice' => 'monthly price.', 'dayPrice' => 'daily price.', 'hourPrice' => 'hourly price.', 'weekPrice' => 'weekly price.', 'yearPrice' => 'yearly price.', 'fixedPrice' => 'fixed price.'], + 'type' => 'string', + 'example' => 'hourPrice', + 'title' => '', + ], + 'PriceMode' => [ + 'description' => 'The pricing mode.', + 'enumValueTitles' => ['STEP_ACCUMULATION' => 'tiered accumulation.', 'STEP_ARRIVE' => 'tiered arrival.', 'NORMAL_PRICE' => 'non-tiered price.'], + 'type' => 'string', + 'example' => 'STEP_ARRIVE', + 'title' => '', + ], + 'Price' => [ + 'description' => 'The price.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'PriceUnit' => ['description' => 'The price unit.', 'type' => 'string', 'example' => '美元/个', 'title' => ''], + 'RangeList' => [ + 'description' => 'When PriceMode is STEP_ACCUMULATION or STEP_ARRIVE, this field contains values that specify the range. When PriceMode is NORMAL_PRICE, this field is NULL.', + 'type' => 'array', + 'items' => [ + 'description' => 'The range object.', + 'type' => 'object', + 'properties' => [ + 'FactorCode' => ['description' => 'The factor code.', 'type' => 'string', 'example' => '212fbd27866307fc79ecf06934a88b2c', 'title' => ''], + 'Min' => ['description' => 'The minimum value.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Max' => ['description' => 'The maximum value.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Type' => [ + 'description' => 'The interval closure type.', + 'enumValueTitles' => ['LORC' => 'left-open, right-closed.', 'LCRO' => 'left-closed, right-open.', 'LCRC' => 'left-closed, right-closed.', 'LORL' => 'left-open, right-open.'], + 'type' => 'string', + 'example' => 'LORC', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SkuFactorMap' => [ + 'description' => 'The collection of factor values. Different commodities have their own factors under pricing entities. For example, the instance_type pricing entity of the ECS commodity has factors such as `vm_region_no, iooptimized, vm_os_kind, instance_type`.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The factor value pair.', 'type' => 'string', 'example' => '{ "vm_region_no": "cn-zhangjiakou-na62-a01", "iooptimized": "optimized", "vm_os_kind": "windows", "instance_type": "ecs.i1.xlarge" }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetRenewalResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</SetRenewalResponse>","errorExample":""}]', - 'title' => 'SetRenewal', - 'summary' => 'Enables auto-renewal for an instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ConvertChargeType' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Query SKU list under a commodity pricing entity', + 'changeSet' => [], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'QuerySplitItemBill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'BillingCycle', + 'in' => 'query', + 'schema' => ['description' => 'The billing cycle. Format: YYYY-MM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2020-03'], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], + ], + [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], [ 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n" - ."\n" - .'> After the call is successful, the billing method of the instance is switched.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + .'Subscription: subscription.'."\n" + .'PayAsYouGo: pay-as-you-go.'."\n" + .'Note: This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PayAsYouGo'], ], [ - 'name' => 'Period', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration. Unit: months. This parameter is required if you switch the billing method to subscription. Valid values:'."\n" - ."\n" - .'* 1 to 9'."\n" - .'* 12'."\n" - .'* 24'."\n" - .'* 36'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '6', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'ProductCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '20'], ], [ - 'name' => 'InstanceId', + 'name' => 'BillOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rm-kasjgfjshgf', - ], + 'schema' => ['description' => 'The ID of the account that owns the resource. The resource owner is the account that actually uses the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'title' => '', 'example' => '123'], ], ], 'responses' => [ @@ -17534,164 +12026,197 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '202657601410661', + 'PageNum' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'BillingCycle' => ['description' => 'The billing cycle. Format: YYYY-MM.', 'type' => 'string', 'title' => '', 'example' => '2020-03'], + 'AccountID' => ['description' => 'The account ID.', 'type' => 'string', 'title' => '', 'example' => '185xxxx3489'], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 300.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'AccountName' => ['description' => 'The user account.', 'type' => 'string', 'title' => '', 'example' => 'test@test.aliyunid.com'], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => 'The bill details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SplitAccountID' => ['description' => 'The account ID to which the attached resource belongs.', 'type' => 'string', 'title' => '', 'example' => '122'], + 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n" + .'Subscription: subscription.'."\n" + .'PayAsYouGo: pay-as-you-go.'."\n" + .'Note: This parameter must be used with the ProductCode parameter.', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGo'], + 'InstanceSpec' => ['description' => 'The instance type.', 'type' => 'string', 'title' => '', 'example' => 'ecs.sn1ne.3xlarge'], + 'DeductedByCoupons' => ['description' => 'The amount deducted using coupons.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'PipCode' => ['description' => 'The product code. This is the same as the product code in the bills of User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'CommodityCode' => ['description' => 'The commodity code. This is the same as the product detail code in the bills of User Center.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'NickName' => ['description' => 'The instance nickname.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'ProductDetail' => ['description' => 'The product details.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'Usage' => ['description' => 'The usage. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'IntranetIP' => ['description' => 'The internal IP address.', 'type' => 'string', 'title' => '', 'example' => '192.xx.xx.xx'], + 'UsageUnit' => ['description' => 'The unit of usage. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => 'GB'], + 'SplitCommodityCode' => ['description' => 'The commodity code of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'DeductedByResourcePackage' => ['description' => 'The amount deducted using resource plans.', 'type' => 'string', 'title' => '', 'example' => 'NULL'], + 'SplitBillingCycle' => ['description' => 'The month of the split bill.', 'type' => 'string', 'title' => '', 'example' => '2020-06'], + 'ServicePeriod' => ['description' => 'The service period.', 'type' => 'string', 'title' => '', 'example' => '10'], + 'SplitItemName' => ['description' => 'The name of the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'iZ28bycvyb4Z'], + 'ListPrice' => ['description' => 'The list price. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '100'], + 'Zone' => ['description' => 'The zone.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'], + 'PretaxGrossAmount' => ['description' => 'The pretax gross amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'InstanceConfig' => ['description' => 'The detailed instance configuration.', 'type' => 'string', 'title' => '', 'example' => 'CPU:12'], + 'BillingDate' => ['description' => 'The billing date. Format: YYYY-MM-DD.', 'type' => 'string', 'title' => '', 'example' => '2020-01-20'], + 'InternetIP' => ['description' => 'The public IP address.', 'type' => 'string', 'title' => '', 'example' => '34.xx.x.x'], + 'Item' => ['description' => 'The bill type:'."\n" + .'SubscriptionOrder (Subscription order).'."\n" + .'PayAsYouGoBill (Pay-as-you-go bill).'."\n" + .'Refund (Refund).'."\n" + .'Adjustment (Adjustment).', 'type' => 'string', 'title' => '', 'example' => 'PayAsYouGoBill'], + 'SplitItemID' => ['description' => 'The split item ID.', 'type' => 'string', 'title' => '', 'example' => 'i-28bycvyb4'], + 'InstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-kjhdskjgshfdlkjfdh'], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'title' => '', 'example' => 'tag'], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + .'CNY.'."\n" + .'USD.'."\n" + .'JPY.', 'type' => 'string', 'title' => '', 'example' => 'CNY'], + 'BillingItem' => ['description' => 'The billing item.', 'type' => 'string', 'title' => '', 'example' => '其他'], + 'CostUnit' => ['description' => 'The cost center.', 'type' => 'string', 'title' => '', 'example' => '未分配'], + 'ListPriceUnit' => ['description' => 'The unit of the list price. This parameter is valid only when isBillingItem is true.', 'type' => 'string', 'title' => '', 'example' => '元'], + 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'title' => '', 'example' => '默认资源组'], + 'PretaxAmount' => ['description' => 'The pretax amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'ServicePeriodUnit' => ['description' => 'The unit of the service duration.', 'type' => 'string', 'title' => '', 'example' => '秒'], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'title' => '', 'example' => '云数据库RDS'], + 'SplitProductDetail' => ['description' => 'The name of the product details for the attached resource.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + 'OwnerID' => ['description' => 'The account ID of the RAM user. This is used in multi-account payment scenarios.', 'type' => 'string', 'title' => '', 'example' => '169***013'], + 'InvoiceDiscount' => ['description' => 'The discount amount.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], + 'SplitAccountName' => ['description' => 'The name of the account to which the attached resource belongs.', 'type' => 'string', 'title' => '', 'example' => '12@test.com'], + 'BillingType' => ['description' => 'The billing method.', 'type' => 'string', 'title' => '', 'example' => '其它'], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'title' => '', 'example' => 'rds'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - ], - 405 => [ - [ - 'errorCode' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', - 'errorMessage' => '您购买的数量超过限制。请重新购买。', - ], - [ - 'errorCode' => 'ORDER.INST_HAS_UNPAID_ORDER', - 'errorMessage' => '您选购的服务存在未支付订单，请支付或作废后再下单！', - ], - [ - 'errorCode' => 'COMMODITY.INVALID_COMPONENT', - 'errorMessage' => '必选模块未选择', - ], - [ - 'errorCode' => 'ORDER.QUANTITY_INVALID', - 'errorMessage' => '您购买的数量超过限制。请重新购买。', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202657601410661\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ConvertChargeTypeResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202657601410661</OrderId>\\n </Data>\\n</ConvertChargeTypeResponse>","errorExample":""}]', - 'summary' => 'Changes the billing method of an instance. You can call this operation to switch the billing method from pay-as-you-go to subscription for Server Load Balancer (SLB) instances, elastic IP addresses (EIPs), and NAT gateways, and switch the billing method from subscription to pay-as-you-go for SLB instances and EIPs.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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 \\"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 \\"SplitBillingCycle\\": \\"2020-06\\",\\n \\"ServicePeriod\\": \\"10\\",\\n \\"SplitItemName\\": \\"iZ28bycvyb4Z\\",\\n \\"ListPrice\\": \\"100\\",\\n \\"Zone\\": \\"cn-hangzhou-h\\",\\n \\"PretaxGrossAmount\\": 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 \\"BillingItem\\": \\"其他\\",\\n \\"CostUnit\\": \\"未分配\\",\\n \\"ListPriceUnit\\": \\"元\\",\\n \\"ResourceGroup\\": \\"默认资源组\\",\\n \\"PretaxAmount\\": 0,\\n \\"ServicePeriodUnit\\": \\"秒\\",\\n \\"ProductName\\": \\"云数据库RDS\\",\\n \\"SplitProductDetail\\": \\"rds\\",\\n \\"OwnerID\\": \\"169***013\\",\\n \\"InvoiceDiscount\\": 0,\\n \\"SplitAccountName\\": \\"12@test.com\\",\\n \\"BillingType\\": \\"其它\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'QuerySplitItemBill', + 'summary' => 'Queries split bills. This API has been upgraded. We recommend that you use the new DescribeSplitItemBill operation.', + 'description' => '- The API for split bills is upgraded. We recommend that you use the new [DescribeSplitItemBill](~~208169~~) operation. This operation no longer supports querying more than 50,000 rows of data.'."\n" + ."\n" + .'- The data is consistent with the split bill data for the specified billing cycle in the User Center.'."\n" + ."\n" + .'- You can query split bills that were generated within the last 12 months.'."\n" + ."\n" + .'- To use this feature, you must first enable it on the [Split Bill](https://usercenter2.aliyun.com/finance/split-bill) page in the console.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RenewInstance' => [ - '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryUserOmsData' => [ + 'summary' => 'Queries the metering records for a specified cloud product.', + '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' => 'ProductCode', + 'name' => 'Table', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service to which the instance belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The product and details of the usage data. This is typically the `ProductCode`. Different products may have multiple metering models.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DataType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rm-skjdhaskjdh', - ], + 'schema' => ['description' => 'The time granularity of the metering data. For more information, see the documentation for the specific product.'."\n" + ."\n" + .'- `Raw`: by hour.'."\n" + ."\n" + .'- `Hour`: by hour.'."\n" + ."\n" + .'- `Day`: by day.'."\n" + ."\n" + .'- `Month`: by month.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Hour', 'title' => ''], ], [ - 'name' => 'RenewPeriod', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of the subscription renewal. Unit: months. Valid values:'."\n" - ."\n" - .'* 1 to 9'."\n" - .'* 12'."\n" - .'* 24'."\n" - .'* 36'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '6', - ], + 'schema' => ['description' => 'The start of the time range to query.'."\n" + ."\n" + .'The time must be in UTC and in the `yyyy-mm-ddThh:mm:ssZ` format, which complies with the ISO 8601 standard.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-20T12:00:00Z', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASKJHKLASJHAFSLKJH', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'The time must be in UTC and in the `yyyy-mm-ddThh:mm:ssZ` format, which complies with the ISO 8601 standard.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-02-21T12:00:00Z', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'Marker', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The position from which to start reading the query results. The results are returned in alphabetical order, starting from the entry that follows the `NextToken` value. If you do not specify this parameter, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'NextToken', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Valid values: 1 to 200. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -17699,87 +12224,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful！', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '202657601410661', + 'Marker' => ['description' => 'The `NextToken` value that marks the start of the next page. If this parameter is empty or not returned, no more data is available.', 'type' => 'string', 'example' => 'NextToken', 'title' => ''], + 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'OmsData' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of OMS data.', '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"}]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', - ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', - ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - [ - 'errorCode' => 'ResourceStatusError', - 'errorMessage' => 'The resource status error.', - ], - [ - 'errorCode' => 'ResourceNotExists', - 'errorMessage' => 'The specific resource is not exists.', - ], + ['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' => 'Invalid user identity.'], ], 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\\": \\"202657601410661\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewInstanceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OrderId>202657601410661</OrderId>\\n </Data>\\n</RenewInstanceResponse>","errorExample":""}]', - 'summary' => 'Renews a specified instance. You cannot call this operation to renew Elastic Compute Service (ECS) instances, ApsaraDB RDS instances, or ApsaraDB for Redis instances. To renew these types of instances, call the dedicated operation of the corresponding service.', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryUserOmsData', + 'description' => '## API description'."\n" + ."\n" + .'- The cloud product parameter must specify a supported product code. You can aggregate metering data by hour or by day.'."\n" + ."\n" + .'- The time must be in ISO 8601 format. Note the following time constraints:'."\n" + ."\n" + .' - Because of data push latency, data integrity is guaranteed for hourly data that is at least 24 hours old and for daily data that is at least 2 days old.'."\n" + ."\n" + .' - You can query metering data from the previous quarter.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RefundInstance' => [ - 'summary' => 'Unsubscribes from an instance that is no longer needed.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryUserOmsData'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeUserOmsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RefundInstance' => [ + 'summary' => 'Cancels subscriptions for instances that you no longer need.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17787,200 +12307,92 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'description' => 'This parameter is required for scenarios that need idempotence. The UUID that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '793F021C-B589-1225-82A9-99232AEBE494', - ], + 'schema' => ['title' => 'clientToken', 'description' => 'A client-generated universally unique identifier (UUID) that is used to ensure the idempotence of the request. If you make multiple calls with the same ClientToken, the system returns the result of the first call. A successful call returns a refund order ID.', 'type' => 'string', 'required' => false, 'example' => '793F021C-B589-1225-82A9-99232AEBE494'], ], [ 'name' => 'ImmediatelyRelease', 'in' => 'query', - 'schema' => [ - 'title' => 'immediatelyRelease', - 'description' => 'This parameter is required for unsubscription scenarios. Valid values: 1 and 0. A value of 1 specifies that the instance is immediately released. A value of 0 specifies that the instance is shut down based on the shutdown policy. This parameter is supported only for specified services. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => 'immediatelyRelease', 'description' => 'This parameter is required for unsubscription. Valid values: 1: The instance is released immediately. 0: The instance is first stopped according to its stop policy. This feature is supported only for some products. By default, instances are released immediately.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'title' => 'productCode', - 'description' => 'The code of the service. This parameter is required for unsubscription scenarios.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['title' => 'productCode', 'description' => 'The product code. This parameter is required for unsubscription. If an error code indicates that the product is not supported, submit a ticket to request that this feature be enabled.', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'instanceId', - 'description' => 'The ID of the instance. This parameter is required for unsubscription scenarios. Do not specify a custom name for this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1etb69sqxgl4*******', - ], + 'schema' => ['title' => 'instanceId', 'description' => 'The ID of the instance. This is not a custom name. This parameter is required for unsubscription.', 'type' => 'string', 'required' => false, 'example' => 'i-bp1etb69sqxgl4*******'], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'title' => 'productType', - 'description' => 'The type of the service. This parameter is required for unsubscription scenarios. Unless otherwise specified, set this parameter to an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '”“', - ], + 'schema' => ['title' => 'productType', 'description' => 'The product type. This parameter is required for unsubscription. Unless otherwise specified, pass an empty string. In API Explorer, you can automatically enter an empty string by moving your mouse pointer over the input box and clicking the button that appears. When you call this operation from your code, pass an empty string "".', 'type' => 'string', 'required' => false, 'example' => '空字符串'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', - 'description' => 'The result of the request.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'description' => 'The description of the execution result.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'UUID', - ], + 'Message' => ['title' => 'message', 'description' => 'The description of the execution result.', 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request. Provide this ID to our technical support for troubleshooting.', 'type' => 'string', 'example' => 'UUID'], 'Data' => [ 'title' => 'data', - 'description' => 'The returned data.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'title' => 'hostId', - 'description' => 'The site of the execution host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'OrderId' => [ - 'title' => 'orderId', - 'description' => 'The ID of the refund order that is returned only if the instance is unsubscribed from.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2100000000***', - ], + 'HostId' => ['title' => 'hostId', 'description' => 'The website where the host is located.', 'type' => 'string', 'example' => 'cn'], + 'OrderId' => ['title' => 'orderId', 'description' => 'The ID of the refund order. This parameter is returned only if the unsubscription is successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '2100000000***'], ], + 'example' => '', ], - 'Code' => [ - 'title' => 'code', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'ResourceNotExists', - ], - 'Success' => [ - 'title' => 'success', - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['title' => 'code', 'description' => 'The response code.', 'type' => 'string', 'example' => 'ResourceNotExists'], + 'Success' => ['title' => 'success', 'description' => 'Indicates whether the operation was successful. `true`: The operation was successful. `false`: The operation failed.', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '', ], ], ], '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.', - ], + ['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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred in the internal server.', 'description' => 'System exception, please try again'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\",\\n \\"OrderId\\": 0\\n },\\n \\"Code\\": \\"ResourceNotExists\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'RefundInstance', - 'description' => '1. Refunds are applicable only for the actual paid amount. Vouchers used for the purchase are non-refundable.'."\n" - .'2. Check the information about unsubscription and confirm the unsubscription terms and refundable amount. The resource that is unsubscribed cannot be restored.'."\n" - .'3. For more information, see [Rules for unsubscribing from resources](https://www.alibabacloud.com/help/en/user-center/refund-rules).', + 'description' => '1. Refunds cover only the amount that you paid. Used coupons are not refunded.'."\n" + ."\n" + .'2. Before you cancel a subscription, carefully check the resource information and confirm the refund terms and amount. After a subscription is canceled, the resource cannot be recovered.'."\n" + ."\n" + .'3. This operation can be called only by direct customers, not resellers.'."\n" + ."\n" + .'4. For more information, see <props="intl">[Refund rules for the international site](https://www.alibabacloud.com/help/zh/user-center/user-guide/refund-rules)</props>.', 'extraInfo' => '**Error codes that are returned if a request is blocked**'."\n" ."\n" .'* ResourceNotExists: The instance does not exist.'."\n" @@ -17993,747 +12405,172 @@ .'* AmbassadorOrderLimitError: The instance has an ambassador order that may raise risks.'."\n" .'* ActivityForbiddenError: You cannot request a refund for an instance that is purchased during the marketing campaigns.'."\n" .'* ProductCheckError: The instance does not pass the precheck.', - ], - 'GetOrderDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefundInstance'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'OrderId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '32453453', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'HostName' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PageNum' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OrderList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Order' => [ - 'description' => 'The orders returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the order.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderSubType' => [ - 'description' => 'The type of the suborder. A value of productsuborder indicates service suborder. A value of refundsuborder indicates refund suborder.'."\n", - 'type' => 'string', - 'example' => 'ProductSubOrder', - ], - 'CreateTime' => [ - 'description' => 'The time when the order was created.'."\n", - 'type' => 'string', - 'example' => '2017-06-08T09:41:30Z', - ], - 'Currency' => [ - 'description' => 'The currency. Valid values: CNY, USD, and JPY.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'Config' => [ - 'description' => 'The configurations of the main service.'."\n", - 'type' => 'string', - 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', - ], - 'SubscriptionType' => [ - 'title' => '', - 'description' => 'The billing method. Valid values: Subscription and PayAsYouGo.'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'UsageStartTime' => [ - 'description' => 'The time when the service starts.'."\n", - 'type' => 'string', - 'example' => '2017-06-08T16:00:00Z', - ], - 'UsageEndTime' => [ - 'description' => 'The time when the service ends.'."\n", - 'type' => 'string', - 'example' => '2117-06-08T16:00:00Z', - ], - 'SubOrderId' => [ - 'description' => 'The ID of the suborder.'."\n", - 'type' => 'string', - 'example' => '234343', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AfterTaxAmount' => [ - 'description' => 'The aftertaxt amount of the order.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'PaymentTime' => [ - 'description' => 'The time of payment.'."\n", - 'type' => 'string', - 'example' => '2017-06-08T09:41:30Z', - ], - 'Operator' => [ - 'description' => 'The ID of the Resource Access Management (RAM) user that performs operations on the order. If no RAM user is involved, this parameter is empty.'."\n", - 'type' => 'string', - 'example' => '23424243432', - ], - 'OrderType' => [ - 'description' => 'The type of the order. Valid values: new, renew, upgrade, and refund.'."\n", - 'type' => 'string', - 'example' => 'New', - ], - 'PaymentStatus' => [ - 'description' => 'The payment state. Valid values: unpaid, paid, and canceled.'."\n", - 'type' => 'string', - 'example' => 'Paid', - ], - 'Quantity' => [ - 'description' => 'The number of main services.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PretaxAmountLocal' => [ - 'description' => 'The pretax amount of the order in local currency.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Tax' => [ - 'description' => 'The tax of the order.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'OriginalConfig' => [ - 'description' => 'The configuration information that is not formatted.'."\n", - 'type' => 'string', - 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', - ], - 'PretaxAmount' => [ - 'description' => 'The pretax amount of the order.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'CommodityCode' => [ - 'description' => 'The commodity code.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'RelatedOrderId' => [ - 'description' => 'The ID of the associated order.'."\n", - 'type' => 'string', - 'example' => '4353453534543', - ], - 'PaymentCurrency' => [ - 'description' => 'The currency used for payment. Valid values: CNY, USD, and JPY.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ProductType' => [ - 'description' => 'The type of the main service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'InstanceIDs' => [ - 'description' => 'The instance IDs.'."\n", - 'type' => 'string', - 'example' => '["rm-bp1a2vsr018313t6o"]', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount of the order.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '3453425324', - ], - 'ProductCode' => [ - 'description' => 'The code of the main service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ExtendInfos' => [ - 'description' => 'The additional information about the order.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The additional information about the order.'."\n" - ."\n" - .'* A value of true for isAutoRenew indicates that automatic renewal is enabled. If automatic renewal is disabled, this parameter is not returned.'."\n" - .'* couponNo indicates the coupon number.'."\n" - .'* couponAmount indicates the amount deducted by using the coupon.'."\n" - .'* discountAmount indicates the amount deducted.'."\n", - 'example' => '{"key":"Order extension information"}', - ], - ], - 'BillModuleConfig' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'billModuleConfig' => [ - 'description' => 'The billing information about the configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'Data disk'."\n", - ], - 'Code' => [ - 'description' => 'The code of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'datadisk', - ], - 'ApiCode' => [ - 'description' => 'The API code of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'datadisk', - ], - 'BillModuleProperties' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'billModuleProperties' => [ - 'description' => 'The attributes of the configured item.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModuleApiCode' => [ - 'description' => 'The API code of the configured item.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'AttrApiCode' => [ - 'description' => 'The attribute code of the configured item.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'Value' => [ - 'description' => 'The attribute value of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], - 'OriginalModuleConfig' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'originalModuleConfig' => [ - 'description' => 'The information about the configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'System disk'."\n", - ], - 'Code' => [ - 'description' => 'The code of the configuration item.'."\n", - 'type' => 'string', - 'example' => 'systemdisk', - ], - 'ModuleProperties' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'moduleProperties' => [ - 'description' => 'The attributes of the configured item.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The attribute code of the configured item.'."\n", - 'type' => 'string', - 'example' => 'cloud_efficiency'."\n", - ], - 'Name' => [ - 'description' => 'The attribute name of the configured item.'."\n", - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - 'Value' => [ - 'description' => 'The attribute value of the configured item.'."\n", - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:RefundBatchRemainRefund', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"OrderSubType\\": \\"子订单类型\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Currency\\": \\" CNY\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Operator\\": \\"23424243432\\",\\n \\"OrderType\\": \\"new\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"Quantity\\": \\"1\\",\\n \\"PretaxAmountLocal\\": \\"0\\",\\n \\"Tax\\": \\"1\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"4353453534543\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"InstanceIDs\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderId\\": \\"3453425324\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"Name\\": \\"数据盘\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"ModuleApiCode\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"Value\\": \\"cloud_ssd\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"Name\\": \\"系统盘\\",\\n \\"Code\\": \\"systemdisk\\",\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Code\\": \\"高效云盘\\",\\n \\"Name\\": \\"cloud_efficiency\\",\\n \\"Value\\": \\"cloud_efficiency\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetOrderDetail', - 'summary' => 'Queries the details of an order that belongs to your Alibaba Cloud account or distributors.', ], - 'QueryOrders' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReleaseInstance' => [ + 'summary' => 'Releases instances by Virtual Network Operators (VNOs).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T12:00:00Z', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['title' => 'productCode', 'description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ecs'], ], [ - 'name' => 'ProductType', + 'name' => 'SubscriptionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], + 'schema' => ['title' => 'subscriptionType', 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'Subscription: the subscription billing method.'."\n" + ."\n" + .'PayAsYouGo: the pay-as-you-go billing method.'."\n", 'type' => 'string', 'required' => true, 'example' => 'PayAsYouGo'], ], [ - 'name' => 'SubscriptionType', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Subscription', - ], + 'schema' => ['title' => 'instanceIds', 'description' => 'The ID of the instance. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-xxxxxxxxxxxx'], ], [ - 'name' => 'OrderType', + 'name' => 'RenewStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the order. Valid values:'."\n" - ."\n" - .'* New: purchases an instance.'."\n" - .'* Renew: renews an instance.'."\n" - .'* Upgrade: upgrades the configurations of an instance.'."\n" - .'* Refund: applies for a refund.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'New', - ], + 'schema' => ['title' => 'renewStatus', 'description' => 'The method that is used to renew the instance. Valid values:'."\n" + ."\n" + .'AutoRenewal: automatically renews the instance.'."\n" + ."\n" + .'ManualRenewal: manually renews the instance.'."\n" + ."\n" + .'NotRenewal: does not renew the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AutoRenewal'], ], [ - 'name' => 'PaymentStatus', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of payment. Valid values for a non-refund order:'."\n" - ."\n" - .'* Unpaid: The order is not paid.'."\n" - .'* Paid: The order is paid.'."\n" - .'* Cancelled: The order is canceled.'."\n" - ."\n" - .'> : You can set this parameter to NULL for a refund order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Paid', - ], + 'schema' => ['title' => 'region', 'description' => 'The region in which the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'CreateTimeStart', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the period during which the orders were created. By default, orders within the last hour are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2016-05-23T13:00:00Z', - ], + 'schema' => ['title' => 'productType', 'description' => 'The type of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'result', + 'description' => 'The return result.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '61293E7A-3406-4447-8620-EC88B0AA66AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['title' => 'message', 'description' => 'The description of the execution result.'."\n", 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['title' => 'requestId', 'description' => 'The ID of the request, which can be used for troubleshooting.'."\n", 'type' => 'string', 'example' => 'UUID'], 'Data' => [ - 'description' => 'The message returned.'."\n", + 'description' => 'data'."\n", 'type' => 'object', 'properties' => [ - 'HostName' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OrderList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Order' => [ - 'description' => 'The orders returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PretaxAmount' => [ - 'description' => 'The pretax amount of the order.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'CommodityCode' => [ - 'description' => 'The service code.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'RelatedOrderId' => [ - 'description' => 'The ID of the associated order.'."\n", - 'type' => 'string', - 'example' => '234535345345342', - ], - 'CreateTime' => [ - 'description' => 'The time when the order was created.'."\n", - 'type' => 'string', - 'example' => '2017-06-08T09:41:30Z', - ], - 'Currency' => [ - 'description' => 'The currency.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'PaymentCurrency' => [ - 'description' => 'The currency of payment.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ProductType' => [ - 'description' => 'The type of the main service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'AfterTaxAmount' => [ - 'description' => 'The aftertax amount of the order.'."\n", - 'type' => 'string', - 'example' => '66', - ], - 'PaymentTime' => [ - 'description' => 'The time of payment.'."\n", - 'type' => 'string', - 'example' => '2017-06-08T09:41:30Z', - ], - 'PretaxGrossAmount' => [ - 'description' => 'The pretax gross amount of the order.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'OrderType' => [ - 'description' => 'The type of the order. Valid values:'."\n" - ."\n" - .'* New: purchases an instance.'."\n" - .'* Renew: renews an instance.'."\n" - .'* Upgrade: upgrades the configurations of an instance.'."\n" - .'* Refund: applies for a refund.'."\n", - 'type' => 'string', - 'example' => 'New', - ], - 'PaymentStatus' => [ - 'description' => 'The status of payment. Valid values for a non-refund order:'."\n" - ."\n" - .'* Unpaid: The order is not paid.'."\n" - .'* Paid: The order is paid.'."\n" - .'* Cancelled: The order is canceled.'."\n" - ."\n" - .'> : The value is NULL for a refund order.'."\n", - 'type' => 'string', - 'example' => 'Paid', - ], - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '34532532', - ], - 'Tax' => [ - 'description' => 'The tax of the order.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PretaxAmountLocal' => [ - 'description' => 'The pretax amount of the order in local currency.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ProductCode' => [ - 'description' => 'The code of the main service.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - ], - ], - ], - ], - ], + 'ReleaseResult' => ['title' => 'releaseResult', 'description' => 'Indicates whether the instance is released.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HostId' => ['title' => 'hostId', 'description' => 'The site of the execution host.'."\n", 'type' => 'string', 'example' => 'cn'], ], + 'title' => '', ], + 'Code' => ['title' => 'code', 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => 'Invalid_Product_Code'], + 'Success' => ['title' => 'success', 'description' => 'A value of true indicates that the execution is complete.'."\n" + ."\n" + .'A value of false indicates that an error occurs during the execution.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', - ], + ['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' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"Data\\": {\\n \\"ReleaseResult\\": true,\\n \\"HostId\\": \\"cn\\"\\n },\\n \\"Code\\": \\"Invalid_Product_Code\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ReleaseInstance', + 'description' => 'This operation is provided for only VNOs to release instances. If a non-specific VNO calls this operation, the request is blocked.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-05-11T01:18:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ReleaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"61293E7A-3406-4447-8620-EC88B0AA66AD\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"PretaxAmount\\": \\"0\\",\\n \\"CommodityCode\\": \\"ecs\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SubscriptionType\\": \\"PayAsYouGo\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"OrderId\\": \\"34532532\\",\\n \\"Tax\\": \\"1\\",\\n \\"PretaxAmountLocal\\": \\"0\\",\\n \\"ProductCode\\": \\"rds\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryOrdersResponse>\\n <Message>Successful!</Message>\\n <RequestId>61293E7A-3406-4447-8620-EC88B0AA66AD</RequestId>\\n <Data>\\n <TotalCount>0</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <OrderList>\\n </OrderList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryOrdersResponse>","errorExample":""}]', - 'summary' => 'Queries the orders of your Alibaba Cloud account or distributors. By default, orders within the last hour are queried. To query earlier orders, specify the CreateTimeStart and CreateTimeEnd parameters.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CancelOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RelieveAccountRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OrderId', + 'name' => 'RelationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '73465432785', - ], + 'schema' => ['description' => 'The relationship type. Only enterprise\\_group is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'enterprise_group'], + ], + [ + 'name' => 'ParentUserId', + 'in' => 'query', + 'schema' => ['description' => 'The UID of the Alibaba Cloud account. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType parameters.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1738376485192612'], + ], + [ + 'name' => 'ChildUserId', + 'in' => 'query', + 'schema' => ['description' => 'The UID of the RAM user. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType parameters.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'title' => '', 'example' => '1512996702208737'], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the request. This ID is used to troubleshoot issues.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'request_id'], + ], + [ + 'name' => 'RelationId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the account association. You must specify either the RelationId parameter, or the ParentUserId, ChildUserId, and RelationType parameters.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => 'RelationId'], ], ], 'responses' => [ @@ -18741,288 +12578,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '30D2285E-A848-4ECB-AA74-4954C60858A1', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => '返回消息'], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'request_id'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'HostId' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], + 'HostId' => ['description' => 'The ID of the host.', 'type' => 'string', 'title' => '', 'example' => 'HostId'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"30D2285E-A848-4ECB-AA74-4954C60858A1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostId\\": \\"cn\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelOrderResponse>\\n <Data>\\n <HostId>cn</HostId>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>30D2285E-A848-4ECB-AA74-4954C60858A1</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</CancelOrderResponse>","errorExample":""}]', - 'summary' => 'Cancels an unpaid order.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateCostUnit' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'RelieveAccountRelation', + 'summary' => 'Disassociates a RAM user from an Alibaba Cloud account.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'RenewChangeInstance' => [ + 'summary' => 'Renews an instance and changes its configuration. The configuration change is applied after the renewal order takes effect. Payment is processed automatically. This operation cannot be used to create ECS or RDS instances.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'UnitEntityList', + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'The product code. To obtain it, call **QueryProductList**.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => 'Product type', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rm-skjdhaskjdh'], + ], + [ + 'name' => 'Parameter', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of cost centers.'."\n", + 'description' => 'Module list', 'type' => 'array', 'items' => [ + 'description' => 'Module information', 'type' => 'object', 'properties' => [ - 'ParentUnitId' => [ - 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '-1', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the owner of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '982375623', - ], - 'UnitName' => [ - 'description' => 'The name of the cost center.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'Value' => ['description' => 'The value configuration for the nth module property. The value of n ranges from 1 to 100.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'disk'], + 'Code' => ['description' => 'The code configuration for the Nth module property. The value of N can be an integer from 1 to 100. If you have multiple module properties, create a separate parameter for each by setting n to 1, 2, 3, and so on.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Bandwidth'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Ensures the idempotence of the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'JASIOFKVNVIXXXXXX'], + ], + [ + 'name' => 'RenewPeriod', + 'in' => 'query', + 'schema' => ['description' => 'The subscription renewal duration, in months. Valid values:'."\n" + ."\n" + .'- 1-9'."\n" + ."\n" + .'- 12'."\n" + ."\n" + .'- 24'."\n" + ."\n" + .'- 36', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '2'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'Success' => ['description' => 'success=true indicates that the call was successful. success=false indicates that an error occurred.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data that is returned.', 'type' => 'object', 'properties' => [ - 'CostUnitDtoList' => [ - 'description' => 'The list of cost center entities.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParentUnitId' => [ - 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'UnitName' => [ - 'description' => 'The name of the cost center.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '84327659328', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the owner of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26387563', - ], - ], - ], - ], + 'OrderId' => ['description' => 'The ID of the successfully created order.', 'type' => 'string', 'title' => '', 'example' => '202407022550621'], + 'HostId' => ['description' => 'The site where the host runs.', 'type' => 'string', 'title' => '', 'example' => '100.100.64.1:8150'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CostUnitDtoList\\": [\\n {\\n \\"ParentUnitId\\": -1,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 84327659328,\\n \\"OwnerUid\\": 26387563\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateCostUnitResponse>\\n <Data>\\n <CostUnitDtoList>\\n <UnitName>dd</UnitName>\\n <ParentUnitId>12***********45</ParentUnitId>\\n <OwnerUid>16************86</OwnerUid>\\n </CostUnitDtoList>\\n </Data>\\n <Message>Successful</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</CreateCostUnitResponse>","errorExample":""}]', - 'summary' => 'Creates a cost center. You can create multiple cost centers at a time.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AllocateCostUnitResource' => [ - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['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' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'RenewChangeInstance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'bss:RenewChangeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'RenewInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'FromUnitUserId', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the owner of the source cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '273394581313325532', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rds'], ], [ - 'name' => 'FromUnitId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the source cost center.'."\n" - ."\n" - .'* A value of 0 indicates that the resources to be transferred have not been allocated to a cost center.'."\n" - .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'rm-skjdhaskjdh'], ], [ - 'name' => 'ToUnitUserId', + 'name' => 'RenewPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the owner of the destination cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '241021678450941490', - ], + 'schema' => ['description' => 'The renewal period for the subscription instance, in months. Valid values:'."\n" + ."\n" + .'- 1-9'."\n" + ."\n" + .'- 12'."\n" + ."\n" + .'- 24'."\n" + ."\n" + .'- 36', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '6'], ], [ - 'name' => 'ToUnitId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the destination cost center.'."\n" - ."\n" - .'* A value of -1 indicates that the allocated resources are changed to unallocated.'."\n" - .'* A value greater than 0 indicates the ID of an existing cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '186419', - ], + 'schema' => ['description' => 'A client token to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ASKJHKLASJHAFSLKJH'], ], [ - 'name' => 'ResourceInstanceList', + 'name' => 'ProductType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource instances to be transferred.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApportionCode' => [ - 'description' => 'The split item of the shared instance. This parameter is required only for shared instances.'."\n" - ."\n" - .'* Eight cloud services support bill splitting. The commodity codes of the eight services are oss, dcdn, snapshot, vod, cdn, live, and cbwp.'."\n" - .'* You can obtain the split item of a shared instance by calling QueryCostUnitResource operation to obtain all resource instances within a cost center.', - 'type' => 'string', - 'required' => false, - 'example' => 'qwer1-cn-beijing', - ], - 'CommodityCode' => [ - 'description' => 'The commodity code of the resource instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss', - ], - 'ResourceUserId' => [ - 'description' => 'The user ID of the resource instance owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '273394581313325532', - ], - 'ResourceId' => [ - 'description' => 'The ID of the resource instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou;standard', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rds'], ], ], 'responses' => [ @@ -19030,102 +12784,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '845C629F-47A7-4F46-A470-ED5047C4C250', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful！'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'ToUnitUserId' => [ - 'description' => 'The user ID of the owner of the destination cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34857693874', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether resources are allocated to the specified cost center. Valid values:'."\n" - ."\n" - .'* true: The resources are allocated to the specified cost center.'."\n" - .'* false: The resources fail to be allocated to the specified cost center.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ToUnitId' => [ - 'description' => 'The ID of the destination cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32857346527', - ], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '202657601410661'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"845C629F-47A7-4F46-A470-ED5047C4C250\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ToUnitUserId\\": 34857693874,\\n \\"IsSuccess\\": true,\\n \\"ToUnitId\\": 32857346527\\n }\\n}","errorExample":""},{"type":"xml","example":"<AllocateCostUnitResourceResponse>\\r\\n <Data>\\r\\n <CostUnitOperate>\\r\\n <IsSuccess>true</IsSuccess>\\r\\n <ToUnitId>1245</ToUnitId>\\r\\n <ToUnitUserId>1686</ToUnitUserId>\\r\\n </CostUnitOperate>\\r\\n </Data>\\r\\n <Message>Successful!</Message>\\r\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>success</Code>\\r\\n</AllocateCostUnitResourceResponse>","errorExample":""}]', - 'title' => 'AllocateCostUnitResource', - 'summary' => 'Transfers resource instances from the source cost center to the destination cost center.', + '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' => 'Invalid user identity.'], + ['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' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderId\\": \\"202657601410661\\"\\n }\\n}","type":"json"}]', + 'title' => 'RenewInstance', + 'summary' => 'Renews a specified instance. This operation cannot be used to renew ECS, RDS, or Redis instances. To renew these instances, call the dedicated renewal API for the specific product.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteCostUnit' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ], ], + ], + 'RenewResourcePackage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'OwnerUid', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2135342', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'lskd****sljhsdj'], ], [ - 'name' => 'UnitId', + 'name' => 'EffectiveDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '376348', - ], + 'schema' => ['description' => 'The time when the resource package takes effect. If you leave this parameter empty, the resource package takes effect immediately.'."\n" + ."\n" + .'Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time zone must be UTC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2020-02-02T12:00:00Z'], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => ['description' => 'The renewal duration of the resource package.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => ['description' => 'The unit of the renewal duration. Valid values:'."\n" + ."\n" + .'- Month'."\n" + ."\n" + .'- Year'."\n" + ."\n" + .'Default value: Month.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Month'], ], ], 'responses' => [ @@ -19133,113 +12887,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '204322301110333'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the call is complete.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123412343', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12431', - ], + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '204322560333'], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'OSSBAG-cn-0xl0n****003'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IsSuccess\\": true,\\n \\"UnitId\\": 123412343,\\n \\"OwnerUid\\": 12431\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteCostUnitResponse>\\n <Data>\\n <CostUnitOperate>\\n <IsSuccess>true</IsSuccess>\\n <OwnerUid>1245</OwnerUid>\\n <UnitId>1686</UnitId>\\n </CostUnitOperate>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</DeleteCostUnitResponse>","errorExample":""}]', - 'summary' => 'Deletes a cost center.', + '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' => 'Invalid user identity.'], + ['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.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'RenewResourcePackage', + 'summary' => 'Renews a resource package instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyCostUnit' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewResourcePackage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetAllExpirationDay' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'UnitEntityList', + 'name' => 'UnifyExpireDay', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cost centers to be modified.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2524352', - ], - 'NewUnitName' => [ - 'description' => 'The new name of the cost center.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'newTest', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1321312312', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The expiration date. You can set an expiration date only for ECS instances that have not expired. The expiration date that you specify do not take effect on expired ECS instances. After the expiration date is set, the expiration date is used when you renew ECS instances.'."\n" + ."\n" + .'You can set the expiration date to a day from the 1st to the 28th of each month.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -19247,124 +12980,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the cost center was modified.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '356349875', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '823756287', - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message that is returned.'."\n", 'type' => 'string', 'example' => 'The message that is returned', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'The ID of the request', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"UnitId\\": 356349875,\\n \\"OwnerUid\\": 823756287\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyCostUnitResponse>\\n <Data>\\n <CostUnitOperate>\\n <IsSuccess>true</IsSuccess>\\n <OwnerUid>1245</OwnerUid>\\n <UnitId>1686</UnitId>\\n </CostUnitOperate>\\n </Data>\\n <Message>Successful!</Message>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Success>true</Success>\\n <Code>success</Code>\\n</ModifyCostUnitResponse>","errorExample":""}]', - 'summary' => 'Modifies one or more cost centers.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The message that is returned\\",\\n \\"RequestId\\": \\"The ID of the request\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SetAllExpirationDay', + 'summary' => 'Sets an expiration date for all Elastic Compute Service (ECS) instances.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryCostUnit' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetRenewal' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'OwnerUid', + 'name' => 'RenewalPeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '28394563429587', - ], + 'schema' => ['description' => 'The auto-renewal period. Valid values:'."\n" + ."\n" + .'* 1'."\n" + .'* 2'."\n" + .'* 3'."\n" + .'* 6'."\n" + .'* 12'."\n" + ."\n" + .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ParentUnitId', + 'name' => 'InstanceIDs', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '-1', - ], + 'schema' => ['description' => 'The ID of the instance. You can enable auto-renewal for up to 100 subscription instances at a time. Separate multiple instance IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-askjdhaskfjh', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. A maximum of 300 entries can be returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The type of the service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], + ], + [ + 'name' => 'SubscriptionType', + 'in' => 'query', + 'schema' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Subscription: subscription'."\n" + .'* PayAsYouGo: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo', 'title' => ''], + ], + [ + 'name' => 'RenewalPeriodUnit', + 'in' => 'query', + 'schema' => ['description' => 'The unit of the auto-renewal period. Valid values:'."\n" + ."\n" + .'* M: months'."\n" + .'* Y: years'."\n" + ."\n" + .'> This parameter is required if the RenewalStatus parameter is set to AutoRenewal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'M', 'title' => ''], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => ['description' => 'The status of renewal. Valid values:'."\n" + ."\n" + .'* AutoRenewal: The instance is automatically renewed.'."\n" + .'* ManualRenewal: The instance is manually renewed.'."\n" + .'* NotRenewal: The instance is not renewed.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AutoRenewal', 'title' => ''], ], ], 'responses' => [ @@ -19372,157 +13088,145 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CostUnitDtoList' => [ - 'description' => 'The cost centers.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParentUnitId' => [ - 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'UnitName' => [ - 'description' => 'The name of the cost center.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23534', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2343464', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CostUnitDtoList\\": [\\n {\\n \\"ParentUnitId\\": -1,\\n \\"UnitName\\": \\"test\\",\\n \\"UnitId\\": 23534,\\n \\"OwnerUid\\": 2343464\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCostUnitResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <PageNum/>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n </Data>\\n</QueryCostUnitResponse>","errorExample":""}]', - 'title' => 'QueryCostUnit', - 'summary' => 'Queries all cost centers within the current node of the cost center tree. If the ParentUnitId parameter is set to -1, all cost centers are queried.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetRenewalResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n</SetRenewalResponse>","errorExample":""}]', + 'title' => 'SetRenewal', + 'summary' => 'Enables auto-renewal for an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryCostUnitResource' => [ - 'summary' => 'Queries the resource instances that are allocated to a cost center. If the unitId parameter is set to 0, the unallocated primary resource instances and sub-resource instances are queried.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-01-25T01:35:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-06T08:58:50.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetRenewal'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SetResellerUserAlarmThreshold' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'OwnerUid', + 'name' => 'AlarmType', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '23453245', - ], + 'schema' => ['description' => 'The alert type. The value quota\\_low\\_balance indicates a low-balance alert for a quota.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'quota_low_balance'], ], [ - 'name' => 'UnitId', + 'name' => 'AlarmThresholds', 'in' => 'query', + 'schema' => ['description' => 'A list of alert rules for the specified alert type. If you do not specify this parameter, no alert threshold is set.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '[{\\"denominator\\":100,\\"numerator\\":30,\\"thresholdType\\":1}]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '235325', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code that is returned if the call fails. For more information, see Error codes.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The message returned for the call.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'Data' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'], + 'Success' => ['description' => 'Indicates whether the call was successful. `true`: success. `false`: failure.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'SetResellerUserAlarmThreshold', + 'description' => 'Sets a low-balance alert rule for a user\'s quota.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserAlarmThreshold'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'summary' => '', + ], + 'SetResellerUserQuota' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The quota of a quota ledger. Unit: CNY.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '750', 'title' => ''], + ], + [ + 'name' => 'Currency', + 'in' => 'query', + 'schema' => ['description' => 'You do not need to set the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'N/A'."\n", 'title' => ''], + ], + [ + 'name' => 'OutBizId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the business.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OD2022040818295234777795624764689', 'title' => ''], ], ], 'responses' => [ @@ -19530,525 +13234,372 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '04332CB7-9A57-4461-97E0-02821D044414', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'ResourceInstanceDtoList' => [ - 'description' => 'The resource instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CommodityCode' => [ - 'description' => 'The product code of the resource.'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'ResourceUserName' => [ - 'description' => 'The username of the resource owner.'."\n", - 'type' => 'string', - 'example' => 'test@test.aliyun.com', - ], - 'CommodityName' => [ - 'description' => 'The commodity name of the resource.'."\n", - 'type' => 'string', - 'example' => 'ApsaraDB'."\n", - ], - 'ResourceUserId' => [ - 'description' => 'The user ID of the resource owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2424242134', - ], - 'ApportionName' => [ - 'description' => 'The split name of the resource.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ApportionCode' => [ - 'description' => 'The split code of the resource.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'FPT_ossbag_absolute_Storage_bj', - ], - 'ResourceNick' => [ - 'description' => 'The custom name of the resource.'."\n", - 'type' => 'string', - 'example' => 'testResource', - ], - 'ResourceTag' => [ - 'description' => 'The tags of the resource.'."\n", - 'type' => 'string', - 'example' => 'testResource', - ], - 'ResourceId' => [ - 'description' => 'The instance ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'OSSBAG-cn-v0h1s4hma018', - ], - 'ResourceGroup' => [ - 'description' => 'The resource group to which the resource belongs.'."\n", - 'type' => 'string', - 'example' => 'Default Resource Group'."\n", - ], - 'RelatedResources' => [ - 'description' => 'The resources related to the resource instance.'."\n", - 'type' => 'string', - 'example' => 'oss', - ], - 'ResourceStatus' => [ - 'description' => 'The status of the resource.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'PipCode' => [ - 'description' => 'The code of the service. The code is the same as that in Cost Center.', - 'type' => 'string', - 'example' => 'rds', - ], - 'ResourceSource' => [ - 'description' => 'The source of the resource. Value:'."\n" - .'- AUTO_ALLOCATE'."\n" - .'- MANUAL_ALLOCATE', - 'type' => 'string', - 'example' => 'MANUAL_ALLOCATE', - ], - ], - ], - ], - 'CostUnit' => [ - 'description' => 'The information about the cost center.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParentUnitId' => [ - 'description' => 'The ID of the parent cost center. A value of -1 indicates the root cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23421', - ], - 'UnitName' => [ - 'description' => 'The name of the cost center.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'UnitId' => [ - 'description' => 'The ID of the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123412', - ], - 'OwnerUid' => [ - 'description' => 'The user ID of the cost center owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '321432', - ], - ], - ], - 'CostUnitStatisInfo' => [ - 'description' => 'The statistical information about the cost center.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalResourceCount' => [ - 'description' => 'The total number of resource instances, including resource instances of sub-cost centers, in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ResourceCount' => [ - 'description' => 'The number of resource instances in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalUserCount' => [ - 'description' => 'The total number of the associated accounts, including associated accounts of sub-cost centers, in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'SubUnitCount' => [ - 'description' => 'The number of sub-cost centers in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ResourceGroupCount' => [ - 'description' => 'The number of resource groups in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalResourceGroupCount' => [ - 'description' => 'The total number of resource groups, including resource groups of sub-cost centers, in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'UserCount' => [ - 'description' => 'The number of sub-cost centers in the cost center.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call failed. For more information, see the "Error codes" section of this topic.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - '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":"<QueryCostUnitResourceResponse>\\n <Code>Success</Code>\\n <Message>Successful！</Message>\\n <RequestId>04332CB7-9A57-4461-97E0-02821D044414</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <TotalCount>12</TotalCount>\\n <ResourceInstanceDtoList>\\n <CommodityCode>rds</CommodityCode>\\n <ResourceUserName>test@test.aliyun.com</ResourceUserName>\\n <CommodityName>云数据库</CommodityName>\\n <ResourceUserId>2424242134</ResourceUserId>\\n <ApportionName>test</ApportionName>\\n <ApportionCode>test</ApportionCode>\\n <ResourceType>FPT_ossbag_absolute_Storage_bj</ResourceType>\\n <ResourceNick>testResource</ResourceNick>\\n <ResourceTag>testResource</ResourceTag>\\n <ResourceId>OSSBAG-cn-v0h1s4hma018</ResourceId>\\n <ResourceGroup>默认资源组</ResourceGroup>\\n <RelatedResources>oss</RelatedResources>\\n <ResourceStatus>Available</ResourceStatus>\\n <PipCode>rds</PipCode>\\n <ResourceSource>MANUAL_ALLOCATE</ResourceSource>\\n </ResourceInstanceDtoList>\\n <CostUnit>\\n <ParentUnitId>23421</ParentUnitId>\\n <UnitName>test</UnitName>\\n <UnitId>123412</UnitId>\\n <OwnerUid>321432</OwnerUid>\\n </CostUnit>\\n <CostUnitStatisInfo>\\n <TotalResourceCount>3</TotalResourceCount>\\n <ResourceCount>1</ResourceCount>\\n <TotalUserCount>2</TotalUserCount>\\n <SubUnitCount>2</SubUnitCount>\\n <ResourceGroupCount>1</ResourceGroupCount>\\n <TotalResourceGroupCount>2</TotalResourceGroupCount>\\n <UserCount>0</UserCount>\\n </CostUnitStatisInfo>\\n </Data>\\n</QueryCostUnitResourceResponse>","errorExample":""}]', - 'title' => 'QueryCostUnitResource', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryFinancialAccountInfo' => [ - 'methods' => [ - 'post', - 'get', + '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\\": \\"F5B803CF-94D8-43AF-ADB3-D819AAD30E27\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify the quota ledger and consumption ledger.', + 'summary' => 'Modify the quota ledger and consumption ledger.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetResellerUserStatus' => [ + 'summary' => 'Enables or disables the SQL audit feature for users.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1990699401005016', - ], + 'schema' => ['description' => 'The status to set for the user account. Valid values:'."\n" + .'Freeze: The user account is frozen.'."\n" + .'Thaw: The user account is restored.'."\n" + .'Trusteeship: The user account is hosted.'."\n" + .'TrusteeshipCancel: The user account is not hosted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Freeze', 'title' => ''], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => ['description' => 'The type of business operation. Valid values:'."\n" + .'FREEZE: Freeze operations.'."\n" + .'TRUSTEESHIP: Hosting operations.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FREEZE', 'title' => ''], + ], + [ + 'name' => 'StopMode', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The stopping mode. Valid values:'."\n" + .'0: Normal shutdown.'."\n" + .'1: Immediate shutdown.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '97426BC2-792E-41F5-92B8-73C710DA7779', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'MemberNickName' => [ - 'description' => 'The display name of the member.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'IsFinancialAccount' => [ - 'description' => 'Indicates whether the account is a financial account. A value of true indicates that the account is a financial account. A value of false indicates that the account is not a financial account.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MemberGroupName' => [ - 'description' => 'The name of the group to which the member belongs.'."\n", - 'type' => 'string', - 'example' => 'Test group'."\n", - ], - 'UserName' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'example' => 'killortop3', - ], - 'AccountType' => [ - 'description' => 'The type of the financial account. A value of MASTER indicates that the account is a management account. A value of MEMBER indicates that the account is a member.'."\n", - 'type' => 'string', - 'example' => 'MEMBER', - ], - 'MemberGroupId' => [ - 'description' => 'The ID of the group to which the member belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '124', - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see the Error codes section.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. `true`: success. `false`: an error occurred.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => '-116', 'errorMessage' => 'Fail to modify Enduser status, Quota is less than 0.', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified request contains invalid parameters.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified request lacks essential parameters.', - ], + ['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' => 'Only set to downtime hosting is supported'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred in the internal server.', - ], + ['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\\": \\"97426BC2-792E-41F5-92B8-73C710DA7779\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MemberNickName\\": \\"测试\\",\\n \\"IsFinancialAccount\\": true,\\n \\"MemberGroupName\\": \\"测试组\\",\\n \\"UserName\\": \\"killortop3\\",\\n \\"AccountType\\": \\"MEMBER\\",\\n \\"MemberGroupId\\": 124\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>Successful!</Message>\\n<RequestId>97426BC2-792E-41F5-92B8-73C710DA7779</RequestId>\\n<Data>\\n <UserName>killortop3</UserName>\\n <MemberGroupName>测试组</MemberGroupName>\\n <MemberNickName>测试</MemberNickName>\\n <IsFinancialAccount>true</IsFinancialAccount>\\n <MemberGroupId>124</MemberGroupId>\\n <AccountType>MEMBER</AccountType>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - 'summary' => 'Queries the information about a financial account.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryEvaluateList' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'SetResellerUserStatus', + 'description' => 'Sets the status of a reseller\'s user account, such as frozen or hosted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetResellerUserStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SubscribeBillToOSS' => [ + 'summary' => 'Subscribes to bill files and stores the bill data in a specified Object Storage Service (OSS) bucket.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'SubscribeBucket', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of orders to be queried. Valid values:'."\n" - ."\n" - .'* 1: the orders in which the invoiceable amount is negative.'."\n" - .'* 2: the orders in which the invoiceable amount is positive.'."\n" - .'* 3: the orders in which the invoiceable amount is not 0.'."\n" - .'* 4: the orders in which the amount that has been invoiced is greater than 0.'."\n" - ."\n" - .'> By default, this parameter is left empty. If this parameter is left empty, all orders are queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the OSS bucket where the subscribed bill files are stored.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'xxxxxx-bucket'], ], [ - 'name' => 'OutBizId', + 'name' => 'SubscribeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the external order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2387432832696', - ], + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- BillingItemDetailForBillingPeriod: bill details by billing item.'."\n" + ."\n" + .'- InstanceDetailForBillingPeriod: bill details by instance.'."\n" + ."\n" + .'- BillingItemDetailMonthly: monthly bill summary by billing item.'."\n" + ."\n" + .'- InstanceDetailMonthly: monthly bill summary by instance.'."\n" + ."\n" + .'- SplitItemDetailDaily: daily summary of split bills.'."\n" + ."\n" + .'- MonthBill: monthly bill in PDF format. You can subscribe to monthly bills only for an Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'BillingItemDetailForBillingPeriod'], ], [ - 'name' => 'PageNum', + 'name' => 'MultAccountRelSubscribe', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The type of bill to which you want to subscribe. This parameter is available only for multi-tier accounts. Valid values:'."\n" + ."\n" + .'- MA: Pushes the bills of the Alibaba Cloud account and the bills of non-trusteeship linked accounts.'."\n" + ."\n" + .'- ACP1: Pushes the bills of sub-accounts of a virtual dealer.'."\n" + ."\n" + .'Default: MA.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MA'], ], [ - 'name' => 'PageSize', + 'name' => 'BucketOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The UID of the OSS bucket owner. This parameter is required only when a distributor subscribes to bills and saves them to an OSS bucket of a sub-account. In this case, the sub-account must be a sub-account of the distributor\'s account and granted the AliyunConsumeDump2OSSRole permission.'."\n" + .'Regular users do not need to specify this parameter. By default, the UID of the current account is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '12341324'], ], [ - 'name' => 'StartAmount', + 'name' => 'BeginBillingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount to be queried.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The initial billing cycle from which bills are pushed. After you subscribe to the bills, the system automatically pushes the data from the initial billing cycle to the current time. This parameter is invalid for monthly bill subscriptions in PDF format. Historical data is not repushed. You can push data generated within the last year.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2021-03'], ], [ - 'name' => 'EndAmount', + 'name' => 'BucketPath', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum amount to be queried.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['title' => '', 'description' => 'The specified folder in the bucket to which you subscribe.', 'type' => 'string', 'required' => false, 'example' => 'testpath'], ], [ - 'name' => 'StartBizTime', + 'name' => 'RowLimitPerFile', 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest time when an order is paid. Specify the time in the yyyy-mm-dd hh:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 12:00:00', - ], + 'schema' => ['description' => 'The maximum number of rows in a single file. If a bill file exceeds this limit, it is split into multiple files. The files are then merged and compressed into a ZIP package.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '300000'], ], [ - 'name' => 'EndBizTime', + 'name' => 'UsingSsl', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use Secure Sockets Layer (SSL) to protect network communications. Valid values:'."\n" + ."\n" + .'- true: Enables SSL encryption to ensure data security and integrity during transmission.'."\n" + ."\n" + .'- false (default): Disables SSL encryption.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The latest time when an order is paid Specify the time in the yyyy-mm-dd hh:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 15:00:00', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F61FCE4B-9B56-4FD9-A17E-******'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"F61FCE4B-9B56-4FD9-A17E-******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'SubscribeBillToOSS', + 'description' => 'Note the following when you call this operation:'."\n" + ."\n" + .'- You can subscribe to only one type of bill file at a time.'."\n" + ."\n" + .'- After you subscribe, the system starts to push the previous day\'s bill file daily. On the fourth day of each month, the system pushes the full bill file for the previous billing cycle. The monthly bill in PDF format for the previous month is also pushed on the fourth day of each month.'."\n" + ."\n" + .'- The generation of daily bill files may be delayed. A delayed bill file is pushed on the following day. This file may also include bill data that was delayed from the previous day. Pull the full data for the previous month at the beginning of each month.'."\n" + ."\n" + .'> The first time you subscribe to bills using OSS, you must grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subscriber. If the authorization is revoked, the system stops pushing files. You must grant the permission again.'."\n" + ."\n" + .'- This subscription is equivalent to the "Data Storage" feature in the Expenses and Costs console. The subscriptions are synchronized.'."\n" + ."\n" + .'- When you subscribe to a folder in a bucket, make sure that the folder name meets the following requirements:'."\n" + ."\n" + .' - Do not use emojis. Use valid UTF-8 characters.'."\n" + ."\n" + .' - Use a forward slash (/) to separate paths and create subdirectories. Do not start a name with a forward slash (/) or a backslash (\\\\). Do not use consecutive forward slashes (/).'."\n" + ."\n" + .' - Do not name a subdirectory "..".'."\n" + ."\n" + .' - The total length must be 1 to 254 characters.'."\n" + ."\n" + .'- File names:'."\n" + ."\n" + .' - **BillingItemDetailForBillingPeriod** (Bill details by billing item)'."\n" + ."\n" + .' - Format of daily pushed files: `UID_BillingItemDetail_YYYYMMDD`. Example: `169**_BillingItemDetail_20190310`.'."\n" + ."\n" + .' - Format of full files at the beginning of the next month: `UID_BillingItemDetail_YYYYMM`. Example: `169**_BillingItemDetail_201903`.'."\n" + ."\n" + .' - **InstanceDetailForBillingPeriod** (Bill details by instance)'."\n" + ."\n" + .' - Format of daily pushed files: `UID_InstanceDetail_YYYYMMDD`. Example: `169**_InstanceDetail_20190310`.'."\n" + ."\n" + .' - Format of full files at the beginning of the next month: `UID_InstanceDetail_YYYYMM`. Example: `169**_InstanceDetail_201903`.'."\n" + ."\n" + .' - **InstanceDetailMonthly** (Monthly bill summary by instance)'."\n" + ."\n" + .' - Format of daily pushed files: `UID_InstanceDetailMonthly_YYYYMM`. Example: `169**_InstanceDetailMonthly_201903`. This file is updated daily with the full data from the beginning of the month to the current day. This process continues until the fourth day of the next month.'."\n" + ."\n" + .' - **BillingItemDetailMonthly** (Monthly bill summary by billing item)'."\n" + ."\n" + .' - Format of daily pushed files: `UID_BillingItemDetailMonthly_YYYYMM`. Example: `169**_BillingItemDetailMonthly_201903`. This file is updated daily with the full data from the beginning of the month to the current day. This process continues until the fourth day of the next month.'."\n" + ."\n" + .' - **SplitItemDetailDaily** (Daily summary of split bills)'."\n" + ."\n" + .' - Format of daily pushed files: `UID_SplitItemDetailDaily_YYYYMM`. Example: `169**_SplitItemDetailDaily_201903`. This file is updated daily with the full data from the beginning of the month to the current day. This process continues until the fourth day of the next month.'."\n" + ."\n" + .' - **MonthBill** (Monthly bill in PDF)'."\n" + ."\n" + .' - Format of monthly pushed files: `UID_MonthBill_YYYYMM`. Example: `169**_MonthBill_201903`. The bill file for the previous month is pushed on the fourth day of each month.'."\n" + ."\n" + .'- Except for MonthBill files, which are in PDF format, all other files are in CSV format. If the number of data rows in a bill exceeds a specific threshold, the bill is split into multiple CSV files. These files are then merged and compressed into a ZIP file. The ZIP file uses the same file name format.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubscribeBillToOSS'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SortType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the sort. Valid values:'."\n" - ."\n" - .'* 1: Sort invoices by ID in descending order.'."\n" - .'* 2: Sort invoices by invoice type in descending order, and then sort invoices of the same type by ID in descending order.'."\n" - .'* 3: Sort invoices by invoice type in ascending order, and then sort invoices of the same type by ID in descending order.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartSearchTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 12:00:00', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EndSearchTime', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-02 12:00:00', - ], + 'schema' => ['description' => 'The resource type. Set the value to instance for savings plan instances.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'instance'], ], [ - 'name' => 'BillCycle', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The billing cycle.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '202003', + 'description' => 'The list of resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spn-XXXXXX'], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BizTypeList', + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The market types in invoices.'."\n" - ."\n" - .'> By default, this parameter is left empty. If this parameter is left empty, all market types are queried.'."\n", + 'description' => 'The list of tags. You can add 1 to 20 tags at a time.', 'type' => 'array', 'items' => [ - 'description' => 'The market type in the invoice. Valid values:'."\n" - ."\n" - .'* ALIYUN: Alibaba Cloud'."\n" - .'* MARKETPLACE: Alibaba Cloud Marketplace'."\n", - 'type' => 'string', + 'description' => 'The tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. An empty string is allowed.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tag1'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '001'], + ], 'required' => false, - 'example' => 'ALIYUN', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'example' => 'ALIYUN', - 'maxItems' => 100, + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], @@ -20057,568 +13608,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D35FF10E-1B2E-4ABA-8401-0AE17725F50B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The number of the page returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalUnAppliedInvoiceAmount' => [ - 'description' => 'The invoiceable amount that meets the query conditions. Unit: Cent.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12344', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalInvoiceAmount' => [ - 'description' => 'The invoiced amount that meets the query conditions. Unit: Cent.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12344', - ], - 'HostId' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'EvaluateList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Evaluate' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of orders that are queried. Valid values:'."\n" - ."\n" - .'* 1: the orders in which the invoiceable amount is negative.'."\n" - .'* 2: the orders in which the invoiceable amount is positive.'."\n" - .'* 3: the orders in which the invoiceable amount is not 0.'."\n" - .'* 4: the orders in which the amount that has been invoiced is greater than 0.'."\n" - ."\n" - .'> By default, this parameter is left empty. If this parameter is left empty, all orders are queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'The status of the invoiceable amount.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BillId' => [ - 'description' => 'The ID of the bill.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234543254325', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2738543', - ], - 'BillCycle' => [ - 'description' => 'The billing cycle.'."\n", - 'type' => 'string', - 'example' => '202002', - ], - 'CanInvoiceAmount' => [ - 'description' => 'The invoiceable amount.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123213', - ], - 'OffsetAcceptAmount' => [ - 'description' => 'If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the **OffsetCostAmount** parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'ItemId' => [ - 'description' => 'The ID of the item.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23453245', - ], - 'OutBizId' => [ - 'description' => 'The ID of the external order.'."\n", - 'type' => 'string', - 'example' => '124324213421', - ], - 'UserNick' => [ - 'description' => 'The nickname of the user.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GmtModified' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'string', - 'example' => '2018-10-10 18:05:44', - ], - 'OpId' => [ - 'description' => 'The ID of the external object.'."\n", - 'type' => 'string', - 'example' => '12341', - ], - 'BizType' => [ - 'description' => 'The market type in the invoice. Valid values:'."\n" - ."\n" - .'* ALIYUN: Alibaba Cloud'."\n" - .'* MARKETPLACE: Alibaba Cloud Marketplace'."\n", - 'type' => 'string', - 'example' => 'ALIYUN', - ], - 'OriginalAmount' => [ - 'description' => 'The original amount.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-10000', - ], - 'InvoicedAmount' => [ - 'description' => 'The invoiced amount.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'GmtCreate' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2018-10-10 18:05:44', - ], - 'PresentAmount' => [ - 'description' => 'The balance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-10000', - ], - 'BizTime' => [ - 'description' => 'The time.'."\n", - 'type' => 'string', - 'example' => '2018-10-10 18:05:44', - ], - 'Name' => [ - 'description' => 'The name of the object to be invoiced.'."\n", - 'type' => 'string', - 'example' => 'Refund of a voucher with denomination marked'."\n", - ], - 'OffsetCostAmount' => [ - 'description' => 'The refund amount used to offset the amount of the invoice. If a refund is issued due to an order such as an unsubscription order or a configuration downgrade order, the refund amount is used to offset the amount of the invoice. The value is consistent with the value of the **OffsetAcceptAmount** parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '500', - ], - 'Id' => [ - 'description' => 'The ID of the invoice.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1325321532', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'InternalError'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'This API is not applicable for caller.'], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1537A007-72D7-4165-8A26-8694A38E219A'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful！\\",\\n \\"RequestId\\": \\"D35FF10E-1B2E-4ABA-8401-0AE17725F50B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"TotalUnAppliedInvoiceAmount\\": 12344,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"TotalInvoiceAmount\\": 10000,\\n \\"HostId\\": \\"\\",\\n \\"EvaluateList\\": {\\n \\"Evaluate\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 1,\\n \\"BillId\\": 0,\\n \\"UserId\\": 2738543,\\n \\"BillCycle\\": \\"202502\\",\\n \\"CanInvoiceAmount\\": 5000,\\n \\"OffsetAcceptAmount\\": -5000,\\n \\"ItemId\\": 0,\\n \\"OutBizId\\": \\"124324213421\\",\\n \\"UserNick\\": \\"HelloWorld\\",\\n \\"GmtModified\\": \\"2025-01-01 00:00:00\\",\\n \\"OpId\\": \\"\\",\\n \\"BizType\\": \\"ALIYUN\\",\\n \\"OriginalAmount\\": 10000,\\n \\"InvoicedAmount\\": 10000,\\n \\"GmtCreate\\": \\"2025-02-01 00:00:00\\",\\n \\"PresentAmount\\": 10000,\\n \\"BizTime\\": \\"2025-02-01 00:00:00\\",\\n \\"Name\\": \\"云服务器ECS(包月)\\",\\n \\"OffsetCostAmount\\": 5000,\\n \\"Id\\": 1325321532\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEvaluateListResponse>\\n <Message>Successful!</Message>\\n <RequestId>D35FF10E-1B2E-4ABA-8401-0AE17725F50B</RequestId>\\n <Data>\\n <TotalInvoiceAmount>8532</TotalInvoiceAmount>\\n <TotalCount>23</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNum>1</PageNum>\\n <TotalUnAppliedInvoiceAmount>8532</TotalUnAppliedInvoiceAmount>\\n <HostId>cn</HostId>\\n <EvaluateList>\\n <Evaluate>\\n <Status>1</Status>\\n <OffsetCostAmount>0</OffsetCostAmount>\\n <BizTime>2020-03-09 10:43:57</BizTime>\\n <GmtModified>2020-03-09 10:45:02</GmtModified>\\n <BillCycle>202003</BillCycle>\\n <BizType>ALIYUN_SERVICE</BizType>\\n <PresentAmount>1</PresentAmount>\\n <OriginalAmount>1</OriginalAmount>\\n <Name>关系型数据库RDS(包月)</Name>\\n <GmtCreate>2020-03-09 10:45:02</GmtCreate>\\n <Type>1</Type>\\n <UserId>1857xxxxxx3489</UserId>\\n <OffsetAcceptAmount>0</OffsetAcceptAmount>\\n <Id>23345345553</Id>\\n <OutBizId>20xxxxxxx112</OutBizId>\\n <InvoicedAmount>0</InvoicedAmount>\\n <CanInvoiceAmount>1</CanInvoiceAmount>\\n </Evaluate>\\n </EvaluateList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryEvaluateListResponse>","errorExample":""}]', - 'summary' => 'Queries the information about the orders for which you want to apply for invoices.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryCustomerAddressList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'TagResources', + 'summary' => 'Adds tags to resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomerInvoiceAddressList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CustomerInvoiceAddress' => [ - 'description' => 'The details of addresses to which invoices are mailed.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Addressee' => [ - 'description' => 'The addressee.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PostalCode' => [ - 'description' => 'The postcode.'."\n", - 'type' => 'string', - 'example' => '000000', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4382956342857', - ], - 'City' => [ - 'description' => 'The city to which the invoice is mailed.'."\n", - 'type' => 'string', - 'example' => 'Hangzhou'."\n", - ], - 'UserNick' => [ - 'description' => 'The nickname of the user.'."\n", - 'type' => 'string', - 'example' => 'testNick', - ], - 'Street' => [ - 'description' => 'The name of the street to which the invoice is mailed.'."\n", - 'type' => 'string', - 'example' => 'Test Street'."\n", - ], - 'Phone' => [ - 'description' => 'The phone number of the addressee.'."\n", - 'type' => 'string', - 'example' => '138xxxxxxxx', - ], - 'County' => [ - 'description' => 'The name of the district to which the invoice is mailed.'."\n", - 'type' => 'string', - 'example' => 'Test District'."\n", - ], - 'BizType' => [ - 'description' => 'The business type.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DeliveryAddress' => [ - 'description' => 'The detailed address to which the invoice is mailed. This parameter is returned after fields are concatenated.'."\n", - 'type' => 'string', - 'example' => 'Test Address'."\n", - ], - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '311601051', - ], - 'Province' => [ - 'description' => 'The province to which the invoice is mailed.'."\n", - 'type' => 'string', - 'example' => 'Zhejiang'."\n", - ], - ], - ], - ], - ], - ], - ], - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CustomerInvoiceAddressList\\": {\\n \\"CustomerInvoiceAddress\\": [\\n {\\n \\"Addressee\\": \\"\\",\\n \\"PostalCode\\": \\"\\",\\n \\"UserId\\": 0,\\n \\"City\\": \\"\\",\\n \\"UserNick\\": \\"\\",\\n \\"Street\\": \\"\\",\\n \\"Phone\\": \\"\\",\\n \\"County\\": \\"\\",\\n \\"BizType\\": \\"\\",\\n \\"DeliveryAddress\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Province\\": \\"\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCustomerAddressListResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <CustomerInvoiceAddressList>\\n <CustomerInvoiceAddress>\\n <Phone>186********</Phone>\\n <Street>测试街道</Street>\\n <PostalCode>000000</PostalCode>\\n <County>测试区</County>\\n <DeliveryAddress>浙江省杭州市**********</DeliveryAddress>\\n <Id>311601051</Id>\\n <Addressee>test</Addressee>\\n <UserId>169***********</UserId>\\n <Province>浙江*</Province>\\n <City>杭州*</City>\\n </CustomerInvoiceAddress>\\n </CustomerInvoiceAddressList>\\n </Data>\\n</QueryCustomerAddressListResponse>","errorExample":""}]', - 'summary' => 'Queries the addresses to which invoices are mailed.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryInvoicingCustomerList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnsubscribeBillToOSS' => [ + 'summary' => 'Unsubscribes from the detailed bill export service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => ['description' => 'The subscription type. Valid values:'."\n" + ."\n" + .'- BillingItemDetailForBillingPeriod: detailed bills of billable items.'."\n" + ."\n" + .'- InstanceDetailForBillingPeriod: detailed bills of instances.'."\n" + ."\n" + .'- BillingItemDetailMonthly: monthly summary of bills by billable item.'."\n" + ."\n" + .'- InstanceDetailMonthly: monthly summary of bills by instance.'."\n" + ."\n" + .'- SplitItemDetailDaily: daily summary of split bills.'."\n" + ."\n" + .'- MonthBill: monthly bills in PDF format. You can only subscribe to the bills of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'BillingItemDetailForBillingPeriod'], + ], + [ + 'name' => 'MultAccountRelSubscribe', + 'in' => 'query', + 'schema' => ['description' => 'The type of bill to push for a multi-level account. Valid values:'."\n" + ."\n" + .'- MA: pushes the bills of the Alibaba Cloud account.'."\n" + ."\n" + .'- ACP1: pushes the bills of a reseller\'s sub-account.'."\n" + ."\n" + .'Default value: MA.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'MA'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BBEF51A3-E933-4F40-A534-C673CBDB9C80', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomerInvoiceList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CustomerInvoice' => [ - 'description' => 'The information about the invoice.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the invoice. Valid values:'."\n" - ."\n" - .'* 0: plain value-added tax (VAT) invoice'."\n" - .'* 1: special VAT invoice'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'The status of the invoice title.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AdjustType' => [ - 'description' => 'The type of invoice that was changed to.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Bank' => [ - 'description' => 'The bank that issues the invoice.'."\n", - 'type' => 'string', - 'example' => 'Test Bank'."\n", - ], - 'StartCycle' => [ - 'description' => 'The time when the payment started.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202002', - ], - 'TitleChangeInstructions' => [ - 'description' => 'The instruction document of the invoice title change.'."\n", - 'type' => 'string', - 'example' => 'instruction.doc', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34565465675', - ], - 'OperatingLicenseAddress' => [ - 'description' => 'The address of the business license.'."\n", - 'type' => 'string', - 'example' => 'XXX, XXX district, XXX city, XXX province'."\n", - ], - 'InvoiceTitle' => [ - 'description' => 'The company name in the invoice title.'."\n", - 'type' => 'string', - 'example' => 'Test Company'."\n", - ], - 'UserNick' => [ - 'description' => 'The nickname of the user.'."\n", - 'type' => 'string', - 'example' => 'testNick', - ], - 'OperatingLicensePhone' => [ - 'description' => 'The phone number of the business license.'."\n", - 'type' => 'string', - 'example' => '138xxxxxxxx', - ], - 'EndCycle' => [ - 'description' => 'The time when the payment ended.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202003', - ], - 'DefaultRemark' => [ - 'description' => 'The default note that is attached when the title is specified.'."\n", - 'type' => 'string', - 'example' => 'PO Code: 12984554'."\n", - ], - 'TaxationLicense' => [ - 'description' => 'The path and file name of the scanned copy of the tax registration certificate.'."\n", - 'type' => 'string', - 'example' => 'taxationLicense.jpg', - ], - 'RegisterNo' => [ - 'description' => 'The tax registration number.'."\n", - 'type' => 'string', - 'example' => '21343245342534', - ], - 'GmtCreate' => [ - 'description' => 'The time when the invoice was created. The time was in the yyyy-mm-dd hh:mm:ss format.'."\n", - 'type' => 'string', - 'example' => '2018-09-07 15:26:20', - ], - 'TaxpayerType' => [ - 'description' => 'The type of the taxpayer. Valid values:'."\n" - ."\n" - .'* 1: general taxpayer'."\n" - .'* 2: special taxpayer'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CustomerType' => [ - 'description' => 'The authentication type of Alipay. Valid values:'."\n" - ."\n" - .'* 1: individual'."\n" - .'* 2: company'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'IssueType' => [ - 'description' => 'The type of issue.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'description' => 'The ID of the invoice.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '239875502738', - ], - 'BankNo' => [ - 'description' => 'The bank account number.'."\n", - 'type' => 'string', - 'example' => '389576348573296349853476', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Successful!'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D23FE74C-742F-4624-A82B-******'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"BBEF51A3-E933-4F40-A534-C673CBDB9C80\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CustomerInvoiceList\\": {\\n \\"CustomerInvoice\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 2,\\n \\"AdjustType\\": 1,\\n \\"Bank\\": \\"测试银行\\",\\n \\"StartCycle\\": 202002,\\n \\"TitleChangeInstructions\\": \\"instruction.doc\\",\\n \\"UserId\\": 34565465675,\\n \\"OperatingLicenseAddress\\": \\"某某省某某市某某区某地址\\",\\n \\"InvoiceTitle\\": \\"测试公司\\",\\n \\"UserNick\\": \\"testNick\\",\\n \\"OperatingLicensePhone\\": \\"138xxxxxxxx\\",\\n \\"EndCycle\\": 202003,\\n \\"DefaultRemark\\": \\"PO代码：12984554\\",\\n \\"TaxationLicense\\": \\"taxationLicense.jpg\\",\\n \\"RegisterNo\\": \\"21343245342534\\",\\n \\"GmtCreate\\": \\"2025-02-01 00:00:00\\",\\n \\"TaxpayerType\\": 1,\\n \\"CustomerType\\": 1,\\n \\"IssueType\\": 1,\\n \\"Id\\": 239875502738,\\n \\"BankNo\\": \\"389576348573296349853476\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryInvoicingCustomerListResponse>\\n <Message>Successful!</Message>\\n <RequestId>BBEF51A3-E933-4F40-A534-C673CBDB9C80</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <CustomerInvoiceList>\\n <CustomerInvoice>\\n <Status>2</Status>\\n <CustomerType>2</CustomerType>\\n <Id>50000************</Id>\\n <InvoiceTitle>个人</InvoiceTitle>\\n <UserId>169***********</UserId>\\n <GmtCreate>2018-09-07 15:26:20</GmtCreate>\\n <TaxpayerType>2</TaxpayerType>\\n </CustomerInvoice>\\n </CustomerInvoiceList>\\n </Data>\\n</QueryInvoicingCustomerListResponse>","errorExample":""}]', - 'summary' => 'Queries the information about invoice titles.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D23FE74C-742F-4624-A82B-******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UnsubscribeBillToOSS', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ApplyInvoice' => [ - 'summary' => 'Submits an application for an invoice.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnsubscribeBillToOSS'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UntagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20626,128 +13734,114 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InvoiceAmount', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The amount of the invoice. Unit: Cent.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '124132', - ], + 'schema' => ['description' => 'The resource type. Set the value to `instance`. This value indicates a savings plan instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'instance'], ], [ - 'name' => 'CustomerId', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the customer. Set the ID to the value of the CustomerId parameter returned by calling the QueryInvoicingCustomerList operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '124132423', - ], + 'schema' => ['description' => 'Specifies whether to remove all tags. This parameter is valid only when `TagKey.N` is not specified. Valid values: `true` and `false`.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'AddressId', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the address to which the invoice is delivered. This parameter is required if the invoice is a paper invoice. Set the ID to the value of the AddressId parameter returned by calling the QueryCustomerAddressList operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The list of resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spn-xxxxxx'], 'required' => true, - 'docRequired' => true, - 'example' => '237958367', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InvoicingType', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the invoice. Valid values:'."\n" - ."\n" - .'* 0: paper invoice'."\n" - .'* 1: electronic invoice'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag key. The value of N can be an integer from 1 to 20.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'codename'], 'required' => false, - 'example' => '1', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ProcessWay', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The channel that is used to process the invoice. A value of 0 indicates that the invoice is processed by Alibaba Cloud. A value of 1 indicates that the invoice is processed by the tax platform. Set the value to 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'The information about the return value.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'PARAM_ERROR'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'This API is not applicable for caller.'], + 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C7C15585-8349-4C62-BEE4-5A391841B9BE'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'UntagResources', + 'summary' => 'Removes tags from resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ApplyUserNick', - 'in' => 'query', - 'schema' => [ - 'description' => 'The nickname of the applicant. The system does not verify the nickname.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpgradeResourcePackage' => [ + 'summary' => 'Upgrades a resource plan.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InvoiceByAmount', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to invoice by amount. A value of true indicates that the user applies for the invoice based on the InvoiceAmount parameter. A value of false indicates that the user applies for the invoice based on the total amount of the invoicing items.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'UserRemark', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The remarks made by the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the resource plan.', 'type' => 'string', 'required' => true, 'example' => 'OSSBAG-cn-0xl*****x002', 'title' => ''], ], [ - 'name' => 'SelectedIds', + 'name' => 'EffectiveDate', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the selected invoicing items. Set the IDs to the IDs returned by calling the QueryEvaluateList operation.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '384752367', - ], - 'required' => true, - 'example' => '384752367', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2020-02-02T12:00:00Z', 'title' => ''], ], [ - 'name' => 'emails', + 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The specifications to which you want to upgrade the resource plan.', 'type' => 'string', 'required' => false, 'example' => '51200', 'title' => ''], ], ], 'responses' => [ @@ -20755,1655 +13849,1723 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'integer', 'format' => 'int64', 'example' => '73387246238746', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'InvoiceApplyId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1323125534', - ], + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'integer', 'format' => 'int64', 'example' => '73387246238746', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the resource plan.', 'type' => 'string', 'example' => 'OSSBAG-cn-0xl*****002', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InvoiceApplyId\\": 1323125534\\n }\\n}","errorExample":""},{"type":"xml","example":"<ApplyInvoiceResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <InvoiceApplyId>1323125534</InvoiceApplyId>\\n </Data>\\n</ApplyInvoiceResponse>","errorExample":""}]', + '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' => 'Invalid user identity.'], + ['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.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'UpgradeResourcePackage', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeResourcePackage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - 'QuerySkuPriceList' => [ - 'summary' => 'Queries the stock keeping units (SKUs) of a service. In most cases, a service has one or more SKUs. A service may even have tens of thousands of SKUs. You can call this operation to query the SKUs of a specific service and the prices of the SKUs. You can configure request parameters to query the specified SKUs based on the configurations of the SKUs.', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'business.ap-southeast-1.aliyuncs.com', 'endpoint' => 'business.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => 'business-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'business.aliyuncs.com', 'endpoint' => 'business.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'Your account has an abnormality, please contact customer service for details'], + ['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' => '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.'], + ['code' => 'AccountNotExist', 'message' => 'Account does not exist.', 'http_code' => 400, 'description' => 'Account does not exist'], + ['code' => 'AccountNotFound', 'message' => 'The specified account does not exist in the system.', 'http_code' => 404, 'description' => 'Account does not exist'], + ['code' => 'AccountRiskFound', 'message' => 'You account has undefined risk.', 'http_code' => 500, 'description' => 'The current account is at risk. Please submit a ticket and try again.'], + ['code' => 'ActionInProcess', 'message' => 'Action in process, please wait.', 'http_code' => 400, 'description' => 'Business processing, please wait'], + ['code' => 'ActivityNotFound', 'message' => 'Activity does not exist.', 'http_code' => 500, 'description' => 'Activity does not exist'], + ['code' => 'AmountExceedLimit', 'message' => 'Amount exceeds limits, please try a different card.', 'http_code' => 400, 'description' => 'The amount exceeds the limit, please contact the issuing bank or change the card to try again.'], + ['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' => 'The transaction amount exceeds the single or daily limit. Please try reducing the transaction amount or contact your bank to increase the limit.'], + ['code' => 'ApplyPaperContractError', 'message' => 'Failed to apply for a paper contract.', 'http_code' => 400, 'description' => 'Failed to apply for paper contract'], + ['code' => 'AsyncFormalContractError', 'message' => 'Application for contract confirmation failed.', 'http_code' => 400, 'description' => 'Failed to apply for contract confirmation'], + ['code' => 'AuthSiteFail', 'message' => 'auth site failed.', 'http_code' => 400, 'description' => 'The account number does not match the home site, please check whether the endpoint is accurate.'], + ['code' => 'AvailableTransferAmountNotEnough', 'message' => 'The available amount for granting or recycling is insufficient.', 'http_code' => 400, 'description' => 'The amount available for allocation/recovery is insufficient. Please confirm and try again.'], + ['code' => 'BillingAccountOperateForbid', 'message' => 'Operation is forbidden for your billing account.', 'http_code' => 400, 'description' => 'You are a customer associated with the distributor, the current operation is prohibited'], + ['code' => 'CanApplyContractError', 'message' => 'Failed to apply for contract verification.', 'http_code' => 400, 'description' => 'Failed to apply for contract verification'], + ['code' => 'CanApplyInvoiceEmptyError', 'message' => 'Current invoice cannot be queried. Contract application is not allowed.', 'http_code' => 400, 'description' => 'Current invoice cannot be queried. Contract application is not allowed.'], + ['code' => 'CanApplyInvoiceNegativeError', 'message' => 'Current invoice amount is negative, contract application is not allowed.', 'http_code' => 400, 'description' => 'Current invoice amount is negative, contract application is not allowed'], + ['code' => 'CanApplyInvoiceStatusError', 'message' => 'Invoice status incorrect, unable to apply for contract.', 'http_code' => 400, 'description' => 'Invoice status is not correct, can not apply for contract'], + ['code' => 'CANCEL_INVOICE_ERROR', 'message' => 'Cancel invoice fail.', 'http_code' => 400, 'description' => 'Cancel invoice fail.'], + ['code' => 'CANCEL_INVOICE_STATUS_ERROR', 'message' => 'The status of this invoice does not meet the cancel conditions.', 'http_code' => 400, 'description' => 'The status of this invoice does not meet the cancel conditions.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'CanTransferAmountNotEnough', 'message' => 'Recoverable/allocated amount is insufficient, please confirm and try again.', 'http_code' => 400, 'description' => 'Recoverable/allocated amount is insufficient, please confirm and try again'], + ['code' => 'CardAlreadyBind', 'message' => 'The specified card has already been added.', 'http_code' => 400, 'description' => 'You have already added this bank card, please do not add it again.'], + ['code' => 'CardBalanceNotEnough', 'message' => 'The card balance is not enough for this transfer, please change the card and try again.', 'http_code' => 400, 'description' => 'Insufficient card balance, please change card and try again'], + ['code' => 'CardBindAccountNumberLimit', 'message' => 'The card has been bound to an Alibaba Cloud account.', 'http_code' => 400, 'description' => 'The card has been bound to an Alibaba Cloud account.'], + ['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' => 'The issuing country of the bank card is not supported for the time being.'], + ['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' => 'This card does not support the current transaction currency. Use a bank card that supports the current transaction currency to try again.'], + ['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' => 'This bank card does not support 3D verification. Please contact your card issuer to activate 3D verification or replace another bank card to try again.'], + ['code' => 'CardNumberInvalid', 'message' => 'The card number is invalid. Enter a valid card number.', 'http_code' => 400, 'description' => 'Invalid bank card number, please enter the correct bank card number.'], + ['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' => 'Channel processing is abnormal, please contact the issuing bank or submit a work order.'], + ['code' => 'ChargeLimit', 'message' => 'Recharge is prohibited for the account associated with the ecological partner.', 'http_code' => 400, 'description' => 'Recharge is prohibited for the account associated with the ecological partner. Please contact the ecological operation consultation'], + ['code' => 'ClaimAmountExceedLimit', 'message' => 'Claim amount exceeds limit.', 'http_code' => 400, 'description' => 'Claim amount exceeds limit, please check and try again'], + ['code' => 'CloseAutoWriteoffError', 'message' => 'close auto write off error.', 'http_code' => 400, 'description' => 'Failed to close automatic write-off'], + ['code' => 'ConfirmInvoiceInfoFail', 'message' => 'The current invoice has an order bill that exceeds the contract.', 'http_code' => 400, 'description' => 'The current invoice has a bill that exceeds the contract.'], + ['code' => 'ConfirmInvoiceInfoFail', 'message' => 'Failed to confirm invoice booking information.', 'http_code' => 400, 'description' => 'Failed to confirm invoice billing information'], + ['code' => 'ContractIdEmptyError', 'message' => 'Contract ID cannot be empty.', 'http_code' => 400, 'description' => 'Contract ID cannot be empty'], + ['code' => 'ContractIdNotNumberError', 'message' => 'Contract ID is not of numerical type.', 'http_code' => 400, 'description' => 'Contract ID is not a numeric type'], + ['code' => 'ContractNoEmptyError', 'message' => 'Contract number cannot be empty.', 'http_code' => 400, 'description' => 'Contract number cannot be empty'], + ['code' => 'ContractNoInvalidError', 'message' => 'Contract not found.', 'http_code' => 400, 'description' => 'No contract found'], + ['code' => 'ContractStatusInvalidForApplyPaperContractError', 'message' => 'The current contract status does not allow the application for mailing contracts.', 'http_code' => 400, 'description' => 'The current contract status does not allow applying for a mail contract.'], + ['code' => 'ContractStatusInvalidForCancelError', 'message' => 'Formal contracts do not allow rejection.', 'http_code' => 400, 'description' => 'Formal contracts do not allow rejection'], + ['code' => 'CouponExist', 'message' => 'The coupon collection has reached the upper limit, and the system has recalculated the best price.', 'http_code' => 500, 'description' => 'The coupon collection has reached the upper limit, and the system has recalculated the best price.'], + ['code' => 'CouponOverMaxRelease', 'message' => 'Coupon Over Max Release.', 'http_code' => 500, 'description' => 'The voucher has been received and the system has recalculated the best price.'], + ['code' => 'CreateCouponError', 'message' => 'create coupon error.', 'http_code' => 500, 'description' => 'The voucher order failed, the system has recalculated the best price.'], + ['code' => 'CreateOrderFailed', 'message' => 'Failed to create transfer order due to system processing error.', 'http_code' => 400, 'description' => 'Failed to create transfer order'], + ['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' => 'Your bank declined this transaction. Please contact your issuing bank for the specific reason, or try using another card.'], + ['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' => 'If the card issuing bank refuses, please contact the card issuing bank to ensure that the bank card online payment service is activated, and then try again.'], + ['code' => 'DeleteContractError', 'message' => 'Failed to delete contract.', 'http_code' => 400, 'description' => 'Failed to delete contract'], + ['code' => 'DeleteReasonEmptyError', 'message' => 'Reason for deletion cannot be empty.', 'http_code' => 400, 'description' => 'Delete reason cannot be empty'], + ['code' => 'ExceedQueryTimesLimit', 'message' => 'Exceed daily query times limit.', 'http_code' => 400, 'description' => 'Daily query limit exceeded'], + ['code' => 'ExistApprovingProcess', 'message' => 'There is a credit control setting process in the approval process, please contact the business manager.', 'http_code' => 400, 'description' => 'There is a credit control setting process in the approval process, please contact the business manager.'], + ['code' => 'ExistUnconfirmedContract', 'message' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', 'http_code' => 400, 'description' => 'The account you operate has a credit control contract to be confirmed. Please confirm the contract first.'."\n"], + ['code' => 'ExpireCard', 'message' => 'Your bank card has expired. Please use another card that is not expired for payment.', 'http_code' => 400, 'description' => 'Your bank card has expired. Please use a bank card that has not expired.'], + ['code' => 'ExpiredCard', 'message' => 'The specified card has been expired.', 'http_code' => 400, 'description' => 'The bank card has expired.'], + ['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' => 'The card expiry date format is incorrect. Please enter it in the correct month/year format (e.g., MM/YY) and try again.'], + ['code' => 'ForbiddenAccessContractError', 'message' => 'Please confirm if you have contract authority.', 'http_code' => 400, 'description' => 'Please confirm whether you have contract authority'], + ['code' => 'FormalContractError', 'message' => 'Contract confirmation failed.', 'http_code' => 400, 'description' => 'Contract confirmation failed'], + ['code' => 'FormalVipContractError', 'message' => 'Key customer contract confirmation failed.', 'http_code' => 400, 'description' => 'Major customer contract confirmation failed'], + ['code' => 'FormalWanWangContractError', 'message' => 'Wanwang Contract Confirmation Failure.', 'http_code' => 400, 'description' => 'Wanwang contract confirmation failed'], + ['code' => 'FunctionPaused', 'message' => 'This function is temporarily suspended for maintenance or updates.', 'http_code' => 400, 'description' => 'This function is temporarily suspended'], + ['code' => 'GenerateFileUrlError', 'message' => 'Failed to generate download address.', 'http_code' => 400, 'description' => 'Failed to generate download address'], + ['code' => 'GetAccountInfoFail', 'message' => 'Failed to get account information, please try again later.', 'http_code' => 400, 'description' => 'Failed to get account information, please try again later'], + ['code' => 'GetContractNoError', 'message' => 'Error in obtaining contract number.', 'http_code' => 400, 'description' => 'Error getting contract number'], + ['code' => 'GetFileUrlError', 'message' => 'Error in obtaining contract file download address.', 'http_code' => 400, 'description' => 'Obtaining contract file download address error'], + ['code' => 'GetFormalResultError', 'message' => 'Error in obtaining contract confirmation results.', 'http_code' => 400, 'description' => 'Error in obtaining contract confirmation result'], + ['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' => 'The real name information verified by E-sign is inconsistent. Please enter the correct mobile phone number and name.'], + ['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' => 'Due to data security and compliance requirements, the Group\'s cloud account amount information permissions are controlled. Please understand the inconvenience caused. You can view it through HCRM/cloud platform. For details, please refer to: 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' => 'Due to data security and compliance requirements, the Group\'s cloud account amount information permissions are controlled. Please understand the inconvenience caused. You can view it through HCRM/cloud platform. For details, please refer to: https://aliyuque.antfin.com/yunfei.xyf/kr0b8h/yvdm6izaeulmq8g2 。'], + ['code' => 'InstanceInfoError', 'message' => 'Instance information provided is incomplete or contains invalid data.', 'http_code' => 400, 'description' => 'Instance information error'], + ['code' => 'InstanceNotBelongToAccount', 'message' => 'The specified instance does not belong to the current account.', 'http_code' => 400, 'description' => 'The instance you want to process does not belong to the current account'], + ['code' => 'InstanceNumberTooLarge', 'message' => 'The instance num exceed 2000.', 'http_code' => 400, 'description' => 'The instance IDs under the corresponding conditions are greater than 2000 and cannot be queried on the page. Please export/subscribe the bill details to view them.'], + ['code' => 'INSUFFICIENT.AVAILABLE.QUOTA', 'message' => 'The account balance is negative. Add funds to the account and try again.', 'http_code' => 200, 'description' => 'Your account balance drops below 0. Top up your account and try again.'], + ['code' => 'InternalError', 'message' => 'An error occurred in the internal server.', 'http_code' => 500, 'description' => 'System exception, please try again'], + ['code' => 'InvalidAmountFormat', 'message' => 'The transaction amount is invalid. Please try using another payment method, or contact customer service.', 'http_code' => 400, 'description' => 'The transaction amount is invalid. Please try using another payment method, or contact customer service.'], + ['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' => 'Invalid bind card request.'], + ['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' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.'], + ['code' => 'InvalidCaptcha', 'message' => 'Invalid Captcha.', 'http_code' => 400, 'description' => 'Your verification code is wrong or has expired, please get it again.'], + ['code' => 'InvalidCard', 'message' => 'There is a problem with the card. Try a different card or submit a ticket.', 'http_code' => 400, 'description' => 'There is a problem with this bank card. Please replace the bank card and try again or submit a ticket.'], + ['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' => 'The card number you entered is incorrect. Please carefully check your card number for any errors or omissions and try again.'], + ['code' => 'InvalidContractError', 'message' => 'Invalid contract failed.', 'http_code' => 400, 'description' => 'Failed to void the contract'], + ['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' => 'Sorry, this currency is not supported for the current transaction. Please try using a supported currency or contact customer service for more details.'], + ['code' => 'InvalidCvv', 'message' => 'Invalid cvv code.', 'http_code' => 400, 'description' => 'Cvv code exception'], + ['code' => 'InvalidFundAccount', 'message' => 'The caller does not have permission for the specified fund account.', 'http_code' => 400, 'description' => 'The current login account is not the administrator of this account and is not authorized to operate this account.'], + ['code' => 'InvalidFundAccount', 'message' => 'The caller does not have permission for the specified billing account.', 'http_code' => 400, 'description' => 'The current login account is not the administrator of this account and is not authorized to operate this account.'], + ['code' => 'InvalidOwner', 'message' => 'The specified owner doesn\'t belong to caller.', 'http_code' => 400, 'description' => 'Invalid user identity.'], + ['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' => 'Transaction information is incorrect. Please check the transaction details you entered (e.g., amount, card number) and try again.'], + ['code' => 'InvalidReasonEmptyError', 'message' => 'Reason for invalidation cannot be empty.', 'http_code' => 400, 'description' => 'Void reason cannot be empty'], + ['code' => 'InvalidSecurityCode', 'message' => 'The security code is invalid ,please contact your issuing bank or try a different card.', 'http_code' => 400, 'description' => 'Your card security code is invalid, please contact the issuing bank or change the card to try again'], + ['code' => 'InvalidTime', 'message' => 'Invalid Time.', 'http_code' => 400, 'description' => 'Date selection for cost analysis is out of range, please re-select'], + ['code' => 'InvoiceAlreadyInvoicingCanNotClose', 'message' => 'Invoice is being issued and cannot be closed.', 'http_code' => 400, 'description' => 'Invoice is being issued and cannot be closed.'], + ['code' => 'InvoiceAmountFormatInvalid', 'message' => 'Illegal format of invoiced amount.', 'http_code' => 400, 'description' => 'Illegal format of invoiced amount'], + ['code' => 'InvoiceAmountInValid', 'message' => 'Illegal amount requested for invoicing.', 'http_code' => 400, 'description' => 'Illegal amount requested for invoicing'], + ['code' => 'InvoiceAmountNegativeInvalid', 'message' => 'The sum of the selected amounts is negative and cannot be invoiced.', 'http_code' => 400, 'description' => 'The sum of the selected amounts is negative and cannot be invoiced.'], + ['code' => 'InvoiceAmountNotValid', 'message' => 'The invoiced amount field is illegal, and supports up to 2 decimal places.', 'http_code' => 400, 'description' => 'The invoiced amount field is illegal, and supports up to 2 decimal places.'], + ['code' => 'InvoiceApplyNotAllowedForTestUser', 'message' => 'Test accounts are not permitted to perform invoicing operations.', 'http_code' => 400, 'description' => 'This account is a test account and cannot be invoiced.'], + ['code' => 'InvoiceAutoApplyConfigNotMatchRealName', 'message' => 'Automatic invoicing only supports the viewpoint consistent with real-name authentication. Please select again.', 'http_code' => 400, 'description' => 'Automatic invoicing only supports the same header as real-name authentication. Please select'], + ['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' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.'], + ['code' => 'InvoiceCandidateSearchTimeInvalid', 'message' => 'Invoicing Candidate query time is illegal.', 'http_code' => 400, 'description' => 'Invoicing Candidate query time is illegal'], + ['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' => 'There is no billing order being processed in the current invoice'], + ['code' => 'InvoiceDataEmptyError', 'message' => 'There are no subscription bills in the current invoice that can apply for contracts.', 'http_code' => 400, 'description' => 'There is no bill in the current invoice that can apply for a contract.'], + ['code' => 'InvoiceDataOverOpeningContract', 'message' => 'The current invoice has an order bill that exceeds the contract.', 'http_code' => 400, 'description' => 'The current invoice has a bill that exceeds the contract.'], + ['code' => 'InvoiceDataUsedError', 'message' => 'The current invoice has a subscription bill for a contract that has already been applied.', 'http_code' => 400, 'description' => 'The current invoice has a bill for the requested contract.'], + ['code' => 'InvoiceFileDownloadError', 'message' => 'Download failed, please try again later.', 'http_code' => 400, 'description' => 'Download failed, please try again later.'], + ['code' => 'InvoiceManualAmountNotAllowed', 'message' => 'Cross-account independent invoicing, amount cannot be specified.', 'http_code' => 400, 'description' => 'Cross-account independent invoicing, amount cannot be specified'], + ['code' => 'InvoiceModeInvalid', 'message' => 'InvoiceMode field is illegal.', 'http_code' => 400, 'description' => 'InvoiceMode field is illegal'], + ['code' => 'InvoiceModeNotValid', 'message' => 'The invoice mode field is invalid. Please select a valid option.', 'http_code' => 400, 'description' => 'InvoiceMode field is illegal'], + ['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' => ''], + ['code' => 'InvoiceRemarkTooLong', 'message' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.', 'http_code' => 400, 'description' => 'The length of the invoice note is too long, please abbreviate it properly and resubmit it!'], + ['code' => 'InvoiceSpecialOnlyForEnterprises', 'message' => 'Special invoices can only be issued by enterprise accounts.', 'http_code' => 400, 'description' => 'Special invoices can only be issued by enterprise accounts.'], + ['code' => 'InvoiceStatusError', 'message' => 'The current invoice status is incorrect, unable to retrieve the contract.', 'http_code' => 400, 'description' => 'The current invoice status is incorrect and the contract cannot be opened.'], + ['code' => 'InvoiceTdsValidateAuditing', 'message' => 'This user TAN NO. In the process of approval, please do not submit repeatedly.', 'http_code' => 400, 'description' => 'This user TAN NO. In the process of approval, please do not submit repeatedly.'], + ['code' => 'InvoiceTdsValidateDuplicate', 'message' => 'The tan no. It has been saved, please do not submit it again.', 'http_code' => 400, 'description' => 'The tan no. It has been saved, please do not submit it again.'], + ['code' => 'InvoiceTdsValidateFailed', 'message' => 'The tan no. It has been used by other accounts. Please confirm whether the input is correct.', 'http_code' => 400, 'description' => 'The tan no. It has been used by other accounts. Please confirm whether the input is correct.'], + ['code' => 'InvoiceTitleNotExist', 'message' => 'Invoice title does not exist.', 'http_code' => 400, 'description' => 'Invoice header does not exist'], + ['code' => 'InvoiceTypeInvalid', 'message' => 'InvoiceType field is illegal.', 'http_code' => 400, 'description' => 'InvoiceType field is illegal'], + ['code' => 'InvoiceTypeNotValid', 'message' => 'The invoice type field is invalid. Please select a valid option.', 'http_code' => 400, 'description' => 'InvoiceType field is illegal'], + ['code' => 'InvoiceUnificationCheckEmailFail', 'message' => 'No default email for unified invoicing check.', 'http_code' => 400, 'description' => 'No default email for unified invoicing check.'], + ['code' => 'InvoiceUnificationCheckTitleFail', 'message' => 'No default invoice title for unified invoicing check.', 'http_code' => 400, 'description' => 'No default invoice title for unified invoicing check.'], + ['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' => 'Account limit recharge'], + ['code' => 'LimitWithdraw', 'message' => 'Account limit withdraw.', 'http_code' => 400, 'description' => 'Account Limit Withdraw'], + ['code' => 'MaxOffsetLimit', 'message' => 'Exceeded maximum page turning limit.', 'http_code' => 400, 'description' => 'Maximum page turning limit exceeded, please view after exporting'], + ['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' => '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.'], + ['code' => 'NoFundAccountPermission', 'message' => 'The caller does not have permission for the specified fund account.', 'http_code' => 400, 'description' => 'The current login account does not have permission to operate the specified account.'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action.', 'http_code' => 400, 'description' => 'You do not have permissions to perform the operation.'], + ['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' => 'If you do not have discount query permission, please contact the main account for authorization. The permission point is queryprice.'."\n"], + ['code' => 'NotActiveService', 'message' => 'You are not active the service，please use after activation.', 'http_code' => 400, 'description' => 'You are not active the service，please use after activation.'], + ['code' => 'NotEligibleForTransfer', 'message' => 'The selected instances do not meet transfer eligibility requirements.', 'http_code' => 400, 'description' => 'Not eligible for transfer'], + ['code' => 'NotOpenUnifiedSettle', 'message' => 'The unified settlement is not open for caller.', 'http_code' => 400, 'description' => 'The unified settlement function has not been opened to you yet, please look forward to it.'], + ['code' => 'NotSupportAllocateCredit', 'message' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.', 'http_code' => 400, 'description' => 'Currently, self-service allocation of credit control quota is not supported. Please contact your service manager to modify the credit control quota.'], + ['code' => 'NoValidInstanceFund', 'message' => 'No valid instance found.', 'http_code' => 400, 'description' => 'No valid instance found'], + ['code' => 'OldFinanceCloudUserNoPermission', 'message' => 'Old finance cloud user has no permission to query new menus.', 'http_code' => 400, 'description' => 'Old version of financial cloud customers do not have access to the new menus, please upgrade the new enterprise organization and try again.'], + ['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' => '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.'], + ['code' => 'OpenAutoWriteoffError', 'message' => 'open auto write off error.', 'http_code' => 400, 'description' => 'Failed to open automatic write-off'], + ['code' => 'OperationTypeError', 'message' => 'Invalid operation type specified, please use a valid operation type.', 'http_code' => 400, 'description' => 'Operation type error'], + ['code' => 'OrderExpiredOrProcessed', 'message' => 'The transfer order has expired or been completed, cannot be processed.', 'http_code' => 400, 'description' => 'Transfer order has expired or been processed'], + ['code' => 'OrderNotExist', 'message' => 'The transaction order does not exist. Please refresh the page and try to initiate a new transaction.', 'http_code' => 400, 'description' => 'The transaction order does not exist. Please refresh the page and try to initiate a new transaction.'], + ['code' => 'OrderNotOperational', 'message' => 'The transfer order is not in a state that allows operations.', 'http_code' => 400, 'description' => 'Transfer order is not operational'], + ['code' => 'OrderQueryError', 'message' => 'Failed to query transfer order information due to system error.', 'http_code' => 400, 'description' => 'Transfer order information query error'], + ['code' => 'PageInfoError', 'message' => 'Invalid pagination parameters provided, please check page number and size.', 'http_code' => 400, 'description' => 'Page information error'], + ['code' => 'PaperContractMultipleApplyError', 'message' => 'This contract has already applied for a paper contract.', 'http_code' => 400, 'description' => 'This contract has been applied for a paper contract.'], + ['code' => 'ParamError', 'message' => 'Parameter error.', 'http_code' => 500, 'description' => 'Parameter error'], + ['code' => 'ParameterError', 'message' => 'Invalid or missing required parameters in the request.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'PARAM_ERROR', 'message' => 'param is error.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'PARAM_INVALID', 'message' => 'Parameter error.', 'http_code' => 533, 'description' => 'Parameter exception'], + ['code' => 'PaymentChannelProcessFail', 'message' => 'Payment channel process fail, please contact your issuer bank or submit a ticket.', 'http_code' => 400, 'description' => 'Payment channel process fail, please contact your issuer bank or submit a ticket.'], + ['code' => 'PaymentDeclinedByBank', 'message' => 'payment is declined by issuer bank.', 'http_code' => 400, 'description' => 'Payment rejected by card issuing bank'], + ['code' => 'PaymentMethodNotExist', 'message' => 'The specific card not exist or has been deleted, please check and try again.', 'http_code' => 400, 'description' => 'The payment method does not exist or has been deleted. Please check and try again.'], + ['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 does not support non-US dollar payment. When setting Paypal as the preferred payment method, set the current settlement currency and the next month\'s settlement currency to 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' => 'Sorry, your transaction does not meet the payment requirements. Please try using another card or payment method.'], + ['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' => 'Payment channel is temporarily inaccessible. Please try again later or use another payment method. If the issue persists, please contact our customer service.'], + ['code' => 'PaySystemAuthenticationFail', 'message' => 'Payment channel authentication failed. Please try again later, or try using another payment method.', 'http_code' => 400, 'description' => 'Payment channel authentication failed. Please try again later, or try using another payment method.'], + ['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' => 'This transaction requires 3D Secure verification. Please follow the instructions on the page to complete your bank\'s 3D Secure verification.'], + ['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' => 'Sorry, this card is not supported by the current payment channel. Please try using another card or payment method.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'PaySystemOTPVerifyUnmatched', 'message' => 'Your bank card has expired. Please use another card that is not expired for payment.', 'http_code' => 400, 'description' => 'Your bank card has expired. Please use another card that is not expired for payment.'], + ['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' => 'Your bank card has an issue. Please contact your issuing bank to inquire about its status and any abnormalities.'], + ['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' => '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.'], + ['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' => 'Your account status is abnormal, unable to complete this transaction. Please contact customer service to inquire about your account status.'], + ['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' => '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.'], + ['code' => 'PAY_QUERY_ORDER_EMPTY_RESULT', 'message' => 'Query order is empty, please check order parameters.', 'http_code' => 501, 'description' => 'Query order is empty'], + ['code' => 'PAY_QUERY_ORDER_ERROR', 'message' => 'Query Order Exception.', 'http_code' => 502, 'description' => 'Query Order Exception'], + ['code' => 'PAY_SYSTEM_EXCEPTION', 'message' => 'Internal system error occurred, please contact technical support.', 'http_code' => 500, 'description' => 'System exception'], + ['code' => 'QueryConnectedRelationListInfoError', 'message' => 'Query information of Party A\'s associated entity list is abnormal, please try again later.', 'http_code' => 400, 'description' => 'Query information of Party A\'s associated entity list is abnormal, please try again later.'], + ['code' => 'QueryContractTaskInfoError', 'message' => 'Query contract task information is abnormal, please try again later.', 'http_code' => 400, 'description' => 'Query contract task information is abnormal, please try again later.'], + ['code' => 'QueryCountExceedLimit', 'message' => 'The count of queries exceeds the daily query limit.', 'http_code' => 400, 'description' => 'Queries exceed daily limit'], + ['code' => 'QueryInvioceListInfoError', 'message' => 'Invoice header list query information is abnormal, please try again later.', 'http_code' => 400, 'description' => 'Invoice header list query information is abnormal, please try again later'], + ['code' => 'QueryInvioceListInfoFail', 'message' => 'Failed to query invoice header list information, please try again later.', 'http_code' => 400, 'description' => 'Failed to query invoice header list information, please try again later'], + ['code' => 'QueryInvoiceInfoError', 'message' => 'Exception in querying invoice information. Please try again later.', 'http_code' => 400, 'description' => 'Invoice information query is abnormal, please try again later'], + ['code' => 'QueryInvoiceInfoFail', 'message' => 'Failed to query invoice information.', 'http_code' => 400, 'description' => 'Failed to query invoice information.'], + ['code' => 'QueryPartyaInfoError', 'message' => 'Party A entity name query is abnormal, please try again later.', 'http_code' => 400, 'description' => 'Party A entity name query is abnormal, please try again later.'], + ['code' => 'RC_3TH_LOGISTICS_DETAIL_REQUEST', 'message' => 'Failed to query the details of the third party logistics node.', 'http_code' => 509, 'description' => 'Failed to query the details of the third party logistics node.'], + ['code' => 'RC_GET_USER_ERROR', 'message' => 'Failed to obtain the group account HavanaId required for order query.', 'http_code' => 508, 'description' => 'Failed to obtain the group account HavanaId required for order query.'], + ['code' => 'RC_ORDER_CONFIRM_FAIL', 'message' => 'Confirm receipt failed.', 'http_code' => 505, 'description' => 'Confirm receipt failed'], + ['code' => 'RC_ORDER_DETAIL_FAIL', 'message' => 'Failed to query order details.', 'http_code' => 503, 'description' => 'Failed to query order details'], + ['code' => 'RC_ORDER_LIST_FAIL', 'message' => 'Failed to query order list.', 'http_code' => 502, 'description' => 'Failed to query order list'], + ['code' => 'RC_ORDER_LOGISTICS_FAIL', 'message' => 'No logistics information.', 'http_code' => 504, 'description' => 'No logistics information'], + ['code' => 'RC_ORDER_LOGISTICS_OVERVIEW_FAIL', 'message' => 'Failed to query logistics overview information.', 'http_code' => 510, 'description' => 'Failed to query logistics overview information.'], + ['code' => 'RC_PAGE_SIZE_MAX_LIMIT_REQUEST', 'message' => 'PageSize parameter setting is too large.', 'http_code' => 507, 'description' => 'PageSize parameter setting is too large'], + ['code' => 'RC_PARAM_IS_EMPTY', 'message' => 'Required field values in request parameters cannot be empty.', 'http_code' => 501, 'description' => 'Required field values in request parameters cannot be empty.'], + ['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' => 'Post-paid commodity for service, the system automatically orders and opens. This kind of order does not support customer inquiry.'], + ['code' => 'RC_REFUND_QUOTA_EXCEED', 'message' => 'Exceeding the limit.', 'http_code' => 523, 'description' => 'Sorry, the total amount that can be unsubscribed this month has been exceeded.'], + ['code' => 'RC_SYSTEM_ERROR', 'message' => 'An error occurred in the internal server.', 'http_code' => 500, 'description' => 'System exception, please try again'], + ['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' => 'The system timed out, the query data may be too much, please shorten the time range or select a specific product and re-query'], + ['code' => 'RC_UNKNOWN_ERROR', 'message' => 'Unknown error.', 'http_code' => 511, 'description' => 'Unknown error'], + ['code' => 'RealNameAuthenticationNotCompleted', 'message' => 'real-name authentication is not completed.', 'http_code' => 400, 'description' => 'Real name authentication not completed'], + ['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' => 'The system only supports individual users authenticated by ID card number and enterprise users authenticated by social unified credit code. Please update the authentication and try again.'], + ['code' => 'RejectContractError', 'message' => 'Refusal of contract failed.', 'http_code' => 400, 'description' => 'Failed to reject the contract'], + ['code' => 'RejectVipContractError', 'message' => 'Refusal of major client contract failed.', 'http_code' => 400, 'description' => 'Failed to reject major customer contract'], + ['code' => 'RejectWanWangContractError', 'message' => 'Refusal of the World Wide Web contract failed.', 'http_code' => 400, 'description' => 'Failed to reject Wanwang contract'], + ['code' => 'RelationOrderDataError', 'message' => 'Abnormal contract related billing data.', 'http_code' => 400, 'description' => 'Contract associated billing data is abnormal'], + ['code' => 'RequestCountExceedBankLimit', 'message' => 'The number of requests has exceeded the limit of the issuer bank. Please try again later.', 'http_code' => 400, 'description' => 'Request quantity exceeds card issuer limit, please try again later'], + ['code' => 'RequestTimeout', 'message' => 'Request timed out. Please try again later.', 'http_code' => 400, 'description' => 'Request timed out, please try again later'], + ['code' => 'ResourceCreatingNotAllowWithdraw', 'message' => 'The resource you purchased is being created and cannot withdraw during this period.', 'http_code' => 400, 'description' => 'The resource you purchased is being created, balance withdrawal is not available during this period, please try again later.'], + ['code' => 'ResourceNotExists', 'message' => 'The specified resource does not exist.', 'http_code' => 400, 'description' => 'The instance does not exist.'], + ['code' => 'RiskReject', 'message' => 'The request rejected by risk control.', 'http_code' => 400, 'description' => 'Request rejected by risk control'], + ['code' => 'RiskReject', 'message' => 'The card poses a security risk. Try a different card or submit a ticket.', 'http_code' => 400, 'description' => 'This bank card is a security risk. Please try again with another bank card or submit a ticket.'], + ['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' => 'This transaction has been rejected by the risk control system due to potential risk. If you have questions, please contact our customer service team.'], + ['code' => 'SameAccountTransfer', 'message' => 'Target account is identical to source account, transfer operation is not allowed.', 'http_code' => 400, 'description' => 'Target account is the same as current account, transfer not allowed'], + ['code' => 'SameLicenseNoError', 'message' => 'The identification numbers of Party B and Party C in the payment agreement cannot be the same.', 'http_code' => 400, 'description' => 'The identification numbers of Party B and Party C in the payment agreement cannot be the same.'], + ['code' => 'SameName', 'message' => 'The specified name already exists.', 'http_code' => 400, 'description' => 'The specified name already exists.'], + ['code' => 'SAME_NAME', 'message' => 'The specified name already exists.', 'http_code' => 400, 'description' => 'Name already exists'], + ['code' => 'SettleBillBeingWrittenOff', 'message' => 'Settle bill is being written off.', 'http_code' => 400, 'description' => 'Bill is being written off, please try again later'], + ['code' => 'SettleTaskCloseError', 'message' => 'close unified settlement task error.', 'http_code' => 400, 'description' => 'Failed to close the settlement task. Please refresh the page and try again.'], + ['code' => 'SettleTaskDeleteError', 'message' => 'delete unified settlement task error.', 'http_code' => 400, 'description' => 'Failed to delete the settlement task. Please refresh the page and try again.'], + ['code' => 'SettleTaskPauseError', 'message' => 'pause unified settlement task error.', 'http_code' => 400, 'description' => 'The settlement task failed to be paused. Please refresh the page and try again.'], + ['code' => 'SettleTaskRestartError', 'message' => 'restart unified settlement task error.', 'http_code' => 400, 'description' => 'Settlement task restart failed, please refresh the page and try again'], + ['code' => 'SettleTaskSaveError', 'message' => 'Failed to save settlement task.', 'http_code' => 400, 'description' => 'Failed to save the settlement task.'], + ['code' => 'SettleTaskStopError', 'message' => 'stop unified settlement task error.', 'http_code' => 400, 'description' => 'Failed to stop the settlement task, please refresh the page and try again'], + ['code' => 'SettleTitleDup', 'message' => 'Duplicate unified settlement title.', 'http_code' => 400, 'description' => 'Duplicate Unified Settlement Title'], + ['code' => 'SettleTitleTooLong', 'message' => 'Unified settlement document title is too long.', 'http_code' => 400, 'description' => 'The title of the unified settlement is too long, please control the title length to be less than 200 characters.'], + ['code' => 'SpecifiedWriteoffCycleConflict', 'message' => 'Specified writeoff cycle conflict.', 'http_code' => 400, 'description' => 'The last specified write-off in this accounting period has not been completed. Please try again later.'], + ['code' => 'SPN_INSTANCE_HAS_SHARED', 'message' => 'Savings plan instance has shared.', 'http_code' => 400, 'description' => 'The saving plan instance is set to share, and the deduction tag cannot be set.'], + ['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' => '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.'], + ['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' => 'The system is abnormal. Please try again later or contact technical support.'], + ['code' => 'TaskAlreadyExist', 'message' => 'The task already exists.', 'http_code' => 400, 'description' => 'The task already exists'], + ['code' => 'TASK_EXIST', 'message' => 'task has already exist.', 'http_code' => 400, 'description' => 'This table already exists and cannot be resubscribed'], + ['code' => 'TaxInfoStatusNotAllowUpdate', 'message' => 'Tax information cannot be modified in the current tax qualification status.', 'http_code' => 400, 'description' => 'Tax information cannot be modified in the current tax qualification status.'], + ['code' => 'TaxInfoTaxNumberInvalid', 'message' => 'VAT No is not valid.', 'http_code' => 400, 'description' => 'The tax number format is illegal.'], + ['code' => 'TransferFailed', 'message' => 'Transfer operation failed due to processing error, please try again.', 'http_code' => 400, 'description' => 'Transfer failed'], + ['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' => 'Non-credit control users cannot use the account balance, please contact the business manager to apply for credit control first.'], + ['code' => 'UnconfirmedContractError', 'message' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', 'http_code' => 400, 'description' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.'], + ['code' => 'UniqueAgentLimit', 'message' => 'The valid agent already exists.', 'http_code' => 400, 'description' => 'The valid agent already exists, please replace the agent and re-create it"'], + ['code' => 'UniqueIdNotValid', 'message' => 'The card binding request has expired. Please refresh and try again.', 'http_code' => 400, 'description' => 'The card binding request has failed. Please refresh the page and try again.'], + ['code' => 'UnpayAmountNotEnough', 'message' => 'Unpay amount not enough.', 'http_code' => 400, 'description' => 'The bill is being written off. The amount you paid is greater than the remaining amount to be written off. Please do not pay again!'], + ['code' => 'UNPAY_AMOUNT_NOT_ENOUGH', 'message' => 'unpay amount not enough.', 'http_code' => 400, 'description' => 'The bill is being written off. The amount you paid is greater than the remaining amount to be written off. Please do not pay again!'], + ['code' => 'UpdateContractMemoError', 'message' => 'Error in modifying contract remarks.', 'http_code' => 400, 'description' => 'Error in modifying contract remarks'], + ['code' => 'UserAccountInfoEmptyError', 'message' => 'AliyunId cannot be empty.', 'http_code' => 400, 'description' => 'aliyunId cannot be empty'], + ['code' => 'UserIdInvalidError', 'message' => 'User not found.', 'http_code' => 400, 'description' => 'User not found'], + ['code' => 'UserInfoEmptyError', 'message' => 'UserId cannot be empty.', 'http_code' => 400, 'description' => 'userId cannot be empty'], + ['code' => 'UserInfoError', 'message' => 'User information provided is incomplete or contains invalid data.', 'http_code' => 400, 'description' => 'User information error'], + ['code' => 'UsernameUidMismatch', 'message' => 'The entered UID and account name do not match, please verify and re-enter.', 'http_code' => 400, 'description' => 'The entered UID and account do not match, please enter correct account information'], + ['code' => 'ValidAuth', 'message' => 'Valid auth check failed.', 'http_code' => 200, 'description' => 'Permission validation does not pass'], + ['code' => 'VericationTimeExceedLimit', 'message' => 'Verification times exceeds limit, please try a different card.', 'http_code' => 400, 'description' => 'The number of verification times exceeds the limit, please change the card and try again.'], + ['code' => 'WithdrawAmountExceedLimit', 'message' => 'Withdraw amount exceeds limit.', 'http_code' => 400, 'description' => 'Withdraw amount exceeds limit'], + ['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' => 'The invoice title is the general ticket title of the special process application, and the special invoice cannot be issued.'], + ['code' => 'EnterpriseInvoiceTitleApplyOnlyForPersonal', 'message' => 'The application process is limited to personal real-name authentication users.', 'http_code' => 400, 'description' => 'The application process is limited to personal real-name authentication users'], + ['code' => 'EnterpriseInvoiceTitleApplyAlreadyExist', 'message' => 'Invoice title data already exists in the application.', 'http_code' => 400, 'description' => 'Invoice title data already exists in the application.'], + ['code' => 'InvoiceTitleRegisterNoIsEmpty', 'message' => 'Unified Social Credit Code cannot be empty.', 'http_code' => 400, 'description' => 'Unified Social Credit Code cannot be empty'], + ['code' => 'RC_NO_REFUND_REMAIN_CHOSEN', 'message' => 'No refund resources selected.', 'http_code' => 502, 'description' => 'No refund resources selected'], + ['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' => 'Only one instance is allowed to be returned if there is no reason to unsubscribe at a time for five days.'], + ['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' => 'The instance you selected to unsubscribe is invalid, please return to the unsubscribe list page to refresh and try again'], + ['code' => 'RC_QUERY_RESOURCE_ERROR', 'message' => 'Failed to obtain unsubscribe resource information.', 'http_code' => 509, 'description' => 'Failed to obtain unsubscribe resource information'], + ['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' => 'The instance unsubscription period you selected is invalid, please return to the unsubscription list page to refresh and try again'], + ['code' => 'RC_SERVICE_TIMEOUT', 'message' => 'Service call timed out, try to reduce the number of queries and retry.', 'http_code' => 522, 'description' => 'Service call timed out, try to reduce the number of queries and retry'], + ['code' => 'RISK_REJECT_RR321', 'message' => 'The request rejected by risk control.', 'http_code' => 400, 'description' => 'Request rejected by risk control'], + ['code' => 'NOT_ALLOW_CANCEL_TRUSTSHIP', 'message' => 'Only supports setting to trusteeship.', 'http_code' => 400, 'description' => 'Only set to downtime hosting is supported'], + ['code' => 'PayChannelPolicy', 'message' => 'The transaction is restricted by policy.', 'http_code' => 400, 'description' => 'The transaction is restricted by policy.'], + ['code' => 'PayChannelStolenCard', 'message' => 'The card has been reported as stolen (fraud account).', 'http_code' => 400, 'description' => 'The card has been reported as stolen (fraud account).'], + ['code' => 'PayChannelFraudReject', 'message' => 'The transaction was rejected due to risk control.', 'http_code' => 400, 'description' => 'The transaction was rejected due to risk control.'], + ['code' => 'PayChannelBlockedByCardholder', 'message' => 'The card has been locked by the cardholder.', 'http_code' => 400, 'description' => 'The card has been locked by the cardholder.'], + ['code' => 'PayChannelSellerAccountRestricted', 'message' => 'The seller\'s channel account is restricted.', 'http_code' => 400, 'description' => 'The seller\'s channel account is restricted.'], + ['code' => 'PayChannelSelectedCardBrandNotAvailable', 'message' => 'The selected card brand is not available.', 'http_code' => 400, 'description' => 'The selected card brand is not available.'], + ['code' => 'PayChannelRestrictedCard', 'message' => 'The issuing bank has restricted the usage scope of the card.', 'http_code' => 400, 'description' => 'The issuing bank has restricted the usage scope of the card.'], + ['code' => 'PayChannelPayOrderInvalidStatus', 'message' => 'The payment order status in the payment channel is invalid.', 'http_code' => 400, 'description' => 'The payment order status in the payment channel is invalid.'], + ['code' => 'PayChannelUserKycNotQualified', 'message' => 'Payment failed due to the user\'s KYC status.', 'http_code' => 400, 'description' => 'Payment failed due to the user\'s KYC status.'], + ['code' => 'PayChannelReEnterTransaction', 'message' => 'The transaction cannot be processed temporarily.', 'http_code' => 400, 'description' => 'The transaction cannot be processed temporarily.'], + ['code' => 'PayChannelCannotVerifyPin', 'message' => 'Unable to verify the PIN.', 'http_code' => 400, 'description' => 'Unable to verify the PIN.'], + ['code' => 'PayChannelInvalidIssuer', 'message' => 'Unable to contact the cardholder\'s issuing bank for authorization.', 'http_code' => 400, 'description' => 'Unable to contact the cardholder\'s issuing bank for authorization.'], + ['code' => 'PayChannelVerifyTimesExceedLimit', 'message' => 'Too many failed verification attempts for the current code.', 'http_code' => 400, 'description' => 'Too many failed verification attempts for the current code.'], + ['code' => 'PayChannelOrderAlreadyPaid', 'message' => 'The order has already been paid in the payment channel.', 'http_code' => 400, 'description' => 'The order has already been paid in the payment channel.'], + ['code' => 'PayChannelIdentityVerifyFailed', 'message' => 'Identity verification timed out or failed to obtain results.', 'http_code' => 400, 'description' => 'Identity verification timed out or failed to obtain results.'], + ['code' => 'PayChannelPinRequired', 'message' => 'A PIN is required to process the transaction but was not provided.', 'http_code' => 400, 'description' => 'A PIN is required to process the transaction but was not provided.'], + ['code' => 'PayChannelUserPaymentVerificationFailed', 'message' => 'The user failed payment verification such as OTP or PIN.', 'http_code' => 400, 'description' => 'The user failed payment verification such as OTP or PIN.'], + ['code' => 'PayChannelBlockedFirstUsed', 'message' => 'The card may be temporarily frozen due to first-use activation or special conditions.', 'http_code' => 400, 'description' => 'The card may be temporarily frozen due to first-use activation or special conditions.'], + ['code' => 'PayChannelOrderStatusInvalid', 'message' => 'The order status is invalid and cannot be processed.', 'http_code' => 400, 'description' => 'The order status is invalid and cannot be processed.'], + ['code' => 'PayChannelIdentityAgeNotEnough', 'message' => 'The user\'s age does not meet the requirement.', 'http_code' => 400, 'description' => 'The user\'s age does not meet the requirement.'], + ['code' => 'PayChannelLawViolation', 'message' => 'The transaction was rejected by the issuing bank.', 'http_code' => 400, 'description' => 'The transaction was rejected by the issuing bank.'], + ['code' => 'PayChannelCloseFailed', 'message' => 'Failed to close the order in the payment channel.', 'http_code' => 400, 'description' => 'Failed to close the order in the payment channel.'], + ['code' => 'PayChannelPayOrderNotExist', 'message' => 'The payment order does not exist in the payment channel.', 'http_code' => 400, 'description' => 'The payment order does not exist in the payment channel.'], + ['code' => 'PayChannelCardNotSupported', 'message' => 'The bank card used for the transaction is not supported.', 'http_code' => 400, 'description' => 'The bank card used for the transaction is not supported.'], + ['code' => 'PayChannelCloseInnerException', 'message' => 'Internal exception occurred while closing the order in the payment channel.', 'http_code' => 400, 'description' => 'Internal exception occurred while closing the order in the payment channel.'], + ['code' => 'PayChannelUserAmountExceedLimit', 'message' => 'The payment amount exceeds the user\'s payment limit.', 'http_code' => 400, 'description' => 'The payment amount exceeds the user\'s payment limit.'], + ['code' => 'PayChannelVerifyUnmatched', 'message' => 'The verification code is invalid.', 'http_code' => 400, 'description' => 'The verification code is invalid.'], + ['code' => 'PayChannelPickupCard', 'message' => 'The issuing bank requests to retain the payment card, usually in suspected counterfeit or fraud scenarios.', 'http_code' => 400, 'description' => 'The issuing bank requests to retain the payment card, usually in suspected counterfeit or fraud scenarios.'], + ['code' => 'PayChannelFailed', 'message' => 'The payment channel returned a failure.', 'http_code' => 400, 'description' => 'The payment channel returned a failure.'], + ['code' => 'PayChannelBuyerAccountRestricted', 'message' => 'The buyer\'s channel account is restricted.', 'http_code' => 400, 'description' => 'The buyer\'s channel account is restricted.'], + ['code' => 'PayChannelGeneralFail', 'message' => 'Unknown error occurred in the payment channel.', 'http_code' => 400, 'description' => 'Unknown error occurred in the payment channel.'], + ['code' => 'PayChannelLostCard', 'message' => 'The card has been reported as lost (fraud account).', 'http_code' => 400, 'description' => 'The card has been reported as lost (fraud account).'], + ['code' => 'PayChannelNoSelectedAccount', 'message' => 'The cardholder selected a non-existent account.', 'http_code' => 400, 'description' => 'The cardholder selected a non-existent account.'], + ['code' => 'PayChannelLifecycle', 'message' => 'The transaction was rejected due to invalid card data.', 'http_code' => 400, 'description' => 'The transaction was rejected due to invalid card data.'], + ['code' => 'PayChannelInvalidIdentityStatus', 'message' => 'The identity status is abnormal.', 'http_code' => 400, 'description' => 'The identity status is abnormal.'], + ['code' => 'PayChannelSystemError', 'message' => 'External payment channel system error.', 'http_code' => 400, 'description' => 'External payment channel system error.'], + ['code' => 'PayChannelAuthenticationRequired', 'message' => 'Payment channel requires 3D Secure authentication.', 'http_code' => 400, 'description' => 'Payment channel requires 3D Secure authentication.'], + ['code' => 'PayChannelInvalidPin', 'message' => 'The provided PIN is incorrect or does not meet the requirements.', 'http_code' => 400, 'description' => 'The provided PIN is incorrect or does not meet the requirements.'], + ['code' => 'PayChannelTradeStatusError', 'message' => 'The payment channel trade status does not support this operation.', 'http_code' => 400, 'description' => 'The payment channel trade status does not support this operation.'], + ['code' => 'PayChannelExpiredCode', 'message' => 'The payment code has expired.', 'http_code' => 400, 'description' => 'The payment code has expired.'], + ['code' => 'PayChannelTransactionNotAllowedAtTerminal', 'message' => 'The transaction is not allowed at the terminal.', 'http_code' => 400, 'description' => 'The transaction is not allowed at the terminal.'], + ['code' => 'PayChannelStopRecurringPayment', 'message' => 'The cardholder has cancelled the recurring payment.', 'http_code' => 400, 'description' => 'The cardholder has cancelled the recurring payment.'], + ['code' => 'InvalidCard', 'message' => 'The credit card is invalid.', 'http_code' => 400, 'description' => 'Your bank card is invalid. Please go to Payment Method Management to check and update your linked bank card.'], + ['code' => 'PaymentParamIllegal', 'message' => 'The payment parameters are illegal.', 'http_code' => 400, 'description' => 'Payment parameters are incorrect. Please check and try again.'], + ['code' => 'ExpiredCard', 'message' => 'The credit card has expired.', 'http_code' => 400, 'description' => 'Your credit card has expired. Please use another credit card.'], + ['code' => 'BindCardNotExist', 'message' => 'The bindcard information was not found during payment.', 'http_code' => 400, 'description' => 'Binding card information not found. Please re-bind your card or contact customer service.'], + ['code' => 'PaymentDeclinedByBank', 'message' => 'The payment was declined by the bank.', 'http_code' => 400, 'description' => 'Your bank declined this transaction. Please contact your bank for details.'], + ['code' => 'PaymentOrderStatusInvalid', 'message' => 'The payment order status returned by the channel is invalid.', 'http_code' => 400, 'description' => 'The payment channel order status is abnormal. Please contact customer service.'], + ['code' => 'AmountLimitExceed', 'message' => 'The amount exceeds the limit.', 'http_code' => 400, 'description' => 'The transaction amount exceeds the limit. Please adjust the amount or contact customer service.'], + ['code' => 'ThirdPartyPayerAccountStatusInvalid', 'message' => 'The third-party payer account status is invalid.', 'http_code' => 400, 'description' => 'The third-party fund account status is abnormal. Please contact customer service.'], + ['code' => 'InvalidCardNumber', 'message' => 'The credit card number is invalid.', 'http_code' => 400, 'description' => 'Your bank card number is invalid. Please go to Payment Method Management to check and update your linked bank card.'], + ['code' => 'CurrencyNotSupport', 'message' => 'The currency is not supported.', 'http_code' => 400, 'description' => 'The current currency is not supported. Please change to another currency or payment method.'], + ['code' => 'RepeatRefundRequestInconsist', 'message' => 'The repeated refund request parameters are inconsistent.', 'http_code' => 400, 'description' => 'The parameters for the second refund are inconsistent. Please check and try again.'], + ['code' => 'PaymentOrderNotExist', 'message' => 'The payment order does not exist in the channel.', 'http_code' => 400, 'description' => 'The payment channel order does not exist. Please refresh the page or initiate a new transaction.'], + ['code' => 'PaymentOrderIsClosed', 'message' => 'The payment order has been closed by the channel.', 'http_code' => 400, 'description' => 'The payment channel order has been closed. Please refresh the page or initiate a new transaction.'], + ['code' => 'RefundTimeExceedLimit', 'message' => 'The refund time exceeds the maximum allowed refund period.', 'http_code' => 400, 'description' => 'The refund time has exceeded the allowed limit. Please contact customer service.'], + ['code' => 'TradeInCaptureOrCancelNotAllowRefund', 'message' => 'Refund is not allowed when the trade is in capture or cancel status.', 'http_code' => 400, 'description' => 'The transaction status does not allow refunds. Please contact customer service.'], + ['code' => 'PaymentChargeback', 'message' => 'The user has initiated a chargeback.', 'http_code' => 400, 'description' => 'The user has charged back this transaction. Please contact customer service.'], + ['code' => 'TransactionTypeNotPermitted', 'message' => 'The credit card does not support this transaction type.', 'http_code' => 400, 'description' => 'Your credit card does not support this transaction type. Please use another credit card or payment method.'], + ['code' => 'InvalidAmount', 'message' => 'The amount is invalid.', 'http_code' => 400, 'description' => 'The amount is invalid. Please check and try again.'], + ['code' => 'RecurringPaymentForbidden', 'message' => 'The user has forbidden recurring payments.', 'http_code' => 400, 'description' => 'You have disabled direct debit. Please contact customer service.'], + ['code' => 'RefundAmountExceedLimit', 'message' => 'The cumulative refund amount exceeds the payment order amount.', 'http_code' => 400, 'description' => 'The refund amount exceeds the total payment order amount. Please check the refund amount.'], + ['code' => 'BillingAgreementCancelled', 'message' => 'The billing agreement has been cancelled.', 'http_code' => 400, 'description' => 'The direct debit agreement has been canceled. Please contact customer service.'], + ['code' => 'RequestTrafficExceedLimit', 'message' => 'The request traffic exceeds the channel rate limit.', 'http_code' => 400, 'description' => 'Payment channel requests are too frequent. Please try again later.'], + ['code' => 'ExpiryDateWrong', 'message' => 'The credit card expiry date is wrong.', 'http_code' => 400, 'description' => 'The credit card expiry date is incorrect. Please check and try again.'], + ['code' => 'PaymentOrderFrozen', 'message' => 'The payment order has been frozen by the channel.', 'http_code' => 400, 'description' => 'The payment channel order has been frozen. Please contact customer service.'], + ['code' => 'BillingAgreementIllegal', 'message' => 'The billing agreement status is illegal.', 'http_code' => 400, 'description' => 'The direct debit agreement status is abnormal. Please contact customer service.'], + ['code' => 'Cvv2Declined', 'message' => 'The credit card CVV2 is invalid.', 'http_code' => 400, 'description' => 'The CVV2 you entered is invalid. Please check and try again.'], + ['code' => 'AgreementNotExist', 'message' => 'The billing agreement does not exist.', 'http_code' => 400, 'description' => 'The direct debit agreement does not exist. Please contact customer service.'], + ['code' => 'COUPON_NOT_FOUND', 'message' => 'No claimable SLA coupons.', 'http_code' => 400, 'description' => 'No claimable SLA coupons'], + ['code' => 'CouponNotFound', 'message' => 'No claimable SLA coupons.', 'http_code' => 400, 'description' => 'No claimable SLA coupons'], + ['code' => 'InvoiceTitleNotExistSubSite', 'message' => 'There is currently no valid invoice title, please add a title before submitting the application.', 'http_code' => 400, 'description' => 'There is currently no valid invoice header, please add a header before submitting the application.'], + ['code' => 'InvoiceCnApiNotSupportInIntlSite', 'message' => 'Domestic station interface, not callable in international environment.', 'http_code' => 400, 'description' => 'Domestic station interface, not callable in international environment'], + ['code' => 'InvoiceIntlApiNotSupportInCnSite', 'message' => 'International station interface, cannot be called in domestic environment.', 'http_code' => 400, 'description' => 'International station interface, cannot be called in domestic environment'], + ['code' => 'InvoiceApplyAmountNotEnough', 'message' => 'The current invoiced amount exceeds the total invoiced amount, please check the order again.', 'http_code' => 400, 'description' => 'The current invoiced amount exceeds the total invoiced amount, please check the order again.'], + ['code' => 'InvoiceApplyAmountNotEnoughSubSite', 'message' => 'The currently submitted invoicing amount exceeds the total invoicing amount, please check again.', 'http_code' => 400, 'description' => 'The currently submitted invoicing amount exceeds the total invoicing amount, please check again'], + ['code' => 'SUBSCRIPTION_0001', 'message' => 'invalid param.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'SUBSCRIPTION_0007', 'message' => 'Limited to once per hour.', 'http_code' => 400, 'description' => 'Only one operation per hour is allowed. If you need to modify it again, please try again next hour.'], + ['code' => 'MultiAccountQueryNotSupported', 'message' => 'The historical month dimension summary does not support multi-account query.', 'http_code' => 400, 'description' => 'Under the "By Product/By Account" dimension, only single account viewing is supported for this month. Switch to other dimensions to view multiple accounts or obtain through export.'], + ['code' => 'LimitedOperation', 'message' => 'Limited to once per hour.', 'http_code' => 400, 'description' => 'Only one operation is permitted per hour. If you need to make further changes, please try again in one hour.'], + ['code' => 'F-10000-16-00609', 'message' => 'Subscription not exist.', 'http_code' => 405, 'description' => 'Subscription does not exist'], + ], + 'changeSet' => [], + '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' => 'Alibaba Cloud Billing API', + 'ramCodes' => ['bss', 'bssapi', 'efc'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [ + [ + 'name' => 'bssapi:ProductType', + 'schema' => ['type' => 'STRING', 'description' => 'Product type for operating resources. Example: ecs'], + ], + [ + 'name' => 'bssapi:ProductCode', + 'schema' => ['type' => 'STRING', 'description' => 'Product code for operating resources. Example: ecs'], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'SetResellerUserQuota', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryResellerUserAlarmThreshold', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryInstanceGaapCost', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeGaapBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryResourcePackageInstances', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'CommodityCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + [ + 'apiName' => 'CreateResellerUserQuota', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateResellerUserQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PriceEntityCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the pricing object.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'instance_type', + ], + [ + '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' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to be returned on each page. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', + ], + [ + 'apiName' => 'QueryCashCoupons', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCoupons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to retrieve the next page. You do not need to set this parameter if you query coverage details for the first time. The response returns a token that you can use to query coverage details of the next page. If a null value is returned for the NextPageToken parameter, no more coverage details can be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', + ], + [ + 'apiName' => 'SetRenewal', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PriceFactorConditionMap', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The conditions of the pricing factors.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '{"vm_region_no":"cn-shiwei-shenshu"}', - 'description' => 'The key-value pair of the pricing factor.'."\n", - ], - 'description' => 'The values of the pricing factors.'."\n", - ], + ], + [ + 'apiName' => 'InquiryPriceRefundInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:RefundQueryRemainAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'ModifyInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F5B803CF-94D8-43AF-ADB3-D819AAD30E27', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message that is returned.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'SkuPricePage' => [ - 'description' => 'The SKUs of the pricing object.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of SKUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18732', - ], - 'NextPageToken' => [ - 'description' => 'The token that is used to query the next page.'."\n", - 'type' => 'string', - 'example' => '080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332', - ], - 'SkuPriceList' => [ - 'description' => 'The SKUs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The SKU.'."\n", - 'type' => 'object', - 'properties' => [ - 'SkuCode' => [ - 'description' => 'The code of the SKU.'."\n", - 'type' => 'string', - 'example' => '017c15a31507bc6de22aa93777461adc', - ], - 'CskuPriceList' => [ - 'description' => 'The prices of the SKUs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The price of the SKU.'."\n", - 'type' => 'object', - 'properties' => [ - 'CskuCode' => [ - 'description' => 'The unique code of the SKU price.'."\n", - 'type' => 'string', - 'example' => 'ac74dd7b52ae6389ddef099283fb8275', - ], - 'Currency' => [ - 'description' => 'The currency.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'USD' => '', - 'CNY' => '', - ], - 'example' => 'CNY', - ], - 'UsageUnit' => [ - 'description' => 'The usage unit.'."\n", - 'type' => 'string', - 'example' => 'Count'."\n", - ], - 'PriceType' => [ - 'description' => 'The pricing type.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'usagePrice' => '', - 'monthPrice' => '', - 'dayPrice' => '', - 'hourPrice' => '', - 'weekPrice' => '', - 'yearPrice' => '', - 'fixedPrice' => '', - ], - 'example' => 'hourPrice', - ], - 'PriceMode' => [ - 'description' => 'The pricing mode.'."\n", - 'type' => 'string', - 'example' => 'STEP_ARRIVE', - ], - 'Price' => [ - 'description' => 'The price.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'STEP_ACCUMULATION' => '', - 'STEP_ARRIVE' => '', - 'NORMAL_PRICE' => '', - ], - 'example' => '100', - ], - 'PriceUnit' => [ - 'description' => 'The unit of the price.'."\n", - 'type' => 'string', - 'example' => 'USD (per unit)'."\n", - ], - 'RangeList' => [ - 'description' => 'If the PriceMode parameter is set to STEP_ACCUMULATION or STEP_ARRIVE, the value of this field exists and specifies the range. If the PriceMode parameter is set to NORMAL_PRICE, the value of this field is null.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Indicates a pricing object.'."\n", - 'type' => 'object', - 'properties' => [ - 'FactorCode' => [ - 'description' => 'The code of the pricing factor.'."\n", - 'type' => 'string', - 'example' => '212fbd27866307fc79ecf06934a88b2c', - ], - 'Min' => [ - 'description' => 'The minimum value.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Max' => [ - 'description' => 'The maximum value.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Type' => [ - 'description' => 'The closure type of the interval.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'LORC' => '', - 'LCRO' => '', - 'LCRC' => '', - 'LORL' => '', - ], - 'example' => 'LORC', - ], - ], - ], - ], - ], - ], - ], - 'SkuFactorMap' => [ - 'description' => 'The values of the pricing factors.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"vm_region_no","cn-qingdao-nebula"}', - 'description' => 'The key-value pair of the pricing factor.'."\n", - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeResourcePackageProduct', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<QuerySkuPriceListResponse>\\n <RequestId>F5B803CF-94D8-43AF-ADB3-D819AAD30E27</RequestId>\\n <Code>Success</Code>\\n <Message>Successful!</Message>\\n <Success>true</Success>\\n <Data>\\n <SkuPricePage>\\n <TotalCount>18732</TotalCount>\\n <NextPageToken>080112060a0422020800180022490a470342000000315333303332363436363336333433393636333136333338333733373333333133373336363336323634363336363337333836333636333636313336363433363332</NextPageToken>\\n <SkuPriceList>\\n <SkuCode>017c15a31507bc6de22aa93777461adc</SkuCode>\\n <CskuPriceList>\\n <CskuCode>ac74dd7b52ae6389ddef099283fb8275</CskuCode>\\n <Currency>CNY</Currency>\\n <UsageUnit>个</UsageUnit>\\n <PriceType>hourPrice</PriceType>\\n <PriceMode>STEP_ARRIVE</PriceMode>\\n <Price>100</Price>\\n <PriceUnit>美元/个</PriceUnit>\\n <RangeList>\\n <FactorCode>212fbd27866307fc79ecf06934a88b2c</FactorCode>\\n <Min>1</Min>\\n <Max>10</Max>\\n <Type>LORC</Type>\\n </RangeList>\\n </CskuPriceList>\\n <SkuFactorMap>\\n <key>{\\"vm_region_no\\",\\"cn-qingdao-nebula\\"}</key>\\n </SkuFactorMap>\\n </SkuPriceList>\\n </SkuPricePage>\\n </Data>\\n</QuerySkuPriceListResponse>","errorExample":""}]', - 'title' => 'QuerySkuPriceList', - ], - 'QueryCommodityList' => [ - 'summary' => 'Queries the information about a service based on the service code.', - 'methods' => [ - 'get', + [ + 'apiName' => 'QueryCostUnitResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteCostUnit', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'bss:DeleteCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CancelOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:CancelOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryBillOverview', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'QueryCommodityList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'Success' => [ - 'description' => 'Indicates whether the information about the service was queried.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'NotApplicable', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'CommodityList' => [ - 'description' => 'The information about the service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the service.'."\n", - 'type' => 'object', - 'properties' => [ - 'CommodityCode' => [ - 'description' => 'The code of the service, which is the same as that on the Billing Management page.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'CommodityName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'ECS (Pay-As-You-Go)'."\n", - ], - 'ChargeType' => [ - 'description' => 'The payment type. Valid values: POSTPAY (pay-as-you-go) and PREPAY (subscription).'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PREPAY' => '', - 'POSTPAY' => '', - ], - 'example' => 'POSTPAY', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'RenewResourcePackage', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => 'QueryCommodityList', - 'description' => 'You can call this operation to query the information about a service based on the service code.'."\n", - ], - 'QueryPriceEntityList' => [ - 'summary' => 'Queries the billable items of a service.', - 'methods' => [ - 'get', + [ + 'apiName' => 'SetResellerUserStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ApplyInvoice', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ApplyInvoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyCostUnit', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryBillToOSSSubscription', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeSubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'CommodityCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + [ + 'apiName' => 'QueryAvailableInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + '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' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message that is returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PriceEntityInfoList' => [ - 'description' => 'The information about the billable items.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The billable item.'."\n", - 'type' => 'object', - 'properties' => [ - 'PriceEntityCode' => [ - 'description' => 'The code of the billable item.'."\n", - 'type' => 'string', - 'example' => 'instance_type', - ], - 'PriceEntityName' => [ - 'description' => 'The name of the billable item.'."\n", - 'type' => 'string', - 'example' => 'Elastic Compute Service (ECS) instance'."\n", - ], - 'PriceFactorList' => [ - 'description' => 'The factors of the billable item.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The factor of the billable item.'."\n", - 'type' => 'object', - 'properties' => [ - 'PriceFactorCode' => [ - 'description' => 'The code of the factor.'."\n", - 'type' => 'string', - 'example' => 'vm_region_no', - ], - 'PriceFactorName' => [ - 'description' => 'The name of the factor.'."\n", - 'type' => 'string', - 'example' => 'Region'."\n", - ], - 'PriceFactorValueList' => [ - 'description' => 'The values of the factor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the factor.'."\n", - 'type' => 'string', - 'example' => 'cn-shiwei-shenshu', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'AllocateCostUnitResource', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:AllocateCostUnitResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => 'QueryPriceEntityList', - 'description' => 'You can call this operation to query the billable items of a service. A billable item is the minimum unit used to calculate costs.'."\n", - 'responseParamsDescription' => 'A service has one or more billable items, and each billable item has one or more factors.'."\n", - ], - 'DescribePricingModule' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'QueryRIUtilizationDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryRiUtilizationDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RefundInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:RefundBatchRemainRefund', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + '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' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'QueryPrepaidCards', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescrbePrepaidCards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service code. You can query the service code by calling the **QueryProductList** operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', + [ + 'apiName' => 'QueryProductList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryProductList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service. You can query the service type by calling the **QueryProductList** operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + ], + [ + 'apiName' => 'SubscribeBillToOSS', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SubscriptionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Subscription', + ], + [ + 'apiName' => 'QueryPriceEntityList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C40A8EE0-8084-49FE-B66E-5E1C3B6AE025', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModuleList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Module' => [ - 'description' => 'The pricing information of modules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'description' => 'The name of the pricing module.'."\n", - 'type' => 'string', - 'example' => 'Instance'."\n", - ], - 'PriceType' => [ - 'description' => 'The price type. Valid values:'."\n" - ."\n" - .'* Usage: usage price'."\n" - .'* Hour: hourly price'."\n" - .'* Day: daily price'."\n" - .'* Week: weekly price'."\n" - .'* Month: monthly price'."\n" - .'* Year: annual price'."\n", - 'type' => 'string', - 'example' => 'Month', - ], - 'Currency' => [ - 'description' => 'The currency. Default value: CNY.'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'ModuleCode' => [ - 'description' => 'The code of the pricing module.'."\n", - 'type' => 'string', - 'example' => 'InstanceType', - ], - 'ConfigList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ConfigList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The pricing attributes that the module depends on.'."\n", - 'type' => 'string', - 'example' => '[ "Region","InstanceType" ]', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'AttributeList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Attribute' => [ - 'description' => 'The module attributes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the attribute.'."\n", - 'type' => 'string', - 'example' => 'DBInstanceStorage', - ], - 'Name' => [ - 'description' => 'The name of the attribute.'."\n", - 'type' => 'string', - 'example' => 'Capacity'."\n", - ], - 'Unit' => [ - 'description' => 'The unit of the attribute.'."\n", - 'type' => 'string', - 'example' => 'GB', - ], - 'Values' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AttributeValue' => [ - 'description' => 'The attribute values.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the attribute value that corresponds to the module code. Valid values:'."\n" - ."\n" - .'* single_float: single value'."\n" - .'* range_float: range value'."\n", - 'type' => 'string', - 'example' => 'single_string', - ], - 'Value' => [ - 'description' => 'The attribute value that corresponds to the module code.'."\n" - ."\n" - .'> If the Type parameter is set to range_float, the valid values of this parameter range from 1024 to 1024000. A value of 1024 indicates that the step size is 1024.'."\n", - 'type' => 'string', - 'example' => 'mysql.n2.medium.1', - ], - 'Remark' => [ - 'description' => 'The description of the module values.'."\n", - 'type' => 'string', - 'example' => 'Connections: 4,000 IOPS is related to storage space'."\n", - ], - 'Name' => [ - 'description' => 'The attribute value that corresponds to the module code.'."\n", - 'type' => 'string', - 'example' => '2 Cores and 4 GB Memory (Basic Edition)'."\n", - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'QueryCustomerAddressList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<DescribePricingModuleResponse>\\n <Message>Successful!</Message>\\n <RequestId>C40A8EE0-8084-49FE-B66E-5E1C3B6AE025</RequestId>\\n <Data>\\n <AttributeList>\\n <Attribute>\\n <Values>\\n <AttributeValue>\\n <Type>single_string</Type>\\n <Value>cn-qingdao-cm5-a01</Value>\\n <Name>华北 1</Name>\\n </AttributeValue>\\n </Values>\\n <Code>Region</Code>\\n <Name>地域</Name>\\n </Attribute>\\n </AttributeList>\\n <ModuleList>\\n <Module>\\n <ModuleCode>DataDisk</ModuleCode>\\n <ModuleName>数据盘</ModuleName>\\n <Currency>CNY</Currency>\\n <PriceType>Month</PriceType>\\n <ConfigList>\\n <ConfigList>Region</ConfigList>\\n <ConfigList>DataDisk.Category</ConfigList>\\n </ConfigList>\\n </Module>\\n </ModuleList>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribePricingModuleResponse>","errorExample":""}]', - 'summary' => 'Queries the pricing information about an Alibaba Cloud service.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryProductList' => [ - 'methods' => [ - 'post', - 'get', + [ + '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' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryDPUtilizationDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:FrDeductLogQueryRequest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeCostBudgetsSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeCostBudgetsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'QueryBill', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeBillList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'QueryTotalCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the total number of services. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + [ + 'apiName' => 'QueryInvoicingCustomerList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCustomerInvoiceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + ], + [ + 'apiName' => 'GetResourcePackagePrice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DescribeSavingsPlansUsageTotal', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'This API is not applicable for caller.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '94858229-2758-4663-A7D0-99490D541F15', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about all Alibaba Cloud services.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of services.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '449', - ], - 'ProductList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Product' => [ - 'description' => 'The service definitions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProductName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => 'CDN (Pay-as-you-go)'."\n", - ], - 'ProductType' => [ - 'description' => 'The type of the service.'."\n", - 'type' => 'string', - 'example' => 'CDN', - ], - 'SubscriptionType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* Subscription: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - 'ProductCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'example' => 'cdn', - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetCustomerAccountInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<QueryProductListResponse>\\n <Message>Successful!</Message>\\n <RequestId>28D1C9AE-4B16-43AE-9E19-4D3CF36F2A1E</RequestId>\\n <Data>\\n <ProductList>\\n <Product>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <ProductName>NAT共享带宽包（按量付费）</ProductName>\\n <ProductCode>bwp</ProductCode>\\n <ProductType/>\\n </Product>\\n <Product>\\n <SubscriptionType>PayAsYouGo</SubscriptionType>\\n <ProductName>内容分发网络CDN（按量付费）</ProductName>\\n <ProductCode>cdn</ProductCode>\\n <ProductType>CDN</ProductType>\\n </Product>\\n </ProductList>\\n <TotalCount>449</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNum>1</PageNum>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</QueryProductListResponse>","errorExample":""}]', - 'summary' => 'Queries the information about all Alibaba Cloud services.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryUserOmsData' => [ - 'summary' => 'Queries the usage data of an Alibaba Cloud service.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'SetResellerUserAlarmThreshold', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:SetResellerUserAlarmThreshold', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryResellerAvailableQuota', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryResellerAvailableQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QuerySkuPriceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeProduct', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'QueryAccountTransactions', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccountTran', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Table', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service whose usage data you want to query and the details of the usage data. The parameter value is usually set to the code of a service. Various usage models are provided for different services.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', + [ + 'apiName' => 'QueryOrders', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DataType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time type of the usage data. Set the parameter based on the description in the documentation of the specified service. Valid values:'."\n" - ."\n" - .'* Raw'."\n" - .'* Hour'."\n" - .'* Day'."\n" - .'* Month'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Hour', + ], + [ + 'apiName' => 'UnsubscribeBillToOSS', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ModifySubscribeToOSS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-02-20T12:00:00Z', + ], + [ + 'apiName' => 'DescribeSavingsPlansCoverageDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-02-21T12:00:00Z', + ], + [ + 'apiName' => 'DescribeSavingsPlansUsageDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Marker', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the record from which the usage data starts to return. The usage data records whose names are alphabetically after the value of the Marker parameter are returned. By default, the usage data starts to return from the earliest record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NextToken', + ], + [ + 'apiName' => 'QueryAccountBalance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeAcccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 200. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'QueryCostUnit', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful！', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Marker' => [ - 'description' => 'Indicates that the returned usage data starts from the next page. If no value is returned for this parameter or this parameter is not returned, no data can be queried.'."\n", - 'type' => 'string', - 'example' => 'NextToken', - ], - 'HostId' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - 'OmsData' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The usage data returned.'."\n", - 'type' => 'object', - 'example' => '[{ "SyncIn": "0", "Bucket": "quota_for_get_service_", "NetworkIn": "0", "PutRequest": "1", "NetworkOut": "0", "GetRequest": "0", "ProcessImgSize": "0", "SyncOut": "0", "Storage": "0", "Region": "ap-northeast-1", "ProviderId": "26842", "CdnIn": "0", "EndTime": "2019-09-03T16:00:00Z", "StartTime": "2019-09-02T16:00:00Z", "StorageType": "standard", "CdnOut": "0"}]', - ], - ], - ], - ], - ], + [ + 'apiName' => 'RenewInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NotApplicable', - 'errorMessage' => 'This API is not applicable for caller.', + [ + 'apiName' => 'GetPayAsYouGoPrice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'bssapi:ProductCode', 'validationType' => 'always'], + ['conditionKey' => 'bssapi:ProductType', 'validationType' => 'always'], ], - [ - 'errorCode' => 'NotAuthorized', - 'errorMessage' => 'This API is not authorized for caller.', + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidOwner', - 'errorMessage' => 'The specified owner doesn\'t belong to caller.', + ], + ], + [ + 'apiName' => 'ReleaseInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bss:ReleaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'apiName' => 'ChangeResellerConsumeAmount', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ChangeResellerConsumeAmount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<QueryUserOmsDataResponse>\\n <Message>Successful!</Message>\\n <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Data>\\n <OmsData>\\n <SyncIn>0</SyncIn>\\n <Bucket>quota_for_get_service_</Bucket>\\n <NetworkIn>0</NetworkIn>\\n <PutRequest>1</PutRequest>\\n <NetworkOut>0</NetworkOut>\\n <GetRequest>0</GetRequest>\\n <ProcessImgSize>0</ProcessImgSize>\\n <SyncOut>0</SyncOut>\\n <Storage>0</Storage>\\n <Region>ap-northeast-1</Region>\\n <ProviderId>26842</ProviderId>\\n <CdnIn>0</CdnIn>\\n <EndTime>2019-09-02T16:00:00Z</EndTime>\\n <StartTime>2019-09-01T16:00:00Z</StartTime>\\n <StorageType>standard</StorageType>\\n <CdnOut>0</CdnOut>\\n </OmsData>\\n <OmsData>\\n <SyncIn>0</SyncIn>\\n <Bucket>quota_for_get_service_</Bucket>\\n <NetworkIn>0</NetworkIn>\\n <PutRequest>1</PutRequest>\\n <NetworkOut>0</NetworkOut>\\n <GetRequest>0</GetRequest>\\n <ProcessImgSize>0</ProcessImgSize>\\n <SyncOut>0</SyncOut>\\n <Storage>0</Storage>\\n <Region>ap-northeast-1</Region>\\n <ProviderId>26842</ProviderId>\\n <CdnIn>0</CdnIn>\\n <EndTime>2019-09-03T16:00:00Z</EndTime>\\n <StartTime>2019-09-02T16:00:00Z</StartTime>\\n <StorageType>standard</StorageType>\\n <CdnOut>0</CdnOut>\\n </OmsData>\\n <HostId>cn</HostId>\\n </Data>\\n</QueryUserOmsDataResponse>","errorExample":""}]', - 'title' => 'QueryUserOmsData', - 'description' => 'You can call this operation to query the usage data of an Alibaba Cloud service. Take note of the following items:'."\n" - ."\n" - .'* The service code that you specify for querying the usage data of a specific Alibaba Cloud service must be valid. You can query the usage data by hour or by day.'."\n" - ."\n" - .'* The time that you specify must follow the ISO8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" - ."\n" - .' * Latency exists in data pushes. Therefore, if you set the DataType parameter to Hour, the integrity of usage data recorded in the last 24 hours can be ensured. If you set the DataType parameter to Day, the integrity of usage data recorded in the last two days can be ensured.'."\n" - .' * You can query the usage data that is recorded in the last quarter.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetAllExpirationDay' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'QueryUserOmsData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribeUserOmsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpgradeResourcePackage', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:CreateResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeSavingsPlansCoverageTotal', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:SavingsPlansAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ConvertChargeType', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:ConvertChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetAllExpirationDay', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'bss:ModifyPrepaidInstanceAutoRenew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'UnifyExpireDay', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expiration date. You can set an expiration date only for ECS instances that have not expired. The expiration date that you specify do not take effect on expired ECS instances. After the expiration date is set, the expiration date is used when you renew ECS instances.'."\n" - ."\n" - .'You can set the expiration date to a day from the 1st to the 28th of each month.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + [ + 'apiName' => 'RenewChangeInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'bss:RenewChangeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message that is returned.'."\n", - 'type' => 'string', - 'example' => 'The message that is returned', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'The ID of the request', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'GetCustomerList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:GetCustomerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"返回信息\\",\\n \\"RequestId\\": \\"请求标识\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>返回信息</Message>\\n<RequestId>请求标识</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'SetAllExpirationDay', - 'summary' => 'Sets an expiration date for all Elastic Compute Service (ECS) instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeCostBudgetsSummary' => [ - 'summary' => 'Query the summary information of the user "Cost Management-Budget".', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribePricingModule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:DescribePricingModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateCostUnit', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'bss:CreateCostUnit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryEvaluateList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bss:QueryEvaluate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetOrderDetail', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'bss:DescribeOrderDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'BudgetName', - 'in' => 'query', - 'schema' => [ - 'title' => '预算名称', - 'description' => 'The name of the budget. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Annual budget'."\n", + [ + 'apiName' => 'DescribeInstanceAmortizedCostByConsumePeriod', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BudgetStatus', - 'in' => 'query', - 'schema' => [ - 'title' => '预算状态', - 'description' => 'The status of the budget. Valid values: overdue and notOverdue. A value of overdue specifies to filter expired budgets. A value of notOverdue specifies to filter budgets that do not expire. By default, if you do not specify this parameter, information about all budgets is to be returned.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'notOverdue' => 'notOverdue', - 'overdue' => 'overdue', - ], - 'example' => 'notOverdue', + ], + [ + 'apiName' => 'QueryAccountTransactionDetails', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryAccountTransactionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BudgetType', - 'in' => 'query', - 'schema' => [ - 'title' => '预算类型', - 'description' => 'The type of the budget. Valid values: cost, byquantity, and asset. A value of cost specifies to filter expense budgets. A value of byquantity specifies to filter budgets calculated based on the resource usage. A value of asset specifies to filter usage or coverage budgets. By default, information about all budgets is returned if you do not specify this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cost' => 'cost', - 'byquantity' => 'byquantity', - 'asset' => 'asset', - ], - 'example' => 'cost', + ], + [ + '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' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '开始读取的位置', - 'description' => 'The position in which the query starts. You must set this parameter to null or the token that is obtained from the previous query. Otherwise, an error is returned. If you set the NextToken parameter to null, the query starts from the beginning. The default value is null.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', + ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '读取的最大数据记录数量', - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 10. Minimum value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', + ], + [ + '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' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'BssResult<CostBudgetResponse>', - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3BFC23FE-A182-4D96-A1E4-7521B30B8E43', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Successful!', - ], - 'Data' => [ - 'description' => 'The data that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'title' => '下页token', - 'description' => 'The token that is used to retrieve the next page'."\n", - 'type' => 'string', - 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=', - ], - 'MaxResults' => [ - 'title' => '本次请求所返回的最大记录条数。', - 'description' => 'The maximum number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TotalCount' => [ - 'title' => '总记录数。', - 'description' => 'The total number of entries that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Items' => [ - 'description' => 'The data that is returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BudgetName' => [ - 'description' => 'The name of the budget.'."\n", - 'type' => 'string', - 'example' => 'Annual budget'."\n", - ], - 'BudgetStatus' => [ - 'description' => 'The status of the budget.'."\n", - 'type' => 'string', - 'example' => 'overdue', - ], - 'BudgetType' => [ - 'description' => 'The type of the budget.'."\n", - 'type' => 'string', - 'example' => 'cost', - ], - 'Budget' => [ - 'description' => 'The information about the budget. The BudgetCycleType parameter indicates the cycle of the budget. Valid values: daily, monthly, quarterly, and yearly. The TotalBudgetAmount parameter indicates the total budget. The BudgetMemo parameter indicates the remarks of the budget.'."\n", - 'type' => 'object', - 'enumValueTitles' => [], - 'example' => '{ "budgetCycleType": "monthly", "budgetMemo": "", "totalBudgetAmount": 220 }', - ], - 'CalculatedValues' => [ - 'description' => 'The information about the estimate-to-actual analysis. The ActualConsumeSum parameter indicates the accumulated actual value. The ActualAddForecastedAmount parameter indicates the sum of accumulated actual value and predicted value. If the BudgetType parameter is set to cost, the sum of actual value and predicted value includes the actual cost incurred from the budget start date to the current date and the predicted cost from the current date to the budget end date. If the BudgetType parameter is set to asset, the sum of actual value and predicted value includes the actual usage or coverage from the budget start date to the budget end date. If the budget end date minus the current date is more than one year, the part that exceeds one year is not included. The ActualAndBudgetComparison parameter indicates the comparison between the actual value and the predicted value. The value of the ActualAndBudgetComparison parameter is calculated based on the following formula: Accumulated actual value/Total budget × 100%.'."\n", - 'type' => 'object', - 'example' => '{ "actualConsumeSum": 88.6, "actualAddForecastedAmount": 89.6, "actualAndBudgetComparison": "20.73%" }', - ], - 'ConsumePeriod' => [ - 'description' => 'The information about the billing cycle. The ConsumePeriodBegin parameter indicates the start date of the budget. The ConsumePeriodEnd parameter indicates the end date of the budget.'."\n", - 'type' => 'object', - 'example' => '{ "consumePeriodBegin": "2022-10", "consumePeriodEnd": "2022-11" }', - ], - ], - ], - ], - 'HostId' => [ - 'title' => '站点名称', - 'description' => 'The site of the host.'."\n", - 'type' => 'string', - 'example' => 'cn', - ], - ], - ], - ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'bssapi:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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":"<DescribeCostBudgetsSummaryResponse>\\n <RequestId>3BFC2DDB-2BC5-1AC4-AE39-AA75A6FADE7C</RequestId>\\n <Message>Successful!</Message>\\n <Data>\\n <TotalCount>75</TotalCount>\\n <NextToken>eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MX0=</NextToken>\\n <MaxResults>1</MaxResults>\\n <Items>\\n <BudgetStatus>notOverdue</BudgetStatus>\\n <ConsumePeriod>\\n <consumePeriodBegin>2022-08</consumePeriodBegin>\\n <consumePeriodEnd>2023-07</consumePeriodEnd>\\n </ConsumePeriod>\\n <Budget>\\n <budgetCycleType>annually</budgetCycleType>\\n <budgetMemo/>\\n <totalBudgetAmount>51752.64</totalBudgetAmount>\\n </Budget>\\n <BudgetName>回归验证-费用预算-按年-当月起1年</BudgetName>\\n <BudgetType>cost</BudgetType>\\n <CalculatedValues>\\n <actualConsumeSum>1189.47</actualConsumeSum>\\n <actualAddForecastedAmount>61883.91</actualAddForecastedAmount>\\n <actualAndBudgetComparison>2.3%</actualAndBudgetComparison>\\n </CalculatedValues>\\n </Items>\\n <HostId>cn</HostId>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</DescribeCostBudgetsSummaryResponse>","errorExample":""}]', - 'title' => 'DescribeCostBudgetsSummary', - 'description' => 'This operation is in beta testing and is only available for specific users in the whitelist. Excessive calls may result in performance issues. For example, the response times out.'."\n", - ], - 'RenewChangeInstance' => [ - 'summary' => '续费变配接口', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribeProductAmortizedCostByConsumePeriod', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'QueryRedeem', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRedeem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QuerySavingsPlansInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + [ + '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' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProductCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rds', + [ + 'apiName' => 'DescribeResourceCoverageTotal', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + ], + [ + 'apiName' => 'QuerySavingsPlansDeductLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDeductLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-skjdhaskjdh', + ], + [ + 'apiName' => 'DescribeResourceUsageDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Parameter', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'disk', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Bandwidth', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'QuerySavingsPlansDiscount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QuerySavingsPlansDiscount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'JASIOFKVNVIXXXXXX', + ], + [ + 'apiName' => 'DescribeResourceCoverageDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceCoverageDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RenewPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', + ], + [ + 'apiName' => 'DescribeProductAmortizedCostByAmortizationPeriod', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '202407022550621', - ], - 'HostId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100.100.64.1:8150', - ], - ], - ], - ], + [ + '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' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ResourceNotExists', - 'errorMessage' => 'The specific resource is not exists. ', + [ + 'apiName' => 'QueryInstanceByTag', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryInstanceByTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ORDER.ACCOUNT_STATUS_ILLEGAL ', - 'errorMessage' => 'Please complete your basic personal information first. ', + ], + ], + [ + 'apiName' => 'QueryPermissionList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryPermissionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError ', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + [ + 'apiName' => 'QueryRelationList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryRelationList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'QueryFinancialAccountInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:QueryFinancialAccountInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceAmortizedCostByAmortizationPeriod', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeCostBill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeResourceUsageTotal', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'bssapi:DescribeResourceUsageTotal', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', '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"}]', - ], - ], - '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' => [], ], ]; |