summaryrefslogtreecommitdiff
path: root/data/en_us/bssopenapi/2023-09-30/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/bssopenapi/2023-09-30/api-docs.php')
-rw-r--r--data/en_us/bssopenapi/2023-09-30/api-docs.php12683
1 files changed, 6167 insertions, 6516 deletions
diff --git a/data/en_us/bssopenapi/2023-09-30/api-docs.php b/data/en_us/bssopenapi/2023-09-30/api-docs.php
index d0bbd27..780da61 100644
--- a/data/en_us/bssopenapi/2023-09-30/api-docs.php
+++ b/data/en_us/bssopenapi/2023-09-30/api-docs.php
@@ -1,1454 +1,1102 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'BssOpenApi',
- 'version' => '2023-09-30',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'BssOpenApi', 'version' => '2023-09-30'],
'directories' => [
[
- 'id' => 223311,
- 'title' => 'Order',
+ 'children' => ['GetOrders', 'GetOrderDetail'],
'type' => 'directory',
- 'children' => [
- 'GetOrders',
- 'GetOrderDetail',
- ],
+ 'title' => 'Order',
],
[
- 'id' => 208736,
- 'title' => 'Invoice',
+ 'children' => ['ListInvoiceTitle', 'ListInvoiceCandidate', 'CreateInvoice'],
'type' => 'directory',
- 'children' => [
- 'ListInvoiceTitle',
- 'ListInvoiceCandidate',
- 'CreateInvoice',
- ],
+ 'title' => 'Invoice',
],
[
- 'id' => 203314,
- 'title' => 'Fund Account',
+ 'children' => ['CreateFundAccountPayRelation', 'SetFundAccountLowAvailableAmountAlarm', 'GetFundAccountCanWithdrawAmount', 'GetFundAccountAvailableAmount', 'GetFundAccountLowAvailableAmountAlarm', 'ListFundAccount', 'CancelFundAccountLowAvailableAmountAlarm', 'GetFundAccountCanAllocateCreditAmount', 'ListFundAccountPayRelation', 'GetFundAccountCanRecycleAmount', 'CreateFundAccountTransfer', 'GetFundAccountTransactionDetails', 'SetFundAccountCreditAmount', 'GetFundAccountCanTransferAmount'],
'type' => 'directory',
- 'children' => [
- 'CreateFundAccountPayRelation',
- 'SetFundAccountLowAvailableAmountAlarm',
- 'GetFundAccountCanWithdrawAmount',
- 'GetFundAccountAvailableAmount',
- 'GetFundAccountLowAvailableAmountAlarm',
- 'ListFundAccount',
- 'CancelFundAccountLowAvailableAmountAlarm',
- 'GetFundAccountCanAllocateCreditAmount',
- 'ListFundAccountPayRelation',
- 'GetFundAccountCanRecycleAmount',
- 'CreateFundAccountTransfer',
- 'GetFundAccountTransactionDetails',
- 'SetFundAccountCreditAmount',
- 'GetFundAccountCanTransferAmount',
- ],
+ 'title' => 'Fund account',
],
[
- 'id' => 204580,
+ 'children' => ['DescribeCoupon', 'DescribeCouponItemList'],
+ 'type' => 'directory',
'title' => 'Coupon',
+ ],
+ [
+ 'children' => ['CreateReportDefinition', 'ListReportDefinitions', 'DeleteReportDefinition'],
'type' => 'directory',
- 'children' => [
- 'DescribeCoupon',
- 'DescribeCouponItemList',
- ],
+ 'title' => 'Bill',
],
[
- 'id' => 208201,
- 'title' => 'Billing',
+ 'children' => ['SaveCostCenterShareRule', 'QueryCostCenterShareRule', 'CreateCostCenter', 'ModifyCostCenter', 'DeleteCostCenter', 'QueryCostCenter', 'QueryCostCenterResource', 'CreateCostCenterRule', 'ModifyCostCenterRule', 'DeleteCostCenterRule', 'QueryCostCenterRule', 'AllocateCostCenterResource', 'QueryCostByCostCenter'],
'type' => 'directory',
- 'children' => [
- 'CreateReportDefinition',
- 'ListReportDefinitions',
- 'DeleteReportDefinition',
- ],
+ 'title' => 'Financial unit',
],
[
- 'id' => 208683,
- 'title' => 'Finance Module',
+ 'children' => ['CheckBudgetNameExists', 'CreateBudget', 'DeleteBudget', 'DescribeBudget', 'DescribeBudgets', 'QueryMonthlySlaList', 'SubmitSlaCouponApply', 'UpdateBudget'],
+ 'type' => 'directory',
+ 'title' => 'Other',
+ ],
+ [
+ 'children' => ['DescribeDeductLogs', 'DescribeFrInstances', 'ReceiveUserConfirm'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'SaveCostCenterShareRule',
- 'QueryCostCenterShareRule',
- 'CreateCostCenter',
- 'ModifyCostCenter',
- 'DeleteCostCenter',
- 'QueryCostCenter',
- 'QueryCostCenterResource',
- 'CreateCostCenterRule',
- 'ModifyCostCenterRule',
- 'DeleteCostCenterRule',
- 'QueryCostCenterRule',
- 'AllocateCostCenterResource',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetOrders' => [
- 'summary' => '订单列表查询',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AllocateCostCenterResource' => [
+ 'summary' => 'Allocates resource instances (instance-based and attached-resource-based) from a source cost center to a destination cost center.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'CreateTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2016-05-23T12:00:00Z',
- ],
- ],
- [
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'ProductCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rds',
- ],
- ],
- [
- 'name' => 'ProductType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rds',
- ],
- ],
- [
- 'name' => 'SubscriptionType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Subscription',
- ],
+ 'name' => 'FromOwnerAccountId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the owner of the source cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1529600453335198', 'title' => ''],
],
[
- 'name' => 'OrderType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'New',
- ],
+ 'name' => 'FromCostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the source cost center. This parameter is required.'."\n"
+ ."\n"
+ .'- 0 indicates that the cost center is unallocated.'."\n"
+ .'- A value greater than 0 indicates an allocated cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '637180', 'title' => ''],
],
[
- 'name' => 'PaymentStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Paid',
- ],
+ 'name' => 'ToCostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the destination cost center. Valid values:'."\n"
+ ."\n"
+ .'- -1: moves the allocated resource to the unallocated state.'."\n"
+ .'- A value greater than 0: allocates the resource to the specified cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '638288', 'title' => ''],
],
[
- 'name' => 'CreateTimeStart',
- 'in' => 'query',
+ 'name' => 'ResourceInstanceList',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2016-05-23T13:00:00Z',
+ 'description' => 'The list of resource instances.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of resource instances.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceUserId' => ['description' => 'The ID of the owner of the billing instance. This parameter is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '273394581313325532', 'title' => ''],
+ 'InstanceId' => ['description' => 'The billing granularity ID. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou;standard'."\n", 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'SCU', 'title' => ''],
+ 'PipCode' => ['description' => 'The product code, which is the same as the product code in User Center bills.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''],
+ 'ResourceNick' => ['description' => 'The custom nickname of the resource.', 'type' => 'string', 'required' => false, 'example' => 'ecs-test-1', 'title' => ''],
+ 'ApportionCode' => ['description' => 'The attached resource type of the attached-resource instance. This parameter is required only for attached-resource product instances.'."\n"
+ .'- Currently, eight commodities support attached resources. The commodity codes are oss, dcdn, snapshot, vod, cdn, live, and cbwp.'."\n"
+ .'- You can call the QueryCostUnitResource operation to obtain all billing instances (including attached-resource instances with their attached resources) under a specific cost center (including the unallocated cost center) of a user.', 'type' => 'string', 'required' => false, 'example' => 'qwer1-cn-beijing', 'title' => ''],
+ 'ResourceTag' => ['description' => 'The tag of the resource.', 'type' => 'string', 'required' => false, 'example' => 'tag-test1', 'title' => ''],
+ 'RelatedResources' => ['description' => 'The resources related to the resource instance.', 'type' => 'string', 'required' => false, 'example' => 'related-resource', 'title' => ''],
+ 'ApportionName' => ['description' => 'The attached resource name.', 'type' => 'string', 'required' => false, 'example' => 'split-item-test1', 'title' => ''],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou;standard:app', 'title' => ''],
+ 'ResourceSource' => ['description' => 'The resource source. Valid values:'."\n"
+ .'- AUTO_ALLOCATE: automatic allocation.'."\n"
+ .'- MANUAL_ALLOCATE: manual allocation.', 'type' => 'string', 'required' => false, 'example' => 'AUTO_ALLOCATE', 'title' => ''],
+ 'CommodityCode' => ['description' => 'The commodity code of the billing instance. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''],
+ 'ResourceStatus' => ['description' => 'The resource status.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
+ 'ResourceUserName' => ['description' => 'The resource ownership username.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'CommodityName' => ['description' => 'The commodity name of the resource.', 'type' => 'string', 'required' => false, 'example' => 'RESOURCE_UDR', 'title' => ''],
+ 'ResourceGroup' => ['description' => 'The resource group.', 'type' => 'string', 'required' => false, 'example' => 'xihe_mpp', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'MemberUid',
+ 'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1779628988149763',
- ],
+ 'schema' => ['title' => '', 'description' => 'The primary sales channel ID. If this parameter is left empty, the sales channel ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<CostCenterOperateDto>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HostName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'PageNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'OrderList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Order' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AfterTaxAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '66',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2017-06-08T09:41:30Z',
- ],
- 'ProductType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'RelatedOrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '234535345345342',
- ],
- 'PaymentCurrency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'PaymentTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2017-06-08T09:41:30Z',
- ],
- 'Tax' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '237258627070169',
- ],
- 'SubscriptionType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Subscription',
- ],
- 'PretaxGrossAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'OrderType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'New',
- ],
- 'PretaxAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Currency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'CommodityCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'PaymentStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Paid',
- ],
- 'PretaxAmountLocal' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'UUID', 'title' => ''],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'The owner of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '1529600453335198'],
+ 'CostCenterId' => ['title' => '', 'description' => 'The cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '640403'],
+ 'IsSuccess' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidOwner',
- 'errorMessage' => 'The specified owner doesn\'t belong to caller.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.ResourceAuthFailed', 'errorMessage' => 'The instance does not belong to the current user.', 'description' => ''],
+ ['errorCode' => 'CostCenter.ResourceNotExist', 'errorMessage' => 'The specified instance is not found in our records.', 'description' => ''],
+ ['errorCode' => 'CostCenter.AllocateResourceRepeat', 'errorMessage' => 'The instance has already been assigned a financial unit. Use transfer allocation for adjustment.', 'description' => ''],
],
- [
- [
- 'errorCode' => 'InvalidCaller',
- 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"CostCenterId\\": 640403,\\n \\"IsSuccess\\": true\\n}","type":"json"}]',
+ 'title' => 'Allocate resources to a cost center',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-22T05:47:39.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:AllocateCostUnitResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"1\\",\\n \\"OrderId\\": \\"237258627070169\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
- 'GetOrderDetail' => [
- 'summary' => '订单详情查询',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CancelFundAccountLowAvailableAmountAlarm' => [
+ 'summary' => 'Cancels the low balance alert for a fund account.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '233501558440169',
- ],
- ],
- [
- 'name' => 'MemberUid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1715322405372273',
- ],
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the fund account. If this parameter is not specified, the ID of the account owned by the current account is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '123321123', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HostName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'PageNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'OrderList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Order' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Operator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '322315',
- ],
- 'AfterTaxAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Config' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]',
- ],
- 'SubOrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '234343',
- ],
- 'PaymentTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2017-06-08T09:41:30Z',
- ],
- 'Tax' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'PaymentCurrency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'UsageEndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2117-06-08T16:00:00Z',
- ],
- 'SubscriptionType' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Subscription',
- ],
- 'PretaxGrossAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'OrderType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'new',
- ],
- 'Currency' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'CommodityCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'UsageStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2017-06-08T16:00:00Z',
- ],
- 'OriginalConfig' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]',
- ],
- 'InstanceIds' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["rm-bp1a2vsr018313t6o"]',
- ],
- 'PaymentStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'paid',
- ],
- 'ExtendInfos' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => '{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}',
- ],
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2017-06-08T09:41:30Z',
- ],
- 'ProductType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'Quantity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'RelatedOrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '241559391310332',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '241559391310333',
- ],
- 'BillModuleConfig' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'billModuleConfig' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'BillModuleProperties' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'billModuleProperties' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
- 'AttrApiCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
- 'ModuleApiCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_ssd',
- ],
- ],
- ],
- ],
- ],
- ],
- 'ApiCode' => [
- 'description' => 'apiCode',
- 'type' => 'string',
- 'example' => 'datadisk',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'datadisk',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- 'OriginalModuleConfig' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'originalModuleConfig' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ModuleProperties' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'moduleProperties' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cloud_efficiency',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'systemdisk',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- 'OrderSubType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'productsuborder',
- ],
- 'PretaxAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Region' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- 'PretaxAmountLocal' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Data' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'default' => 'true', 'example' => 'true', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DFC1F7F9-3BA9-BA4D-2F2E653', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidOwner',
- 'errorMessage' => 'The specified owner doesn\'t belong to caller.',
- ],
- ],
- [
- [
- 'errorCode' => 'InvalidCaller',
- 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.',
- ],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DFC1F7F9-3BA9-BA4D-2F2E653\\"\\n}","type":"json"}]',
+ 'title' => 'Cancel low balance alert for a fund account',
+ 'description' => 'Cancels the low balance alert for a fund account.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"Operator\\": \\"322315\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"0\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"new\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"InstanceIds\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Quantity\\": \\"3\\",\\n \\"RelatedOrderId\\": \\"241559391310332\\",\\n \\"OrderId\\": \\"241559391310333\\",\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"ModuleApiCode\\": \\"cloud_ssd\\"\\n }\\n ]\\n },\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"Name\\": \\"数据盘\\"\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_efficiency\\",\\n \\"Code\\": \\"cloud_efficiency\\",\\n \\"Name\\": \\"高效云盘\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"systemdisk\\",\\n \\"Name\\": \\"系统盘\\"\\n }\\n ]\\n },\\n \\"OrderSubType\\": \\"productsuborder\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
- 'ListInvoiceTitle' => [
- 'summary' => '发票抬头查询服务',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CheckBudgetNameExists' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
- [
- 'APP' => [],
- ],
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'BudgetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'required' => true, 'example' => 'department1'],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary sales channel ID. If this parameter is left empty, the channel ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2688801000001'],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<BssInvoiceTitleDTO>',
- 'description' => 'BssApiListResult<BssInvoiceTitleDTO>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '数据列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'UnifiedSocialCreditCode' => [
- 'title' => '统一社会信用代码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '111111111111111',
- ],
- 'AccountId' => [
- 'title' => '用户ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1990699401005016',
- ],
- 'RegisteredAddress' => [
- 'title' => '注册场所地址',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-06-01 00:00:00',
- ],
- 'InvoiceTitle' => [
- 'title' => '发票抬头',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Id' => [
- 'title' => '发票抬头id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'BankAccountNumber' => [
- 'title' => '基本开户账号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'RegisteredLandline' => [
- 'title' => '注册固定电话',
- 'description' => '',
- 'type' => 'string',
- 'example' => '010-12345678',
- ],
- 'AccountBankName' => [
- 'title' => '开户银行名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F1E2D3C4-B5A6-7890-1234-567890ABCDEF', 'title' => ''],
+ 'Exists' => ['title' => '', 'description' => 'Indicates whether the budget name already exists.', 'type' => 'boolean', 'example' => 'true'],
+ 'BudgetName' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'example' => 'department1'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.',
- ],
- [
- 'errorCode' => 'InnerAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.',
- ],
- [
- 'errorCode' => 'InnerSubAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.',
- ],
- [
- 'errorCode' => 'SubAccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Check whether a budget name exists',
+ 'summary' => 'Checks whether a specified budgetName exists.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:CheckBudgetNameExists',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"UnifiedSocialCreditCode\\": \\"111111111111111\\",\\n \\"AccountId\\": 1990699401005016,\\n \\"RegisteredAddress\\": \\"北京市朝阳区\\",\\n \\"CreateTime\\": \\"2025-06-01 00:00:00\\",\\n \\"InvoiceTitle\\": \\"xx公司\\",\\n \\"Id\\": \\"123456\\",\\n \\"BankAccountNumber\\": \\"1234567890\\",\\n \\"RegisteredLandline\\": \\"010-12345678\\",\\n \\"AccountBankName\\": \\"招商银行\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1E2D3C4-B5A6-7890-1234-567890ABCDEF\\",\\n \\"Exists\\": true,\\n \\"BudgetName\\": \\"department1\\"\\n}","type":"json"}]',
],
- 'ListInvoiceCandidate' => [
- 'summary' => '对客OpenAPI开票对象查询',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateBudget' => [
+ 'summary' => 'Creates a budget.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'Status',
- 'in' => 'query',
+ 'name' => 'BudgetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'required' => true, 'example' => 'Department_dev_budget'],
+ ],
+ [
+ 'name' => 'BudgetType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The budget type.',
+ 'enumValueTitles' => ['CONSUME' => 'CONSUME'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CONSUME',
+ ],
+ ],
+ [
+ 'name' => 'Metric',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The budget metric.',
+ 'enumValueTitles' => ['REQUIRE_AMOUNT' => 'REQUIRE_AMOUNT'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'REQUIRE_AMOUNT',
+ ],
+ ],
+ [
+ 'name' => 'CycleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The cycle type.',
+ 'enumValueTitles' => ['QUARTERLY' => 'QUARTERLY', 'ANNUALLY' => 'ANNUALLY', 'MONTHLY' => 'MONTHLY'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'MONTHLY',
+ ],
+ ],
+ [
+ 'name' => 'CycleStartPeriod',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start cycle.', 'type' => 'string', 'required' => true, 'example' => '2026-01'],
+ ],
+ [
+ 'name' => 'CycleEndPeriod',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end cycle.', 'type' => 'string', 'required' => true, 'example' => '2026-12'],
+ ],
+ [
+ 'name' => 'QuotaType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The quota type.',
+ 'enumValueTitles' => ['SPECIFY' => 'SPECIFY', 'FIXED' => 'FIXED'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'FIXED',
+ ],
+ ],
+ [
+ 'name' => 'Quota',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The fixed quota value. If the type is quota, the unit is percentage.', 'type' => 'string', 'required' => false, 'example' => '1000'],
+ ],
+ [
+ 'name' => 'CycleQuota',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '状态',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The per-cycle specified quota. This parameter is required when QuotaType is set to `SPECIFY`.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '',
- '',
- '',
- '',
- ],
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
+ 'type' => 'object',
+ 'properties' => [
+ 'CyclePeriod' => ['title' => '', 'description' => 'The cycle.', 'type' => 'string', 'required' => false, 'example' => '2026-01'],
+ 'Quota' => ['title' => '', 'description' => 'The quota.', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'enumValueTitles' => [],
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- ],
+ 'example' => '',
],
],
[
- 'name' => 'Types',
- 'in' => 'query',
+ 'name' => 'QueryFilter',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '类型',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '',
- '',
- '',
- '',
- '',
- 7 => '',
- '',
- ],
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'title' => '',
+ 'description' => 'The parameter code.',
+ 'enumValueTitles' => ['PRODUCT' => 'PRODUCT', 'RESOURCE_OWNER_ACCOUNT' => 'RESOURCE_OWNER_ACCOUNT', 'COMMODITY' => 'COMMODITY', 'COST_CENTER' => 'COST_CENTER', 'LINE_ITEM_TYPE' => 'LINE_ITEM_TYPE', 'REGION' => 'REGION'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'RESOURCE_OWNER_ACCOUNT',
+ ],
+ 'SelectType' => ['title' => '', 'description' => 'The selection mode.', 'type' => 'string', 'required' => false, 'example' => 'IN'],
+ 'Values' => [
+ 'title' => '',
+ 'description' => 'The list of filter values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => '5772131917493334Test', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'enumValueTitles' => [],
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- ],
+ 'example' => '',
],
],
[
- 'name' => 'BusinessIds',
- 'in' => 'query',
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'],
+ ],
+ [
+ 'name' => 'WarnConfs',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '业务单据号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The alert configurations.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '', 'description' => 'The alert name. This is a user-defined optional field. If not specified, the backend automatically generates a name.', 'type' => 'string', 'required' => false, 'example' => 'Alter-1'],
+ 'WarnTarget' => [
+ 'title' => '',
+ 'description' => 'The alert target.',
+ 'enumValueTitles' => ['FORECAST_ACCUMULATED' => 'FORECAST_ACCUMULATED', 'ACTUAL_ACCUMULATED' => 'ACTUAL_ACCUMULATED', 'FORECAST' => 'FORECAST', 'ACTUAL' => 'ACTUAL'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FORECAST',
+ ],
+ 'ThresholdType' => [
+ 'title' => '',
+ 'description' => 'The threshold type.',
+ 'enumValueTitles' => ['FIXED' => 'FIXED', 'PERCENTAGE' => 'PERCENTAGE'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FIXED',
+ ],
+ 'ThresholdValue' => ['title' => '', 'description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '2000'],
+ 'MscContacts' => [
+ 'title' => '',
+ 'description' => 'The list of Message Center contacts.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Message Center contact.', 'type' => 'string', 'required' => false, 'example' => '1512795', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'MscChannels' => [
+ 'title' => '',
+ 'description' => 'The list of Message Center notification channels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Message Center notification channel.', 'type' => 'string', 'required' => false, 'example' => 'EMAIL', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'EventBridge' => ['title' => '', 'description' => 'Specifies whether to enable EventBridge.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'comment'],
+ ],
'required' => false,
- 'example' => '202506',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'StartTime',
+ 'name' => 'EcIdAccountIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of enterprises and accounts. An empty value indicates the current account.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The enterprise and account.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. An empty value indicates all accounts under the current entity ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The account to access.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5772131917494444', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '2025-06-01 00:00:00',
- 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$',
+ 'example' => '',
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'Nbid',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The level-1 marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '26842'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '结束时间',
+ 'title' => '',
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-07-01 00:00:00',
- 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$',
+ 'type' => 'object',
+ 'properties' => [
+ 'BudgetName' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'example' => 'Department_dev_budget'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39EDD65E-68C5-1B17-8440-C729C7591D74', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a budget',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BudgetName\\": \\"Department_dev_budget\\",\\n \\"RequestId\\": \\"39EDD65E-68C5-1B17-8440-C729C7591D74\\"\\n}","type":"json"}]',
+ ],
+ 'CreateCostCenter' => [
+ 'summary' => 'Create Cost Center',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BillingCycles',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'CostCenterEntityList',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '账期',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Cost center entity list',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'object',
+ 'properties' => [
+ 'CostCenterName' => ['title' => '', 'description' => 'Cost center name (must be unique within the same account)', 'type' => 'string', 'required' => true, 'example' => '资源组'],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'Owner user ID of the new cost center', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1314839403940987'],
+ 'ParentCostCenterId' => ['title' => '', 'description' => 'Parent cost center ID. A value of -1 indicates the root cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '-1'],
+ ],
'required' => false,
- 'example' => '202506',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'required' => true,
+ 'example' => '',
],
],
[
- 'name' => 'InvoiceIssuers',
+ 'name' => 'Nbid',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2084210001'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '开票主体',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ALIYUN_SERVICE',
- 'pattern' => '^[0-9a-zA-Z_-]+$',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<CostCenterDto>',
+ 'type' => 'object',
+ 'properties' => [
+ 'CostCenterDtoList' => [
+ 'title' => '',
+ 'description' => 'Data list',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CostCenterName' => ['title' => '', 'description' => 'Cost center name (must be unique within the same account)', 'type' => 'string', 'example' => '资源组'],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'Owner user ID of the cost center', 'type' => 'integer', 'format' => 'int64', 'example' => '1314839403940987'],
+ 'CostCenterId' => ['title' => '', 'description' => 'Cost center ID', 'type' => 'integer', 'format' => 'int64', 'example' => '485938'],
+ 'ParentCostCenterId' => ['title' => '', 'description' => 'Parent cost center ID', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', 'title' => ''],
],
- 'required' => false,
- 'pattern' => '^[0-9a-zA-Z_-]+$',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNameLengthExceed', 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotBelongToUser', 'errorMessage' => 'Cost unit is not belong to this user.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNameExist', 'errorMessage' => 'The financial unit name already exists.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNumberExceed', 'errorMessage' => 'The maximum number of financial units has been exceeded.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotExist', 'errorMessage' => 'The financial unit does not exist or is invalid.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitLevelExceed', 'errorMessage' => 'The depth of the financial unit exceeds the maximum hierarchy level.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterDtoList\\": [\\n {\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\"\\n}","type":"json"}]',
+ 'title' => 'Create Cost Center',
+ 'description' => 'Creates one or more cost centers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateCostCenterRule' => [
+ 'summary' => 'Create a financial unit auto-allocation rule',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'CostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Financial unit ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '485938'],
+ ],
+ [
+ 'name' => 'FilterExpression',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'Rule expression',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpressionType' => [
+ 'description' => 'Operation type',
+ 'enumValueTitles' => ['DIMENSION' => 'Leaf node filter type (used when the code is not a tag)', 'TAG' => 'Leaf node filter type (used when the code is a tag)', 'NARY' => 'Sub-condition relationship (used for non-leaf conditions)'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NARY',
+ 'title' => '',
+ ],
+ 'OperatorType' => [
+ 'description' => 'Relational expression',
+ 'enumValueTitles' => ['OR' => 'OR', 'AND' => 'AND'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AND',
+ 'title' => '',
+ ],
+ 'Operands' => [
+ 'description' => 'Condition expression',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition expression'."\n"
+ .'**See the example for the overall structure (supports multi-level nesting). The fields below are for field description only.**', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' '."\n"
+ .' "Operands": ['."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "TAG-xxx",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "TAG"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_ID",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_NICK",'."\n"
+ .' "Values": ['."\n"
+ .' "111"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "RESOURCE_GROUP",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "ARTICLE",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "PRODUCT",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "OWNER",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Operand' => ['description' => 'Filter condition (deprecated)', 'type' => 'any', 'required' => false, 'example' => '无', 'title' => ''],
+ 'FilterValues' => [
+ 'description' => 'Sub-condition filter',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'Condition filter key',
+ 'enumValueTitles' => ['OWNER' => 'Account', 'ARTICLE' => 'Product detail', 'RESOURCE_GROUP' => 'Resource group', 'xxx (user-defined tag key)' => 'Business tag, based on the actual configuration value of the user', 'PRODUCT' => 'Product', 'INSTANCE_NICK' => 'Instance name', 'INSTANCE_ID' => 'Instance ID (billing granularity)'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TAG-test-xxx-key',
+ 'title' => '',
+ ],
+ 'CodeName' => ['description' => 'Condition filter key name (deprecated)', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
+ 'Values' => [
+ 'description' => 'Condition filter value list',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition filter value.'."\n"
+ .'Only one value can be entered for INSTANCE_NICK or INSTANCE_ID.', 'type' => 'string', 'required' => false, 'example' => '["TAG-test-xxx"]'."\n", 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SelectType' => [
+ 'description' => 'Association relationship between code and value',
+ 'enumValueTitles' => ['LIKE' => 'Used in other cases for Code', 'IN' => 'Used when Code is INSTANCE_NICK or INSTANCE_ID'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'IN',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
+ 'example' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Nbid',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'First-level marketplace ID. If left empty, the ID of the marketplace to which the current user belongs is used by default.', 'type' => 'string', 'required' => false, 'example' => '2084210001'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- 'default' => '20',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Long>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['description' => 'Financial unit allocation rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.RuleExpressionIllegal', 'errorMessage' => 'The auto-allocation rule configuration is invalid.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotExist', 'errorMessage' => 'The financial unit does not exist or is invalid.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1111,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
+ 'title' => 'Create a financial unit auto-allocation rule',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateFundAccountPayRelation' => [
+ 'summary' => 'Create payment relationships for a fund account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Fund account ID.', 'type' => 'string', 'required' => true, 'example' => '12332112'],
+ ],
[
'name' => 'EcIdAccountIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of enterprises and accounts.',
'type' => 'array',
'items' => [
+ 'description' => 'List of enterprises and accounts.',
'type' => 'object',
'properties' => [
'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of Alibaba Cloud accounts for delegated payment.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1990699401005016',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
+ 'items' => ['description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1501603440974415', 'title' => ''],
+ 'required' => true,
+ 'example' => '',
],
+ 'EcId' => ['title' => '', 'description' => 'Enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1501603440974415'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'required' => true,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If this parameter is left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<BssOpenInvoiceEvaluateDTO>',
- 'description' => 'BssApiPageResult<BssOpenInvoiceEvaluateDTO>',
+ 'title' => '',
+ 'description' => 'BssApiListResult<CreateBillingAccountPayRelationResponse>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Data list.',
'type' => 'array',
'items' => [
+ 'description' => 'Response data.',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '开票对象状态',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BillingCycle' => [
- 'title' => '账期',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '202506',
- ],
- 'AccountId' => [
- 'title' => '账号ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1990699401005016',
- ],
- 'AcceptedOffsetAmount' => [
- 'title' => '接受冲抵金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.01',
- ],
- 'ProductName' => [
- 'title' => '产品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ProductCode' => [
- 'title' => '产品Code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'pts',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-06-91 00:00:00',
- ],
- 'TotalAmount' => [
- 'title' => '总金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.01',
- ],
- 'ResourceOwnerAccountName' => [
- 'title' => '资源归属账号名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'InvoiceIssuer' => [
- 'title' => '开票主体',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIYUN_SERVICE',
- ],
- 'InvoiceableAmount' => [
- 'title' => '可开票金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.01',
- ],
- 'OffsetAmount' => [
- 'title' => '冲抵金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Type' => [
- 'title' => '开票对象类型',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ResourceOwnerAccountId' => [
- 'title' => '资源归属账号ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1990699401005016',
- ],
- 'CommodityCode' => [
- 'title' => '商品Code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'pts',
- ],
- 'Id' => [
- 'title' => '开票对象id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '12345',
- ],
- 'BusinessTime' => [
- 'title' => '业务发生时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-06-01 00:00:00'."\n",
- ],
- 'InvoicedAmount' => [
- 'title' => '已开票金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'BusinessId' => [
- 'title' => '业务单据号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '202506',
- ],
- 'CommodityName' => [
- 'title' => '商品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AccountName' => [
- 'title' => '账号名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'AccountId' => ['title' => '', 'description' => 'AccountId of the user who pays with the account.', 'type' => 'string', 'example' => '1501603440974415'],
+ 'FundAccountId' => ['title' => '', 'description' => 'Account ID.', 'type' => 'string', 'example' => '12332112'],
+ 'ResultMessage' => ['title' => '', 'description' => 'Result message.', 'type' => 'string', 'example' => 'Successful'],
+ 'ResultCode' => ['title' => '', 'description' => 'Result code.', 'type' => 'string', 'example' => 'Success'],
+ 'AccountName' => ['title' => '', 'description' => 'Name of the user who pays with the account.', 'type' => 'string', 'example' => 'test@test.aliyunid.com'."\n"],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.',
- ],
- [
- 'errorCode' => 'InnerAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.',
- ],
- [
- 'errorCode' => 'InnerSubAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.',
- ],
- [
- 'errorCode' => 'SubAccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- [
- 'errorCode' => 'InvoiceCandidateSearchTimeInvalid',
- 'errorMessage' => 'Invoicing Candidate query time is illegal.',
+ ['errorCode' => 'InvalidBillingAccount', 'errorMessage' => 'The caller does not have permission for the specified billing account.', 'description' => ''],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": \\"1501603440974415\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"ResultMessage\\": \\"Successful\\",\\n \\"ResultCode\\": \\"Success\\",\\n \\"AccountName\\": \\"test@test.aliyunid.com\\\\n\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999\\"\\n}","type":"json"}]',
+ 'title' => 'Create payment relationships for a fund account',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-28T07:54:23.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'CreateFundAccountTransfer' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'FromFundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the source account (payer account ID).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123212323'],
+ ],
+ [
+ 'name' => 'ToFundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the destination account (payee account ID).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11112231'],
+ ],
+ [
+ 'name' => 'Amount',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The transfer amount.', 'type' => 'string', 'required' => true, 'example' => '100'],
+ ],
+ [
+ 'name' => 'Currency',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The currency.', 'type' => 'string', 'required' => true, 'example' => 'CNY'],
+ ],
+ [
+ 'name' => 'FinanceType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The asset type. Currently, only cash is supported. Valid values:'."\n"
+ .'- cash: cash.', 'type' => 'string', 'required' => true, 'example' => 'cash'],
+ ],
+ [
+ 'name' => 'TransferType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The transfer type. Valid values:'."\n"
+ .'- grant: transfer.'."\n"
+ .'- recycle: revocation.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'grant',
+ 'enum' => ['grant', 'recycle'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ [
+ 'name' => 'Remark',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => true, 'example' => '转账的备注'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Void>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1BB79-5B23-3EA-BB4F-352F93E'."\n"
+ ."\n", 'title' => ''],
+ ],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'AccountNotExist', 'errorMessage' => 'Account does not exist.', 'description' => 'Account does not exist'],
+ ['errorCode' => 'AvailableTransferAmountNotEnough', 'errorMessage' => 'The available amount for granting or recycling is insufficient.', 'description' => 'The amount available for allocation/recovery is insufficient. Please confirm and try again.'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"BillingCycle\\": 202506,\\n \\"AccountId\\": 1990699401005016,\\n \\"AcceptedOffsetAmount\\": \\"0.01\\",\\n \\"ProductName\\": \\"性能测试\\",\\n \\"ProductCode\\": \\"pts\\",\\n \\"CreateTime\\": \\"2025-06-91 00:00:00\\",\\n \\"TotalAmount\\": \\"0.01\\",\\n \\"ResourceOwnerAccountName\\": \\"测试账号\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\",\\n \\"InvoiceableAmount\\": \\"0.01\\",\\n \\"OffsetAmount\\": \\"0\\",\\n \\"Type\\": 1,\\n \\"ResourceOwnerAccountId\\": 1990699401005016,\\n \\"CommodityCode\\": \\"pts\\",\\n \\"Id\\": \\"12345\\",\\n \\"BusinessTime\\": \\"2025-06-01 00:00:00\\\\n\\",\\n \\"InvoicedAmount\\": \\"0\\",\\n \\"BusinessId\\": \\"202506\\",\\n \\"CommodityName\\": \\"性能测试\\",\\n \\"AccountName\\": \\"测试账号\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
- ],
- 'CreateInvoice' => [
- 'summary' => '申请发票',
- 'methods' => [
- 'post',
+ 'title' => 'Create account transfer or revocation',
+ 'summary' => 'Creates an account transfer or revocation.',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-05T11:33:26.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyTransfer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"1BB79-5B23-3EA-BB4F-352F93E\\\\n\\\\n\\"\\n}","type":"json"}]',
+ ],
+ 'CreateInvoice' => [
+ 'summary' => 'Apply for Invoice',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1456,127 +1104,86 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => false,
- 'notSupportAutoTestReason' => '自动化测试平台配置的统一测试UID=1948392007548064不支持开票操作',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '自动化测试平台配置的统一测试UID=1948392007548064不支持开票操作'],
'parameters' => [
[
'name' => 'Amount',
'in' => 'query',
- 'schema' => [
- 'title' => '开票信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0.01',
- 'pattern' => '^[\\d._-]+$',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies the invoice amount. Supports up to two decimal places.'."\n"
+ .'- If not specified, the invoice will be issued for the total invoiceable amount of all invoiceCandidateIds.'."\n"
+ .'- If specified, the invoice will be issued for the specified amount. The specified amount cannot exceed the total invoiceable amount of all invoiceCandidateIds.', 'type' => 'string', 'pattern' => '^[\\d._-]+$', 'required' => false, 'example' => '0.01'],
],
[
'name' => 'InvoiceTitleId',
'in' => 'query',
- 'schema' => [
- 'title' => '发票抬头信息Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- 'pattern' => '^\\d+$',
- ],
+ 'schema' => ['title' => '', 'description' => 'Invoice title ID.'."\n"
+ ."\n"
+ .'- The ID parameter returned by the ListInvoiceTitle API for the current logged-in account.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d+$', 'example' => '12345'],
],
[
'name' => 'RecipientEmails',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '接收邮箱',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of email addresses to receive the invoice. A maximum of 3 can be specified.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1@1.com',
- ],
+ 'items' => ['description' => 'Email address to receive the invoice.', 'type' => 'string', 'required' => true, 'example' => '1@1.com', 'title' => ''],
'required' => true,
'maxItems' => 3,
'minItems' => 1,
+ 'example' => '',
],
],
[
'name' => 'InvoiceRemark',
'in' => 'query',
- 'schema' => [
- 'title' => '发票备注',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'maxLength' => 200,
- ],
+ 'schema' => ['title' => '', 'description' => 'Invoice remark.', 'type' => 'string', 'maxLength' => 200, 'required' => false, 'example' => '备注信息'],
],
[
'name' => 'InvoiceCandidateIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '开票对象列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of invoice candidate IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- 'pattern' => '^\\d+$',
- ],
+ 'items' => ['description' => 'Invoice candidate ID.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d+$', 'example' => '12345', 'title' => ''],
'required' => true,
'pattern' => '^\\d+$',
'minItems' => 1,
+ 'example' => '',
],
],
[
'name' => 'InvoiceType',
'in' => 'query',
'schema' => [
- 'title' => '开票类型',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Invoice type.',
+ 'enumValueTitles' => ['Digital electronic general invoice', 'Digital electronic special invoice'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [
- '',
- '',
- ],
+ 'enum' => ['0', '1'],
'example' => '0',
- 'enum' => [
- '0',
- '1',
- ],
],
],
[
'name' => 'InvoiceMode',
'in' => 'query',
'schema' => [
- 'title' => '开票方式',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Invoice mode.'."\n"
+ .'- 0: Independent invoicing. Expenses of multiple accounts under the enterprise are invoiced separately for each account.'."\n"
+ .'- 1: Consolidated invoicing. Expenses of multiple accounts under the enterprise are consolidated and invoiced under the invoicing entity.'."\n"
+ .'If only one account is passed in the AccountIds parameter, independent invoicing is applied.',
+ 'enumValueTitles' => ['Independent invoicing', 'Consolidated invoicing'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [
- '',
- '',
- ],
+ 'enum' => ['0', '1'],
'example' => '0',
- 'enum' => [
- '0',
- '1',
- ],
],
],
[
@@ -1584,205 +1191,108 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Enterprise and account list. If empty, the current account is queried.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of accounts to access. If empty, all accounts under the current entity ID are selected.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1990699401005016',
- ],
+ 'items' => ['description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1990699401005016', 'title' => ''],
'required' => false,
'maxItems' => 100,
+ 'example' => '',
],
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'EcId' => ['title' => '', 'description' => 'Enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<BssOpenInvoiceApplyDTO>',
+ 'title' => '',
'description' => 'BssApiListResult<BssOpenInvoiceApplyDTO>',
'type' => 'object',
'properties' => [
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Data list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'AccountId' => [
- 'title' => '账号ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1990699401005016',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Amount' => [
- 'title' => '开票金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0.01',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1001',
- ],
- 'InvoiceIssuer' => [
- 'title' => '开票主体',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIYUN_SERVICE',
- ],
+ 'AccountId' => ['title' => '', 'description' => 'Account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '不可开票'],
+ 'Amount' => ['title' => '', 'description' => 'Invoice amount.', 'type' => 'string', 'example' => '0.01'],
+ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '1001'],
+ 'InvoiceIssuer' => ['title' => '', 'description' => 'Invoice issuer.', 'type' => 'string', 'example' => 'ALIYUN_SERVICE'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InnerAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.',
- ],
- [
- 'errorCode' => 'InnerSubAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- [
- 'errorCode' => 'AccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.',
- ],
- [
- 'errorCode' => 'SubAccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.',
- ],
- [
- 'errorCode' => 'InvoiceManualAmountNotAllowed',
- 'errorMessage' => 'Cross-account independent invoicing, amount cannot be specified.',
- ],
- [
- 'errorCode' => 'InvoiceRecipientEmailsMoreThanThree',
- 'errorMessage' => 'Maximum 3 email addresses allowed for invoice application.',
- ],
- [
- 'errorCode' => 'InvoiceCandidateNotFound',
- 'errorMessage' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.',
- ],
- [
- 'errorCode' => 'InvoiceTitleNotExist',
- 'errorMessage' => 'Invoice title does not exist.',
- ],
- [
- 'errorCode' => 'InvoiceRemarkTooLong',
- 'errorMessage' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.',
- ],
- [
- 'errorCode' => 'InvoiceAmountInValid',
- 'errorMessage' => 'Illegal amount requested for invoicing.',
- ],
- [
- 'errorCode' => 'InvoiceAmountFormatInvalid',
- 'errorMessage' => 'Illegal format of invoiced amount.',
- ],
- [
- 'errorCode' => 'InvoiceModeInvalid',
- 'errorMessage' => 'InvoiceMode field is illegal.',
- ],
- [
- 'errorCode' => 'InvoiceTypeInvalid',
- 'errorMessage' => 'InvoiceType field is illegal.',
- ],
- [
- 'errorCode' => 'InvoiceSpecialOnlyForEnterprises',
- 'errorMessage' => 'Special invoices can only be issued by enterprise accounts.',
- ],
- [
- 'errorCode' => 'InvoiceAmountNegativeInvalid',
- 'errorMessage' => 'The sum of the selected amounts is negative and cannot be invoiced.',
- ],
+ ['errorCode' => 'InnerAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', '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 。'],
+ ['errorCode' => 'InnerSubAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', '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 。'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'SubAccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', '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.'],
+ ['errorCode' => 'InvoiceManualAmountNotAllowed', 'errorMessage' => 'Cross-account independent invoicing, amount cannot be specified.', 'description' => 'Cross-account independent invoicing, amount cannot be specified'],
+ ['errorCode' => 'InvoiceRecipientEmailsMoreThanThree', 'errorMessage' => 'Maximum 3 email addresses allowed for invoice application.', 'description' => ''],
+ ['errorCode' => 'InvoiceCandidateNotFound', 'errorMessage' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.', 'description' => 'No valid data to be invoiced can be found based on the invoicing object list and account list passed in.'],
+ ['errorCode' => 'InvoiceTitleNotExist', 'errorMessage' => 'Invoice title does not exist.', 'description' => 'Invoice header does not exist'],
+ ['errorCode' => 'InvoiceRemarkTooLong', 'errorMessage' => 'Invoice remarks must not exceed 200 characters. Please abbreviate and resubmit.', 'description' => 'The length of the invoice note is too long, please abbreviate it properly and resubmit it!'],
+ ['errorCode' => 'InvoiceAmountInValid', 'errorMessage' => 'Illegal amount requested for invoicing.', 'description' => 'Illegal amount requested for invoicing'],
+ ['errorCode' => 'InvoiceAmountFormatInvalid', 'errorMessage' => 'Illegal format of invoiced amount.', 'description' => 'Illegal format of invoiced amount'],
+ ['errorCode' => 'InvoiceModeInvalid', 'errorMessage' => 'InvoiceMode field is illegal.', 'description' => 'InvoiceMode field is illegal'],
+ ['errorCode' => 'InvoiceTypeInvalid', 'errorMessage' => 'InvoiceType field is illegal.', 'description' => 'InvoiceType field is illegal'],
+ ['errorCode' => 'InvoiceSpecialOnlyForEnterprises', 'errorMessage' => 'Special invoices can only be issued by enterprise accounts.', 'description' => 'Special invoices can only be issued by enterprise accounts.'],
+ ['errorCode' => 'InvoiceAmountNegativeInvalid', 'errorMessage' => 'The sum of the selected amounts is negative and cannot be invoiced.', 'description' => 'The sum of the selected amounts is negative and cannot be invoiced.'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": 1990699401005016,\\n \\"Message\\": \\"不可开票\\",\\n \\"Amount\\": \\"0.01\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
- ],
- 'CreateFundAccountPayRelation' => [
- 'summary' => '创建资金账户付款关系',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Invoice Application',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'CreateReportDefinition' => [
+ 'summary' => 'Creates a billing report subscription.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1790,158 +1300,292 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FundAccountId',
+ 'name' => 'ReportSourceType',
'in' => 'formData',
- 'schema' => [
- 'title' => '资金账户Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12332112',
- ],
+ 'schema' => ['description' => 'The subscription source. Valid values: OSS, MC, and MSC_EMAIL.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''],
],
[
- 'name' => 'EcIdAccountIds',
+ 'name' => 'ReportType',
'in' => 'query',
- 'style' => 'json',
+ 'schema' => ['title' => '', 'description' => 'The subscription type. Valid values:'."\n"
+ .'- consumeDetailBillV2: consumption details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- splitDetailBillV2: split details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- costDetailBillV2: cost details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- monthBillOverview: monthly bill overview. This value is supported only by OSS/MSC_EMAIL subscriptions.'."\n"
+ .'- focus: FOCUS bill. This value is supported only by OSS/MC subscriptions.', 'type' => 'string', 'required' => true, 'example' => 'consumeDetailBillV2'],
+ ],
+ [
+ 'name' => 'BeginBillingCycle',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The start billing cycle for push. After the subscription succeeds, the system automatically pushes data from the start billing cycle to the current time. This parameter is invalid for monthly bill PDF subscriptions, and historical data will not be re-pushed. You can push data within the last year.', 'type' => 'string', 'required' => false, 'example' => '2025-05'],
+ ],
+ [
+ 'name' => 'OssBucketOwnerAccountId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the OSS bucket owner that stores the files. If this is a Bid/Reseller subscription and you need to push data to a sub-account\'s OSS, specify this parameter. The account must be a sub-account of the calling account, and the AliyunConsumeDump2OSSRole permission must be granted to this account. Regular users do not need to specify this parameter. The default value is the calling account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567812345678', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the OSS bucket for file storage.', 'type' => 'string', 'required' => false, 'example' => 'sh-bill', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketPath',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The storage path of the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'bill/', 'title' => ''],
+ ],
+ [
+ 'name' => 'McProject',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the MaxCompute project.', 'type' => 'string', 'required' => false, 'example' => 'project', 'title' => ''],
+ ],
+ [
+ 'name' => 'McTableName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the MaxCompute subscription table.', 'type' => 'string', 'required' => false, 'example' => 'table', 'title' => ''],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The first-level site ID. If this parameter is left empty, the site ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ [
+ 'name' => 'SplitFileOnUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email subscription configuration that specifies whether to split attachments by user ID.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NotSendOnNoData',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email subscription configuration that specifies whether to skip sending emails when no bills are available.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'SendWithAttach',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email subscription configuration that specifies whether to send emails with bill attachments.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IncludeMembers',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The email subscription configuration that specifies whether to include multi-account members of the organization in bills.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '企业与账号列表',
+ 'title' => '',
'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AccountIds' => [
- 'title' => '被代付的阿里云账号列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1501603440974415',
- ],
- 'required' => true,
- ],
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1501603440974415',
- ],
- ],
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '340CAB45-0637-5875-9BE4-EFD5750F6BA5', 'title' => ''],
+ 'ReportTaskId' => ['description' => 'The ID of the billing subscription task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''],
+ 'ReportSourceType' => ['description' => 'The subscription source. Valid values: OSS and MC.', 'type' => 'string', 'example' => 'OSS', 'title' => ''],
+ 'ReportSourceName' => ['description' => 'The name of the subscription source.', 'type' => 'string', 'example' => 'OSS', 'title' => ''],
+ 'ReportType' => ['title' => '', 'description' => 'The subscription type. Valid values:'."\n"
+ .'- consumeDetailBillV2: consumption details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- splitDetailBillV2: split details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- costDetailBillV2: cost details. This value is supported only by OSS/MC subscriptions.'."\n"
+ .'- monthBillOverview: monthly bill overview. This value is supported only by OSS/MSC_EMAIL subscriptions.'."\n"
+ .'- focus: FOCUS bill. This value is supported only by OSS/MC subscriptions.', 'type' => 'string', 'example' => 'consumeDetailBillV2'],
+ 'BeginBillingCycle' => ['title' => '', 'description' => 'The start billing cycle for push. After the subscription succeeds, the system automatically pushes data from the start billing cycle to the current time. This parameter is invalid for monthly bill PDF subscriptions, and historical data will not be re-pushed. You can push data within the last year.', 'type' => 'string', 'example' => '2025-05'],
+ 'SubscribeCreateTime' => ['description' => 'The time when the subscription was created.', 'type' => 'string', 'example' => '2025-05-21 10:36:31', 'title' => ''],
+ 'OssBucketOwnerAccountId' => ['description' => 'The UID of the OSS bucket owner that stores the files. If this is a Bid/Reseller subscription and you need to push data to a sub-account\'s OSS, specify this parameter. The account must be a sub-account of the calling account, and the AliyunConsumeDump2OSSRole permission must be granted to this account. Regular users do not need to specify this parameter. The default value is the calling account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567812345678', 'title' => ''],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket for file storage.', 'type' => 'string', 'example' => 'sh-bill', 'title' => ''],
+ 'OssBucketPath' => ['description' => 'The storage path of the OSS bucket.', 'type' => 'string', 'example' => 'bill/', 'title' => ''],
],
- 'required' => true,
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'TASK_EXIST', 'errorMessage' => 'task has already exist.', 'description' => 'This table already exists and cannot be resubscribed'],
+ ['errorCode' => 'InvalidBucket', 'errorMessage' => 'The bucket is invalid or the bucket does not belong to you.', 'description' => ''],
+ ['errorCode' => 'InvalidHistoricalNbid', 'errorMessage' => 'Historical field does not support subscription bill.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"340CAB45-0637-5875-9BE4-EFD5750F6BA5\\",\\n \\"ReportTaskId\\": 123123,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"consumeDetailBillV2\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"sh-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n}","type":"json"}]',
+ 'title' => 'Create Report Subscription',
+ 'description' => 'When you call this API operation, note the following information:'."\n"
+ ."\n"
+ .'- You can subscribe to one type of billing file at a time.'."\n"
+ ."\n"
+ .'- Except for monthly bill PDFs, starting from the day after the subscription, the system pushes daily billing files that contain full detailed data from the beginning of the current month to the present. Before the 4th of each month, the system pushes full billing files for the complete billing cycle of the previous month.'."\n"
+ .'- Monthly bill PDFs are pushed before the 4th of each month for the previous month.'."\n"
+ ."\n"
+ .'- Billing files generated on a daily basis may have delays. Delayed billing files are pushed on the day after they are generated and may also contain bills that were delayed from before the previous day and generated on the previous day. We recommend that you pull the full files for the previous month at the beginning of each month.'."\n"
+ ."\n"
+ .'> Apply for the required permissions by following the procedure described in the documentation: [Billing Subscription](https://help.aliyun.com/zh/user-center/user-guide/billing-subscription?spm=5176.21213303.J_v8LsmxMG6alneH-O7TCPa.1.3ef82f3d5ZIf08&scm=20140722.S_help@@%E6%96%87%E6%A1%A3@@2861820._.ID_help@@%E6%96%87%E6%A1%A3@@2861820-RL_%E8%B4%A6%E5%8D%95%E8%AE%A2%E9%98%85-LOC_2024SPHelpResult-OR_ser-PAR1_2150419517478292121114501eaee8-V_4-RE_new5-P0_0-P1_0)'."\n"
+ ."\n"
+ .'- This subscription and the Expenses and Costs - Billing Subscription are the same feature, and subscriptions are interchangeable.'."\n"
+ ."\n"
+ .'- When subscribing to a directory under a bucket, follow the directory naming conventions:'."\n"
+ ."\n"
+ .' - Emojis are not allowed. Use compliant UTF-8 characters.'."\n"
+ .' - Forward slashes (/) are used to separate paths and can quickly create subdirectories. However, do not start with / or \\, and do not use consecutive forward slashes (/).'."\n"
+ .' - Subdirectories named .. are not allowed.'."\n"
+ .' - The total length must be 1 to 254 characters.'."\n"
+ ."\n"
+ .'- File names:'."\n"
+ .' - Example: **consumeDetailBillV2** (billing item details)'."\n"
+ .' '."\n"
+ .' - Daily push file name format: `{Account UID}_{Site ID}_{Bill type}_{YYYYMM|YYYYMMDD}`, for example: `169**_2688801000001_consumeDetailBillV2_20190312`.'."\n"
+ .' '."\n"
+ .' - Full file name format at the beginning of the next month: `{Account UID}_{Site ID}_{Bill type}_{YYYYMM|YYYYMM}`, for example: `169**_2688801000001_consumeDetailBillV2_201903`.'."\n"
+ ."\n"
+ .'- Monthly bill PDF files are in .pdf format, and other file types are in .csv format. When the data volume is large, the system automatically splits the exported bills into multiple files and compresses them into one or more .zip files. The .zip file name format is the same.',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-22T06:39:14.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyOssSub',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeleteBudget' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'BudgetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'required' => true, 'example' => 'department1'],
+ ],
[
'name' => 'Nbid',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the primary marketplace. If this parameter is left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
+ 'title' => '',
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7EA6C02D-06D0-4213-9C3B-E67910F7D1EB', 'title' => ''],
+ 'BudgetName' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'example' => 'department1'],
+ ],
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteBudget',
+ 'summary' => 'Deletes a budget.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7EA6C02D-06D0-4213-9C3B-E67910F7D1EB\\",\\n \\"BudgetName\\": \\"department1\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteCostCenter' => [
+ 'summary' => 'Delete Cost Center',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'OwnerAccountId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'User ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1314839403940987'],
+ ],
+ [
+ 'name' => 'CostCenterId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '485938'],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'First-level marketplace ID. If left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<CreateBillingAccountPayRelationResponse>',
- 'description' => 'BssApiListResult<CreateBillingAccountPayRelationResponse>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<CostCenterOperateDto>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '数据列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AccountId' => [
- 'title' => '使用账户付款的用户AccountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1501603440974415',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '12332112',
- ],
- 'ResultMessage' => [
- 'title' => '结果信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Successful',
- ],
- 'ResultCode' => [
- 'title' => '结果编码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'AccountName' => [
- 'title' => '使用账户付款的用户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test@test.aliyunid.com'."\n",
- ],
- ],
- ],
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205', 'title' => ''],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'User ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1314839403940987'],
+ 'CostCenterId' => ['title' => '', 'description' => 'Cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '485938'],
+ 'IsSuccess' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'True'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidBillingAccount',
- 'errorMessage' => 'The caller does not have permission for the specified billing account.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ ['errorCode' => 'CostCenter.DeleteWithShareRule', 'errorMessage' => 'This financial unit involves splitting expense rules. Please adjust relevant rules before deleting the financial unit.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotExist', 'errorMessage' => 'The financial unit does not exist or is invalid.', 'description' => ''],
+ ['errorCode' => 'CostCenter.DeleteWithSubUnitOrResource', 'errorMessage' => 'Financial units with sub-units, allocated resources, or auto-allocation rules cannot be deleted.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"IsSuccess\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete Cost Center',
+ 'description' => 'This API is in canary release and is only available to whitelisted users. Excessive calls may cause performance issues such as response timeouts.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"AccountId\\": \\"1501603440974415\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"ResultMessage\\": \\"Successful\\",\\n \\"ResultCode\\": \\"Success\\",\\n \\"AccountName\\": \\"test@test.aliyunid.com\\\\n\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999\\"\\n}","type":"json"}]',
],
- 'SetFundAccountLowAvailableAmountAlarm' => [
- 'summary' => '设置资金账户低额预警',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteCostCenterRule' => [
+ 'summary' => 'Delete financial unit automatic allocation rule',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1949,210 +1593,275 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ThresholdAmount',
+ 'name' => 'CostCenterId',
'in' => 'formData',
- 'schema' => [
- 'title' => '低额预警阈值',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['title' => '', 'description' => 'Financial unit ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '637127'],
],
[
- 'name' => 'FundAccountId',
- 'in' => 'formData',
+ 'name' => 'FilterExpression',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '资金账户id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Rule expression.'."\n"
+ .'**This field does not need to be entered during the delete operation.**',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpressionType' => [
+ 'description' => 'The operation type.',
+ 'enumValueTitles' => ['DIMENSION' => 'Leaf node filter type (used when Code is not a tag)', 'TAG' => 'Leaf node filter type (used when Code is a tag)', 'NARY' => 'Sub-condition relationship (used for non-leaf conditions)'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NARY',
+ 'title' => '',
+ ],
+ 'OperatorType' => ['description' => 'The relational expression.', 'type' => 'string', 'required' => false, 'example' => 'AND', 'title' => ''],
+ 'Operands' => [
+ 'description' => 'The conditional expressions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The conditional expression.'."\n"
+ .'**See the example for the overall structure (supports multi-level nesting). The following fields are only field descriptions.**', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' '."\n"
+ .' "Operands": ['."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "TAG-xxx",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "TAG"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_ID",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_NICK",'."\n"
+ .' "Values": ['."\n"
+ .' "111"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "RESOURCE_GROUP",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "ARTICLE",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "PRODUCT",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "OWNER",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Operand' => ['description' => 'The filter condition (no longer used).', 'type' => 'any', 'required' => false, 'example' => '无', 'title' => ''],
+ 'FilterValues' => [
+ 'description' => 'The sub-expression filter conditions.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'The condition filter key.',
+ 'enumValueTitles' => ['OWNER' => 'Account', 'ARTICLE' => 'Product detail', 'RESOURCE_GROUP' => 'Resource group', 'xxx (user-defined tag key)' => 'Business tag, based on the user\'s actual configuration value', 'PRODUCT' => 'Product', 'INSTANCE_NICK' => 'Instance name', 'INSTANCE_ID' => 'Billing granularity'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TAG-test-xxx-key'."\n",
+ 'title' => '',
+ ],
+ 'CodeName' => ['description' => 'The condition filter key name.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
+ 'Values' => [
+ 'description' => 'The condition filter values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The condition filter value. Only one value can be entered for INSTANCE_NICK or INSTANCE_NICK.', 'type' => 'string', 'required' => false, 'example' => '["TAG-test-xxx"]'."\n", 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SelectType' => [
+ 'description' => 'The association between Code and value.',
+ 'enumValueTitles' => ['LIKE' => 'Used when Code is other values', 'IN' => 'Used when Code is INSTANCE_NICK or INSTANCE_NICK'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'IN',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => '12321213',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Level-1 marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Boolean>',
- 'description' => 'BssApiPlainResult<Boolean>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Long>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '08108BF5-1AA3-518E-9986-95A3616E8DA9',
- ],
+ 'Data' => ['description' => 'The ID of the financial unit allocation rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '37404', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'The response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'UUID', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotExist', 'errorMessage' => 'The financial unit does not exist or is invalid.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 37404,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\"\\n}","type":"json"}]',
+ 'title' => 'Delete financial unit automatic allocation rule',
+ 'description' => 'This API is in canary release and is only available to whitelisted users. Excessive calls may cause performance issues such as response timeouts.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"08108BF5-1AA3-518E-9986-95A3616E8DA9\\"\\n}","type":"json"}]',
],
- 'GetFundAccountCanWithdrawAmount' => [
- 'summary' => '查询资金账户可提现金额',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteReportDefinition' => [
+ 'summary' => 'Deletes a bill report export subscription.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'FundAccountId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '资金账户id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123212232',
- ],
+ 'name' => 'ReportTaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the bill subscription task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123', 'title' => ''],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the primary sales channel. If this parameter is left empty, the ID of the sales channel to which the current user belongs is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<WithdrawInfoDTO>',
- 'description' => 'BssApiPlainResult<WithdrawInfoDTO>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3',
- ],
- 'CashAmount' => [
- 'title' => '现金余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'CanWithdrawAmount' => [
- 'title' => '可提现金额 = 现金余额 - 转账账本金额 - (欠票金额 + 历史月未结清金额 + 当前月未结清金额 - 转账账本金额) - 按量付费业务预留金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '500',
- ],
- 'CanOriginalWithdrawAmount' => [
- 'title' => '可原路提现金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '400',
- ],
- 'CannotOriginalWithdrawAmount' => [
- 'title' => '不可原路提现金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'PayAsYouGoReversedAmount' => [
- 'title' => '按量业务预留金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'TransferAmount' => [
- 'title' => '转账金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'CreditMemoAmount' => [
- 'title' => '欠票金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'CurrentMonthUnclearedAmount' => [
- 'title' => '当前月未结清金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'HistoryMonthUnclearedAmount' => [
- 'title' => '历史月未结清金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
+ 'Data' => ['description' => 'Indicates whether the subscription is deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ ['errorCode' => 'InvalidHistoricalNbid', 'errorMessage' => 'Historical field does not support subscription bill.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a report subscription',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyOssSub',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"CashAmount\\": \\"1000\\",\\n \\"CanWithdrawAmount\\": \\"500\\",\\n \\"CanOriginalWithdrawAmount\\": \\"400\\",\\n \\"CannotOriginalWithdrawAmount\\": \\"100\\",\\n \\"PayAsYouGoReversedAmount\\": \\"100\\",\\n \\"TransferAmount\\": \\"0\\",\\n \\"CreditMemoAmount\\": \\"100\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"200\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"100\\"\\n}","type":"json"}]',
],
- 'GetFundAccountAvailableAmount' => [
- 'summary' => '查询资金账户可用金',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeBudget' => [
+ 'summary' => 'Query a Single Budget',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2160,248 +1869,145 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'FundAccountId',
+ 'name' => 'BudgetName',
'in' => 'formData',
- 'schema' => [
- 'title' => '账户Id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12332112',
- ],
+ 'schema' => ['title' => '', 'description' => 'Budget name.', 'type' => 'string', 'required' => true, 'example' => 'department1'],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<BillingAccountAvailableAmountResponse>',
- 'description' => 'BssApiPlainResult<BillingAccountAvailableAmountResponse>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '12332112',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的账号accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1344312434',
- ],
- 'FundAccountStatus' => [
- 'title' => '账户状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'valid',
- ],
- 'FundAccountType' => [
- 'title' => '资金账户类型'."\n"
- .'DIRECT_USER-阿里云直客账户;'."\n"
- .' RESELLER_QUOTA-生态账户',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'REDIRECT_USER',
- ],
- 'AvailableAmount' => [
- 'title' => '可用额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'CashAmount' => [
- 'title' => '现金余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'NegativeBillAmount' => [
- 'title' => '负账单金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'CreditAmount' => [
- 'title' => '信控配额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'AvailableCreditAmount' => [
- 'title' => '信控余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'CreditRefundAmount' => [
- 'title' => '信控退款余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'UnclearedAmount' => [
- 'title' => '未结清金额 (当前月未结清 + 历史月未结清)',
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'CurrentMonthUnclearedAmount' => [
- 'title' => '当月未结清金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'HistoryMonthUnclearedAmount' => [
- 'title' => '历史月未结清金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '30',
- ],
- 'BankAcceptanceAmount' => [
- 'title' => '银承汇票额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A1B2C3D4-E5F6-7890-ABCD-EF1234567890', 'title' => ''],
+ 'BudgetName' => ['title' => '', 'description' => 'Budget name.', 'type' => 'string', 'example' => 'department1'],
+ 'BudgetType' => ['title' => '', 'description' => 'Budget type.', 'type' => 'string', 'example' => 'CONSUME'],
+ 'Metric' => ['title' => '', 'description' => 'Budget metric.', 'type' => 'string', 'example' => 'REQUIRE_AMOUNT'],
+ 'CycleType' => ['title' => '', 'description' => 'Cycle type.', 'type' => 'string', 'example' => 'MONTHLY'],
+ 'CycleStartPeriod' => ['title' => '', 'description' => 'Start cycle period.', 'type' => 'string', 'example' => '2025-10'],
+ 'CycleEndPeriod' => ['title' => '', 'description' => 'End cycle period.', 'type' => 'string', 'example' => '2026-12'],
+ 'QuotaType' => ['title' => '', 'description' => 'Quota type.', 'type' => 'string', 'example' => 'FIXED'],
+ 'Quota' => ['title' => '', 'description' => 'Fixed quota value.', 'type' => 'string', 'example' => '1000'],
+ 'CycleQuota' => [
+ 'title' => '',
+ 'description' => 'Quota specified per cycle.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CyclePeriod' => ['title' => '', 'description' => 'Cycle period.', 'type' => 'string', 'example' => '202601'],
+ 'Quota' => ['title' => '', 'description' => 'Quota.', 'type' => 'string', 'example' => '100'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'ExtendLedgerList' => [
- 'title' => '扩展的账本列表',
- 'description' => '',
+ 'QueryFilter' => [
+ 'title' => '',
+ 'description' => 'Filter conditions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Currency' => [
- 'title' => '账本金额币种,比如:CNY/USD等',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'LedgerName' => [
- 'title' => '账本名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '应付对冲账本',
- ],
- 'OriginalAmount' => [
- 'title' => '账本余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '50',
+ 'Code' => ['title' => '', 'description' => 'Parameter code.', 'type' => 'string', 'example' => 'RESOURCE_OWNER_ACCOUNT'],
+ 'SelectType' => ['title' => '', 'description' => 'Selection mode.', 'type' => 'string', 'example' => 'IN'],
+ 'Values' => [
+ 'title' => '',
+ 'description' => 'Filter value list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Dimension value.', 'type' => 'string', 'example' => '5772131917493334', 'title' => ''],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'QuotaAmount' => [
- 'title' => '生态终端客户配额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'QuotaConsumedAmount' => [
- 'title' => '生态终端客户已消费额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'Currency' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
+ 'EcIdAccountIdsFilter' => [
+ 'title' => '',
+ 'description' => 'Enterprise multi-account filter conditions.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['description' => 'Enterprise entity ID.', 'type' => 'string', 'example' => 'E2024112210463400001', 'title' => ''],
+ 'AccountIds' => [
+ 'description' => 'Member account IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5772131917494444', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
- 'OriginalCashAmountList' => [
- 'title' => '原始现金账本列表(国际站用户可能存在多个币种的现金账本)',
- 'description' => '',
+ 'Comment' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'example' => 'comment'],
+ 'WarnConfs' => [
+ 'title' => '',
+ 'description' => 'Alert configurations.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Amount' => [
- 'title' => '金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
+ 'Name' => ['title' => '', 'description' => 'Alert name. User-defined and optional. If not specified, the backend automatically generates a name.', 'type' => 'string', 'example' => 'Alter-1'],
+ 'Sequence' => ['title' => '', 'description' => 'Sequence number. Only present in responses. Alerts are numbered in ascending order of alert ID, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WarnTarget' => ['title' => '', 'description' => 'Alert target.', 'type' => 'string', 'example' => 'ACTUAL'],
+ 'ThresholdType' => ['title' => '', 'description' => 'Threshold type.', 'type' => 'string', 'example' => 'FIXED'],
+ 'ThresholdValue' => ['title' => '', 'description' => 'Threshold value.', 'type' => 'string', 'example' => '1000'],
+ 'MscContacts' => [
+ 'title' => '',
+ 'description' => 'Message center contact list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Contact ID.', 'type' => 'string', 'example' => '112100', 'title' => ''],
+ 'example' => '',
],
- 'Currency' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'USD',
+ 'MscChannels' => [
+ 'title' => '',
+ 'description' => 'Message center notification channel list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Notification channel.', 'type' => 'string', 'example' => 'EMAIL', 'title' => ''],
+ 'example' => '',
],
+ 'EventBridge' => ['title' => '', 'description' => 'Specifies whether to enable EventBridge.', 'type' => 'boolean', 'example' => ''],
+ 'Comment' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'example' => 'comment'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'CreditUser' => [
- 'title' => '是否开通信控',
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 'false',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'AccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.',
- ],
- [
- 'errorCode' => 'SubAccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- [
- 'errorCode' => 'InnerAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.',
- ],
- [
- 'errorCode' => 'InnerSubAccountNoQueryPricePermission',
- 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query Single Budget Details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"FundAccountOwnerAccountId\\": \\"1344312434\\",\\n \\"FundAccountStatus\\": \\"valid\\",\\n \\"FundAccountType\\": \\"REDIRECT_USER\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"50\\",\\n \\"NegativeBillAmount\\": \\"0\\",\\n \\"CreditAmount\\": \\"100\\",\\n \\"AvailableCreditAmount\\": \\"50\\",\\n \\"CreditRefundAmount\\": \\"0\\",\\n \\"UnclearedAmount\\": \\"50\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"20\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"30\\",\\n \\"BankAcceptanceAmount\\": \\"0\\",\\n \\"ExtendLedgerList\\": [\\n {\\n \\"Currency\\": \\"CNY\\",\\n \\"LedgerName\\": \\"应付对冲账本\\",\\n \\"OriginalAmount\\": \\"50\\"\\n }\\n ],\\n \\"QuotaAmount\\": \\"20\\",\\n \\"QuotaConsumedAmount\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalCashAmountList\\": [\\n {\\n \\"Amount\\": \\"10\\",\\n \\"Currency\\": \\"USD\\"\\n }\\n ],\\n \\"CreditUser\\": true\\n}","type":"json"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"A1B2C3D4-E5F6-7890-ABCD-EF1234567890\\",\\n \\"BudgetName\\": \\"department1\\",\\n \\"BudgetType\\": \\"CONSUME\\",\\n \\"Metric\\": \\"REQUIRE_AMOUNT\\",\\n \\"CycleType\\": \\"MONTHLY\\",\\n \\"CycleStartPeriod\\": \\"2025-10\\",\\n \\"CycleEndPeriod\\": \\"2026-12\\",\\n \\"QuotaType\\": \\"FIXED\\",\\n \\"Quota\\": \\"1000\\",\\n \\"CycleQuota\\": [\\n {\\n \\"CyclePeriod\\": \\"202601\\",\\n \\"Quota\\": \\"100\\"\\n }\\n ],\\n \\"QueryFilter\\": [\\n {\\n \\"Code\\": \\"RESOURCE_OWNER_ACCOUNT\\",\\n \\"SelectType\\": \\"IN\\",\\n \\"Values\\": [\\n \\"5772131917493334\\"\\n ]\\n }\\n ],\\n \\"EcIdAccountIdsFilter\\": {\\n \\"EcId\\": \\"E2024112210463400001\\",\\n \\"AccountIds\\": [\\n 5772131917494444\\n ]\\n },\\n \\"Comment\\": \\"comment\\",\\n \\"WarnConfs\\": [\\n {\\n \\"Name\\": \\"Alter-1\\",\\n \\"Sequence\\": 1,\\n \\"WarnTarget\\": \\"ACTUAL\\",\\n \\"ThresholdType\\": \\"FIXED\\",\\n \\"ThresholdValue\\": \\"1000\\",\\n \\"MscContacts\\": [\\n \\"112100\\"\\n ],\\n \\"MscChannels\\": [\\n \\"EMAIL\\"\\n ],\\n \\"EventBridge\\": false,\\n \\"Comment\\": \\"comment\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'GetFundAccountLowAvailableAmountAlarm' => [
- 'summary' => '查询资金账户低额预警',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeBudgets' => [
+ 'summary' => 'Query budget list',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2409,77 +2015,181 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'FundAccountId',
+ 'name' => 'PageNo',
'in' => 'formData',
- 'schema' => [
- 'title' => '资金账户id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12332112',
- ],
+ 'schema' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'BudgetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget name. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'department1'],
+ ],
+ [
+ 'name' => 'BudgetType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget type.', 'type' => 'string', 'required' => false, 'example' => 'CONSUME'],
+ ],
+ [
+ 'name' => 'ExpireStatus',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The expiration status.', 'type' => 'string', 'required' => false, 'example' => 'NOT_EXPIRED'],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If this parameter is left empty, the ID of the marketplace to which the current user belongs is used by default.', 'type' => 'string', 'required' => false, 'example' => '2688801000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<BalanceAlarmDTO>',
- 'description' => 'BssApiPlainResult<BalanceAlarmDTO>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
- 'ThresholdAmount' => [
- 'title' => '预警阈值',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'AlarmEnabled' => [
- 'title' => '是否开启预警',
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 'false',
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The data list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BudgetName' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'example' => 'department1-test'],
+ 'BudgetType' => ['title' => '', 'description' => 'The budget type.', 'type' => 'string', 'example' => 'CONSUME'],
+ 'Metric' => ['title' => '', 'description' => 'The budget metric.', 'type' => 'string', 'example' => 'REQUIRE_AMOUNT'],
+ 'CycleStartPeriod' => ['title' => '', 'description' => 'The start period.', 'type' => 'string', 'example' => '2025-10'],
+ 'CycleEndPeriod' => ['title' => '', 'description' => 'The end period.', 'type' => 'string', 'example' => '2026-12'],
+ 'CycleType' => ['title' => '', 'description' => 'The cycle type.', 'type' => 'string', 'example' => 'MONTHLY'],
+ 'ExpireStatus' => ['title' => '', 'description' => 'The expiration status.', 'type' => 'string', 'example' => 'NOT_EXPIRED'],
+ 'QueryFilter' => [
+ 'title' => '',
+ 'description' => 'The filter conditions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '', 'description' => 'The parameter code.', 'type' => 'string', 'example' => 'RESOURCE_OWNER_ACCOUNT'],
+ 'SelectType' => ['title' => '', 'description' => 'The selection mode.', 'type' => 'string', 'example' => 'IN'],
+ 'Values' => [
+ 'title' => '',
+ 'description' => 'The filter value list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The dimension value.', 'type' => 'string', 'example' => '5772131917493334', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'EcIdAccountIdsFilter' => [
+ 'title' => '',
+ 'description' => 'The enterprise multi-account filter conditions.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['description' => 'The enterprise entity ID.', 'type' => 'string', 'example' => 'E2024112210463400001', 'title' => ''],
+ 'AccountIds' => [
+ 'description' => 'The member account IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5772131917494444', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'QuotaType' => ['title' => '', 'description' => 'The quota type.', 'type' => 'string', 'example' => 'FIXED'],
+ 'Quota' => ['title' => '', 'description' => 'The fixed quota value.', 'type' => 'string', 'example' => '10000'],
+ 'CycleQuota' => [
+ 'title' => '',
+ 'description' => 'The specified quota per cycle.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CyclePeriod' => ['title' => '', 'description' => 'The cycle period.', 'type' => 'string', 'example' => '202601'],
+ 'Quota' => ['title' => '', 'description' => 'The quota.', 'type' => 'string', 'example' => '100'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'WarnConfs' => [
+ 'title' => '',
+ 'description' => 'The alert configurations.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '', 'description' => 'The alert name. This parameter is user-defined and optional. If not specified, the backend automatically generates a name.', 'type' => 'string', 'example' => 'Alert-1'],
+ 'Sequence' => ['title' => '', 'description' => 'The sort sequence number. This parameter is present only in responses. Alerts are numbered in ascending order by alert ID, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WarnTarget' => ['title' => '', 'description' => 'The alert target.', 'type' => 'string', 'example' => 'ACTUAL'],
+ 'ThresholdType' => ['title' => '', 'description' => 'The threshold type.', 'type' => 'string', 'example' => 'FIXED'],
+ 'ThresholdValue' => ['title' => '', 'description' => 'The threshold value.', 'type' => 'string', 'example' => '100'],
+ 'MscContacts' => [
+ 'title' => '',
+ 'description' => 'The list of message center contacts.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The contact.', 'type' => 'string', 'example' => '12210', 'title' => ''],
+ 'example' => '',
+ ],
+ 'MscChannels' => [
+ 'title' => '',
+ 'description' => 'The list of message center notification channels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The notification channel.', 'type' => 'string', 'example' => 'EMAIL', 'title' => ''],
+ 'example' => '',
+ ],
+ 'EventBridge' => ['title' => '', 'description' => 'Indicates whether EventBridge is enabled.', 'type' => 'boolean', 'example' => ''],
+ 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => 'comment1'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Comment' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => 'budget-1'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DB2A9097-289C-11CE-AA74-235FCFD39204', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query budget list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"ThresholdAmount\\": \\"100\\",\\n \\"AlarmEnabled\\": true\\n}","type":"json"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Data\\": [\\n {\\n \\"BudgetName\\": \\"department1-test\\",\\n \\"BudgetType\\": \\"CONSUME\\",\\n \\"Metric\\": \\"REQUIRE_AMOUNT\\",\\n \\"CycleStartPeriod\\": \\"2025-10\\",\\n \\"CycleEndPeriod\\": \\"2026-12\\",\\n \\"CycleType\\": \\"MONTHLY\\",\\n \\"ExpireStatus\\": \\"NOT_EXPIRED\\",\\n \\"QueryFilter\\": [\\n {\\n \\"Code\\": \\"RESOURCE_OWNER_ACCOUNT\\",\\n \\"SelectType\\": \\"IN\\",\\n \\"Values\\": [\\n \\"5772131917493334\\"\\n ]\\n }\\n ],\\n \\"EcIdAccountIdsFilter\\": {\\n \\"EcId\\": \\"E2024112210463400001\\",\\n \\"AccountIds\\": [\\n 5772131917494444\\n ]\\n },\\n \\"QuotaType\\": \\"FIXED\\",\\n \\"Quota\\": \\"10000\\",\\n \\"CycleQuota\\": [\\n {\\n \\"CyclePeriod\\": \\"202601\\",\\n \\"Quota\\": \\"100\\"\\n }\\n ],\\n \\"WarnConfs\\": [\\n {\\n \\"Name\\": \\"Alert-1\\",\\n \\"Sequence\\": 1,\\n \\"WarnTarget\\": \\"ACTUAL\\",\\n \\"ThresholdType\\": \\"FIXED\\",\\n \\"ThresholdValue\\": \\"100\\",\\n \\"MscContacts\\": [\\n \\"12210\\"\\n ],\\n \\"MscChannels\\": [\\n \\"EMAIL\\"\\n ],\\n \\"EventBridge\\": false,\\n \\"Comment\\": \\"comment1\\"\\n }\\n ],\\n \\"Comment\\": \\"budget-1\\"\\n }\\n ],\\n \\"RequestId\\": \\"DB2A9097-289C-11CE-AA74-235FCFD39204\\"\\n}","type":"json"}]',
],
- 'ListFundAccount' => [
- 'summary' => '查询资金账户列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeCoupon' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2487,254 +2197,364 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'QueryOnlyManage',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '只查询管理的账户列表,默认false',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
- ],
+ 'name' => 'EffectiveStartTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The effective start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1684750028000'],
],
[
- 'name' => 'QueryOnlyInUse',
- 'in' => 'formData',
+ 'name' => 'EffectiveEndTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The effective end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1708423156000'],
+ ],
+ [
+ 'name' => 'ExpireStartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The expiration start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1684750028000'],
+ ],
+ [
+ 'name' => 'ExpireEndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The expiration end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1708423156000'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'AVAILABLE'],
+ ],
+ [
+ 'name' => 'CouponType',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The coupon type.', 'type' => 'string', 'required' => false, 'example' => 'CERTAIN'],
+ ],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary campaign information.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ [
+ 'name' => 'CouponId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The coupon ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '351430260343'],
+ ],
+ [
+ 'name' => 'CouponNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '554863270150'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '只查询在用的账户列表,默认为false',
- 'description' => '',
- 'type' => 'boolean',
+ 'title' => '',
+ 'description' => 'The enterprise and account list. If this parameter is left empty, the current account is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1501603440974415'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accessed accounts. If this parameter is left empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1501603440974415', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'default' => 'false',
+ 'example' => '',
],
],
[
- 'name' => 'Nbid',
+ 'name' => 'MaxResults',
'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'CouponTemplateIdList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2084210001',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'IncludeShare',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<BillingAccount>',
- 'description' => 'BssApiListResult<BillingAccount>',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<CouponVO>',
'type' => 'object',
'properties' => [
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的账号accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '132123211',
- ],
- 'FundAccountType' => [
- 'title' => '账户类型'."\n"
- .'DIRECT_USER-阿里云直客账户; '."\n"
- .'RESELLER_QUOTA-生态账户',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DIRECT_USER',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1022231',
+ 'CouponId' => ['title' => '', 'description' => 'The coupon ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59243658'],
+ 'CouponNo' => ['title' => '', 'description' => 'The coupon code.', 'type' => 'string', 'example' => '731074910070'],
+ 'CouponType' => ['title' => '', 'description' => 'The coupon type.', 'type' => 'string', 'example' => 'CERTAIN'],
+ 'CouponTypeName' => ['title' => '', 'description' => 'The coupon type name.', 'type' => 'string', 'example' => '满减券'],
+ 'Amount' => ['title' => '', 'description' => 'The face value.', 'type' => 'string', 'example' => '9929.750000'],
+ 'RemainAmount' => ['title' => '', 'description' => 'The remaining amount.', 'type' => 'string', 'example' => '100.00'],
+ 'ItemNames' => [
+ 'title' => '',
+ 'description' => 'The product code list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The applicable product name.', 'type' => 'string', 'example' => '全产品适用', 'title' => ''],
+ 'example' => '',
],
- 'FundAccountName' => [
- 'title' => '账户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的账户',
+ 'UniversalType' => ['title' => '', 'description' => 'The coupon applicable scope.', 'type' => 'string', 'example' => 'UNIVERSAL'],
+ 'YhOrderTypes' => [
+ 'title' => '',
+ 'description' => 'The list of order types applicable to the coupon.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The applicable order type.', 'type' => 'string', 'example' => '新购', 'title' => ''],
+ 'example' => '',
],
- 'Permissions' => [
- 'title' => '用户拥有的账户权限集合'."\n"
- .'using - 使用;'."\n"
- .'manage - 管理;'."\n"
- .'owner - 拥有;',
- 'description' => '',
+ 'Status' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'Available'],
+ 'GmtCreate' => ['description' => 'The coupon issuance time.', 'type' => 'string', 'example' => '2021-03-02T15:12Z'."\n", 'title' => ''],
+ 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2021-03-02T15:12Z'],
+ 'EndTime' => ['title' => '', 'description' => 'The end time.', 'type' => 'string', 'example' => '2021-03-06T15:12Z'],
+ 'Site' => ['title' => '', 'description' => 'The site.', 'type' => 'string', 'example' => 'CHINA'],
+ 'SiteName' => ['title' => '', 'description' => 'The site name.', 'type' => 'string', 'example' => '官网自营'],
+ 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'example' => '新买28号'],
+ 'MoneyLimit' => ['title' => '', 'description' => 'The amount limit.', 'type' => 'string', 'example' => '无订单金额限制'],
+ 'Currency' => ['title' => '', 'description' => 'The currency.', 'type' => 'string', 'example' => 'CNY'],
+ 'SuitAccount' => ['title' => '', 'description' => 'The applicable account.', 'type' => 'string', 'example' => '1902671110151254'],
+ 'OrderTimeRule' => ['title' => '', 'description' => 'The order duration limit rule.', 'type' => 'string', 'example' => '预付费规则:购买订单时长大于3600s才能使用'],
+ 'ShareUidList' => [
+ 'title' => '',
+ 'description' => 'The shared account list.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Uid' => ['title' => '', 'description' => 'The Alibaba Cloud UID.', 'type' => 'string', 'example' => '1902671110151254'],
+ 'UserNick' => ['title' => '', 'description' => 'The Alibaba Cloud account.', 'type' => 'string', 'example' => '阿里云计算有限公司'],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'owner',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Nbid' => [
- 'title' => '一级售卖场',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2684210001',
- ],
- 'FundAccountAdminAccountName' => [
- 'title' => '账户对应的MA用户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的账户',
- ],
- 'CreateDate' => [
- 'title' => '账户创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-12-30 12:00:00',
- ],
- 'FundAccountAdminAccountId' => [
- 'title' => '账户对应的MA用户accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1232121',
- ],
- 'FundAccountStatus' => [
- 'title' => '账户状态'."\n"
- .'VALID-有效;'."\n"
- .'FROZEN-冻结; '."\n"
- .'CLOSED-注销',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'VALID',
- ],
+ 'SuitItemType' => ['title' => '', 'description' => 'The applicable product type. Valid values: all, which indicates that the coupon is applicable to all products. white, which indicates that the coupon is applicable to specified products. black, which indicates that the coupon is not applicable to specified products.', 'type' => 'string', 'example' => 'all'],
+ 'ShowSetDeductTagButton' => ['description' => 'Indicates whether to display the tag deduction button.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'CertainAmount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'FirstBuy' => ['title' => '', 'description' => 'Indicates whether there is a first purchase restriction.', 'type' => 'boolean', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'AccountNotExist',
- 'errorMessage' => 'Account does not exist.',
- ],
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'SubAccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', '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.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"FundAccountOwnerAccountId\\": \\"132123211\\",\\n \\"FundAccountType\\": \\"DIRECT_USER\\",\\n \\"FundAccountId\\": \\"1022231\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"Permissions\\": [\\n \\"owner\\"\\n ],\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountAdminAccountName\\": \\"云某的账户\\",\\n \\"CreateDate\\": \\"2024-12-30 12:00:00\\",\\n \\"FundAccountAdminAccountId\\": \\"1232121\\",\\n \\"FundAccountStatus\\": \\"VALID\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
- ],
- 'CancelFundAccountLowAvailableAmountAlarm' => [
- 'summary' => '取消资金账户低额预警',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query coupon list',
+ 'summary' => 'Queries a list of coupons.',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-14T06:14:53.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-04-24T07:53:40.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCoupon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Data\\": [\\n {\\n \\"CouponId\\": 59243658,\\n \\"CouponNo\\": \\"731074910070\\",\\n \\"CouponType\\": \\"CERTAIN\\",\\n \\"CouponTypeName\\": \\"满减券\\",\\n \\"Amount\\": \\"9929.750000\\",\\n \\"RemainAmount\\": \\"100.00\\",\\n \\"ItemNames\\": [\\n \\"全产品适用\\"\\n ],\\n \\"UniversalType\\": \\"UNIVERSAL\\",\\n \\"YhOrderTypes\\": [\\n \\"新购\\"\\n ],\\n \\"Status\\": \\"Available\\",\\n \\"GmtCreate\\": \\"2021-03-02T15:12Z\\\\n\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"Site\\": \\"CHINA\\",\\n \\"SiteName\\": \\"官网自营\\",\\n \\"Remark\\": \\"新买28号\\",\\n \\"MoneyLimit\\": \\"无订单金额限制\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SuitAccount\\": \\"1902671110151254\\",\\n \\"OrderTimeRule\\": \\"预付费规则:购买订单时长大于3600s才能使用\\",\\n \\"ShareUidList\\": [\\n {\\n \\"Uid\\": \\"1902671110151254\\",\\n \\"UserNick\\": \\"阿里云计算有限公司\\"\\n }\\n ],\\n \\"SuitItemType\\": \\"all\\",\\n \\"ShowSetDeductTagButton\\": true,\\n \\"CertainAmount\\": \\"\\",\\n \\"FirstBuy\\": false\\n }\\n ],\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeCouponItemList' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FundAccountId',
- 'in' => 'formData',
+ 'name' => 'CouponId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The coupon ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '59104570'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The product name. Fuzzy matching is supported.', 'type' => 'string', 'required' => false, 'example' => '云服务器ECS'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '资金账户id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The list of enterprise entities and accounts. If this parameter is left empty, the current account is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If this parameter is left empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1004064243473974', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '123321123',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The level-1 sales channel ID. If this parameter is left empty, the channel ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Boolean>',
- 'description' => 'BssApiPlainResult<Boolean>',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<ItemNameVO>',
'type' => 'object',
'properties' => [
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DFC1F7F9-3BA9-BA4D-2F2E653',
+ 'title' => '',
+ 'description' => 'The data list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'vm'],
+ 'Name' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '云服务器ECS'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query the list of products available for a coupon',
+ 'summary' => 'Queries the list of products available for a coupon.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCouponItemList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DFC1F7F9-3BA9-BA4D-2F2E653\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"vm\\",\\n \\"Name\\": \\"云服务器ECS\\"\\n }\\n ],\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\"\\n}","type":"json"}]',
],
- 'GetFundAccountCanAllocateCreditAmount' => [
- 'summary' => '查询资金账户可分配信控额度',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DescribeDeductLogs' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2742,137 +2562,269 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FundAccountId',
+ 'name' => 'Group',
'in' => 'formData',
'schema' => [
- 'title' => '资金账户id,不设置时默认使用当前账号拥有(owner)的账户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The resource dimension for the query.',
+ 'enumValueTitles' => ['oss_arc' => 'OSS region-independent reserved storage.', 'cu' => 'storage capacity unit (SCU)', 'ecsRi' => 'reserved instance.', 'oss_rc' => 'OSS reserved storage.', 'fr' => 'resource plan.', 'polardb' => 'PolarDB compute package.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'oss_rc',
+ ],
+ ],
+ [
+ 'name' => 'BillingStartTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The billing start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1647446400000'],
+ ],
+ [
+ 'name' => 'BillingEndTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The billing end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1679068799999'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'OSSBAG-cn******'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '50', 'example' => '20'],
+ ],
+ [
+ 'name' => 'BillingCommodityCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The commodity code of the deducted item.', 'type' => 'string', 'required' => false, 'example' => 'snapshot'],
+ ],
+ [
+ 'name' => 'CommodityCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'required' => false, 'example' => 'ossbag'],
+ ],
+ [
+ 'name' => 'RelationAccountIds',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The list of deduction accounts.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The deduction account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[]', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The enterprise and account list. If this parameter is empty, the current account is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The enterprise and account list. If this parameter is empty, the current account is queried.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If this parameter is empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The member accounts ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1990699401005016', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '1233231',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If this parameter is empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ [
+ 'name' => 'BillInstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance ID for billing deduction.', 'type' => 'string', 'required' => false, 'example' => 'ecs-******', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<UserCreditLimitResponse>',
- 'description' => 'BssApiPlainResult<UserCreditLimitResponse>',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<InstanceDeductResponse>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655',
- ],
- 'Ecid' => [
- 'title' => '企业实体id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2032123221',
- ],
- 'EcidCreditAmount' => [
- 'title' => '企业信控配额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'EcidAllocatedCreditAmount' => [
- 'title' => '企业已分配信控额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '300',
- ],
- 'MaxCanAllocateCreditAmount' => [
- 'title' => '当前账户最大可分配信控额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1500',
- ],
- 'MinCanAllocateCreditAmount' => [
- 'title' => '当前账户最小可分配信控额度',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'Nbid' => [
- 'title' => '一级售卖场',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2684210001',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12332112',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的阿里云accountId',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123433121',
- ],
- 'FundAccountName' => [
- 'title' => '账户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的名称',
- ],
- 'FundAccountEcid' => [
- 'title' => '账户ecid',
- 'description' => '',
- 'type' => 'string',
- 'example' => '202321232',
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The data list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1929817951466001'],
+ 'InstanceId' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'OSSBAG-cn-****s'],
+ 'CapacityType' => [
+ 'title' => '',
+ 'description' => 'The capacity type.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'absolute', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '总量恒定型', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'CapacityTypeCode' => ['title' => '', 'description' => 'The capacity type code.', 'type' => 'string', 'example' => 'absolute'],
+ 'CapacityTypeName' => ['title' => '', 'description' => 'The capacity type name.', 'type' => 'string', 'example' => '总量恒定型'],
+ 'CycleType' => [
+ 'title' => '',
+ 'description' => 'The commitment cycle.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The commitment cycle code.', 'type' => 'string', 'example' => 'hour', 'title' => ''],
+ 'Name' => ['description' => 'The commitment cycle name.', 'type' => 'string', 'example' => '小时', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'CycleTypeCode' => ['title' => '', 'description' => 'The commitment cycle code.', 'type' => 'string', 'example' => 'hour'],
+ 'CycleTypeName' => ['title' => '', 'description' => 'The commitment cycle name.', 'type' => 'string', 'example' => '小时'],
+ 'CapacityBeforeDeductViewValue' => ['title' => '', 'description' => 'The display value of the capacity before deduction.', 'type' => 'string', 'example' => '40.000000'],
+ 'CapacityBeforeDeductViewUnit' => ['title' => '', 'description' => 'The display unit of the capacity before deduction.', 'type' => 'string', 'example' => 'GB'],
+ 'CapacityDeductedViewValue' => ['title' => '', 'description' => 'The display value of the deducted capacity.', 'type' => 'string', 'example' => '16.103515'],
+ 'CapacityDeductedViewUnit' => ['title' => '', 'description' => 'The display unit of the deducted capacity.', 'type' => 'string', 'example' => 'GB'],
+ 'CapacityAfterDeductViewValue' => ['title' => '', 'description' => 'The display value of the capacity after deduction.', 'type' => 'string', 'example' => '23.896484'],
+ 'CapacityAfterDeductViewUnit' => ['title' => '', 'description' => 'The display unit of the capacity after deduction.', 'type' => 'string', 'example' => 'GB'],
+ 'DeductTime' => ['title' => '', 'description' => 'The deduction time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1679039572000'],
+ 'Commodity' => [
+ 'title' => '',
+ 'description' => 'The commodity.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'ossbag', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '对象存储OSS资源包(包月)', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'CommodityCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'ossbag'],
+ 'CommodityName' => ['title' => '', 'description' => 'The commodity name.', 'type' => 'string', 'example' => '对象存储OSS资源包(包月)'],
+ 'Product' => [
+ 'title' => '',
+ 'description' => 'The product.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'oss', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '对象存储', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'oss'],
+ 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '对象存储'],
+ 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => 'icloudtest'],
+ 'RelationAccountId' => ['title' => '', 'description' => 'The deduction account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'RelationAccountName' => ['title' => '', 'description' => 'The deduction account name.', 'type' => 'string', 'example' => 'icloudtest'],
+ 'BillingCommodity' => [
+ 'title' => '',
+ 'description' => 'The deducted commodity.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'snapshot', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '云服务器ECS-快照', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'BillingCommodityCode' => ['title' => '', 'description' => 'The deducted commodity code.', 'type' => 'string', 'example' => 'snapshot'],
+ 'BillingCommodityName' => ['title' => '', 'description' => 'The deducted commodity name.', 'type' => 'string', 'example' => '云服务器ECS-快照'],
+ 'BillingInstanceId' => ['title' => '', 'description' => 'The deduction instance.', 'type' => 'string', 'example' => 'cn-beijing'],
+ 'BillingStartTime' => ['title' => '', 'description' => 'The effective period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1679032800000'],
+ 'BillingEndTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1679036400000'],
+ 'MeasureBeforeDeductViewValue' => ['title' => '', 'description' => 'The display value of the metering amount before deduction.', 'type' => 'string', 'example' => '16.103515'],
+ 'MeasureBeforeDeductViewUnit' => ['title' => '', 'description' => 'The display unit of the metering amount before deduction.', 'type' => 'string', 'example' => 'GB'],
+ 'MeasureAfterDeductViewValue' => ['title' => '', 'description' => 'The display value of the metering amount after deduction.', 'type' => 'string', 'example' => '0'],
+ 'MeasureAfterDeductViewUnit' => ['title' => '', 'description' => 'The display unit of the metering amount after deduction.', 'type' => 'string', 'example' => 'Byte'],
+ 'MeasureDeductedViewValue' => ['title' => '', 'description' => 'The display value of the deducted metering amount.', 'type' => 'string', 'example' => '16.103515'],
+ 'MeasureDeductedViewUnit' => ['title' => '', 'description' => 'The display unit of the deducted metering amount.', 'type' => 'string', 'example' => 'GB'],
+ 'Template' => [
+ 'title' => '',
+ 'description' => 'The template.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'FPT_ossbag********', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '标准存储包', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'TemplateCode' => ['title' => '', 'description' => 'The template code.', 'type' => 'string', 'example' => 'FPT_ossbag********'],
+ 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '标准存储包'."\n"],
+ 'Factor' => ['title' => '', 'description' => 'The deduction factor.', 'type' => 'string', 'example' => '1'],
+ 'BillingPriceField' => [
+ 'title' => '',
+ 'description' => 'The deduction billable item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'Storage', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '零折使用容量', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'BillingPriceFieldCode' => ['title' => '', 'description' => 'The deduction billable item code.', 'type' => 'string', 'example' => 'Storage'],
+ 'BillingPriceFieldName' => ['title' => '', 'description' => 'The deduction billable item name.', 'type' => 'string', 'example' => '零折使用容量'],
+ 'InstanceBelongAccountId' => ['title' => '', 'description' => 'The ID of the account to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'InstanceBelongAccountName' => ['title' => '', 'description' => 'The name of the account to which the instance belongs.', 'type' => 'string', 'example' => 'icloudtest'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'You are not authorized to call the API operation. Please check whether RAM user has the permission or check whether ownerId and callerId have been given the appropriate permission.', 'description' => ''],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"CC706AAC-75A6-55B5-9AB7-7D171C6C7655\\",\\n \\"Ecid\\": \\"2032123221\\",\\n \\"EcidCreditAmount\\": \\"1000\\",\\n \\"EcidAllocatedCreditAmount\\": \\"300\\",\\n \\"MaxCanAllocateCreditAmount\\": \\"1500\\",\\n \\"MinCanAllocateCreditAmount\\": \\"200\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 123433121,\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"FundAccountEcid\\": \\"202321232\\"\\n}","type":"json"}]',
- ],
- 'ListFundAccountPayRelation' => [
- 'summary' => '查询资金账户的付款关系',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query resource plan deduction records',
+ 'summary' => 'Queries resource plan deduction records.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 8,\\n \\"Data\\": [\\n {\\n \\"AccountId\\": 1929817951466001,\\n \\"InstanceId\\": \\"OSSBAG-cn-****s\\",\\n \\"CapacityType\\": {\\n \\"Code\\": \\"absolute\\",\\n \\"Name\\": \\"总量恒定型\\"\\n },\\n \\"CapacityTypeCode\\": \\"absolute\\",\\n \\"CapacityTypeName\\": \\"总量恒定型\\",\\n \\"CycleType\\": {\\n \\"Code\\": \\"hour\\",\\n \\"Name\\": \\"小时\\"\\n },\\n \\"CycleTypeCode\\": \\"hour\\",\\n \\"CycleTypeName\\": \\"小时\\",\\n \\"CapacityBeforeDeductViewValue\\": \\"40.000000\\",\\n \\"CapacityBeforeDeductViewUnit\\": \\"GB\\",\\n \\"CapacityDeductedViewValue\\": \\"16.103515\\",\\n \\"CapacityDeductedViewUnit\\": \\"GB\\",\\n \\"CapacityAfterDeductViewValue\\": \\"23.896484\\",\\n \\"CapacityAfterDeductViewUnit\\": \\"GB\\",\\n \\"DeductTime\\": 1679039572000,\\n \\"Commodity\\": {\\n \\"Code\\": \\"ossbag\\",\\n \\"Name\\": \\"对象存储OSS资源包(包月)\\"\\n },\\n \\"CommodityCode\\": \\"ossbag\\",\\n \\"CommodityName\\": \\"对象存储OSS资源包(包月)\\",\\n \\"Product\\": {\\n \\"Code\\": \\"oss\\",\\n \\"Name\\": \\"对象存储\\"\\n },\\n \\"ProductCode\\": \\"oss\\",\\n \\"ProductName\\": \\"对象存储\\",\\n \\"AccountName\\": \\"icloudtest\\",\\n \\"RelationAccountId\\": 1990699401005016,\\n \\"RelationAccountName\\": \\"icloudtest\\",\\n \\"BillingCommodity\\": {\\n \\"Code\\": \\"snapshot\\",\\n \\"Name\\": \\"云服务器ECS-快照\\"\\n },\\n \\"BillingCommodityCode\\": \\"snapshot\\",\\n \\"BillingCommodityName\\": \\"云服务器ECS-快照\\",\\n \\"BillingInstanceId\\": \\"cn-beijing\\",\\n \\"BillingStartTime\\": 1679032800000,\\n \\"BillingEndTime\\": 1679036400000,\\n \\"MeasureBeforeDeductViewValue\\": \\"16.103515\\",\\n \\"MeasureBeforeDeductViewUnit\\": \\"GB\\",\\n \\"MeasureAfterDeductViewValue\\": \\"0\\",\\n \\"MeasureAfterDeductViewUnit\\": \\"Byte\\",\\n \\"MeasureDeductedViewValue\\": \\"16.103515\\",\\n \\"MeasureDeductedViewUnit\\": \\"GB\\",\\n \\"Template\\": {\\n \\"Code\\": \\"FPT_ossbag********\\",\\n \\"Name\\": \\"标准存储包\\"\\n },\\n \\"TemplateCode\\": \\"FPT_ossbag********\\",\\n \\"TemplateName\\": \\"标准存储包\\\\n\\",\\n \\"Factor\\": \\"1\\",\\n \\"BillingPriceField\\": {\\n \\"Code\\": \\"Storage\\",\\n \\"Name\\": \\"零折使用容量\\"\\n },\\n \\"BillingPriceFieldCode\\": \\"Storage\\",\\n \\"BillingPriceFieldName\\": \\"零折使用容量\\",\\n \\"InstanceBelongAccountId\\": 1990699401005016,\\n \\"InstanceBelongAccountName\\": \\"icloudtest\\"\\n }\\n ],\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeFrInstances' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2880,250 +2832,516 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FundAccountId',
+ 'name' => 'Group',
'in' => 'formData',
'schema' => [
- 'title' => '资金账户Id',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The resource dimension to query.',
+ 'enumValueTitles' => ['oss_arc' => 'OSS region-independent reserved capacity.', 'ecsRi' => 'reserved instance.', 'cu' => 'storage capacity unit (SCU)', 'oss_rc' => 'OSS reserved capacity.', 'fr' => 'resource plan.', 'polardb' => 'PolarDB computing package.'],
'type' => 'string',
- 'required' => true,
- 'example' => '12323123',
+ 'required' => false,
+ 'example' => 'cu',
],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'title' => '关系状态'."\n"
- .'valid - 有效'."\n"
- .'expired - 无效',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The resource status.',
+ 'enumValueTitles' => ['valid' => 'valid.', 'invalid' => 'invalid.', 'exhaust' => 'exhausted.'],
'type' => 'string',
'required' => false,
'example' => 'valid',
],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
+ 'name' => 'PageNum',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '50', 'example' => '20'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1678939035000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710604800000'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'alb_cubag*******'],
+ ],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'slb'],
+ ],
+ [
+ 'name' => 'CommodityCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'required' => false, 'example' => 'slb_albcubag_dp_cn'],
+ ],
+ [
+ 'name' => 'TemplateCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The template code.', 'type' => 'string', 'required' => false, 'example' => 'slb_albcubag*******'],
+ ],
+ [
+ 'name' => 'Spec',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The specification.', 'type' => 'string', 'required' => false, 'example' => '*'],
+ ],
+ [
+ 'name' => 'CapacityType',
+ 'in' => 'formData',
'schema' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The capacity type.',
+ 'enumValueTitles' => ['periodMonthlyShift' => 'dynamic monthly cycle.', 'deadlineAcc' => 'total decremental.', 'absolute' => 'total constant.', 'periodMonthlyAcc' => 'natural monthly cycle.'],
+ 'type' => 'string',
'required' => false,
- 'example' => '1',
- 'default' => '1',
+ 'example' => 'deadlineAcc',
],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
+ 'name' => 'CycleType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The cycle type.', 'type' => 'string', 'required' => false, 'example' => 'dynamicMonth', 'title' => ''],
+ ],
+ [
+ 'name' => 'SortField',
+ 'in' => 'formData',
'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The sort field.',
+ 'enumValueTitles' => ['startTime' => 'start time.', 'endTime' => 'end time.'],
+ 'type' => 'string',
'required' => false,
- 'example' => '20',
- 'default' => '20',
+ 'example' => 'startTime',
],
],
[
- 'name' => 'Nbid',
- 'in' => 'query',
+ 'name' => 'SortRule',
+ 'in' => 'formData',
'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The sorting rule.',
+ 'enumValueTitles' => ['asc' => 'ascending.', 'desc' => 'descending.'],
'type' => 'string',
'required' => false,
- 'example' => '2684201000001',
+ 'example' => 'asc',
+ ],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The enterprise and account list. If this parameter is empty, the current account is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The enterprise and account list. If this parameter is empty, the current account is queried.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If this parameter is empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of a member account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1990699401005016', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If this parameter is empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684202000018'],
+ ],
+ [
+ 'name' => 'InstanceTag',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The instance label value of the resource plan.', 'type' => 'string', 'required' => false, 'example' => 'FR-***', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<BillingAccountPayRelation>',
- 'description' => 'BssApiPageResult<BillingAccountPayRelation>',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<InstanceOverviewResponse>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- 'default' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '123231213',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的阿里云accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '312328912',
- ],
- 'AccountId' => [
- 'title' => '付款关系关联的用户accountId,即使用该账户付款的账号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '32812132121',
- ],
- 'AccountName' => [
- 'title' => '用户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的名称',
- ],
- 'EffectiveTime' => [
- 'title' => '付款关系生效时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-12-01 12:00:10',
+ 'AccountId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'Product' => [
+ 'title' => '',
+ 'description' => 'The product.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'slb', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '负载均衡', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'IneffectiveTime' => [
- 'title' => '付款关系失效时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-01-01 12:12:12',
+ 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '性能测试'],
+ 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'pts'],
+ 'Commodity' => [
+ 'title' => '',
+ 'description' => 'The commodity.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'slb_albcubag_dp_cn', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'ALB资源包', 'title' => ''],
+ ],
+ 'example' => '',
],
+ 'CommodityCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'pts'],
+ 'CommodityName' => ['title' => '', 'description' => 'The commodity name.', 'type' => 'string', 'example' => '性能测试'],
+ 'InstanceId' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'alb_cubag*******'],
+ 'Spec' => ['title' => '', 'description' => 'The specification.', 'type' => 'string', 'example' => '*'],
'Status' => [
- 'title' => '关系状态'."\n"
- .'valid - 有效;'."\n"
- .'expired - 无效',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'valid',
- ],
- 'RelationType' => [
- 'title' => '关系类型,收款关系/付款关系',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PAYMENT',
- ],
- 'OperatorType' => [
- 'title' => '授权操作人类型'."\n"
- .'aliyun_pk - 用户;'."\n"
- .'system - 阿里云系统;',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyun_pk',
- ],
- 'OperatorNo' => [
- 'title' => '授权操作人'."\n"
- .'操作人类型为aliyun_pk时,operatorNo为阿里云accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1232343423',
+ 'title' => '',
+ 'description' => 'The resource status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'valid', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '有效', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'OperatorName' => [
- 'title' => '操作人名称'."\n"
- .'操作人类型为aliyun_pk时, 操作人名称为阿里云昵称'."\n"
- .'操作人类型为system时, 操作人名称为"阿里云小二"',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的名称',
+ 'StatusCode' => ['title' => '', 'description' => 'The resource status code.', 'type' => 'string', 'example' => 'valid'],
+ 'StatusName' => ['title' => '', 'description' => 'The resource status name.', 'type' => 'string', 'example' => '有效'],
+ 'CapacityType' => [
+ 'title' => '',
+ 'description' => 'The capacity type.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'deadlineAcc', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '总量递减型', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
+ 'CapacityTypeCode' => ['title' => '', 'description' => 'The capacity type code.', 'type' => 'string', 'example' => 'deadlineAcc'],
+ 'CapacitiyTypeName' => ['title' => '', 'description' => 'The capacity type name.', 'type' => 'string', 'example' => '总量递减型'],
+ 'CycleType' => [
+ 'title' => '',
+ 'description' => 'The commitment cycle.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The commitment cycle code.', 'type' => 'string', 'example' => 'hour', 'title' => ''],
+ 'Name' => ['description' => 'The commitment cycle name.', 'type' => 'string', 'example' => '小时', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'Nbid' => [
- 'title' => '一级售卖场',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2684210001',
+ 'CycleTypeCode' => ['description' => 'The commitment cycle code.', 'type' => 'string', 'example' => 'hour', 'title' => ''],
+ 'CycleTypeName' => ['title' => '', 'description' => 'The commitment cycle name.', 'type' => 'string', 'example' => '小时'],
+ 'InitCapacityViewValue' => ['title' => '', 'description' => 'The initial capacity display value.', 'type' => 'string', 'example' => '1000.000000'],
+ 'InitCapacityViewUnit' => ['title' => '', 'description' => 'The initial capacity display unit.', 'type' => 'string', 'example' => 'CU'],
+ 'CurrCapacityViewValue' => ['title' => '', 'description' => 'The current capacity display value.', 'type' => 'string', 'example' => '1000.000000'],
+ 'CurrCapacityViewUnit' => ['title' => '', 'description' => 'The current capacity display unit.', 'type' => 'string', 'example' => 'CU'],
+ 'PeriodCapacityViewValue' => ['title' => '', 'description' => 'The period capacity display value.', 'type' => 'string', 'example' => '1000.000000'],
+ 'PeriodCapacityViewUnit' => ['title' => '', 'description' => 'The period capacity display unit.', 'type' => 'string', 'example' => 'CU'],
+ 'PeriodTime' => ['title' => '', 'description' => 'The period time.', 'type' => 'string', 'example' => 'hour'],
+ 'PurchaseTime' => ['title' => '', 'description' => 'The purchase time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678939036000'],
+ 'StartTime' => ['title' => '', 'description' => 'The effective period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678939035000'],
+ 'EndTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710604800000'],
+ 'Region' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => '*'],
+ 'Template' => [
+ 'title' => '',
+ 'description' => 'The template.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The property code.', 'type' => 'string', 'example' => 'alb_cubag*******', 'title' => ''],
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => '中国内地区域', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'Ecid' => [
- 'title' => '付款关系关联的用户的企业实体id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '213231232',
+ 'TemplateCode' => ['title' => '', 'description' => 'The template code.', 'type' => 'string', 'example' => 'FPT_armsappbag_deadlineAcc_bj'],
+ 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'new_test'],
+ 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => 'icloudtest'],
+ 'EnableRenew' => ['title' => '', 'description' => 'Indicates whether the resource plan can be renewed.', 'type' => 'boolean', 'example' => 'false'],
+ 'EnableUpgrade' => ['title' => '', 'description' => 'Indicates whether the resource plan can be upgraded.', 'type' => 'boolean', 'example' => 'false'],
+ 'EnableExchange' => ['title' => '', 'description' => 'Indicates whether the resource plan can be exchanged.', 'type' => 'boolean', 'example' => 'false'],
+ 'ExchangeCommodityCode' => ['title' => '', 'description' => 'The commodity code for exchange.', 'type' => 'string', 'example' => 'null'],
+ 'RegionName' => ['description' => 'The region name.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''],
+ 'DeductRegions' => [
+ 'description' => 'The list of deductible regions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The deductible region.', 'type' => 'string', 'example' => '北京', 'title' => ''],
+ 'Code' => ['description' => 'The deductible region code.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'InitCapacityBaseValue' => ['description' => 'The initial capacity baseline value.', 'type' => 'string', 'example' => '1000.000000', 'title' => ''],
+ 'InitCapacityBaseUnit' => ['description' => 'The initial capacity baseline unit.', 'type' => 'string', 'example' => 'CU', 'title' => ''],
+ 'CurrCapacityBaseValue' => ['description' => 'The current capacity baseline value.', 'type' => 'string', 'example' => '1000.000000', 'title' => ''],
+ 'CurrCapacityBaseUnit' => ['description' => 'The current capacity baseline unit.', 'type' => 'string', 'example' => 'CU', 'title' => ''],
+ 'periodCapacityBaseValue' => ['description' => 'The period capacity baseline value.', 'type' => 'string', 'example' => '1000.000000', 'title' => ''],
+ 'periodCapacityBaseUnit' => ['description' => 'The period capacity baseline unit.', 'type' => 'string', 'example' => 'CU', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''],
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'You are not authorized to call the API operation. Please check whether RAM user has the permission or check whether ownerId and callerId have been given the appropriate permission.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query resource plan instances',
+ 'summary' => 'Queries resource plan instances.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"Data\\": [\\n {\\n \\"AccountId\\": 1990699401005016,\\n \\"Product\\": {\\n \\"Code\\": \\"slb\\",\\n \\"Name\\": \\"负载均衡\\"\\n },\\n \\"ProductName\\": \\"性能测试\\",\\n \\"ProductCode\\": \\"pts\\",\\n \\"Commodity\\": {\\n \\"Code\\": \\"slb_albcubag_dp_cn\\",\\n \\"Name\\": \\"ALB资源包\\"\\n },\\n \\"CommodityCode\\": \\"pts\\",\\n \\"CommodityName\\": \\"性能测试\\",\\n \\"InstanceId\\": \\"alb_cubag*******\\",\\n \\"Spec\\": \\"*\\",\\n \\"Status\\": {\\n \\"Code\\": \\"valid\\",\\n \\"Name\\": \\"有效\\"\\n },\\n \\"StatusCode\\": \\"valid\\",\\n \\"StatusName\\": \\"有效\\",\\n \\"CapacityType\\": {\\n \\"Code\\": \\"deadlineAcc\\",\\n \\"Name\\": \\"总量递减型\\"\\n },\\n \\"CapacityTypeCode\\": \\"deadlineAcc\\",\\n \\"CapacitiyTypeName\\": \\"总量递减型\\",\\n \\"CycleType\\": {\\n \\"Code\\": \\"hour\\",\\n \\"Name\\": \\"小时\\"\\n },\\n \\"CycleTypeCode\\": \\"hour\\",\\n \\"CycleTypeName\\": \\"小时\\",\\n \\"InitCapacityViewValue\\": \\"1000.000000\\",\\n \\"InitCapacityViewUnit\\": \\"CU\\",\\n \\"CurrCapacityViewValue\\": \\"1000.000000\\",\\n \\"CurrCapacityViewUnit\\": \\"CU\\",\\n \\"PeriodCapacityViewValue\\": \\"1000.000000\\",\\n \\"PeriodCapacityViewUnit\\": \\"CU\\",\\n \\"PeriodTime\\": \\"hour\\",\\n \\"PurchaseTime\\": 1678939036000,\\n \\"StartTime\\": 1678939035000,\\n \\"EndTime\\": 1710604800000,\\n \\"Region\\": \\"*\\",\\n \\"Template\\": {\\n \\"Code\\": \\"alb_cubag*******\\",\\n \\"Name\\": \\"中国内地区域\\"\\n },\\n \\"TemplateCode\\": \\"FPT_armsappbag_deadlineAcc_bj\\",\\n \\"TemplateName\\": \\"new_test\\",\\n \\"AccountName\\": \\"icloudtest\\",\\n \\"EnableRenew\\": false,\\n \\"EnableUpgrade\\": false,\\n \\"EnableExchange\\": false,\\n \\"ExchangeCommodityCode\\": \\"null\\",\\n \\"RegionName\\": \\"cn-qingdao\\",\\n \\"DeductRegions\\": [\\n {\\n \\"Name\\": \\"北京\\",\\n \\"Code\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"InitCapacityBaseValue\\": \\"1000.000000\\",\\n \\"InitCapacityBaseUnit\\": \\"CU\\",\\n \\"CurrCapacityBaseValue\\": \\"1000.000000\\",\\n \\"CurrCapacityBaseUnit\\": \\"CU\\",\\n \\"periodCapacityBaseValue\\": \\"1000.000000\\",\\n \\"periodCapacityBaseUnit\\": \\"CU\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetFundAccountAvailableAmount' => [
+ 'summary' => 'Query available balance of fund account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Account ID. If not specified, the account ID owned by the current account (owner) is used by default.', 'type' => 'string', 'example' => '12332112', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<BillingAccountAvailableAmountResponse>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8', 'title' => ''],
+ 'FundAccountId' => ['title' => '', 'description' => 'Account ID', 'type' => 'string', 'example' => '12332112'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'Account ID of the fund account owner', 'type' => 'string', 'example' => '1344312434'],
+ 'FundAccountStatus' => ['title' => '', 'description' => 'Account status', 'type' => 'string', 'example' => 'valid'],
+ 'FundAccountType' => ['title' => '', 'description' => 'Fund account type. Valid values:'."\n"
+ .'DIRECT_USER: Alibaba Cloud direct customer account.'."\n"
+ .'RESELLER_QUOTA: ecosystem account.', 'type' => 'string', 'example' => 'REDIRECT_USER'],
+ 'AvailableAmount' => ['title' => '', 'description' => 'Available amount', 'type' => 'string', 'example' => '100'],
+ 'CashAmount' => ['title' => '', 'description' => 'Cash balance', 'type' => 'string', 'example' => '50'],
+ 'NegativeBillAmount' => ['title' => '', 'description' => 'Negative bill amount', 'type' => 'string', 'example' => '0'],
+ 'CreditAmount' => ['title' => '', 'description' => 'Credit quota', 'type' => 'string', 'example' => '100'],
+ 'AvailableCreditAmount' => ['title' => '', 'description' => 'Available credit amount', 'type' => 'string', 'example' => '50'],
+ 'CreditRefundAmount' => ['title' => '', 'description' => 'Credit refund balance', 'type' => 'string', 'example' => '0'],
+ 'UnclearedAmount' => ['title' => '', 'description' => 'Uncleared amount (current month uncleared + historical months uncleared)', 'type' => 'string', 'example' => '50'],
+ 'CurrentMonthUnclearedAmount' => ['title' => '', 'description' => 'Current month uncleared amount', 'type' => 'string', 'example' => '20'],
+ 'HistoryMonthUnclearedAmount' => ['title' => '', 'description' => 'Historical months uncleared amount', 'type' => 'string', 'example' => '30'],
+ 'BankAcceptanceAmount' => ['title' => '', 'description' => 'Bank acceptance bill amount', 'type' => 'string', 'example' => '0'],
+ 'ExtendLedgerList' => [
+ 'title' => '',
+ 'description' => 'Extended ledger list',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Currency' => ['title' => '', 'description' => 'Currency of the ledger amount, such as CNY and USD.', 'type' => 'string', 'example' => 'CNY'],
+ 'LedgerName' => ['title' => '', 'description' => 'Ledger name', 'type' => 'string', 'example' => '应付对冲账本'],
+ 'OriginalAmount' => ['title' => '', 'description' => 'Ledger balance', 'type' => 'string', 'example' => '50'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
+ 'QuotaAmount' => ['title' => '', 'description' => 'Ecosystem end customer quota', 'type' => 'string', 'example' => '20'],
+ 'QuotaConsumedAmount' => ['title' => '', 'description' => 'Consumed quota of ecosystem end customer', 'type' => 'string', 'example' => '10'],
+ 'Currency' => ['title' => '', 'description' => 'Currency', 'type' => 'string', 'example' => 'CNY'],
+ 'OriginalCashAmountList' => [
+ 'title' => '',
+ 'description' => 'Original cash ledger list. International site users may have cash ledgers in multiple currencies.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Amount' => ['title' => '', 'description' => 'Amount', 'type' => 'string', 'example' => '10'],
+ 'Currency' => ['title' => '', 'description' => 'Currency', 'type' => 'string', 'example' => 'USD'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'CreditUser' => ['title' => '', 'description' => 'Indicates whether credit control is enabled', 'type' => 'boolean', 'default' => 'false', 'example' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'SubAccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', '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.'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ['errorCode' => 'InnerAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', '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 。'],
+ ['errorCode' => 'InnerSubAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', '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 。'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"F96A2D13-7509-5DF9-A60E-E7E3A3CB68E8\\",\\n \\"FundAccountId\\": \\"12332112\\",\\n \\"FundAccountOwnerAccountId\\": \\"1344312434\\",\\n \\"FundAccountStatus\\": \\"valid\\",\\n \\"FundAccountType\\": \\"REDIRECT_USER\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"50\\",\\n \\"NegativeBillAmount\\": \\"0\\",\\n \\"CreditAmount\\": \\"100\\",\\n \\"AvailableCreditAmount\\": \\"50\\",\\n \\"CreditRefundAmount\\": \\"0\\",\\n \\"UnclearedAmount\\": \\"50\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"20\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"30\\",\\n \\"BankAcceptanceAmount\\": \\"0\\",\\n \\"ExtendLedgerList\\": [\\n {\\n \\"Currency\\": \\"CNY\\",\\n \\"LedgerName\\": \\"应付对冲账本\\",\\n \\"OriginalAmount\\": \\"50\\"\\n }\\n ],\\n \\"QuotaAmount\\": \\"20\\",\\n \\"QuotaConsumedAmount\\": \\"10\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalCashAmountList\\": [\\n {\\n \\"Amount\\": \\"10\\",\\n \\"Currency\\": \\"USD\\"\\n }\\n ],\\n \\"CreditUser\\": false\\n}","type":"json"}]',
+ 'title' => 'Query available balance of fund account',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-18T03:29:27.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-05-09T08:54:13.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- [
- 'errorCode' => 'AccountNotExist',
- 'errorMessage' => 'Account does not exist.',
+ ],
+ ],
+ ],
+ 'GetFundAccountCanAllocateCreditAmount' => [
+ 'summary' => 'Query allocatable credit limit of a fund account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account owned by the current account is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '1233231', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<UserCreditLimitResponse>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CC706AAC-75A6-55B5-9AB7-7D171C6C7655', 'title' => ''],
+ 'Ecid' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'example' => '2032123221'],
+ 'EcidCreditAmount' => ['title' => '', 'description' => 'The enterprise credit quota.', 'type' => 'string', 'example' => '1000'],
+ 'EcidAllocatedCreditAmount' => ['title' => '', 'description' => 'The allocated credit limit of the enterprise.', 'type' => 'string', 'example' => '300'],
+ 'MaxCanAllocateCreditAmount' => ['title' => '', 'description' => 'The maximum allocatable credit limit of the current account.', 'type' => 'string', 'example' => '1500'],
+ 'MinCanAllocateCreditAmount' => ['title' => '', 'description' => 'The minimum allocatable credit limit of the current account.', 'type' => 'string', 'example' => '200'],
+ 'Site' => ['title' => '', 'description' => 'The site.', 'type' => 'string', 'example' => '26842'],
+ 'Nbid' => ['title' => '', 'description' => 'The primary marketplace.', 'type' => 'string', 'example' => '2684210001'],
+ 'FundAccountId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12332112'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'The Alibaba Cloud account ID of the account owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '123433121'],
+ 'FundAccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => '云某的名称'],
+ 'FundAccountEcid' => ['title' => '', 'description' => 'The account ECID.', 'type' => 'string', 'example' => '202321232'],
+ ],
+ 'example' => '',
],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"CC706AAC-75A6-55B5-9AB7-7D171C6C7655\\",\\n \\"Ecid\\": \\"2032123221\\",\\n \\"EcidCreditAmount\\": \\"1000\\",\\n \\"EcidAllocatedCreditAmount\\": \\"300\\",\\n \\"MaxCanAllocateCreditAmount\\": \\"1500\\",\\n \\"MinCanAllocateCreditAmount\\": \\"200\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 123433121,\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"FundAccountEcid\\": \\"202321232\\"\\n}","type":"json"}]',
+ 'title' => 'Query allocatable credit limit of a fund account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyCredit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Data\\": [\\n {\\n \\"FundAccountId\\": \\"123231213\\",\\n \\"FundAccountOwnerAccountId\\": \\"312328912\\",\\n \\"AccountId\\": \\"32812132121\\",\\n \\"AccountName\\": \\"云某的名称\\",\\n \\"EffectiveTime\\": \\"2024-12-01 12:00:10\\",\\n \\"IneffectiveTime\\": \\"2025-01-01 12:12:12\\",\\n \\"Status\\": \\"valid\\",\\n \\"RelationType\\": \\"PAYMENT\\",\\n \\"OperatorType\\": \\"aliyun_pk\\",\\n \\"OperatorNo\\": \\"1232343423\\",\\n \\"OperatorName\\": \\"云某的名称\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"Ecid\\": \\"213231232\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
],
'GetFundAccountCanRecycleAmount' => [
- 'summary' => '查询资金账户可回收金额',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Queries the reclaimable amount of a fund account.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3131,296 +3349,289 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RecycleFromFundAccountId',
'in' => 'formData',
- 'schema' => [
- 'title' => '回收源账户ID (出款方账户id),不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '122321223',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the source account (payer account) from which funds are reclaimed. If not specified, the account ID owned by the current account is used by default.', 'type' => 'string', 'example' => '122321223', 'required' => false],
],
[
'name' => 'Currency',
'in' => 'formData',
- 'schema' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CNY',
- ],
+ 'schema' => ['title' => '', 'description' => 'The currency.', 'type' => 'string', 'required' => true, 'example' => 'CNY'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<RecycleBillingAccountQueryResult>',
+ 'title' => '',
'description' => 'BssApiPlainResult<RecycleBillingAccountQueryResult>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
- 'RecycleFromFundAccountId' => [
- 'title' => '回收源账户ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1232122132',
- ],
- 'TransferAmount' => [
- 'title' => '转账账本余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'AvailableAmount' => [
- 'title' => '被回收账户的可用金',
- 'description' => '',
- 'type' => 'string',
- 'example' => '300',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
+ 'RecycleFromFundAccountId' => ['title' => '', 'description' => 'The ID of the source account from which funds are reclaimed.', 'type' => 'string', 'example' => '1232122132'],
+ 'TransferAmount' => ['title' => '', 'description' => 'The transfer ledger balance.', 'type' => 'string', 'example' => '200'],
+ 'AvailableAmount' => ['title' => '', 'description' => 'The available balance of the account from which funds are reclaimed.', 'type' => 'string', 'example' => '300'],
'RecycleToFundAccountList' => [
- 'title' => '可回收到的账户列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of accounts to which funds can be reclaimed.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'FundAccountOwnerAccountId' => [
- 'title' => '可回收到的账户归属的accountId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '183221321',
- ],
- 'MaxRecyclableAmount' => [
- 'title' => '最大可回收金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '120',
- ],
- 'FundAccountId' => [
- 'title' => '可回收到的账户ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '122323121',
- ],
- 'FundAccountName' => [
- 'title' => '可回收到的账户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的账户',
- ],
- 'OriginalTransferRemainAmount' => [
- 'title' => '可原路回收的转账金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '120',
- ],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'The account ID that owns the target account to which funds can be reclaimed.', 'type' => 'string', 'example' => '183221321'],
+ 'MaxRecyclableAmount' => ['title' => '', 'description' => 'The maximum reclaimable amount.', 'type' => 'string', 'example' => '120'],
+ 'FundAccountId' => ['title' => '', 'description' => 'The ID of the target account to which funds can be reclaimed.', 'type' => 'string', 'example' => '122323121'],
+ 'FundAccountName' => ['title' => '', 'description' => 'The name of the target account to which funds can be reclaimed.', 'type' => 'string', 'example' => '云某的账户'],
+ 'OriginalTransferRemainAmount' => ['title' => '', 'description' => 'The remaining transfer amount that can be reclaimed through the original transfer path.', 'type' => 'string', 'example' => '120'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Currency' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
+ 'Currency' => ['title' => '', 'description' => 'The currency.', 'type' => 'string', 'example' => 'CNY'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"RecycleFromFundAccountId\\": \\"1232122132\\",\\n \\"TransferAmount\\": \\"200\\",\\n \\"AvailableAmount\\": \\"300\\",\\n \\"RecycleToFundAccountList\\": [\\n {\\n \\"FundAccountOwnerAccountId\\": \\"183221321\\",\\n \\"MaxRecyclableAmount\\": \\"120\\",\\n \\"FundAccountId\\": \\"122323121\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"OriginalTransferRemainAmount\\": \\"120\\"\\n }\\n ],\\n \\"Currency\\": \\"CNY\\"\\n}","type":"json"}]',
- ],
- 'CreateFundAccountTransfer' => [
- 'summary' => '创建资金账户划拨/回收',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Query reclaimable amount of a fund account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetFundAccountCanTransferAmount' => [
+ 'summary' => 'Query the transferable amount of a fund account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FromFundAccountId',
+ 'name' => 'FundAccountId',
'in' => 'formData',
- 'schema' => [
- 'title' => '转出账户id (出款方账户id)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123212323',
- ],
+ 'schema' => ['title' => '', 'description' => 'Transfer source account ID. If not specified, the account ID owned by the current account is used by default.', 'type' => 'string', 'example' => '123212', 'required' => false],
],
[
- 'name' => 'ToFundAccountId',
+ 'name' => 'Currency',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Currency', 'type' => 'string', 'required' => true, 'example' => 'CNY'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '转入账户id (收款方账户id)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '11112231',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<TransferBillingAccount>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
+ 'MaxTransferableAmount' => ['title' => '', 'description' => 'Transferable amount', 'type' => 'string', 'example' => '100'],
+ 'CashAmount' => ['title' => '', 'description' => 'Cash ledger balance', 'type' => 'string', 'example' => '500'],
+ 'TransferAmount' => ['title' => '', 'description' => 'Transfer ledger balance', 'type' => 'string', 'example' => '100'],
+ 'AvailableAmount' => ['title' => '', 'description' => 'Available amount', 'type' => 'string', 'example' => '100'],
+ 'Currency' => ['title' => '', 'description' => 'Currency', 'type' => 'string', 'example' => 'CNY'],
+ 'Site' => ['title' => '', 'description' => 'Site', 'type' => 'string', 'example' => '26842'],
+ 'Nbid' => ['title' => '', 'description' => 'Primary marketplace', 'type' => 'string', 'example' => '2684210001'],
+ 'FundAccountId' => ['title' => '', 'description' => 'Account ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12332112'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the fund account owner', 'type' => 'integer', 'format' => 'int64', 'example' => '154738212323'],
+ 'FundAccountName' => ['title' => '', 'description' => 'Account name', 'type' => 'string', 'example' => '云某的账户'],
+ 'FundAccountEcid' => ['title' => '', 'description' => 'Enterprise entity ID of the account owner', 'type' => 'string', 'example' => '2032121324'],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'Amount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '转账金额',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100',
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"MaxTransferableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"500\\",\\n \\"TransferAmount\\": \\"100\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 154738212323,\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"FundAccountEcid\\": \\"2032121324\\"\\n}","type":"json"}]',
+ 'title' => 'Query the transferable amount of a fund account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetFundAccountCanWithdrawAmount' => [
+ 'summary' => 'Query Withdrawable Amount of Fund Account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Currency',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CNY',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'FinanceType',
+ 'name' => 'FundAccountId',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account ID owned by the current account (owner) is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '123212232', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '资产类型(当前仅支持现金)'."\n"
- .'cash-现金;',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cash',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<WithdrawInfoDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DF58589C-A06C-4224-8615-7797E6474FA3', 'title' => ''],
+ 'CashAmount' => ['title' => '', 'description' => 'Cash balance', 'type' => 'string', 'example' => '1000'],
+ 'CanWithdrawAmount' => ['title' => '', 'description' => 'Withdrawable amount = Cash balance - Transfer ledger amount - (Outstanding invoice amount + Historical months unsettled amount + Current month unsettled amount - Transfer ledger amount) - Pay-as-you-go reserved amount', 'type' => 'string', 'example' => '500'],
+ 'CanOriginalWithdrawAmount' => ['title' => '', 'description' => 'Amount withdrawable via original payment method', 'type' => 'string', 'example' => '400'],
+ 'CannotOriginalWithdrawAmount' => ['title' => '', 'description' => 'Amount not withdrawable via original payment method', 'type' => 'string', 'example' => '100'],
+ 'PayAsYouGoReversedAmount' => ['title' => '', 'description' => 'Pay-as-you-go reserved amount', 'type' => 'string', 'example' => '100'],
+ 'TransferAmount' => ['title' => '', 'description' => 'Transfer amount', 'type' => 'string', 'example' => '0'],
+ 'CreditMemoAmount' => ['title' => '', 'description' => 'Outstanding invoice amount', 'type' => 'string', 'example' => '100'],
+ 'CurrentMonthUnclearedAmount' => ['title' => '', 'description' => 'Current month unsettled amount', 'type' => 'string', 'example' => '200'],
+ 'HistoryMonthUnclearedAmount' => ['title' => '', 'description' => 'Historical months unsettled amount', 'type' => 'string', 'example' => '100'],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'TransferType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '转账类型'."\n"
- .'grant-划拨;'."\n"
- .'recycle;回收',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'grant',
- 'enum' => [
- 'grant',
- 'recycle',
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"DF58589C-A06C-4224-8615-7797E6474FA3\\",\\n \\"CashAmount\\": \\"1000\\",\\n \\"CanWithdrawAmount\\": \\"500\\",\\n \\"CanOriginalWithdrawAmount\\": \\"400\\",\\n \\"CannotOriginalWithdrawAmount\\": \\"100\\",\\n \\"PayAsYouGoReversedAmount\\": \\"100\\",\\n \\"TransferAmount\\": \\"0\\",\\n \\"CreditMemoAmount\\": \\"100\\",\\n \\"CurrentMonthUnclearedAmount\\": \\"200\\",\\n \\"HistoryMonthUnclearedAmount\\": \\"100\\"\\n}","type":"json"}]',
+ 'title' => 'Query Withdrawable Amount of Fund Account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
+ ],
+ ],
+ 'GetFundAccountLowAvailableAmountAlarm' => [
+ 'summary' => 'Query Fund Account Low Balance Alert',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Remark',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'FundAccountId',
'in' => 'formData',
- 'schema' => [
- 'title' => '备注',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '转账的备注',
- ],
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account ID owned by the current account is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '12332112', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Void>',
- 'description' => 'BssApiPlainResult<Void>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<BalanceAlarmDTO>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1BB79-5B23-3EA-BB4F-352F93E'."\n"
- ."\n",
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
+ 'ThresholdAmount' => ['title' => '', 'description' => 'Alert threshold', 'type' => 'string', 'example' => '100'],
+ 'AlarmEnabled' => ['title' => '', 'description' => 'Whether the alert is enabled', 'type' => 'boolean', 'default' => 'false', 'example' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- [
- 'errorCode' => 'AccountNotExist',
- 'errorMessage' => 'Account does not exist.',
- ],
- [
- 'errorCode' => 'AvailableTransferAmountNotEnough',
- 'errorMessage' => 'The available amount for granting or recycling is insufficient.',
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"ThresholdAmount\\": \\"100\\",\\n \\"AlarmEnabled\\": false\\n}","type":"json"}]',
+ 'title' => 'Query Fund Account Low Balance Alert',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"1BB79-5B23-3EA-BB4F-352F93E\\\\n\\\\n\\"\\n}","type":"json"}]',
],
'GetFundAccountTransactionDetails' => [
- 'summary' => '查询资金账户收支明细',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Query fund account transaction details',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3428,137 +3639,80 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'FundAccountId',
'in' => 'formData',
- 'schema' => [
- 'title' => '资金账户id,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123221232',
- ],
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account ID owned by the current account (owner) is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '123221232', 'required' => false],
],
[
'name' => 'TransactionNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '流水号',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '543231231',
- ],
+ 'schema' => ['title' => '', 'description' => 'Transaction serial number', 'type' => 'integer', 'format' => 'int64', 'example' => '543231231', 'required' => false],
],
[
'name' => 'BillNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '交易单号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023212312321',
- ],
+ 'schema' => ['title' => '', 'description' => 'Transaction order number', 'type' => 'string', 'example' => '2023212312321', 'required' => false],
],
[
'name' => 'ChannelTransactionNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '交易渠道流水号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20250312334312322',
- ],
+ 'schema' => ['title' => '', 'description' => 'Transaction channel serial number', 'type' => 'string', 'example' => '20250312334312322', 'required' => false],
],
[
'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询开始时间戳(毫秒)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1735664461000',
- ],
+ 'schema' => ['title' => '', 'description' => 'Query start timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1735664461000', 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '查询结束时间戳(毫秒)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1735664561000',
- ],
+ 'schema' => ['title' => '', 'description' => 'Query end timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1735664561000', 'required' => false],
],
[
'name' => 'TransactionDirection',
'in' => 'formData',
'schema' => [
- 'title' => '交易方向 in/out(资金流入流出)',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Transaction direction: in/out (fund inflow/outflow)',
'type' => 'string',
- 'required' => false,
'example' => 'IN',
- 'enum' => [
- 'IN',
- 'OUT',
- ],
+ 'enum' => ['IN', 'OUT'],
+ 'required' => false,
],
],
[
'name' => 'TransactionType',
'in' => 'formData',
- 'schema' => [
- 'title' => '交易类型。 传入以下交易类型,查询返回对应类型结果,不存在时结果为空。不传默认返回所有类型。'."\n"
- ."\n"
- .'充值:CHARGE。'."\n"
- ."\n"
- .'提现:WITHDRAW。'."\n"
- ."\n"
- .'退款:REFUND。'."\n"
- ."\n"
- .'消费:PAY。'."\n"
- ."\n"
- .'转账:TRANSFER。'."\n"
- ."\n"
- .'调账:ADJUST。'."\n"
- ."\n"
- .'订单失效退款: PAY_FAILED。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CHARGE',
- ],
+ 'schema' => ['title' => '', 'description' => 'Transaction type. If a transaction type is specified, only results of that type are returned. If the specified type does not exist, the result is empty. If not specified, all types are returned by default.'."\n"
+ ."\n"
+ .'Top-up: CHARGE.'."\n"
+ ."\n"
+ .'Withdrawal: WITHDRAW.'."\n"
+ ."\n"
+ .'Refund: REFUND.'."\n"
+ ."\n"
+ .'Payment: PAY.'."\n"
+ ."\n"
+ .'Transfer: TRANSFER.'."\n"
+ ."\n"
+ .'Adjustment: ADJUST.'."\n"
+ ."\n"
+ .'Order expiration refund: PAY_FAILED.', 'type' => 'string', 'example' => 'CHARGE', 'required' => false],
],
[
'name' => 'TransactionTypeList',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '交易类型列表,支持多个参数查询',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Transaction type list. Supports querying with multiple parameters.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CHARGE',
- ],
+ 'items' => ['description' => 'Transaction type', 'type' => 'string', 'required' => false, 'example' => 'CHARGE', 'title' => ''],
'required' => false,
+ 'example' => '',
],
],
[
@@ -3566,556 +3720,425 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '交易渠道,传入时按交易渠道查询,不传时默认查所有。'."\n"
+ 'title' => '',
+ 'description' => 'Transaction channel. If specified, the query filters by transaction channel. If not specified, all channels are queried by default.'."\n"
."\n"
- .'用户余额:ACCT_CASH。'."\n"
+ .'User balance: ACCT_CASH.'."\n"
."\n"
- .'支付宝:ALIPAY。'."\n"
+ .'Alipay: ALIPAY.'."\n"
."\n"
- .'支付宝支付通:ALIPAY_ZHIFUTONG。'."\n"
+ .'Alipay Zhifutong: ALIPAY_ZHIFUTONG.'."\n"
."\n"
- .'对公汇款:OFFLINE_REMIT。'."\n"
+ .'Offline remittance: OFFLINE_REMIT.'."\n"
."\n"
- .'信控额度退款:REFUND。'."\n"
+ .'Credit control quota refund: REFUND.'."\n"
."\n"
- .'网银:UNION_PAY_BANK。'."\n"
+ .'Online banking: UNION_PAY_BANK.'."\n"
."\n"
- .'信用卡:CREDIT_CARD。(国际站才有)'."\n"
+ .'Credit card: CREDIT_CARD. (International site only)'."\n"
."\n"
- .'AYPAL:PAYPAL 。(国际站才有)'."\n"
+ .'PayPal: PAYPAL. (International site only)'."\n"
."\n\n",
- 'description' => '',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ACCT_CASH',
- ],
+ 'items' => ['description' => 'Fund type', 'type' => 'string', 'required' => false, 'example' => 'ACCT_CASH', 'title' => ''],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小(最大200)',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'Page size (maximum 200)', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'example' => '20', 'default' => '20', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<FundFlowResponse>',
+ 'title' => '',
'description' => 'BssApiPageResult<FundFlowResponse>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- 'default' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
+ 'CurrentPage' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Data list',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'TransactionType' => [
- 'title' => '交易类型。 传入以下交易类型,查询返回对应类型结果,不存在时结果为空。不传默认返回所有类型。'."\n"
- ."\n"
- .'充值:CHARGE。'."\n"
- ."\n"
- .'提现:WITHDRAW。'."\n"
- ."\n"
- .'退款:REFUND。'."\n"
- ."\n"
- .'消费:PAY。'."\n"
- ."\n"
- .'转账:TRANSFER。'."\n"
- ."\n"
- .'调账:ADJUST。'."\n"
- ."\n"
- .'订单失效退款: PAY_FAILED。'."\n",
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHARGE',
- ],
- 'ChannelTransactionNumber' => [
- 'title' => '外部交易流水号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '20244389232',
- ],
- 'TransactionNumber' => [
- 'title' => '流水号',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5423121',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1232121',
- ],
- 'Nbid' => [
- 'title' => '一级售卖场',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2684210001',
- ],
- 'TransactionAccount' => [
- 'title' => '对应交易账号,比如支付宝充值账号或转账对端账号。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '186****3975',
- ],
- 'BillNumber' => [
- 'title' => '订单号或者账单号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2323203243',
- ],
- 'Remark' => [
- 'title' => '备注',
- 'description' => '',
- 'type' => 'string',
- 'example' => '订单备注',
- ],
- 'TransactionDirection' => [
- 'title' => '交易方向 in/out(收入/支出)',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'IN',
- ],
- 'FundType' => [
- 'title' => '资金形式',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACCT_BOOK',
- ],
- 'Currency' => [
- 'title' => '交易金额币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'USD',
- ],
- 'TransactionChannel' => [
- 'title' => '交易渠道,传入时按交易渠道查询,不传时默认查所有。'."\n"
- ."\n"
- .'用户余额:ACCT_CASH。'."\n"
- ."\n"
- .'支付宝:ALIPAY。'."\n"
- ."\n"
- .'支付宝支付通:ALIPAY_ZHIFUTONG。'."\n"
- ."\n"
- .'对公汇款:OFFLINE_REMIT。'."\n"
- ."\n"
- .'信控额度退款:REFUND。'."\n"
- ."\n"
- .'网银:UNION_PAY_BANK。'."\n"
- ."\n"
- .'信用卡:CREDIT_CARD。(国际站才有)'."\n"
- ."\n"
- .'AYPAL:PAYPAL 。(国际站才有)'."\n"
- ."\n\n",
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALIPAY',
- ],
- 'FundAccountName' => [
- 'title' => '账户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的名称',
- ],
- 'TransactionAmount' => [
- 'title' => '交易金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TransactionTime' => [
- 'title' => '交易时间格式化字符串',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-12-01 12:00:00',
- ],
- 'FundAccountEcid' => [
- 'title' => '企业实体id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '23473943',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的阿里云accountId',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32343231',
- ],
- 'Balance' => [
- 'title' => '操作后余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '5',
- ],
+ 'Site' => ['title' => '', 'description' => 'Site', 'type' => 'string', 'example' => '26842'],
+ 'TransactionType' => ['title' => '', 'description' => 'Transaction type. If a transaction type is specified, only results of that type are returned. If the specified type does not exist, the result is empty. If not specified, all types are returned by default.'."\n"
+ ."\n"
+ .'Top-up: CHARGE.'."\n"
+ ."\n"
+ .'Withdrawal: WITHDRAW.'."\n"
+ ."\n"
+ .'Refund: REFUND.'."\n"
+ ."\n"
+ .'Payment: PAY.'."\n"
+ ."\n"
+ .'Transfer: TRANSFER.'."\n"
+ ."\n"
+ .'Adjustment: ADJUST.'."\n"
+ ."\n"
+ .'Order expiration refund: PAY_FAILED.'."\n", 'type' => 'string', 'example' => 'CHARGE'],
+ 'ChannelTransactionNumber' => ['title' => '', 'description' => 'External transaction serial number', 'type' => 'string', 'example' => '20244389232'],
+ 'TransactionNumber' => ['title' => '', 'description' => 'Transaction serial number', 'type' => 'integer', 'format' => 'int64', 'example' => '5423121'],
+ 'FundAccountId' => ['title' => '', 'description' => 'Account ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1232121'],
+ 'Nbid' => ['title' => '', 'description' => 'Primary marketplace', 'type' => 'string', 'example' => '2684210001'],
+ 'TransactionAccount' => ['title' => '', 'description' => 'Corresponding transaction account, such as the Alipay top-up account or the counterparty account for transfers.', 'type' => 'string', 'example' => '186****3975'],
+ 'BillNumber' => ['title' => '', 'description' => 'Order number or bill number', 'type' => 'string', 'example' => '2323203243'],
+ 'Remark' => ['title' => '', 'description' => 'Remarks', 'type' => 'string', 'example' => '订单备注'],
+ 'TransactionDirection' => ['title' => '', 'description' => 'Transaction direction: in/out (income/expenditure)', 'type' => 'string', 'example' => 'IN'],
+ 'FundType' => ['title' => '', 'description' => 'Fund type', 'type' => 'string', 'example' => 'ACCT_BOOK'],
+ 'Currency' => ['title' => '', 'description' => 'Transaction amount currency', 'type' => 'string', 'example' => 'USD'],
+ 'TransactionChannel' => ['title' => '', 'description' => 'Transaction channel. If specified, the query filters by transaction channel. If not specified, all channels are queried by default.'."\n"
+ ."\n"
+ .'User balance: ACCT_CASH.'."\n"
+ ."\n"
+ .'Alipay: ALIPAY.'."\n"
+ ."\n"
+ .'Alipay Zhifutong: ALIPAY_ZHIFUTONG.'."\n"
+ ."\n"
+ .'Offline remittance: OFFLINE_REMIT.'."\n"
+ ."\n"
+ .'Credit control quota refund: REFUND.'."\n"
+ ."\n"
+ .'Online banking: UNION_PAY_BANK.'."\n"
+ ."\n"
+ .'Credit card: CREDIT_CARD. (International site only)'."\n"
+ ."\n"
+ .'PayPal: PAYPAL. (International site only)'."\n"
+ ."\n\n", 'type' => 'string', 'example' => 'ALIPAY'],
+ 'FundAccountName' => ['title' => '', 'description' => 'Account name', 'type' => 'string', 'example' => '云某的名称'],
+ 'TransactionAmount' => ['title' => '', 'description' => 'Transaction amount', 'type' => 'string', 'example' => '10'],
+ 'TransactionTime' => ['title' => '', 'description' => 'Formatted transaction time string', 'type' => 'string', 'example' => '2024-12-01 12:00:00'],
+ 'FundAccountEcid' => ['title' => '', 'description' => 'Enterprise entity ID', 'type' => 'string', 'example' => '23473943'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'Alibaba Cloud account ID of the account owner', 'type' => 'integer', 'format' => 'int64', 'example' => '32343231'],
+ 'Balance' => ['title' => '', 'description' => 'Balance after the operation', 'type' => 'string', 'example' => '5'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MaxOffsetLimit',
- 'errorMessage' => 'Exceeded maximum page turning limit.',
- ],
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'MaxOffsetLimit', 'errorMessage' => 'Exceeded maximum page turning limit.', 'description' => 'Maximum page turning limit exceeded, please view after exporting'],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"TransactionType\\": \\"CHARGE\\",\\n \\"ChannelTransactionNumber\\": \\"20244389232\\",\\n \\"TransactionNumber\\": 5423121,\\n \\"FundAccountId\\": 1232121,\\n \\"Nbid\\": \\"2684210001\\",\\n \\"TransactionAccount\\": \\"186****3975\\",\\n \\"BillNumber\\": \\"2323203243\\",\\n \\"Remark\\": \\"订单备注\\",\\n \\"TransactionDirection\\": \\"IN\\",\\n \\"FundType\\": \\"ACCT_BOOK\\",\\n \\"Currency\\": \\"USD\\",\\n \\"TransactionChannel\\": \\"ALIPAY\\",\\n \\"FundAccountName\\": \\"云某的名称\\",\\n \\"TransactionAmount\\": \\"10\\",\\n \\"TransactionTime\\": \\"2024-12-01 12:00:00\\",\\n \\"FundAccountEcid\\": \\"23473943\\",\\n \\"FundAccountOwnerAccountId\\": 32343231,\\n \\"Balance\\": \\"5\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\"\\n}","type":"json"}]',
- ],
- 'SetFundAccountCreditAmount' => [
- 'summary' => '设置资金账户的信控限额',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Query fund account transaction details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeFund',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetOrderDetail' => [
+ 'summary' => 'Queries the details of a specific order for a user or a reseller\'s customer.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'FundAccountId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '资金账户id, 不设置时默认使用当前账号拥有(owner)的账户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1232312',
- ],
- ],
- [
- 'name' => 'CreditAmount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '授信额度',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '500',
- ],
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The order ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '233501558440169', 'title' => ''],
],
[
- 'name' => 'Currency',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '信控额度币种。目前国内仅支持CNY,国际仅支持USD',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CNY',
- ],
+ 'name' => 'MemberUid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the enterprise multi-account member managed by the current account. Leave this parameter empty if this scenario does not apply.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1715322405372273', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Void>',
- 'description' => 'BssApiPlainResult<Void>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n",
+ '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' => 'D6E068C3-25BC-455A-85FE-45F0B22ECB1F', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ '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 records.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
+ 'OrderList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Order' => [
+ 'description' => 'The list of orders.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The order details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Operator' => ['description' => 'The ID of the RAM user who operated the order. This field is empty if not applicable.', 'type' => 'string', 'example' => '322315', 'title' => ''],
+ 'AfterTaxAmount' => ['description' => 'The after-tax amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'Config' => ['description' => 'The configuration of the main product.', 'type' => 'string', 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', 'title' => ''],
+ 'SubOrderId' => ['description' => 'The sub-order ID.', 'type' => 'string', 'example' => '234343', 'title' => ''],
+ 'PaymentTime' => ['description' => 'The payment time of the order.', 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''],
+ 'Tax' => ['description' => 'The tax.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'PaymentCurrency' => ['description' => 'The payment currency. CNY: Chinese Yuan. USD: US Dollar. JPY: Japanese Yen.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'UsageEndTime' => ['description' => 'The service end time.', 'type' => 'string', 'example' => '2117-06-08T16:00:00Z', 'title' => ''],
+ 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n"
+ .'- Subscription: subscription.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'title' => '', 'example' => 'Subscription'],
+ 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type. Valid values:'."\n"
+ .'- New: new purchase.'."\n"
+ .'- Renew: renewal.'."\n"
+ .'- Upgrade: upgrade.'."\n"
+ .'- TempUpgrade: temporary upgrade.'."\n"
+ .'- Downgrade: downgrade.'."\n"
+ .'- Refund: refund.'."\n"
+ .'- Convert: payment type conversion.'."\n"
+ .'- ResizeDisk: disk resizing.'."\n"
+ .'- CompensatoryRenew: compensatory renewal.'."\n"
+ .'- IncreaseUpgrade: bandwidth upgrade.'."\n"
+ .'- Exchange: exchange.'."\n"
+ .'- ChangeOperatingSystem: operating system change.', 'type' => 'string', 'example' => 'new', 'title' => ''],
+ 'Currency' => ['description' => 'The currency. Valid values:'."\n"
+ .'- CNY.'."\n"
+ .'- USD.'."\n"
+ .'- JPY.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'UsageStartTime' => ['description' => 'The service start time.', 'type' => 'string', 'example' => '2017-06-08T16:00:00Z', 'title' => ''],
+ 'OriginalConfig' => ['description' => 'The non-standardized module information.', 'type' => 'string', 'example' => 'DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]', 'title' => ''],
+ 'InstanceIds' => ['description' => 'The list of instance IDs.', 'type' => 'string', 'example' => '["rm-bp1a2vsr018313t6o"]', 'title' => ''],
+ 'PaymentStatus' => ['description' => 'The payment status. For non-refund orders, valid values:'."\n"
+ .'- Unpaid: unpaid.'."\n"
+ .'- Paid: paid.'."\n"
+ .'- Cancelled: cancelled.', 'type' => 'string', 'example' => 'paid', 'title' => ''],
+ 'ExtendInfos' => [
+ 'description' => 'The extended information of the order.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The extended information of the order.'."\n"
+ .'- IsAutoRenew=true indicates an auto-renewal order. This parameter is not returned for non-auto-renewal orders.'."\n"
+ .'- CouponNo: the coupon number.'."\n"
+ .'- DeductedByCoupons: the amount deducted by coupons, in the unit of yuan.'."\n"
+ .'- DiscountAmount: the discount amount, in the unit of yuan.', 'type' => 'string', 'example' => '{"IsAutoRenew":"true","DiscountAmount":"100.98","DeductedByCoupons":"98.88","CouponNo":"319170900877"}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''],
+ 'ProductType' => ['description' => 'The product type.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'Quantity' => ['description' => 'The quantity.', 'type' => 'string', 'example' => '3', 'title' => ''],
+ 'RelatedOrderId' => ['description' => 'The related order ID.', 'type' => 'string', 'example' => '241559391310332', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '241559391310333', 'title' => ''],
+ 'BillModuleConfig' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'billModuleConfig' => [
+ 'description' => 'The billing configuration information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BillModuleProperties' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'billModuleProperties' => [
+ 'description' => 'The values of the configuration.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Value' => ['description' => 'The property value of the configuration.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
+ 'AttrApiCode' => ['description' => 'The property code of the configuration.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
+ 'ModuleApiCode' => ['description' => 'The configuration API code.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ApiCode' => ['description' => 'The API code.', 'type' => 'string', 'example' => 'datadisk', 'title' => ''],
+ 'Code' => ['description' => 'The configuration code.', 'type' => 'string', 'example' => 'datadisk', 'title' => ''],
+ 'Name' => ['description' => 'The component name.', 'type' => 'string', 'example' => '数据盘', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OriginalModuleConfig' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'originalModuleConfig' => [
+ 'description' => 'The specific configuration information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ModuleProperties' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'moduleProperties' => [
+ 'description' => 'The list of configuration properties.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Value' => ['description' => 'The configuration property value.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'Code' => ['description' => 'The configuration property code.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''],
+ 'Name' => ['description' => 'The configuration property name.', 'type' => 'string', 'example' => '高效云盘', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The configuration code.', 'type' => 'string', 'example' => 'systemdisk', 'title' => ''],
+ 'Name' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => '系统盘', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OrderSubType' => ['description' => 'The sub-order type:'."\n"
+ .'- productsuborder: product sub-order.'."\n"
+ .'- refundsuborder: refund sub-order.', 'type' => 'string', 'example' => 'productsuborder', 'title' => ''],
+ 'PretaxAmount' => ['description' => 'The payable amount of the order.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'PretaxAmountLocal' => ['description' => 'The amount in local currency.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- [
- 'errorCode' => 'ExistApprovingProcess',
- 'errorMessage' => 'There is a credit control setting process in the approval process, please contact the business manager.',
- ],
- [
- 'errorCode' => 'ExistUnconfirmedContract',
- 'errorMessage' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.',
- ],
- [
- 'errorCode' => 'NotSupportAllocateCredit',
- 'errorMessage' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.',
- ],
+ ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]',
- ],
- 'GetFundAccountCanTransferAmount' => [
- 'summary' => '查询资金账户的可转出金额',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ ['errorCode' => 'InvalidCaller', 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', 'description' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'FundAccountId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '转账源账户ID,不传时默认使用当前账号拥有(owner)的账户id。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123212',
- ],
- ],
- [
- 'name' => 'Currency',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CNY',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'BssApiPlainResult<TransferBillingAccount>',
- 'description' => 'BssApiPlainResult<TransferBillingAccount>',
- 'type' => 'object',
- 'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
- 'MaxTransferableAmount' => [
- 'title' => '可转账金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'CashAmount' => [
- 'title' => '现金账本余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '500',
- ],
- 'TransferAmount' => [
- 'title' => '转账账本余额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'AvailableAmount' => [
- 'title' => '可用金',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'Currency' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'Nbid' => [
- 'title' => '一级售卖场',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2684210001',
- ],
- 'FundAccountId' => [
- 'title' => '账户Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12332112',
- ],
- 'FundAccountOwnerAccountId' => [
- 'title' => '账户归属人的阿里云accountId',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '154738212323',
- ],
- 'FundAccountName' => [
- 'title' => '账户名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '云某的账户',
- ],
- 'FundAccountEcid' => [
- 'title' => '账户归属的企业实体id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2032121324',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"D6E068C3-25BC-455A-85FE-45F0B22ECB1F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"Operator\\": \\"322315\\",\\n \\"AfterTaxAmount\\": \\"0\\",\\n \\"Config\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"SubOrderId\\": \\"234343\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"0\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"UsageEndTime\\": \\"2117-06-08T16:00:00Z\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"new\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"UsageStartTime\\": \\"2017-06-08T16:00:00Z\\",\\n \\"OriginalConfig\\": \\"DBInstanceClass:[DBInstanceClass:rds.mysql.s1.small;EngineVersion:8.0;Region:cn-qingdao;]DBFlowType:[Region:cn-qingdao;]\\",\\n \\"InstanceIds\\": \\"[\\\\\\"rm-bp1a2vsr018313t6o\\\\\\"]\\",\\n \\"PaymentStatus\\": \\"paid\\",\\n \\"ExtendInfos\\": {\\n \\"key\\": \\"{\\\\\\"IsAutoRenew\\\\\\":\\\\\\"true\\\\\\",\\\\\\"DiscountAmount\\\\\\":\\\\\\"100.98\\\\\\",\\\\\\"DeductedByCoupons\\\\\\":\\\\\\"98.88\\\\\\",\\\\\\"CouponNo\\\\\\":\\\\\\"319170900877\\\\\\"}\\"\\n },\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"Quantity\\": \\"3\\",\\n \\"RelatedOrderId\\": \\"241559391310332\\",\\n \\"OrderId\\": \\"241559391310333\\",\\n \\"BillModuleConfig\\": {\\n \\"billModuleConfig\\": [\\n {\\n \\"BillModuleProperties\\": {\\n \\"billModuleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_ssd\\",\\n \\"AttrApiCode\\": \\"cloud_ssd\\",\\n \\"ModuleApiCode\\": \\"cloud_ssd\\"\\n }\\n ]\\n },\\n \\"ApiCode\\": \\"datadisk\\",\\n \\"Code\\": \\"datadisk\\",\\n \\"Name\\": \\"数据盘\\"\\n }\\n ]\\n },\\n \\"OriginalModuleConfig\\": {\\n \\"originalModuleConfig\\": [\\n {\\n \\"ModuleProperties\\": {\\n \\"moduleProperties\\": [\\n {\\n \\"Value\\": \\"cloud_efficiency\\",\\n \\"Code\\": \\"cloud_efficiency\\",\\n \\"Name\\": \\"高效云盘\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"systemdisk\\",\\n \\"Name\\": \\"系统盘\\"\\n }\\n ]\\n },\\n \\"OrderSubType\\": \\"productsuborder\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query Order Details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeOrderDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => 'Request timed out. Please try again later.',
- ],
- [
- 'errorCode' => 'NoFundAccountPermission',
- 'errorMessage' => 'The caller does not have permission for the specified fund account.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"MaxTransferableAmount\\": \\"100\\",\\n \\"CashAmount\\": \\"500\\",\\n \\"TransferAmount\\": \\"100\\",\\n \\"AvailableAmount\\": \\"100\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountId\\": 12332112,\\n \\"FundAccountOwnerAccountId\\": 154738212323,\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"FundAccountEcid\\": \\"2032121324\\"\\n}","type":"json"}]',
],
- 'DescribeCoupon' => [
- 'summary' => '查询优惠券列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetOrders' => [
+ 'summary' => 'Queries the order list of a user or a reseller customer. By default, this operation queries orders created within the most recent hour. To query orders over a longer time range, set the CreateTimeStart and CreateTimeEnd parameters.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4123,418 +4146,308 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'EffectiveStartTime',
+ 'name' => 'CreateTimeEnd',
'in' => 'query',
- 'schema' => [
- 'title' => '生效开始时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1684750028000',
- ],
+ 'schema' => ['description' => 'The end of the order creation time range. If not specified, orders created within the most recent hour are queried. Format: YYYY-MM-ddTHH:mm:ssZ. Time zone: UTC.', 'type' => 'string', 'required' => false, 'example' => '2016-05-23T12:00:00Z', 'title' => ''],
],
[
- 'name' => 'EffectiveEndTime',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'title' => '生效结束时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1708423156000',
- ],
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ExpireStartDate',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '失效开始时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1684750028000',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
- 'name' => 'ExpireEndDate',
+ 'name' => 'ProductCode',
'in' => 'query',
- 'schema' => [
- 'title' => '失效结束时间',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1708423156000',
- ],
+ 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''],
],
[
- 'name' => 'Status',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'title' => '状态',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AVAILABLE',
- ],
+ 'schema' => ['description' => 'The product type.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''],
],
[
- 'name' => 'CouponType',
+ 'name' => 'SubscriptionType',
'in' => 'query',
- 'schema' => [
- 'title' => '优惠券类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CERTAIN',
- ],
+ 'schema' => ['description' => 'The subscription type. Valid values:'."\n"
+ .'- Subscription: upfront.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'Subscription', 'title' => ''],
],
[
- 'name' => 'Nbid',
+ 'name' => 'OrderType',
'in' => 'query',
- 'schema' => [
- 'title' => '一级场信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['description' => 'The order type. Valid values:'."\n"
+ .'- New: new purchase.'."\n"
+ .'- Renew: renewal.'."\n"
+ .'- Upgrade: upgrade.'."\n"
+ .'- TempUpgrade: temporary upgrade.'."\n"
+ .'- Downgrade: downgrade.'."\n"
+ .'- Refund: refund.'."\n"
+ .'- Convert: billing method conversion.'."\n"
+ .'- ResizeDisk: cloud disk resizing.'."\n"
+ .'- CompensatoryRenew: compensatory renewal.'."\n"
+ .'- IncreaseUpgrade: bandwidth upgrade.'."\n"
+ .'- Exchange: exchange.'."\n"
+ .'- ChangeOperatingSystem: operating system change.', 'type' => 'string', 'required' => false, 'example' => 'New', 'title' => ''],
],
[
- 'name' => 'CouponId',
+ 'name' => 'PaymentStatus',
'in' => 'query',
- 'schema' => [
- 'title' => '优惠券id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '351430260343',
- ],
+ 'schema' => ['description' => 'The payment status. For non-refund orders, valid values:'."\n"
+ .'- Unpaid: unpaid.'."\n"
+ .'- Paid: paid.'."\n"
+ .'- Cancelled: canceled.'."\n"
+ ."\n"
+ .'> For refund orders, set this parameter to NULL.', 'type' => 'string', 'required' => false, 'example' => 'Paid', 'title' => ''],
],
[
- 'name' => 'CouponNo',
+ 'name' => 'CreateTimeStart',
'in' => 'query',
- 'schema' => [
- 'title' => '券编码',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '554863270150',
- ],
+ 'schema' => ['description' => 'The start of the order creation time range. If not specified, orders created within the most recent hour are queried. Format: YYYY-MM-ddTHH:mm:ssZ. Time zone: UTC.', 'type' => 'string', 'required' => false, 'example' => '2016-05-23T13:00:00Z', 'title' => ''],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'MemberUid',
'in' => 'query',
+ 'schema' => ['description' => 'The UID of a member account in an enterprise with multiple member accounts. Leave this parameter empty if this scenario does not apply.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1779628988149763', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '当前页码',
+ 'type' => 'object',
+ 'properties' => [
+ '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 returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. A maximum of 20 entries per page is recommended. A larger number may cause a timeout.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OrderList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Order' => [
+ 'description' => 'The order list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AfterTaxAmount' => ['description' => 'The after-tax amount.', 'type' => 'string', 'example' => '66', 'title' => ''],
+ 'ProductCode' => ['description' => 'The primary product code.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''],
+ 'ProductType' => ['description' => 'The primary product type.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'RelatedOrderId' => ['description' => 'The related order ID.', 'type' => 'string', 'example' => '234535345345342', 'title' => ''],
+ 'PaymentCurrency' => ['description' => 'The payment currency. CNY: Chinese Yuan. USD: US Dollar. JPY: Japanese Yen.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'PaymentTime' => ['description' => 'The payment time.', 'type' => 'string', 'example' => '2017-06-08T09:41:30Z', 'title' => ''],
+ 'Tax' => ['description' => 'The tax amount. This parameter is used only on the China site (Chinese mainland).', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '237258627070169', 'title' => ''],
+ 'SubscriptionType' => ['description' => 'The subscription type. Valid values:'."\n"
+ .'- Subscription: upfront.'."\n"
+ .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'example' => 'Subscription', 'title' => ''],
+ 'PretaxGrossAmount' => ['description' => 'The original amount.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type. Valid values:'."\n"
+ .'- New: new purchase.'."\n"
+ .'- Renew: renewal.'."\n"
+ .'- Upgrade: upgrade.'."\n"
+ .'- TempUpgrade: temporary upgrade.'."\n"
+ .'- Downgrade: downgrade.'."\n"
+ .'- Refund: refund.'."\n"
+ .'- Convert: billing method conversion.'."\n"
+ .'- ResizeDisk: cloud disk resizing.'."\n"
+ .'- CompensatoryRenew: compensatory renewal.'."\n"
+ .'- IncreaseUpgrade: bandwidth upgrade.'."\n"
+ .'- Exchange: exchange.'."\n"
+ .'- ChangeOperatingSystem: operating system change.', 'type' => 'string', 'example' => 'New', 'title' => ''],
+ 'PretaxAmount' => ['description' => 'The payable amount of the order.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'CNY', 'title' => ''],
+ 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'PaymentStatus' => ['description' => 'The payment status. For non-refund orders, valid values:'."\n"
+ .'- Unpaid: unpaid.'."\n"
+ .'- Paid: paid.'."\n"
+ .'- Cancelled: canceled.'."\n"
+ ."\n"
+ .'> For refund orders, set this parameter to NULL.', 'type' => 'string', 'example' => 'Paid', 'title' => ''],
+ 'PretaxAmountLocal' => ['description' => 'The amount in local currency.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidOwner', 'errorMessage' => 'The specified owner doesn\'t belong to caller.', 'description' => 'Invalid user identity.'],
+ ],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
+ ['errorCode' => 'InvalidCaller', 'errorMessage' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.', 'description' => 'The caller\'s primary account is invalid or does not have permission to query enterprise member account information.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HostName\\": \\"test\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"OrderList\\": {\\n \\"Order\\": [\\n {\\n \\"AfterTaxAmount\\": \\"66\\",\\n \\"ProductCode\\": \\"rds\\",\\n \\"CreateTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"ProductType\\": \\"rds\\",\\n \\"RelatedOrderId\\": \\"234535345345342\\",\\n \\"PaymentCurrency\\": \\"CNY\\",\\n \\"PaymentTime\\": \\"2017-06-08T09:41:30Z\\",\\n \\"Tax\\": \\"1\\",\\n \\"OrderId\\": \\"237258627070169\\",\\n \\"SubscriptionType\\": \\"Subscription\\",\\n \\"PretaxGrossAmount\\": \\"0\\",\\n \\"OrderType\\": \\"New\\",\\n \\"PretaxAmount\\": \\"0\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"CommodityCode\\": \\"rds\\",\\n \\"PaymentStatus\\": \\"Paid\\",\\n \\"PretaxAmountLocal\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query order list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bssapi:QueryOrders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListFundAccount' => [
+ 'summary' => 'Query fund account list',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'EcIdAccountIds',
+ 'name' => 'QueryOnlyManage',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to query only the managed account list. Default value: false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'QueryOnlyInUse',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to query only the active account list. Default value: false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'Nbid',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1501603440974415',
- ],
- 'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1501603440974415',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => 'Level-1 marketplace ID. If this parameter is left empty, the ID of the marketplace to which the current user belongs is used by default.', 'type' => 'string', 'example' => '2084210001', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<CouponVO>',
- 'description' => 'BssApiPageResult<CouponVO>',
+ 'title' => '',
+ 'description' => 'BssApiListResult<BillingAccount>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Data list',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CouponId' => [
- 'title' => '优惠券id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '59243658',
- ],
- 'CouponNo' => [
- 'title' => '券编码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '731074910070',
- ],
- 'CouponType' => [
- 'title' => '优惠券类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CERTAIN',
- ],
- 'CouponTypeName' => [
- 'title' => '优惠券类型名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Amount' => [
- 'title' => '面值',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9929.750000',
- ],
- 'RemainAmount' => [
- 'title' => '剩余金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '100.00',
- ],
- 'ItemNames' => [
- 'title' => '产品code列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- 'UniversalType' => [
- 'title' => '优惠券适用范围',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UNIVERSAL',
- ],
- 'YhOrderTypes' => [
- 'title' => '优惠券适用订单类型列表',
- 'description' => '',
+ 'Site' => ['title' => '', 'description' => 'Site', 'type' => 'string', 'example' => '26842'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'Account ID of the fund account owner', 'type' => 'string', 'example' => '132123211'],
+ 'FundAccountType' => ['title' => '', 'description' => 'Account type.'."\n"
+ .'DIRECT_USER: Alibaba Cloud direct customer account.'."\n"
+ .'RESELLER_QUOTA: ecosystem account.', 'type' => 'string', 'example' => 'DIRECT_USER'],
+ 'FundAccountId' => ['title' => '', 'description' => 'Account ID', 'type' => 'string', 'example' => '1022231'],
+ 'FundAccountName' => ['title' => '', 'description' => 'Account name', 'type' => 'string', 'example' => '云某的账户'],
+ 'Permissions' => [
+ 'title' => '',
+ 'description' => 'Set of account permissions that the user has.'."\n"
+ .'using: use.'."\n"
+ .'manage: manage.'."\n"
+ .'owner: own.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- 'Status' => [
- 'title' => '状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Available',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-03-02T15:12Z'."\n",
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-03-02T15:12Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-03-06T15:12Z',
- ],
- 'Site' => [
- 'title' => '站点',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHINA',
- ],
- 'SiteName' => [
- 'title' => '站点名称',
- 'description' => '',
- 'type' => 'string',
+ 'items' => ['description' => 'Permission', 'type' => 'string', 'example' => 'owner', 'title' => ''],
'example' => '',
],
- 'Remark' => [
- 'title' => '备注',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'MoneyLimit' => [
- 'title' => '金额限制',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Currency' => [
- 'title' => '币种',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CNY',
- ],
- 'SuitAccount' => [
- 'title' => '适用帐号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1902671110151254',
- ],
- 'OrderTimeRule' => [
- 'title' => '订单时长限制规则',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ShareUidList' => [
- 'title' => '共享帐号列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Uid' => [
- 'title' => '阿里云uid',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1902671110151254',
- ],
- 'UserNick' => [
- 'title' => '阿里云帐号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'SuitItemType' => [
- 'title' => '适用产品类型:all 全产品通用 white 指定产品适用 black 指定产品不适用',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'all',
- ],
- 'ShowSetDeductTagButton' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CertainAmount' => [
- 'type' => 'string',
- ],
- 'FirstBuy' => [
- 'title' => '是否有首购限制',
- 'type' => 'boolean',
- ],
+ 'Nbid' => ['title' => '', 'description' => 'Level-1 marketplace', 'type' => 'string', 'example' => '2684210001'],
+ 'FundAccountAdminAccountName' => ['title' => '', 'description' => 'Name of the MA user associated with the account', 'type' => 'string', 'example' => '云某的账户'],
+ 'CreateDate' => ['title' => '', 'description' => 'Account creation time', 'type' => 'string', 'example' => '2024-12-30 12:00:00'],
+ 'FundAccountAdminAccountId' => ['title' => '', 'description' => 'Account ID of the MA user associated with the account', 'type' => 'string', 'example' => '1232121'],
+ 'FundAccountStatus' => ['title' => '', 'description' => 'Account status.'."\n"
+ .'VALID: valid.'."\n"
+ .'FROZEN: frozen.'."\n"
+ .'CLOSED: closed.', 'type' => 'string', 'example' => 'VALID'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C880B065-A781-4F19-B6DD-3E0E3B715C64',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.',
- ],
- [
- 'errorCode' => 'SubAccountNoQueryPricePermission',
- 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.',
- ],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'AccountNotExist', 'errorMessage' => 'Account does not exist.', 'description' => 'Account does not exist'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Site\\": \\"26842\\",\\n \\"FundAccountOwnerAccountId\\": \\"132123211\\",\\n \\"FundAccountType\\": \\"DIRECT_USER\\",\\n \\"FundAccountId\\": \\"1022231\\",\\n \\"FundAccountName\\": \\"云某的账户\\",\\n \\"Permissions\\": [\\n \\"owner\\"\\n ],\\n \\"Nbid\\": \\"2684210001\\",\\n \\"FundAccountAdminAccountName\\": \\"云某的账户\\",\\n \\"CreateDate\\": \\"2024-12-30 12:00:00\\",\\n \\"FundAccountAdminAccountId\\": \\"1232121\\",\\n \\"FundAccountStatus\\": \\"VALID\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'title' => 'Query fund account list',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Data\\": [\\n {\\n \\"CouponId\\": 59243658,\\n \\"CouponNo\\": \\"731074910070\\",\\n \\"CouponType\\": \\"CERTAIN\\",\\n \\"CouponTypeName\\": \\"满减券\\",\\n \\"Amount\\": \\"9929.750000\\",\\n \\"RemainAmount\\": \\"100.00\\",\\n \\"ItemNames\\": [\\n \\"全产品适用\\"\\n ],\\n \\"UniversalType\\": \\"UNIVERSAL\\",\\n \\"YhOrderTypes\\": [\\n \\"新购\\"\\n ],\\n \\"Status\\": \\"Available\\",\\n \\"GmtCreate\\": \\"2021-03-02T15:12Z\\\\n\\",\\n \\"StartTime\\": \\"2021-03-02T15:12Z\\",\\n \\"EndTime\\": \\"2021-03-06T15:12Z\\",\\n \\"Site\\": \\"CHINA\\",\\n \\"SiteName\\": \\"官网自营\\",\\n \\"Remark\\": \\"新买28号\\",\\n \\"MoneyLimit\\": \\"无订单金额限制\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"SuitAccount\\": \\"1902671110151254\\",\\n \\"OrderTimeRule\\": \\"预付费规则:购买订单时长大于3600s才能使用\\",\\n \\"ShareUidList\\": [\\n {\\n \\"Uid\\": \\"1902671110151254\\",\\n \\"UserNick\\": \\"阿里云计算有限公司\\"\\n }\\n ],\\n \\"SuitItemType\\": \\"all\\",\\n \\"ShowSetDeductTagButton\\": true,\\n \\"CertainAmount\\": \\"\\",\\n \\"FirstBuy\\": true\\n }\\n ],\\n \\"RequestId\\": \\"C880B065-A781-4F19-B6DD-3E0E3B715C64\\"\\n}","type":"json"}]',
],
- 'DescribeCouponItemList' => [
- 'summary' => '查询优惠券可用商品列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListFundAccountPayRelation' => [
+ 'summary' => 'Query payment relationships of an account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4542,412 +4455,453 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CouponId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '优惠券id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '59104570',
- ],
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Fund account ID.', 'type' => 'string', 'required' => true, 'example' => '12323123'],
],
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '商品名称(支持模糊匹配)',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The relationship status.'."\n"
+ .'valid: valid.'."\n"
+ .'expired: invalid.', 'type' => 'string', 'example' => 'valid', 'required' => false],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'EcIdAccountIds',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1004064243473974',
- ],
- 'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1004064243473974',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If this parameter is left empty, the ID of the marketplace to which the current user belongs is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<ItemNameVO>',
- 'description' => 'BssApiPageResult<ItemNameVO>',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<BillingAccountPayRelation>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '商品code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'vm',
- ],
- 'Name' => [
- 'title' => '商品名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'FundAccountId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => '123231213'],
+ 'FundAccountOwnerAccountId' => ['title' => '', 'description' => 'The Alibaba Cloud account ID of the account owner.', 'type' => 'string', 'example' => '312328912'],
+ 'AccountId' => ['title' => '', 'description' => 'The account ID of the user associated with the payment relationship, that is, the account that uses this account for payment.', 'type' => 'string', 'example' => '32812132121'],
+ 'AccountName' => ['title' => '', 'description' => 'The user name.', 'type' => 'string', 'example' => '云某的名称'],
+ 'EffectiveTime' => ['title' => '', 'description' => 'The time when the payment relationship takes effect.', 'type' => 'string', 'example' => '2024-12-01 12:00:10'],
+ 'IneffectiveTime' => ['title' => '', 'description' => 'The time when the payment relationship expires.', 'type' => 'string', 'example' => '2025-01-01 12:12:12'],
+ 'Status' => ['title' => '', 'description' => 'The relationship status.'."\n"
+ .'valid: valid.'."\n"
+ .'expired: invalid.', 'type' => 'string', 'example' => 'valid'],
+ 'RelationType' => ['title' => '', 'description' => 'The relationship type, which can be collection relationship or payment relationship.', 'type' => 'string', 'example' => 'PAYMENT'],
+ 'OperatorType' => ['title' => '', 'description' => 'The type of the authorized operator.'."\n"
+ .'aliyun_pk: user.'."\n"
+ .'system: Alibaba Cloud system.', 'type' => 'string', 'example' => 'aliyun_pk'],
+ 'OperatorNo' => ['title' => '', 'description' => 'The authorized operator.'."\n"
+ .'When the operator type is aliyun_pk, operatorNo is the Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1232343423'],
+ 'OperatorName' => ['title' => '', 'description' => 'The operator name.'."\n"
+ .'When the operator type is aliyun_pk, the operator name is the Alibaba Cloud nickname.'."\n"
+ .'When the operator type is system, the operator name is "Alibaba Cloud assistant".', 'type' => 'string', 'example' => '云某的名称'],
+ 'Site' => ['title' => '', 'description' => 'The site.', 'type' => 'string', 'example' => '26842'],
+ 'Nbid' => ['title' => '', 'description' => 'The primary marketplace.', 'type' => 'string', 'example' => '2684210001'],
+ 'Ecid' => ['title' => '', 'description' => 'The enterprise entity ID of the user associated with the payment relationship.', 'type' => 'string', 'example' => '213231232'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EAE08A27-386C-579E-966D-8853EC3C5D0E',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'AccountNotExist', 'errorMessage' => 'Account does not exist.', 'description' => 'Account does not exist'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Query payment relationships of an account',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Code\\": \\"vm\\",\\n \\"Name\\": \\"云服务器ECS\\"\\n }\\n ],\\n \\"RequestId\\": \\"EAE08A27-386C-579E-966D-8853EC3C5D0E\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Data\\": [\\n {\\n \\"FundAccountId\\": \\"123231213\\",\\n \\"FundAccountOwnerAccountId\\": \\"312328912\\",\\n \\"AccountId\\": \\"32812132121\\",\\n \\"AccountName\\": \\"云某的名称\\",\\n \\"EffectiveTime\\": \\"2024-12-01 12:00:10\\",\\n \\"IneffectiveTime\\": \\"2025-01-01 12:12:12\\",\\n \\"Status\\": \\"valid\\",\\n \\"RelationType\\": \\"PAYMENT\\",\\n \\"OperatorType\\": \\"aliyun_pk\\",\\n \\"OperatorNo\\": \\"1232343423\\",\\n \\"OperatorName\\": \\"云某的名称\\",\\n \\"Site\\": \\"26842\\",\\n \\"Nbid\\": \\"2684210001\\",\\n \\"Ecid\\": \\"213231232\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
],
- 'CreateReportDefinition' => [
- 'summary' => '创建账单订阅',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListInvoiceCandidate' => [
+ 'summary' => 'Query invoice candidate data, which can be used for invoicing.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ReportSourceType',
- 'in' => 'formData',
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'List of invoice candidate statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Invoice candidate status.',
+ 'enumValueTitles' => ['Invoiced', 'Not invoiced (invoiceable)', 'Partially invoiced', 'Invoice processing in progress, locked'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enum' => ['0', '1', '2', '3'],
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
'required' => false,
- 'example' => 'OSS',
+ 'enumValueTitles' => [],
+ 'enum' => ['0', '1', '2', '3'],
+ 'example' => '',
],
],
[
- 'name' => 'ReportType',
+ 'name' => 'Types',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '账单存储类型,类型来源参考API:ListReportTypesForReportDefinition',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'BillingItemDetailForBillingPeriod',
+ 'title' => '',
+ 'description' => 'List of invoice candidate types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Invoice candidate type.',
+ 'enumValueTitles' => [1 => 'Order', 'Bill', 'Contract', 'Adjustment bill', 'Refund order', 7 => 'Adjustment order', 'Commission bill'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'],
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'],
+ 'example' => '',
],
],
[
- 'name' => 'BeginBillingCycle',
+ 'name' => 'BusinessIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '推送起始账期。订阅成功后,系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效,不会对历史数据重新推送。最多可推送最近1年内数据。',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'List of business document numbers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Business document number, such as order number.', 'type' => 'string', 'required' => false, 'example' => '202506', 'title' => ''],
'required' => false,
- 'example' => '2025-05',
+ 'example' => '',
],
],
[
- 'name' => 'OssBucketOwnerAccountId',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1234567812345678',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time. Format: yyyy-mm-dd hh:mm:ss.', 'type' => 'string', 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'required' => false, 'example' => '2025-06-01 00:00:00'],
],
[
- 'name' => 'OssBucketName',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sh-bill',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time. Format: yyyy-mm-dd hh:mm:ss.', 'type' => 'string', 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'required' => false, 'example' => '2025-07-01 00:00:00'],
],
[
- 'name' => 'OssBucketPath',
+ 'name' => 'BillingCycles',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'List of billing cycles.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Billing cycle.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '202506', 'title' => ''],
'required' => false,
- 'example' => 'bill/',
+ 'example' => '',
],
],
[
- 'name' => 'McProject',
- 'in' => 'formData',
+ 'name' => 'InvoiceIssuers',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'List of invoice issuers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Invoice issuer.', 'type' => 'string', 'pattern' => '^[0-9a-zA-Z_-]+$', 'required' => false, 'example' => 'ALIYUN_SERVICE', 'title' => ''],
'required' => false,
- 'example' => 'project',
+ 'pattern' => '^[0-9a-zA-Z_-]+$',
+ 'example' => '',
],
],
[
- 'name' => 'McTableName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'table',
- ],
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Nbid',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'SplitFileOnUserId',
+ 'name' => 'EcIdAccountIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'List of enterprises and accounts. If empty, the current account itself is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'List of accounts to access. If empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1990699401005016', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
+ ],
+ 'EcId' => ['title' => '', 'description' => 'Enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '12345'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'NotSendOnNoData',
+ 'name' => 'Nbid',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'BssApiPageResult<BssOpenInvoiceEvaluateDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The list of data entries.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '', 'description' => 'The status of the invoice candidate.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'BillingCycle' => ['title' => '', 'description' => 'The billing cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '202506'],
+ 'AccountId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'AcceptedOffsetAmount' => ['title' => '', 'description' => 'The accepted offset amount.', 'type' => 'string', 'example' => '0.01'],
+ 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '性能测试'],
+ 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'pts'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2025-06-91 00:00:00'],
+ 'TotalAmount' => ['title' => '', 'description' => 'The total amount.', 'type' => 'string', 'example' => '0.01'],
+ 'ResourceOwnerAccountName' => ['title' => '', 'description' => 'The name of the resource owner account.', 'type' => 'string', 'example' => '测试账号'],
+ 'InvoiceIssuer' => ['title' => '', 'description' => 'The invoice issuer.', 'type' => 'string', 'example' => 'ALIYUN_SERVICE'],
+ 'InvoiceableAmount' => ['title' => '', 'description' => 'The invoiceable amount.', 'type' => 'string', 'example' => '0.01'],
+ 'OffsetAmount' => ['title' => '', 'description' => 'The offset amount.', 'type' => 'string', 'example' => '0'],
+ 'Type' => ['title' => '', 'description' => 'The type of the invoice candidate.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ResourceOwnerAccountId' => ['title' => '', 'description' => 'The ID of the resource owner account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'CommodityCode' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => 'pts'],
+ 'Id' => ['title' => '', 'description' => 'The ID of the invoice candidate.', 'type' => 'string', 'example' => '12345'],
+ 'BusinessTime' => ['title' => '', 'description' => 'The time when the business event occurred.', 'type' => 'string', 'example' => '2025-06-01 00:00:00'."\n"],
+ 'InvoicedAmount' => ['title' => '', 'description' => 'The invoiced amount.', 'type' => 'string', 'example' => '0'],
+ 'BusinessId' => ['title' => '', 'description' => 'The business document number.', 'type' => 'string', 'example' => '202506'],
+ 'CommodityName' => ['title' => '', 'description' => 'The commodity name.', 'type' => 'string', 'example' => '性能测试'],
+ 'AccountName' => ['title' => '', 'description' => 'The account name.', 'type' => 'string', 'example' => '测试账号'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'SendWithAttach',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'InnerAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', '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 。'],
+ ['errorCode' => 'InnerSubAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', '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 。'],
+ ['errorCode' => 'SubAccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', '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.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ['errorCode' => 'InvoiceCandidateSearchTimeInvalid', 'errorMessage' => 'Invoicing Candidate query time is illegal.', 'description' => 'Invoicing Candidate query time is illegal'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"BillingCycle\\": 202506,\\n \\"AccountId\\": 1990699401005016,\\n \\"AcceptedOffsetAmount\\": \\"0.01\\",\\n \\"ProductName\\": \\"性能测试\\",\\n \\"ProductCode\\": \\"pts\\",\\n \\"CreateTime\\": \\"2025-06-91 00:00:00\\",\\n \\"TotalAmount\\": \\"0.01\\",\\n \\"ResourceOwnerAccountName\\": \\"测试账号\\",\\n \\"InvoiceIssuer\\": \\"ALIYUN_SERVICE\\",\\n \\"InvoiceableAmount\\": \\"0.01\\",\\n \\"OffsetAmount\\": \\"0\\",\\n \\"Type\\": 1,\\n \\"ResourceOwnerAccountId\\": 1990699401005016,\\n \\"CommodityCode\\": \\"pts\\",\\n \\"Id\\": \\"12345\\",\\n \\"BusinessTime\\": \\"2025-06-01 00:00:00\\\\n\\",\\n \\"InvoicedAmount\\": \\"0\\",\\n \\"BusinessId\\": \\"202506\\",\\n \\"CommodityName\\": \\"性能测试\\",\\n \\"AccountName\\": \\"测试账号\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'title' => 'Invoice Candidate Query Service',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeQueryInvoice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ListInvoiceTitle' => [
+ 'summary' => 'Query the list of available invoice titles',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'IncludeMembers',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => '',
- 'description' => '',
+ 'description' => 'BssApiListResult<BssInvoiceTitleDTO>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '340CAB45-0637-5875-9BE4-EFD5750F6BA5',
- ],
- 'ReportTaskId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123123',
- ],
- 'ReportSourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSS',
- ],
- 'ReportSourceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSS',
- ],
- 'ReportType' => [
- 'title' => '账单存储类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BillingItemDetailForBillingPeriod',
- ],
- 'BeginBillingCycle' => [
- 'title' => '推送起始账期。订阅成功后,系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效,不会对历史数据重新推送。最多可推送最近1年内数据。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05',
- ],
- 'SubscribeCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05-21 10:36:31',
- ],
- 'OssBucketOwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567812345678',
- ],
- 'OssBucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sh-bill',
- ],
- 'OssBucketPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bill/',
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'Invoice title list',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UnifiedSocialCreditCode' => ['title' => '', 'description' => 'Unified social credit code. 15, 17, 18, or 20 characters.', 'type' => 'string', 'example' => '111111111111111'],
+ 'AccountId' => ['title' => '', 'description' => 'Account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990699401005016'],
+ 'RegisteredAddress' => ['title' => '', 'description' => 'Registered address.', 'type' => 'string', 'example' => '北京市朝阳区'],
+ 'CreateTime' => ['title' => '', 'description' => 'The time when the invoice title was created.', 'type' => 'string', 'example' => '2025-06-01 00:00:00'],
+ 'InvoiceTitle' => ['title' => '', 'description' => 'Invoice title.', 'type' => 'string', 'example' => 'xx公司'],
+ 'Id' => ['title' => '', 'description' => 'Invoice title ID.', 'type' => 'string', 'example' => '123456'],
+ 'BankAccountNumber' => ['title' => '', 'description' => 'Basic bank account number.', 'type' => 'string', 'example' => '1234567890'],
+ 'RegisteredLandline' => ['title' => '', 'description' => 'Registered landline number.', 'type' => 'string', 'example' => '010-12345678'],
+ 'AccountBankName' => ['title' => '', 'description' => 'Bank name.', 'type' => 'string', 'example' => '招商银行'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TASK_EXIST',
- 'errorMessage' => 'task has already exist.',
- ],
- [
- 'errorCode' => 'InvalidBucket',
- 'errorMessage' => 'The bucket is invalid or the bucket does not belong to you.',
- ],
- [
- 'errorCode' => 'InvalidHistoricalNbid',
- 'errorMessage' => 'Historical field does not support subscription bill.',
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'InnerAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account. More questions please refer to the document.', '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 。'],
+ ['errorCode' => 'InnerSubAccountNoQueryPricePermission', 'errorMessage' => 'In view of data security and compliance requirements, please understand the inconvenience caused to you by controlling the amount-related information and permissions of the group\'s cloud account.', '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 。'],
+ ['errorCode' => 'SubAccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Contact the main account to go to the RAM console for authorization. The Action to be authorized is bss:QueryPrice.', '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.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"UnifiedSocialCreditCode\\": \\"111111111111111\\",\\n \\"AccountId\\": 1990699401005016,\\n \\"RegisteredAddress\\": \\"北京市朝阳区\\",\\n \\"CreateTime\\": \\"2025-06-01 00:00:00\\",\\n \\"InvoiceTitle\\": \\"xx公司\\",\\n \\"Id\\": \\"123456\\",\\n \\"BankAccountNumber\\": \\"1234567890\\",\\n \\"RegisteredLandline\\": \\"010-12345678\\",\\n \\"AccountBankName\\": \\"招商银行\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'title' => 'Invoice title query service',
+ 'requestParamsDescription' => 'No parameters are required. The API directly queries the list of available invoice titles for the currently logged-in UID.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeQueryInvoice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"340CAB45-0637-5875-9BE4-EFD5750F6BA5\\",\\n \\"ReportTaskId\\": 123123,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"sh-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n}","type":"json"}]',
],
'ListReportDefinitions' => [
- 'summary' => '查看已订阅的报告列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Queries the list of subscribed reports.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4955,23 +4909,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The level-1 marketplace ID. If this parameter is left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
@@ -4982,178 +4925,173 @@
'type' => 'object',
'properties' => [
'ReportDefinitions' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ReportTaskId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123321',
- ],
- 'ReportSourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSS',
- ],
- 'ReportSourceName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSS',
- ],
- 'ReportType' => [
- 'title' => '账单存储类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BillingItemDetailForBillingPeriod',
- ],
- 'BeginBillingCycle' => [
- 'title' => '推送起始账期。订阅成功后,系统会自动推送起始账期到当前时间的数据。月账单PDF订阅时此参数无效,不会对历史数据重新推送。最多可推送最近1年内数据。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05',
- ],
- 'SubscribeCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05-21 10:36:31',
- ],
- 'OssBucketOwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567812345678',
- ],
- 'OssBucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss-bill',
- ],
- 'OssBucketPath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'bill/',
- ],
+ 'ReportTaskId' => ['description' => 'The bill subscription task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123321', 'title' => ''],
+ 'ReportSourceType' => ['description' => 'The subscription source. Valid values: OSS and MC.', 'type' => 'string', 'example' => 'OSS', 'title' => ''],
+ 'ReportSourceName' => ['description' => 'The subscription source name.', 'type' => 'string', 'example' => 'OSS', 'title' => ''],
+ 'ReportType' => ['title' => '', 'description' => 'The subscription type. Valid values:'."\n"
+ .'- BillingItemDetailForBillingPeriod: billable item consumption details.'."\n"
+ .'- InstanceDetailForBillingPeriod: instance consumption details.'."\n"
+ .'- BillingItemDetailMonthly: billable item consumption summary by billing cycle.', 'type' => 'string', 'example' => 'BillingItemDetailForBillingPeriod'],
+ 'BeginBillingCycle' => ['title' => '', 'description' => 'The start billing cycle for push. After the subscription is created, the system automatically pushes data from the start billing cycle to the current time. This parameter does not take effect for monthly bill PDF subscriptions, and historical data is not re-pushed. Data within the last year can be pushed.', 'type' => 'string', 'example' => '2025-05'],
+ 'SubscribeCreateTime' => ['description' => 'The time when the subscription was created.', 'type' => 'string', 'example' => '2025-05-21 10:36:31', 'title' => ''],
+ 'OssBucketOwnerAccountId' => ['description' => 'The UID of the OSS bucket owner that stores the files. Specify this parameter when a Bid/Reseller subscription needs to push data to the OSS bucket of a sub-account. The specified account must be a sub-account of the calling account and must be granted the AliyunConsumeDump2OSSRole permission. Regular users do not need to specify this parameter. The calling account is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567812345678', 'title' => ''],
+ 'OssBucketName' => ['description' => 'The name of the OSS bucket that stores the files.', 'type' => 'string', 'example' => 'oss-bill', 'title' => ''],
+ 'OssBucketPath' => ['description' => 'The storage path of the OSS bucket.', 'type' => 'string', 'example' => 'bill/', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidHistoricalNbid',
- 'errorMessage' => 'Historical field does not support subscription bill.',
- ],
+ ['errorCode' => 'InvalidHistoricalNbid', 'errorMessage' => 'Historical field does not support subscription bill.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportDefinitions\\": [\\n {\\n \\"ReportTaskId\\": 123321,\\n \\"ReportSourceType\\": \\"OSS\\",\\n \\"ReportSourceName\\": \\"OSS\\",\\n \\"ReportType\\": \\"BillingItemDetailForBillingPeriod\\",\\n \\"BeginBillingCycle\\": \\"2025-05\\",\\n \\"SubscribeCreateTime\\": \\"2025-05-21 10:36:31\\",\\n \\"OssBucketOwnerAccountId\\": 1234567812345678,\\n \\"OssBucketName\\": \\"oss-bill\\",\\n \\"OssBucketPath\\": \\"bill/\\"\\n }\\n ],\\n \\"Metadata\\": \\"\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
- ],
- 'DeleteReportDefinition' => [
- 'summary' => '取消账单订阅',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'View subscribed reports',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeOss',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyCostCenter' => [
+ 'summary' => 'Modify cost centers',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true],
'parameters' => [
[
- 'name' => 'ReportTaskId',
+ 'name' => 'CostCenterEntityList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The list of cost center entities.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CostCenterName' => ['title' => '', 'description' => 'The new name of the cost center. The name must be unique within the same account.', 'type' => 'string', 'required' => true, 'example' => '资源组'],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'The ID of the owner to which the cost center belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1314839403940987'],
+ 'CostCenterId' => ['title' => '', 'description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '485938'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => '123123',
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The level-1 marketplace ID. If this parameter is left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
- 'description' => '',
+ 'description' => 'BssApiListResult<CostCenterOperateDto>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n",
+ 'CostCenterOperateDto' => [
+ 'title' => '',
+ 'description' => 'The list of data entries.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'IsSuccess' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'True'],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'The ID of the owner to which the cost center belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1314839403940987'],
+ 'CostCenterId' => ['title' => '', 'description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '485938'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidHistoricalNbid',
- 'errorMessage' => 'Historical field does not support subscription bill.',
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotBelongToUser', 'errorMessage' => 'Cost unit is not belong to this user.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNameLengthExceed', 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNameExist', 'errorMessage' => 'The financial unit name already exists.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterOperateDto\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'title' => 'Modify cost centers',
+ 'description' => 'Modifies one or more cost centers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]',
],
- 'SaveCostCenterShareRule' => [
- 'summary' => '修改财务单元分摊规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ModifyCostCenterRule' => [
+ 'summary' => 'Modify financial unit rules',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5161,253 +5099,218 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OwnerAccountId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1977800748053695',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Owner of the financial unit (deprecated)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567812345678'],
],
[
- 'name' => 'CreateShareRuleList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ToCostCenterList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '583055',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'FromCostCenterList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '583053',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'ShareRatioList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.5',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'ShareRuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'ShareType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'AVERAGE' => '',
- 'CUSTOM' => '',
- 'RATIO' => '',
- ],
- 'example' => 'RATIO',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'name' => 'CostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Financial unit ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '485938'],
],
[
- 'name' => 'ModifyShareRuleList',
+ 'name' => 'FilterExpression',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ShareRuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1828',
- ],
- 'ToCostCenterList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Rule expression',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpressionType' => [
+ 'description' => 'Operation type',
+ 'enumValueTitles' => ['DIMENSION' => 'Leaf node filter type (used when code is not a tag)', 'TAG' => 'Leaf node filter type (used when code is a tag)', 'NARY' => 'Sub-condition relationship (used for non-leaf conditions)'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NARY',
+ 'title' => '',
+ ],
+ 'OperatorType' => [
+ 'description' => 'Relational expression',
+ 'enumValueTitles' => ['OR' => 'OR', 'AND' => 'AND'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AND',
+ 'title' => '',
+ ],
+ 'Operands' => [
+ 'description' => 'Condition expression',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition expression. **See the example for the overall structure (supports multi-level nesting). The following fields are for field description only.**', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' '."\n"
+ .' "Operands": ['."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "TAG-xxx",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "TAG"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_ID",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_NICK",'."\n"
+ .' "Values": ['."\n"
+ .' "111"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "RESOURCE_GROUP",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "ARTICLE",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "PRODUCT",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "OWNER",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Operand' => ['description' => 'Filter condition (deprecated)', 'type' => 'any', 'required' => false, 'example' => '无', 'title' => ''],
+ 'FilterValues' => [
+ 'description' => 'Sub-condition filter',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'Condition filter key',
+ 'enumValueTitles' => ['OWNER' => 'Account', 'ARTICLE' => 'Product detail', 'RESOURCE_GROUP' => 'Resource group', 'xxx (user-defined tag key)' => 'Business tag, based on user\'s actual configuration value', 'PRODUCT' => 'Product', 'INSTANCE_NICK' => 'Instance name', 'INSTANCE_ID' => 'Instance ID (billing granularity)'],
+ 'type' => 'string',
'required' => false,
- 'example' => '583056',
+ 'example' => 'TAG-test-xxx-key',
+ 'title' => '',
],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'FromCostCenterList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'CodeName' => ['description' => 'Condition filter key name (deprecated)', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
+ 'Values' => [
+ 'description' => 'Condition filter value list',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition filter value. Only one value can be entered for INSTANCE_NICK or INSTANCE_ID.', 'type' => 'string', 'required' => false, 'example' => '["TAG-test-xxx"]'."\n", 'title' => ''],
'required' => false,
- 'example' => '583052',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'ShareRatioList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
+ 'SelectType' => [
+ 'description' => 'Association between code and value',
+ 'enumValueTitles' => ['LIKE' => 'Used when Code is other cases', 'IN' => 'Used when Code is INSTANCE_NICK or INSTANCE_ID'],
+ 'type' => 'string',
'required' => false,
- 'example' => '0.2',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- 'ShareRuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'ShareType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'AVERAGE' => '',
- 'CUSTOM' => '',
- 'RATIO' => '',
+ 'example' => 'IN',
+ 'title' => '',
],
- 'example' => 'CUSTOM',
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'RemoveShareRuleList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1827',
],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Level-1 marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<CostCenterShareRuleSaveDto>',
- 'description' => 'BssApiPlainResult<CostCenterShareRuleSaveDto>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Long>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Data' => ['description' => 'Financial unit allocation rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '5632', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.RuleExpressionIllegal', 'errorMessage' => 'The auto-allocation rule configuration is invalid.', 'description' => ''],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotExist', 'errorMessage' => 'The financial unit does not exist or is invalid.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5632,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ 'title' => 'Modify financial unit auto-allocation rules',
+ 'description' => 'Modify one or more financial units',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'QueryCostCenterShareRule' => [
- 'summary' => '查询财务单元分摊规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryCostByCostCenter' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5415,800 +5318,661 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'OwnerAccountId',
+ 'name' => 'BillingMonth',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1529600453335198',
- ],
+ 'schema' => ['title' => '', 'description' => 'Billing month (format: YYYYMM)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '202506'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'GroupByCostCenterLevel',
'in' => 'query',
- 'schema' => [
- 'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nYCisJwqt18pP5E9yb47iu',
- ],
+ 'schema' => ['title' => '', 'description' => 'Whether to aggregate and display by cost center level', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'OwnerAccountId',
'in' => 'query',
- 'schema' => [
- 'title' => '单次查询的最大记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'Account ID that owns the resource', 'type' => 'integer', 'format' => 'int64', 'example' => '1374729705039203', 'required' => false],
],
[
- 'name' => 'EcIdAccountIds',
+ 'name' => 'Metrics',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1004064243473974',
- ],
- 'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1501603440974415',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['title' => '', 'description' => 'Cost type', 'type' => 'string', 'required' => true, 'example' => 'REQUIRE_AMOUNT'],
],
[
- 'name' => 'Nbid',
+ 'name' => 'DisplayZeroAmountBills',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Whether to display data rows with zero payable amount', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiTokenResult<CostCenterShareRuleDto>',
- 'description' => 'BssApiTokenResult<CostCenterShareRuleDto>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=',
- ],
- 'MaxResults' => [
- 'title' => '单次查询的最大记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Data' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
+ 'TotalAmount' => ['title' => '', 'description' => 'Sum of totalAllocatedAmount across all cost centers', 'type' => 'string', 'example' => '130296.64'],
+ 'ConsumeAmountList' => [
+ 'title' => '',
+ 'description' => 'Cost center consumption amount details list',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'OwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1529600453335198',
- ],
- 'ShareRuleId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1826',
- ],
- 'ShareRuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ShareRuleType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'AVERAGE' => '',
- 'CUSTOM' => '',
- 'RATIO' => '',
- ],
- 'example' => 'AVERAGE',
- ],
- 'FromCostCenterShareRuleDetails' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1529600453335198',
- ],
- 'RootCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '583050',
- ],
- 'CostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '637127',
- ],
- 'ParentCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '637537',
- ],
- 'PrevCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '583059',
- ],
- 'CostCenterCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '970354711219#',
- ],
- 'CostCenterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-07-16 13:49:59',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-07-16 13:49:59',
- 'title' => '',
- ],
- ],
- ],
- ],
- 'ToCostCenterShareRuleDetails' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1529600453335198',
- ],
- 'RootCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '583050',
- ],
- 'CostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '637127',
- ],
- 'ParentCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '637537',
- ],
- 'PrevCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '583055',
- ],
- 'CostCenterCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '970354711215#',
- ],
- 'CostCenterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ShareRatio' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.2',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-07-16 13:49:59',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-07-16 13:49:59',
- ],
- ],
- ],
- ],
- 'GmtModified' => [
- 'title' => '最近修改时间',
- 'type' => 'string',
- 'example' => '2026-01-01 00:00:00',
- ],
+ 'CostCenterId' => ['title' => '', 'description' => 'Cost center ID', 'type' => 'integer', 'format' => 'int64', 'example' => '530658'],
+ 'CostCenterName' => ['title' => '', 'description' => 'Cost center name', 'type' => 'string', 'example' => '项目组A'],
+ 'CostCenterCode' => ['title' => '', 'description' => 'Cost center code', 'type' => 'string', 'example' => '15945703968#'],
+ 'ParentCostCenterId' => ['description' => 'Parent cost center ID', 'type' => 'integer', 'format' => 'int64', 'example' => '637537', 'title' => ''],
+ 'PreCostCenterId' => ['description' => 'Previous cost center ID', 'type' => 'integer', 'format' => 'int64', 'example' => '6375371', 'title' => ''],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'Account ID that owns the resource', 'type' => 'integer', 'format' => 'int64', 'example' => '1857464601594004'],
+ 'OwnerAccountName' => ['title' => '', 'description' => 'Account name that owns the resource', 'type' => 'string', 'example' => '研发团队测试账号'],
+ 'Level' => ['title' => '', 'description' => 'Level', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalAllocatedAmount' => ['title' => '', 'description' => 'Total (sum of cost type amount and shared allocation amount)', 'type' => 'string', 'example' => '100'],
+ 'DirectAmount' => ['title' => '', 'description' => 'Cost type amount', 'type' => 'string', 'example' => '80'],
+ 'AllocatedAmount' => ['title' => '', 'description' => 'Shared allocation amount', 'type' => 'string', 'example' => '20'],
+ 'TotalAllocatedAmountPercent' => ['title' => '', 'description' => 'Cost type amount percentage', 'type' => 'string', 'example' => '0.01'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.ResourceAuthFailed',
- 'errorMessage' => 'The instance does not belong to the current user.',
+ ['errorCode' => 'AccountNoQueryPricePermission', 'errorMessage' => 'This page cannot be accessed because you do not have discount rights query permissions. Please contact the main account to go to the cost center for authorization. The permission point that needs authorization is queryprice.', '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.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified request lacks essential parameters.', 'description' => ''],
+ ['errorCode' => 'CostCenter.UnitNotBelongToUser', 'errorMessage' => 'Cost unit is not belong to this user.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Query cost center expense overview results',
+ 'summary' => 'Query cost center expense overview',
+ 'description' => 'Query cost center expense overview results for a specified billing period',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Data\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"ShareRuleId\\": 1826,\\n \\"ShareRuleName\\": \\"test\\",\\n \\"ShareRuleType\\": \\"AVERAGE\\",\\n \\"FromCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583059,\\n \\"CostCenterCode\\": \\"970354711219#\\",\\n \\"CostCenterName\\": \\"成本计划\\",\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"ToCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583055,\\n \\"CostCenterCode\\": \\"970354711215#\\",\\n \\"CostCenterName\\": \\"成本分摊\\",\\n \\"ShareRatio\\": 0.2,\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2026-01-01 00:00:00\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"TotalAmount\\": \\"130296.64\\",\\n \\"ConsumeAmountList\\": [\\n {\\n \\"CostCenterId\\": 530658,\\n \\"CostCenterName\\": \\"项目组A\\",\\n \\"CostCenterCode\\": \\"15945703968#\\",\\n \\"ParentCostCenterId\\": 637537,\\n \\"PreCostCenterId\\": 6375371,\\n \\"OwnerAccountId\\": 1857464601594004,\\n \\"OwnerAccountName\\": \\"研发团队测试账号\\",\\n \\"Level\\": 1,\\n \\"TotalAllocatedAmount\\": \\"100\\",\\n \\"DirectAmount\\": \\"80\\",\\n \\"AllocatedAmount\\": \\"20\\",\\n \\"TotalAllocatedAmountPercent\\": \\"0.01\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'CreateCostCenter' => [
- 'summary' => '创建财务单元',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryCostCenter' => [
+ 'summary' => 'Queries financial units.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CostCenterEntityList',
+ 'name' => 'OwnerAccountId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the user who owns the financial unit.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1314839403940987'],
+ ],
+ [
+ 'name' => 'ParentCostCenterId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the parent financial unit. A value of -1 indicates the root financial unit.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '-1'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '财务单元实体列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of enterprises and accounts. If this parameter is left empty, the current account is queried.',
'type' => 'array',
'items' => [
+ 'description' => 'The list of enterprises and accounts. If this parameter is left empty, the current account is queried.',
'type' => 'object',
'properties' => [
- 'CostCenterName' => [
- 'title' => '财务单元名称(同一个账号必须唯一)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'EcId' => ['title' => '', 'description' => 'The ID of the enterprise entity.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If this parameter is left empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the member accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1501603440974415', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
'example' => '',
],
- 'OwnerAccountId' => [
- 'title' => '新财务单元的属主用户 ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1314839403940987',
- ],
- 'ParentCostCenterId' => [
- 'title' => '父财务单元 ID,-1 表示财务单元根。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '-1',
- ],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
+ 'required' => false,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2084210001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the primary sales channel. If this parameter is left empty, the sales channel ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<CostCenterCreateDto>',
+ 'title' => '',
'description' => 'BssApiPageResult<CostCenterDto>',
'type' => 'object',
'properties' => [
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'CostCenterDtoList' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of financial unit data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'CostCenterName' => [
- 'title' => '财务单元名字(同一个账号必须唯一)',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1314839403940987',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '485938',
- ],
- 'ParentCostCenterId' => [
- 'title' => '父级财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- ],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'The ID of the user who owns the financial unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '1314839403940987'],
+ 'ParentCostCenterId' => ['title' => '', 'description' => 'The ID of the parent financial unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'],
+ 'CostCenterId' => ['title' => '', 'description' => 'The ID of the financial unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '485938'],
+ 'CostCenterName' => ['title' => '', 'description' => 'The name of the financial unit. The name must be unique within the same account.', 'type' => 'string', 'example' => '资源组'],
+ 'PrevCostCenterId' => ['title' => '', 'description' => 'The ID of the previous financial unit.', 'type' => 'integer', 'format' => 'int64', 'example' => '485996'],
+ 'CostCenterCode' => ['title' => '', 'description' => 'The code of the financial unit.', 'type' => 'string', 'example' => '15945703968#'],
+ 'Level' => ['title' => '', 'description' => 'The level of the financial unit node.', 'type' => 'integer', 'format' => 'int32', 'example' => 'loose'],
+ 'Priority' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response struct.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNameLengthExceed',
- 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotBelongToUser',
- 'errorMessage' => 'Cost unit is not belong to this user.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNameExist',
- 'errorMessage' => 'The financial unit name already exists.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNumberExceed',
- 'errorMessage' => 'The maximum number of financial units has been exceeded.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotExist',
- 'errorMessage' => 'The financial unit does not exist or is invalid.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitLevelExceed',
- 'errorMessage' => 'The depth of the financial unit exceeds the maximum hierarchy level.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The specified request lacks essential parameters.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterDtoList\\": [\\n {\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\"\\n}","type":"json"}]',
- ],
- 'ModifyCostCenter' => [
- 'summary' => '修改财务单元',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query financial units',
+ 'description' => 'Queries a parent financial unit and its child financial units.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"CostCenterDtoList\\": [\\n {\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"ParentCostCenterId\\": -1,\\n \\"CostCenterId\\": 485938,\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"PrevCostCenterId\\": 485996,\\n \\"CostCenterCode\\": \\"15945703968#\\",\\n \\"Level\\": 0,\\n \\"Priority\\": 0\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
+ ],
+ 'QueryCostCenterResource' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CostCenterEntityList',
+ 'name' => 'OwnerAccountId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The owner user ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567812345678', 'title' => ''],
+ ],
+ [
+ 'name' => 'CostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
'in' => 'query',
- 'style' => 'json',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '', 'description' => 'The token for the next query. An empty NextToken indicates that there are no more results.', 'type' => 'string', 'required' => false, 'example' => 'CAESEgoQCg4KCmd'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['title' => '', 'description' => 'The maximum number of records per query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'],
+ ],
+ [
+ 'name' => 'EcIdAccountIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '财务单元实体列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of enterprises and accounts. An empty value indicates querying the current account.',
'type' => 'array',
'items' => [
+ 'description' => 'The list of enterprises and accounts.',
'type' => 'object',
'properties' => [
- 'CostCenterName' => [
- 'title' => '财务单元的新名字(同一个账号必须唯一)',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1501603440974415'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accessed accounts. An empty value indicates that all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1501603440974415', 'required' => false, 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
'example' => '',
],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1314839403940987',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '485938',
- ],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The first-level marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiListResult<CostCenterOperateDto>',
- 'description' => 'BssApiListResult<CostCenterOperateDto>',
+ 'title' => '',
+ 'description' => 'BssApiTokenResult<CostCenterResourceDto>',
'type' => 'object',
'properties' => [
- 'CostCenterOperateDto' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'NextToken' => ['title' => '', 'description' => 'The token for the next query. An empty NextToken indicates that there are no more results.', 'type' => 'string', 'required' => true, 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9'],
+ 'MaxResults' => ['title' => '', 'description' => 'The maximum number of records per query.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
+ 'CostCenterResourceDtoList' => [
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
+ 'description' => 'The detailed data.',
'type' => 'object',
'properties' => [
- 'IsSuccess' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1314839403940987',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '485938',
- ],
+ 'OwnerAccountId' => ['description' => 'The customer ID to which the cost center belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567812345678', 'title' => ''],
+ 'OwnerAccountName' => ['description' => 'The customer name to which the cost center belongs.', 'type' => 'string', 'example' => '客户A', 'title' => ''],
+ 'ResourceUserId' => ['description' => 'The owner user ID of the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567812345678', 'title' => ''],
+ 'ResourceUserName' => ['description' => 'The owner username of the resource.', 'type' => 'string', 'example' => 'test@test.aliyun.com'."\n", 'title' => ''],
+ 'RootCostCenterId' => ['description' => 'The root cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'CostCenterId' => ['description' => 'The cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'ParentCostCenterId' => ['description' => 'The parent cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'CostCenterCode' => ['description' => 'The cost center code.', 'type' => 'string', 'example' => 'code', 'title' => ''],
+ 'CostCenterName' => ['description' => 'The cost center name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'CostCenterCreateTime' => ['description' => 'The creation time of the cost center.', 'type' => 'string', 'example' => '2025-05-18 12:12:25', 'title' => ''],
+ 'CostCenterUpdateTime' => ['description' => 'The last update time of the cost center.', 'type' => 'string', 'example' => '2025-05-18 16:12:25', 'title' => ''],
+ 'ResourceUpdateTime' => ['description' => 'The last update time of the cost center. This is a reserved field and is currently unavailable.', 'type' => 'string', 'example' => '2025-05-18 16:12:25'."\n", 'title' => ''],
+ 'PipCode' => ['description' => 'The product code, which is the same as the product code in Cost Center bills.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
+ 'PipName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '云数据库', 'title' => ''],
+ 'CommodityCode' => ['description' => 'The commodity code of the resource.', 'type' => 'string', 'example' => 'otsbag', 'title' => ''],
+ 'CommodityName' => ['description' => 'The commodity name of the resource.', 'type' => 'string', 'example' => '云数据库', 'title' => ''],
+ 'ApportionItemCode' => ['description' => 'The apportionment item code of the resource.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ApportionItemName' => ['description' => 'The apportionment item name of the resource.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'OSSBAG-cn-v0h1s4hma018'."\n", 'title' => ''],
+ 'InstanceId' => ['description' => 'The billing granularity ID.', 'type' => 'string', 'example' => 'cn-hangzhou;standard', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'FPT_ossbag_absolute_Storage_bj', 'title' => ''],
+ 'ResourceTag' => ['description' => 'The tag of the resource.', 'type' => 'string', 'example' => 'tag', 'title' => ''],
+ 'ResourceNick' => ['description' => 'The custom alias of the resource.', 'type' => 'string', 'example' => 'testResource', 'title' => ''],
+ 'ResourceGroup' => ['description' => 'The resource group to which the resource belongs.', 'type' => 'string', 'example' => '默认资源组'."\n", 'title' => ''],
+ 'ResourceSource' => ['description' => 'The resource source. Valid values:'."\n"
+ .'- AUTO_ALLOCATE: automatically allocated.'."\n"
+ .'- MANUAL_ALLOCATE: manually allocated.', 'type' => 'string', 'example' => 'MANUAL_ALLOCATE', 'title' => ''],
+ 'RegionNo' => ['type' => 'string', 'example' => 'cn-shanghai', 'description' => '', 'title' => ''],
+ 'RegionName' => ['type' => 'string', 'example' => '上海', 'description' => '', 'title' => ''],
+ 'RecentBillingMonth' => ['type' => 'integer', 'format' => 'int64', 'example' => '202509', 'description' => '', 'title' => ''],
+ 'FinanceUnitRuleVersion' => ['type' => 'integer', 'format' => 'int64', 'example' => '3', 'description' => '', 'title' => ''],
+ 'StartBillingMonth' => ['type' => 'integer', 'format' => 'int64', 'example' => '202509', 'description' => '', 'title' => ''],
+ 'ApplicablePeriodNum' => ['type' => 'integer', 'format' => 'int64', 'example' => '3', 'description' => '', 'title' => ''],
+ 'AddStrategy' => ['type' => 'string', 'example' => 'AUTO_ALLOCATE', 'description' => '', 'title' => ''],
+ 'AddStrategyName' => ['type' => 'string', 'example' => '自动分配', 'description' => '', 'title' => ''],
+ 'MasterCommodityCode' => ['type' => 'string', 'example' => 'ecs', 'description' => '', 'title' => ''],
+ 'MasterInstanceId' => ['type' => 'string', 'example' => 'i-xxxxx', 'description' => '', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response structure.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The specified request lacks essential parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotBelongToUser',
- 'errorMessage' => 'Cost unit is not belong to this user.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNameLengthExceed',
- 'errorMessage' => 'The length of the financial unit name exceeds the maximum limit.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNameExist',
- 'errorMessage' => 'The financial unit name already exists.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.ResourceAuthFailed', 'errorMessage' => 'The instance does not belong to the current user.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query resources of a cost center',
+ 'summary' => 'Queries the list of resource instances that belong to a cost center of the user. When CostCenterId is 0, it queries unallocated primary and sub-resource instances.',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-22T05:47:39.000Z', 'description' => 'Response parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CostCenterOperateDto\\": [\\n {\\n \\"IsSuccess\\": true,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
- ],
- 'DeleteCostCenter' => [
- 'summary' => '删除财务单元',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"MaxResults\\": 200,\\n \\"TotalCount\\": 2000,\\n \\"CostCenterResourceDtoList\\": [\\n {\\n \\"OwnerAccountId\\": 1234567812345678,\\n \\"OwnerAccountName\\": \\"客户A\\",\\n \\"ResourceUserId\\": 1234567812345678,\\n \\"ResourceUserName\\": \\"test@test.aliyun.com\\\\n\\",\\n \\"RootCostCenterId\\": -1,\\n \\"CostCenterId\\": 123456,\\n \\"ParentCostCenterId\\": 123456,\\n \\"CostCenterCode\\": \\"code\\",\\n \\"CostCenterName\\": \\"test\\",\\n \\"CostCenterCreateTime\\": \\"2025-05-18 12:12:25\\",\\n \\"CostCenterUpdateTime\\": \\"2025-05-18 16:12:25\\",\\n \\"ResourceUpdateTime\\": \\"2025-05-18 16:12:25\\\\n\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PipName\\": \\"云数据库\\",\\n \\"CommodityCode\\": \\"otsbag\\",\\n \\"CommodityName\\": \\"云数据库\\",\\n \\"ApportionItemCode\\": \\"test\\",\\n \\"ApportionItemName\\": \\"test\\",\\n \\"ResourceId\\": \\"OSSBAG-cn-v0h1s4hma018\\\\n\\",\\n \\"InstanceId\\": \\"cn-hangzhou;standard\\",\\n \\"ResourceType\\": \\"FPT_ossbag_absolute_Storage_bj\\",\\n \\"ResourceTag\\": \\"tag\\",\\n \\"ResourceNick\\": \\"testResource\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\n\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"RegionName\\": \\"上海\\",\\n \\"RecentBillingMonth\\": 202509,\\n \\"FinanceUnitRuleVersion\\": 3,\\n \\"StartBillingMonth\\": 202509,\\n \\"ApplicablePeriodNum\\": 3,\\n \\"AddStrategy\\": \\"AUTO_ALLOCATE\\",\\n \\"AddStrategyName\\": \\"自动分配\\",\\n \\"MasterCommodityCode\\": \\"ecs\\",\\n \\"MasterInstanceId\\": \\"i-xxxxx\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
+ ],
+ 'QueryCostCenterRule' => [
+ 'summary' => 'Query cost center rules',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'OwnerAccountId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1314839403940987',
- ],
+ 'name' => 'CostCenterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '597745', 'title' => ''],
],
[
- 'name' => 'CostCenterId',
+ 'name' => 'EcIdAccountIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '485938',
+ 'title' => '',
+ 'description' => 'List of enterprises and accounts. If empty, queries the current account itself.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'List of enterprises and accounts. If empty, queries the current account itself.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'List of accounts to access. If empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1990699401005016', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
+ ],
+ 'EcId' => ['title' => '', 'description' => 'Enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<CostCenterOperateDto>',
- 'description' => 'BssApiPlainResult<CostCenterOperateDto>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<CostCenterRuleDto>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C1BD134E-D914-6AE0-1901-AEB2A99FA205',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1314839403940987',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '485938',
- ],
- 'IsSuccess' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'UUID', 'title' => ''],
+ 'OwnerAccountId' => ['title' => '', 'description' => 'The owner user of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '1977800748053695'],
+ 'RootCostCenterId' => ['title' => '', 'description' => 'The root cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'CostCenterId' => ['title' => '', 'description' => 'The cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '597745'],
+ 'Id' => ['description' => 'The ID of the cost center auto-allocation rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '32048', 'title' => ''],
+ 'FilterExpression' => [
+ 'description' => 'The rule expression.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExpressionType' => [
+ 'description' => 'The operation type.',
+ 'enumValueTitles' => ['DIMENSION' => 'Leaf node filter type (used when code is not a tag)', 'TAG' => 'Leaf node filter type (used when code is a tag)', 'NARY' => 'Sub-condition relationship (used for non-leaf conditions)'],
+ 'type' => 'string',
+ 'example' => 'NARY',
+ 'title' => '',
+ ],
+ 'OperatorType' => [
+ 'description' => 'The relational expression.',
+ 'enumValueTitles' => ['OR' => 'OR', 'AND' => 'AND'],
+ 'type' => 'string',
+ 'example' => 'AND',
+ 'title' => '',
+ ],
+ 'Operands' => [
+ 'description' => 'The condition expression.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The condition expression. See the example for the overall structure (supports multi-level nesting). The following fields are field descriptions only.', 'type' => 'any', 'example' => '{'."\n"
+ .' '."\n"
+ .' "Operands": ['."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "TAG-xxx",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "TAG"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_ID",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "INSTANCE_NICK",'."\n"
+ .' "Values": ['."\n"
+ .' "111"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "LIKE"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "RESOURCE_GROUP",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "ARTICLE",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "PRODUCT",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "FilterValues": {'."\n"
+ .' "Code": "OWNER",'."\n"
+ .' "Values": ['."\n"
+ .' "xxxxx"'."\n"
+ .' ],'."\n"
+ .' "SelectType": "IN"'."\n"
+ .' },'."\n"
+ .' "ExpressionType": "DIMENSION"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Operand' => ['description' => 'The filter condition (deprecated).', 'type' => 'any', 'example' => '无', 'title' => ''],
+ 'FilterValues' => [
+ 'description' => 'The sub-condition filter.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => 'The condition filter key.',
+ 'enumValueTitles' => ['OWNER' => 'Account', 'ARTICLE' => 'Product details', 'RESOURCE_GROUP' => 'Resource group', 'xxx (user-defined tag key)' => 'Business tag, based on the user\'s actual configured value', 'PRODUCT' => 'Product', 'INSTANCE_NICK' => 'Instance name', 'INSTANCE_ID' => 'Instance ID (billing granularity)'],
+ 'type' => 'string',
+ 'example' => 'TAG-test-xxx-key'."\n",
+ 'title' => '',
+ ],
+ 'CodeName' => ['description' => 'The condition filter key name (deprecated).', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'Values' => [
+ 'description' => 'The attribute value types corresponding to the module code. Valid values:'."\n"
+ .'- single_float: single value type.'."\n"
+ .'- range_float: range value type.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The condition filter value. Only one value can be entered for INSTANCE_NICK or INSTANCE_ID.', 'type' => 'string', 'example' => '["TAG-test-xxx"]'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SelectType' => [
+ 'description' => 'The association between code and value.',
+ 'enumValueTitles' => ['LIKE' => 'Used in other cases for Code', 'IN' => 'Used when Code is INSTANCE_NICK or INSTANCE_ID'],
+ 'type' => 'string',
+ 'example' => 'IN',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Status' => ['description' => 'The status. Valid values:'."\n"
+ .'- on: active.'."\n"
+ .'- off: inactive.', 'type' => 'string', 'example' => 'on', 'title' => ''],
+ 'IsDeleted' => ['description' => 'The deletion status. Valid values:'."\n"
+ .'* **0**: active.'."\n"
+ .'* **1**: inactive.', 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => 'Tue Nov 12 14:49:43 CST 2024', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => 'Wed Oct 16 10:15:37 CST 2024', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.DeleteWithShareRule',
- 'errorMessage' => 'This financial unit involves splitting expense rules. Please adjust relevant rules before deleting the financial unit.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotExist',
- 'errorMessage' => 'The financial unit does not exist or is invalid.',
- ],
- [
- 'errorCode' => 'CostCenter.DeleteWithSubUnitOrResource',
- 'errorMessage' => 'Financial units with sub-units, allocated resources, or auto-allocation rules cannot be deleted.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1977800748053695,\\n \\"RootCostCenterId\\": 0,\\n \\"CostCenterId\\": 597745,\\n \\"Id\\": 32048,\\n \\"FilterExpression\\": {\\n \\"ExpressionType\\": \\"NARY\\",\\n \\"OperatorType\\": \\"AND\\",\\n \\"Operands\\": [\\n \\"{\\\\n \\\\n \\\\\\"Operands\\\\\\": [\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"TAG-xxx\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"TAG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_ID\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_NICK\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"111\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"RESOURCE_GROUP\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"ARTICLE\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"PRODUCT\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"OWNER\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n ],\\n \\"Operand\\": \\"无\\",\\n \\"FilterValues\\": {\\n \\"Code\\": \\"TAG-test-xxx-key\\\\n\\",\\n \\"CodeName\\": \\"无\\",\\n \\"Values\\": [\\n \\"[\\\\\\"TAG-test-xxx\\\\\\"]\\\\n\\"\\n ],\\n \\"SelectType\\": \\"IN\\"\\n }\\n },\\n \\"Status\\": \\"on\\",\\n \\"IsDeleted\\": 0,\\n \\"GmtCreate\\": \\"Tue Nov 12 14:49:43 CST 2024\\",\\n \\"GmtModified\\": \\"Wed Oct 16 10:15:37 CST 2024\\"\\n}","type":"json"}]',
+ 'title' => 'Query cost center auto-allocation rules',
+ 'description' => 'Query parent cost center and its child cost centers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"C1BD134E-D914-6AE0-1901-AEB2A99FA205\\",\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"IsSuccess\\": true\\n}","type":"json"}]',
],
- 'QueryCostCenter' => [
- 'summary' => '查询财务单元',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryCostCenterShareRule' => [
+ 'summary' => 'Query cost center sharing rules',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6216,233 +5980,182 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OwnerAccountId',
'in' => 'query',
- 'schema' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1314839403940987',
- ],
+ 'schema' => ['description' => 'The owner account ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1529600453335198', 'title' => ''],
],
[
- 'name' => 'ParentCostCenterId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '父财务单元 ID,-1 表示财务单元根。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '-1',
- ],
- ],
- [
- 'name' => 'CurrentPage',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'Reserved field.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nYCisJwqt18pP5E9yb47iu'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'Reserved field.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'EcIdAccountIds',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of enterprises and accounts. If empty, the current account is queried.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list information.',
'type' => 'object',
'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => true, 'example' => '1004064243473974'],
'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If empty, all accounts under the current entity ID are selected.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1501603440974415',
- ],
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1501603440974415', 'title' => ''],
'required' => false,
'maxItems' => 100,
- ],
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1004064243473974',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPageResult<CostCenterDto>',
- 'description' => 'BssApiPageResult<CostCenterDto>',
+ 'title' => '',
+ 'description' => 'BssApiTokenResult<CostCenterShareRuleDto>',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'CostCenterDtoList' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'NextToken' => ['title' => '', 'description' => 'Reserved field.', 'type' => 'string', 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0='],
+ 'MaxResults' => ['title' => '', 'description' => 'Reserved field.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The returned data list.',
'type' => 'array',
'items' => [
+ 'description' => 'The object information.',
'type' => 'object',
'properties' => [
- 'PrevCostCenterId' => [
- 'title' => '前序财务单元 ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '485996',
- ],
- 'CostCenterName' => [
- 'title' => '财务单元名字(同一个账号必须唯一)',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CostCenterCode' => [
- 'title' => '财务单元CODE',
- 'description' => '',
+ 'OwnerAccountId' => ['description' => 'The owner account ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '1529600453335198', 'title' => ''],
+ 'ShareRuleId' => ['description' => 'The sharing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1826', 'title' => ''],
+ 'ShareRuleName' => ['description' => 'The sharing rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ShareRuleType' => [
+ 'description' => 'The sharing rule type.',
+ 'enumValueTitles' => ['AVERAGE' => 'Split evenly', 'CUSTOM' => 'Custom split ratio', 'RATIO' => 'Split by ratio'],
'type' => 'string',
- 'example' => '15945703968#',
- ],
- 'Level' => [
- 'title' => '财务单元节点级数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'loose',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1314839403940987',
+ 'example' => 'AVERAGE',
+ 'title' => '',
],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '485938',
+ 'FromCostCenterShareRuleDetails' => [
+ 'description' => 'The source cost center rule details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OwnerAccountId' => ['description' => 'The owner account ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '1529600453335198', 'title' => ''],
+ 'RootCostCenterId' => ['description' => 'The root cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '583050', 'title' => ''],
+ 'CostCenterId' => ['description' => 'The cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '637127', 'title' => ''],
+ 'ParentCostCenterId' => ['description' => 'The parent cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '637537', 'title' => ''],
+ 'PrevCostCenterId' => ['description' => 'The previous cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '583059', 'title' => ''],
+ 'CostCenterCode' => ['description' => 'The cost center code.', 'type' => 'string', 'example' => '970354711219#', 'title' => ''],
+ 'CostCenterName' => ['description' => 'The cost center name.', 'type' => 'string', 'example' => '成本计划', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-07-16 13:49:59', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => '2025-07-16 13:49:59'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'ParentCostCenterId' => [
- 'title' => '父级财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
+ 'ToCostCenterShareRuleDetails' => [
+ 'description' => 'The target cost center rule details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OwnerAccountId' => ['description' => 'The owner account ID of the cost center.', 'type' => 'integer', 'format' => 'int64', 'example' => '1529600453335198', 'title' => ''],
+ 'RootCostCenterId' => ['description' => 'The root cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '583050', 'title' => ''],
+ 'CostCenterId' => ['description' => 'The cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '637127', 'title' => ''],
+ 'ParentCostCenterId' => ['description' => 'The parent cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '637537', 'title' => ''],
+ 'PrevCostCenterId' => ['description' => 'The previous cost center ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '583055', 'title' => ''],
+ 'CostCenterCode' => ['description' => 'The cost center code.', 'type' => 'string', 'example' => '970354711215#', 'title' => ''],
+ 'CostCenterName' => ['description' => 'The cost center name.', 'type' => 'string', 'example' => '成本分摊', 'title' => ''],
+ 'ShareRatio' => ['description' => 'The sharing ratio.', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-07-16 13:49:59', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2025-07-16 13:49:59', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'GmtModified' => ['title' => '', 'type' => 'string', 'example' => '2026-01-01 00:00:00', 'description' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
+ ['errorCode' => 'CostCenter.ResourceAuthFailed', 'errorMessage' => 'The instance does not belong to the current user.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query cost center sharing rules',
+ 'description' => 'Queries the sharing rules of user cost centers.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"CostCenterDtoList\\": [\\n {\\n \\"PrevCostCenterId\\": 485996,\\n \\"CostCenterName\\": \\"资源组\\",\\n \\"CostCenterCode\\": \\"15945703968#\\",\\n \\"Level\\": 0,\\n \\"OwnerAccountId\\": 1314839403940987,\\n \\"CostCenterId\\": 485938,\\n \\"ParentCostCenterId\\": -1\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6NH0=\\",\\n \\"MaxResults\\": 20,\\n \\"TotalCount\\": 20,\\n \\"Data\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"ShareRuleId\\": 1826,\\n \\"ShareRuleName\\": \\"test\\",\\n \\"ShareRuleType\\": \\"AVERAGE\\",\\n \\"FromCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583059,\\n \\"CostCenterCode\\": \\"970354711219#\\",\\n \\"CostCenterName\\": \\"成本计划\\",\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"ToCostCenterShareRuleDetails\\": [\\n {\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"RootCostCenterId\\": 583050,\\n \\"CostCenterId\\": 637127,\\n \\"ParentCostCenterId\\": 637537,\\n \\"PrevCostCenterId\\": 583055,\\n \\"CostCenterCode\\": \\"970354711215#\\",\\n \\"CostCenterName\\": \\"成本分摊\\",\\n \\"ShareRatio\\": 0.2,\\n \\"GmtCreate\\": \\"2025-07-16 13:49:59\\",\\n \\"GmtModified\\": \\"2025-07-16 13:49:59\\"\\n }\\n ],\\n \\"GmtModified\\": \\"2026-01-01 00:00:00\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
],
- 'QueryCostCenterResource' => [
- 'summary' => '查询财务单元下资源信息',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryMonthlySlaList' => [
+ 'summary' => 'Queries the SLA compensation list of a user.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6450,389 +6163,191 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OwnerAccountId',
+ 'name' => 'Months',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Optional. Month list in yyyyMM format.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The month in yyyyMM format. Only the last two months are supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '202603', 'title' => ''],
'required' => false,
- 'example' => '1234567812345678',
- 'title' => '账号ID',
+ 'example' => '[202602,202603]',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'CostCenterId',
+ 'name' => 'ProductCodes',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Optional. Filter by product code.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The cloud product code.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''],
'required' => false,
- 'example' => '123456',
- 'title' => '成本中心ID',
+ 'example' => '["ecs","oss"]',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'allowEmptyValue' => true,
+ 'name' => 'InstanceIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Optional. Filter by instance ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance ID. Separate multiple IDs with commas. A maximum of 100 IDs are supported.', 'type' => 'string', 'required' => false, 'example' => 'rm-xxxxxxxxxxxx', 'title' => ''],
'required' => false,
- 'example' => 'CAESEgoQCg4KCmd',
+ 'example' => '["instance_1","instance_2"]',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'allowEmptyValue' => true,
+ 'name' => 'PayStatuses',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '单次查询的最大记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'Optional. Filter by compensation status. Valid values: 0 and 1.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The compensation status. Valid values: 0 (uncompensated) and 1 (compensated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
- 'example' => '200',
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number. Default value: 1, which indicates the first page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
+ ],
+ [
'name' => 'EcIdAccountIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of enterprise entities and accounts. If this parameter is left empty, the current account is queried.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list of enterprise entities and accounts. If this parameter is left empty, the current account is queried.',
'type' => 'object',
'properties' => [
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1501603440974415',
- ],
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1501603440974415'],
'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The list of accounts to query. If this parameter is left empty, all accounts under the current entity ID are selected.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1501603440974415',
- 'title' => '账号id',
- ],
+ 'items' => ['description' => 'The member account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1501603440974415', 'required' => false, 'title' => ''],
'required' => false,
'maxItems' => 100,
+ 'example' => '',
],
],
'required' => false,
- 'title' => '账号信息',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'The level-1 marketplace ID. If this parameter is left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'example' => '2684201000001', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
- 'description' => 'BssApiTokenResult<CostCenterResourceDto>',
+ 'description' => 'BssApiPageResult<MonthlySlaInfoDTO>',
'type' => 'object',
'properties' => [
- 'NextToken' => [
- 'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9',
- ],
- 'MaxResults' => [
- 'title' => '单次查询的最大记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2000',
- ],
- 'CostCenterResourceDtoList' => [
- 'title' => '数据列表',
- 'description' => '',
+ 'CurrentPage' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The data list.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'OwnerAccountId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567812345678',
- 'title' => '资源归属账号id',
- ],
- 'OwnerAccountName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX公司',
- 'title' => '资源归属账号名称',
- ],
- 'ResourceUserId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567812345678',
- 'title' => '分配资源账号id',
- ],
- 'ResourceUserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test@test.aliyun.com'."\n",
- 'title' => '分配资源账号名称',
- ],
- 'RootCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '-1',
- 'title' => '财务单元根节点id',
- ],
- 'CostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- 'title' => '财务单元id',
- ],
- 'ParentCostCenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- 'title' => '财务单元上级节点id',
- ],
- 'CostCenterCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'code',
- 'title' => '财务单元code',
- ],
- 'CostCenterName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- 'title' => '财务单元名称',
- ],
- 'CostCenterCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05-18 12:12:25',
- 'title' => '财务单元创建时间',
- ],
- 'CostCenterUpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05-18 16:12:25',
- 'title' => '财务单元修改时间',
- ],
- 'ResourceUpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025-05-18 16:12:25'."\n",
- ],
- 'PipCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'PipName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CommodityCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'otsbag',
- ],
- 'CommodityName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ApportionItemCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ApportionItemName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OSSBAG-cn-v0h1s4hma018'."\n",
- ],
- 'InstanceId' => [
- 'type' => 'string',
- ],
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FPT_ossbag_absolute_Storage_bj',
- ],
- 'ResourceTag' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'tag',
- ],
- 'ResourceNick' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testResource',
- ],
- 'ResourceGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ResourceSource' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MANUAL_ALLOCATE',
- 'title' => '资源来源',
- ],
- 'RegionNo' => [
- 'title' => '地域',
- 'type' => 'string',
- 'example' => 'cn-shanghai',
- ],
- 'RegionName' => [
- 'title' => '地域名称',
- 'type' => 'string',
- 'example' => '上海',
- ],
- 'RecentBillingMonth' => [
- 'title' => '最近出账账期',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202509',
- ],
- 'FinanceUnitRuleVersion' => [
- 'title' => '规则版本',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'StartBillingMonth' => [
- 'title' => '规则生效账期',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202509',
- ],
- 'ApplicablePeriodNum' => [
- 'title' => '刷新账期数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'AddStrategy' => [
- 'title' => '添加策略',
- 'type' => 'string',
- 'example' => 'AUTO_ALLOCATE',
- ],
- 'AddStrategyName' => [
- 'title' => '添加策略名称',
- 'type' => 'string',
- 'example' => '自动分配',
- ],
- 'MasterCommodityCode' => [
- 'title' => '关联商品code',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'MasterInstanceId' => [
- 'title' => '关联实例ID',
- 'type' => 'string',
- 'example' => 'i-xxxxx',
- ],
+ 'Month' => ['title' => '', 'description' => 'The month in yyyyMM format.', 'type' => 'integer', 'format' => 'int32', 'example' => '202603'],
+ 'DamagedId' => ['title' => '', 'description' => 'The unique identifier of the damage record, which is used for targeted compensation application.', 'type' => 'string', 'example' => '9b7***9413'],
+ 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'oss'],
+ 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'OSSBAG-cn-0xl0n****003'],
+ 'AvailableRate' => ['title' => '', 'description' => 'The service availability.', 'type' => 'number', 'format' => 'double', 'example' => '99.9155'],
+ 'PayRate' => ['title' => '', 'description' => 'The compensation ratio. Unit: %.', 'type' => 'number', 'format' => 'double', 'example' => '10'],
+ 'MonthlyServiceCharge' => ['title' => '', 'description' => 'The monthly service charge.', 'type' => 'number', 'format' => 'double', 'example' => '365.00'],
+ 'ShouldPaySum' => ['title' => '', 'description' => 'The compensation amount.', 'type' => 'number', 'format' => 'double', 'example' => '36.5'],
+ 'PayStatus' => ['title' => '', 'description' => 'The compensation status. Valid values: 0 (uncompensated) and 1 (compensated).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PayDescription' => ['title' => '', 'description' => 'The compensation description.', 'type' => 'string', 'example' => 'SLA赔付'],
],
'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.ResourceAuthFailed',
- 'errorMessage' => 'The instance does not belong to the current user.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9\\",\\n \\"MaxResults\\": 200,\\n \\"TotalCount\\": 2000,\\n \\"CostCenterResourceDtoList\\": [\\n {\\n \\"OwnerAccountId\\": 1234567812345678,\\n \\"OwnerAccountName\\": \\"客户A\\",\\n \\"ResourceUserId\\": 1234567812345678,\\n \\"ResourceUserName\\": \\"test@test.aliyun.com\\\\n\\",\\n \\"RootCostCenterId\\": -1,\\n \\"CostCenterId\\": 123456,\\n \\"ParentCostCenterId\\": 123456,\\n \\"CostCenterCode\\": \\"code\\",\\n \\"CostCenterName\\": \\"test\\",\\n \\"CostCenterCreateTime\\": \\"2025-05-18 12:12:25\\",\\n \\"CostCenterUpdateTime\\": \\"2025-05-18 16:12:25\\",\\n \\"ResourceUpdateTime\\": \\"2025-05-18 16:12:25\\\\n\\",\\n \\"PipCode\\": \\"rds\\",\\n \\"PipName\\": \\"云数据库\\",\\n \\"CommodityCode\\": \\"otsbag\\",\\n \\"CommodityName\\": \\"云数据库\\",\\n \\"ApportionItemCode\\": \\"test\\",\\n \\"ApportionItemName\\": \\"test\\",\\n \\"ResourceId\\": \\"OSSBAG-cn-v0h1s4hma018\\\\n\\",\\n \\"InstanceId\\": \\"cn-hangzhou;standard\\",\\n \\"ResourceType\\": \\"FPT_ossbag_absolute_Storage_bj\\",\\n \\"ResourceTag\\": \\"tag\\",\\n \\"ResourceNick\\": \\"testResource\\",\\n \\"ResourceGroup\\": \\"默认资源组\\\\n\\",\\n \\"ResourceSource\\": \\"MANUAL_ALLOCATE\\",\\n \\"RegionNo\\": \\"cn-shanghai\\",\\n \\"RegionName\\": \\"上海\\",\\n \\"RecentBillingMonth\\": 202509,\\n \\"FinanceUnitRuleVersion\\": 3,\\n \\"StartBillingMonth\\": 202509,\\n \\"ApplicablePeriodNum\\": 3,\\n \\"AddStrategy\\": \\"AUTO_ALLOCATE\\",\\n \\"AddStrategyName\\": \\"自动分配\\",\\n \\"MasterCommodityCode\\": \\"ecs\\",\\n \\"MasterInstanceId\\": \\"i-xxxxx\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
- ],
- 'CreateCostCenterRule' => [
- 'summary' => '新建财务单元规则',
- 'methods' => [
- 'post',
+ 'title' => 'Query SLA Compensation',
+ 'description' => 'Queries the SLA compensation details list of a user. Only data from the last two months is available.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bssapi:QueryMonthlySlaList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"Data\\": [\\n {\\n \\"Month\\": 202603,\\n \\"DamagedId\\": \\"9b7***9413\\",\\n \\"ProductCode\\": \\"oss\\",\\n \\"InstanceId\\": \\"OSSBAG-cn-0xl0n****003\\",\\n \\"AvailableRate\\": 99.9155,\\n \\"PayRate\\": 10,\\n \\"MonthlyServiceCharge\\": 365,\\n \\"ShouldPaySum\\": 36.5,\\n \\"PayStatus\\": 1,\\n \\"PayDescription\\": \\"SLA赔付\\"\\n }\\n ],\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
+ ],
+ 'ReceiveUserConfirm' => [
+ 'parameters' => [],
+ 'responses' => [],
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'SaveCostCenterShareRule' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6840,268 +6355,193 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CostCenterId',
- 'in' => 'formData',
+ 'name' => 'OwnerAccountId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The user ID of the cost center owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1977800748053695', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateShareRuleList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The list of sharing rules to create.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ShareRuleName' => ['description' => 'The name of the sharing rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'ShareType' => [
+ 'description' => 'The type of the sharing rule.',
+ 'enumValueTitles' => ['AVERAGE' => 'Split equally', 'CUSTOM' => 'Custom split ratio', 'RATIO' => 'Split by ratio'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'RATIO',
+ 'title' => '',
+ ],
+ 'FromCostCenterList' => [
+ 'description' => 'The list of source cost centers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The source cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '583053', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 300,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ToCostCenterList' => [
+ 'description' => 'The list of target cost centers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The target cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '583055', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 300,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ShareRatioList' => [
+ 'description' => 'The list of sharing ratios.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The sharing ratio.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '485938',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'FilterExpression',
+ 'name' => 'ModifyShareRuleList',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '规则表达式',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ExpressionType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DIMENSION' => '',
- 'TAG' => '',
- 'NARY' => '',
+ 'description' => 'The list of sharing rules to modify.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ShareRuleId' => ['description' => 'The ID of the sharing rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1828', 'title' => ''],
+ 'ShareRuleName' => ['description' => 'The name of the sharing rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
+ 'ShareType' => [
+ 'description' => 'The type of the sharing rule.',
+ 'enumValueTitles' => ['AVERAGE' => 'Split equally', 'CUSTOM' => 'Custom split ratio', 'RATIO' => 'Split by ratio'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'CUSTOM',
+ 'title' => '',
],
- 'example' => 'NARY',
- ],
- 'OperatorType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OR' => 'OR',
- 'AND' => 'AND',
+ 'FromCostCenterList' => [
+ 'description' => 'The list of source cost centers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The source cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '583052', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 300,
+ 'title' => '',
+ 'example' => '',
],
- 'example' => 'AND',
- ],
- 'Operands' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
+ 'ToCostCenterList' => [
+ 'description' => 'The list of target cost centers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The target cost center ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '583056', 'title' => ''],
'required' => false,
- 'example' => '{'."\n"
- .' '."\n"
- .' "Operands": ['."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "TAG-xxx",'."\n"
- .' "Values": ['."\n"
- .' "xxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "TAG"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_ID",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_NICK",'."\n"
- .' "Values": ['."\n"
- .' "111"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "RESOURCE_GROUP",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "ARTICLE",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "PRODUCT",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "OWNER",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }',
+ 'maxItems' => 300,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
- ],
- 'Operand' => [
- 'description' => '',
- 'type' => 'any',
- 'required' => false,
- 'example' => '',
- ],
- 'FilterValues' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OWNER' => '',
- 'ARTICLE' => '',
- 'RESOURCE_GROUP' => '',
- 'xxx(用户自定义标签key)' => '',
- 'PRODUCT' => '',
- 'INSTANCE_NICK' => '',
- 'INSTANCE_ID' => '',
- ],
- 'example' => 'TAG-test-xxx-key',
- ],
- 'CodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Values' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["TAG-test-xxx"]'."\n",
- ],
- 'required' => false,
- ],
- 'SelectType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'LIKE' => '',
- 'IN' => '',
- ],
- 'example' => 'IN',
- ],
+ 'ShareRatioList' => [
+ 'description' => 'The list of sharing ratios.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The sharing ratio.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 200,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Nbid',
+ 'name' => 'RemoveShareRuleList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of sharing rules to delete.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The sharing rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1827', 'title' => ''],
'required' => false,
- 'example' => '2084210001',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary marketplace ID. If left empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '2684201000001'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Long>',
- 'description' => 'BssApiPlainResult<Long>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<CostCenterShareRuleSaveDto>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1111',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'The metadata of the response.', 'type' => 'any', 'example' => '{}'],
+ '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' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.RuleExpressionIllegal',
- 'errorMessage' => 'The auto-allocation rule configuration is invalid.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotExist',
- 'errorMessage' => 'The financial unit does not exist or is invalid.',
- ],
+ ['errorCode' => 'CostCenter.MasterAndSubHasNoRelation', 'errorMessage' => 'Your account has no valid account relation yet.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1111,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\"\\n}","type":"json"}]',
- ],
- 'ModifyCostCenterRule' => [
- 'summary' => '修改财务单元规则',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ModifyCostCenterShareRules',
+ 'summary' => 'Modifies cost center sharing rules, including creating, modifying, and deleting sharing rules.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SetFundAccountCreditAmount' => [
+ 'summary' => 'Set the credit control limit for a fund account',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7109,280 +6549,75 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OwnerAccountId',
+ 'name' => 'FundAccountId',
'in' => 'formData',
- 'schema' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1234567812345678',
- ],
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account owned by the current account (owner) is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '1232312', 'required' => false],
],
[
- 'name' => 'CostCenterId',
+ 'name' => 'CreditAmount',
'in' => 'formData',
- 'schema' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '485938',
- ],
- ],
- [
- 'name' => 'FilterExpression',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '规则表达式',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ExpressionType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DIMENSION' => '',
- 'TAG' => '',
- 'NARY' => '',
- ],
- 'example' => 'NARY',
- ],
- 'OperatorType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OR' => 'OR',
- 'AND' => 'AND',
- ],
- 'example' => 'AND',
- ],
- 'Operands' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'required' => false,
- 'example' => '{'."\n"
- .' '."\n"
- .' "Operands": ['."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "TAG-xxx",'."\n"
- .' "Values": ['."\n"
- .' "xxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "TAG"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_ID",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_NICK",'."\n"
- .' "Values": ['."\n"
- .' "111"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "RESOURCE_GROUP",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "ARTICLE",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "PRODUCT",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "OWNER",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }',
- ],
- 'required' => false,
- ],
- 'Operand' => [
- 'description' => '',
- 'type' => 'any',
- 'required' => false,
- 'example' => '',
- ],
- 'FilterValues' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OWNER' => '',
- 'ARTICLE' => '',
- 'RESOURCE_GROUP' => '',
- 'xxx(用户自定义标签key)' => '',
- 'PRODUCT' => '',
- 'INSTANCE_NICK' => '',
- 'INSTANCE_ID' => '',
- ],
- 'example' => 'TAG-test-xxx-key',
- ],
- 'CodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Values' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["TAG-test-xxx"]'."\n",
- ],
- 'required' => false,
- ],
- 'SelectType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'LIKE' => '',
- 'IN' => '',
- ],
- 'example' => 'IN',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => 'Credit limit', 'type' => 'string', 'required' => true, 'example' => '500'],
],
[
- 'name' => 'Nbid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'name' => 'Currency',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Currency for the credit control limit. Currently, only CNY is supported in mainland China, and only USD is supported for international use.', 'type' => 'string', 'required' => true, 'example' => 'CNY'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Long>',
- 'description' => 'BssApiPlainResult<Long>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Void>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5632',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6000EE23-274B-4E07-A697-FF2E999520A4',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response metadata', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'."\n", 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.RuleExpressionIllegal',
- 'errorMessage' => 'The auto-allocation rule configuration is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotExist',
- 'errorMessage' => 'The financial unit does not exist or is invalid.',
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You do not have permissions to perform the operation.'],
+ ['errorCode' => 'ExistApprovingProcess', 'errorMessage' => 'There is a credit control setting process in the approval process, please contact the business manager.', 'description' => 'There is a credit control setting process in the approval process, please contact the business manager.'],
+ ['errorCode' => 'ExistUnconfirmedContract', 'errorMessage' => 'The account you operate has a credit contract to be confirmed. Please confirm the contract first.', 'description' => 'The account you operate has a credit control contract to be confirmed. Please confirm the contract first.'."\n"],
+ ['errorCode' => 'NotSupportAllocateCredit', 'errorMessage' => 'Self-service credit limit allocation is currently unavailable. Please contact your service manager for assistance.', 'description' => 'Currently, self-service allocation of credit control quota is not supported. Please contact your service manager to modify the credit control quota.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'Set the credit control limit for a fund account',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-16T13:58:45.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyCredit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5632,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"6000EE23-274B-4E07-A697-FF2E999520A4\\"\\n}","type":"json"}]',
],
- 'DeleteCostCenterRule' => [
- 'summary' => '删除财务单元规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SetFundAccountLowAvailableAmountAlarm' => [
+ 'summary' => 'Set Fund Account Low Balance Alert',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7390,930 +6625,1346 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CostCenterId',
+ 'name' => 'ThresholdAmount',
'in' => 'formData',
- 'schema' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '637127',
- ],
+ 'schema' => ['title' => '', 'description' => 'Low balance alert threshold.', 'type' => 'string', 'required' => true, 'example' => '100'],
],
[
- 'name' => 'FilterExpression',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '规则表达式',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ExpressionType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'DIMENSION' => '',
- 'TAG' => '',
- 'NARY' => '',
- ],
- 'example' => 'NARY',
- ],
- 'OperatorType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AND',
- ],
- 'Operands' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'required' => false,
- 'example' => '{'."\n"
- .' '."\n"
- .' "Operands": ['."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "TAG-xxx",'."\n"
- .' "Values": ['."\n"
- .' "xxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "TAG"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_ID",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_NICK",'."\n"
- .' "Values": ['."\n"
- .' "111"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "RESOURCE_GROUP",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "ARTICLE",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "PRODUCT",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "OWNER",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }',
- ],
- 'required' => false,
- ],
- 'Operand' => [
- 'description' => '',
- 'type' => 'any',
- 'required' => false,
- 'example' => '',
- ],
- 'FilterValues' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'OWNER' => '',
- 'ARTICLE' => '',
- 'RESOURCE_GROUP' => '',
- 'xxx(用户自定义标签key)' => '',
- 'PRODUCT' => '',
- 'INSTANCE_NICK' => '',
- 'INSTANCE_ID' => '',
- ],
- 'example' => 'TAG-test-xxx-key'."\n",
- ],
- 'CodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Values' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["TAG-test-xxx"]'."\n",
- ],
- 'required' => false,
- ],
- 'SelectType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'LIKE' => '',
- 'IN' => '',
- ],
- 'example' => 'IN',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Nbid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'name' => 'FundAccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Fund account ID. If not specified, the account ID owned by the current account (owner) is used by default.', 'type' => 'integer', 'format' => 'int64', 'example' => '12321213', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<Long>',
- 'description' => 'BssApiPlainResult<Long>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '37404',
- ],
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UUID',
- ],
+ 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Metadata' => ['title' => '', 'description' => 'The response metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08108BF5-1AA3-518E-9986-95A3616E8DA9', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified request contains invalid parameters.',
- ],
- [
- 'errorCode' => 'CostCenter.UnitNotExist',
- 'errorMessage' => 'The financial unit does not exist or is invalid.',
- ],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => 'Request timed out. Please try again later.', 'description' => 'Request timed out, please try again later'],
+ ['errorCode' => 'NoFundAccountPermission', 'errorMessage' => 'The caller does not have permission for the specified fund account.', 'description' => 'The current login account does not have permission to operate the specified account.'],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"08108BF5-1AA3-518E-9986-95A3616E8DA9\\"\\n}","type":"json"}]',
+ 'title' => 'Set Fund Account Low Balance Alert',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 37404,\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\"\\n}","type":"json"}]',
],
- 'QueryCostCenterRule' => [
- 'summary' => '查询财务单元规则',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitSlaCouponApply' => [
+ 'summary' => 'User claims coupons for the last two months.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CostCenterId',
+ 'name' => 'DamagedIds',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Optional. Damaged record IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Damaged record ID.', 'type' => 'string', 'required' => false, 'example' => '9b7***9413', 'title' => ''],
'required' => false,
- 'example' => '597745',
+ 'maxItems' => 100,
+ 'example' => '',
],
],
[
+ 'name' => 'Month',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Required. Application month in the yyyyMM format.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '202603'],
+ ],
+ [
'name' => 'EcIdAccountIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '企业与账号列表,为空表示查询当前账号自身',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Enterprise and account list. If empty, the current account itself is queried.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Enterprise and account list. If empty, the current account itself is queried.',
'type' => 'object',
'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'Enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1501603440974415'],
'AccountIds' => [
- 'title' => '访问的账号列表,为空代表全选当前实体ID下所有账号',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of accounts to access. If empty, all accounts under the current entity ID are selected.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1990699401005016',
- ],
+ 'items' => ['title' => '', 'description' => 'Member account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1501603440974415', 'required' => false],
'required' => false,
'maxItems' => 100,
- ],
- 'EcId' => [
- 'title' => '企业实体ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1004064243473974',
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '',
],
'required' => false,
'maxItems' => 100,
+ 'example' => '',
],
],
[
'name' => 'Nbid',
'in' => 'query',
- 'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2684201000001',
- ],
+ 'schema' => ['title' => '', 'description' => 'Primary marketplace ID. If empty, the marketplace ID of the current user is used by default.', 'type' => 'string', 'example' => '2084210001', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<CostCenterRuleDto>',
- 'description' => 'BssApiPlainResult<CostCenterRuleDto>',
+ 'title' => '',
+ 'description' => 'BssApiPlainResult<CouponApplyResult>',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'UUID',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1977800748053695',
- ],
- 'RootCostCenterId' => [
- 'title' => '根财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '597745',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32048',
- ],
- 'FilterExpression' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ExpressionType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'DIMENSION' => '',
- 'TAG' => '',
- 'NARY' => '',
- ],
- 'example' => 'NARY',
- ],
- 'OperatorType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'OR' => 'OR',
- 'AND' => 'AND',
- ],
- 'example' => 'AND',
- ],
- 'Operands' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' '."\n"
- .' "Operands": ['."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "TAG-xxx",'."\n"
- .' "Values": ['."\n"
- .' "xxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "TAG"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_ID",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "INSTANCE_NICK",'."\n"
- .' "Values": ['."\n"
- .' "111"'."\n"
- .' ],'."\n"
- .' "SelectType": "LIKE"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "RESOURCE_GROUP",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "ARTICLE",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "PRODUCT",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "FilterValues": {'."\n"
- .' "Code": "OWNER",'."\n"
- .' "Values": ['."\n"
- .' "xxxxx"'."\n"
- .' ],'."\n"
- .' "SelectType": "IN"'."\n"
- .' },'."\n"
- .' "ExpressionType": "DIMENSION"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }',
- ],
- ],
- 'Operand' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => '',
- ],
- 'FilterValues' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'OWNER' => '',
- 'ARTICLE' => '',
- 'RESOURCE_GROUP' => '',
- 'xxx(用户自定义标签key)' => '',
- 'PRODUCT' => '',
- 'INSTANCE_NICK' => '',
- 'INSTANCE_ID' => '',
- ],
- 'example' => 'TAG-test-xxx-key'."\n",
- ],
- 'CodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Values' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["TAG-test-xxx"]'."\n",
- ],
- ],
- 'SelectType' => [
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'LIKE' => '',
- 'IN' => '',
- ],
- 'example' => 'IN',
- ],
- ],
- ],
- ],
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'on',
- ],
- 'IsDeleted' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'false',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Tue Nov 12 14:49:43 CST 2024',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Wed Oct 16 10:15:37 CST 2024',
- ],
+ 'Metadata' => ['title' => '', 'description' => 'Response structure metadata.', 'type' => 'any', 'example' => '{}'],
+ 'RequestId' => ['title' => '', 'description' => 'Unique request identifier used to tag a request for troubleshooting.', 'type' => 'string', 'example' => '79EE7556-0CFD-44EB-9CD6-B3B526E3A85F'],
+ 'SumCoupon' => ['description' => 'Total claimed amount.', 'type' => 'number', 'format' => 'double', 'example' => '6.4', 'title' => ''],
+ 'ValidStartTime' => ['title' => '', 'description' => 'Start time.', 'type' => 'string', 'example' => 'Tue Oct 27 13:15:58 CST 2026'],
+ 'ValidEndTime' => ['title' => '', 'description' => 'End time.', 'type' => 'string', 'example' => 'Mon Apr 27 00:00:00 CST 2026'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified request contains invalid parameters.', 'description' => ''],
+ ['errorCode' => 'CouponNotFound', 'errorMessage' => 'No claimable SLA coupons.', 'description' => 'No claimable SLA coupons'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'SLA Compensation Claim',
+ 'description' => '1. Call QueryMonthlySlaList to obtain the claimable months and records.'."\n"
+ ."\n"
+ .'2. Claim by month or by record.'."\n"
+ ."\n"
+ .'Note: Only compensation for the last two months can be claimed. Historical compensation has been automatically issued.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bssapi:SubmitSlaCouponApply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1977800748053695,\\n \\"RootCostCenterId\\": 0,\\n \\"CostCenterId\\": 597745,\\n \\"Id\\": 32048,\\n \\"FilterExpression\\": {\\n \\"ExpressionType\\": \\"NARY\\",\\n \\"OperatorType\\": \\"AND\\",\\n \\"Operands\\": [\\n \\"{\\\\n \\\\n \\\\\\"Operands\\\\\\": [\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"TAG-xxx\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"TAG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_ID\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"INSTANCE_NICK\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"111\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"LIKE\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"RESOURCE_GROUP\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"ARTICLE\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"PRODUCT\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"FilterValues\\\\\\": {\\\\n \\\\\\"Code\\\\\\": \\\\\\"OWNER\\\\\\",\\\\n \\\\\\"Values\\\\\\": [\\\\n \\\\\\"xxxxx\\\\\\"\\\\n ],\\\\n \\\\\\"SelectType\\\\\\": \\\\\\"IN\\\\\\"\\\\n },\\\\n \\\\\\"ExpressionType\\\\\\": \\\\\\"DIMENSION\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n ],\\n \\"Operand\\": \\"无\\",\\n \\"FilterValues\\": {\\n \\"Code\\": \\"TAG-test-xxx-key\\\\n\\",\\n \\"CodeName\\": \\"无\\",\\n \\"Values\\": [\\n \\"[\\\\\\"TAG-test-xxx\\\\\\"]\\\\n\\"\\n ],\\n \\"SelectType\\": \\"IN\\"\\n }\\n },\\n \\"Status\\": \\"on\\",\\n \\"IsDeleted\\": 0,\\n \\"GmtCreate\\": \\"Tue Nov 12 14:49:43 CST 2024\\",\\n \\"GmtModified\\": \\"Wed Oct 16 10:15:37 CST 2024\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F\\",\\n \\"SumCoupon\\": 6.4,\\n \\"ValidStartTime\\": \\"Tue Oct 27 13:15:58 CST 2026\\",\\n \\"ValidEndTime\\": \\"Mon Apr 27 00:00:00 CST 2026\\"\\n}","type":"json"}]',
],
- 'AllocateCostCenterResource' => [
- 'summary' => '财务单元实例重分配',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateBudget' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'FromOwnerAccountId',
+ 'name' => 'OriginalBudgetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1529600453335198',
- ],
+ 'schema' => ['description' => 'The original budget name.', 'type' => 'string', 'required' => true, 'example' => 'OriginalBudgetName', 'title' => ''],
],
[
- 'name' => 'FromCostCenterId',
+ 'name' => 'BudgetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget name.', 'type' => 'string', 'required' => true, 'example' => 'NewBudgetName'],
+ ],
+ [
+ 'name' => 'BudgetType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget type.', 'type' => 'string', 'required' => true, 'example' => 'CONSUME'],
+ ],
+ [
+ 'name' => 'Metric',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The budget metric.', 'type' => 'string', 'required' => true, 'example' => 'REQUIRE_AMOUNT'],
+ ],
+ [
+ 'name' => 'CycleType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The cycle type.', 'type' => 'string', 'required' => true, 'example' => 'MONTHLY'],
+ ],
+ [
+ 'name' => 'CycleStartPeriod',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start period of the cycle.', 'type' => 'string', 'required' => true, 'example' => '2026-01'],
+ ],
+ [
+ 'name' => 'CycleEndPeriod',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end period of the cycle.', 'type' => 'string', 'required' => true, 'example' => '2026-12'],
+ ],
+ [
+ 'name' => 'QuotaType',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The quota type.', 'type' => 'string', 'required' => true, 'example' => 'FIXED'],
+ ],
+ [
+ 'name' => 'Quota',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The fixed quota value.', 'type' => 'string', 'required' => false, 'example' => '1000'],
+ ],
+ [
+ 'name' => 'CycleQuota',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The quota specified for each cycle.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CyclePeriod' => ['title' => '', 'description' => 'The cycle period.', 'type' => 'string', 'required' => false, 'example' => '2026-01'],
+ 'Quota' => ['title' => '', 'description' => 'The quota.', 'type' => 'string', 'required' => false, 'example' => '1000'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '637180',
+ 'example' => '',
],
],
[
- 'name' => 'ToCostCenterId',
+ 'name' => 'QueryFilter',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The filter conditions.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '', 'description' => 'The parameter code.', 'type' => 'string', 'required' => false, 'example' => 'PRODUCT'],
+ 'SelectType' => ['title' => '', 'description' => 'The selection mode.', 'type' => 'string', 'required' => false, 'example' => 'IN'],
+ 'Values' => [
+ 'title' => '',
+ 'description' => 'The list of filter values.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '638288',
+ 'example' => '',
],
],
[
- 'name' => 'ResourceInstanceList',
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'required' => false, 'example' => 'comment'],
+ ],
+ [
+ 'name' => 'WarnConfs',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The alert configurations.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'ResourceUserId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '273394581313325532',
- ],
- 'InstanceId' => [
- 'type' => 'string',
- ],
- 'ResourceType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SCU',
- ],
- 'PipCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
- 'ResourceNick' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs-test-1',
- ],
- 'ApportionCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwer1-cn-beijing',
- ],
- 'ResourceTag' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag-test1',
- ],
- 'RelatedResources' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'related-resource',
- ],
- 'ApportionName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'split-item-test1',
- ],
- 'ResourceId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou;standard',
- ],
- 'ResourceSource' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AUTO_ALLOCATE',
- ],
- 'CommodityCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss',
- ],
- 'ResourceStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'ResourceUserName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'CommodityName' => [
- 'description' => '',
- 'type' => 'string',
+ 'Name' => ['title' => '', 'description' => 'The alert name. This is user-defined and optional. If not specified, the backend automatically generates a name.', 'type' => 'string', 'required' => false, 'example' => 'warn1'],
+ 'WarnTarget' => ['title' => '', 'description' => 'The alert target.', 'type' => 'string', 'required' => false, 'example' => 'ACTUAL'],
+ 'ThresholdType' => ['title' => '', 'description' => 'The threshold type.', 'type' => 'string', 'required' => false, 'example' => 'FIXED'],
+ 'ThresholdValue' => ['title' => '', 'description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '1000'],
+ 'MscContacts' => [
+ 'title' => '',
+ 'description' => 'The list of Message Center contacts.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Message Center contact.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
- 'example' => 'RESOURCE_UDR',
+ 'example' => '',
],
- 'ResourceGroup' => [
- 'description' => '',
- 'type' => 'string',
+ 'MscChannels' => [
+ 'title' => '',
+ 'description' => 'The list of Message Center notification channels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The Message Center notification channel.', 'type' => 'string', 'required' => false, 'example' => 'EMAIL', 'title' => ''],
'required' => false,
- 'example' => 'xihe_mpp',
+ 'example' => '',
],
+ 'EventBridge' => ['title' => '', 'description' => 'Specifies whether to enable EventBridge.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Comment' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'required' => false, 'example' => 'comment'],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
+ 'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'Nbid',
+ 'name' => 'EcIdAccountIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '一级售卖场ID,如果为空,默认使用当前用户所属的场ID填充',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The list of enterprise entities and accounts. If this parameter is left empty, the current account is queried.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EcId' => ['title' => '', 'description' => 'The enterprise entity ID.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'AccountIds' => [
+ 'title' => '',
+ 'description' => 'The list of accounts to access. If this parameter is left empty, all accounts under the current entity ID are selected.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The account to access.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5772131917494444', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => '2684201000001',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Nbid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The primary sales channel ID. If this parameter is left empty, the sales channel ID of the current user is used by default.', 'type' => 'string', 'required' => false, 'example' => '26842'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BssApiPlainResult<CostCenterOperateDto>',
- 'description' => 'BssApiPlainResult<CostCenterOperateDto>',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'Metadata' => [
- 'title' => '返回结构元数据',
- 'description' => '',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UUID',
- ],
- 'OwnerAccountId' => [
- 'title' => '财务单元的属主用户',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1529600453335198',
- ],
- 'CostCenterId' => [
- 'title' => '财务单元ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '640403',
- ],
- 'IsSuccess' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'BudgetName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03A59CD4-6C6B-1A62-B64C-F1F2AF7830F3', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'CostCenter.MasterAndSubHasNoRelation',
- 'errorMessage' => 'Your account has no valid account relation yet.',
- ],
- [
- 'errorCode' => 'CostCenter.ResourceAuthFailed',
- 'errorMessage' => 'The instance does not belong to the current user.',
- ],
- [
- 'errorCode' => 'CostCenter.ResourceNotExist',
- 'errorMessage' => 'The specified instance is not found in our records.',
- ],
- [
- 'errorCode' => 'CostCenter.AllocateResourceRepeat',
- 'errorMessage' => 'The instance has already been assigned a financial unit. Use transfer allocation for adjustment.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateBudget',
+ 'summary' => 'Updates a budget.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metadata\\": \\"{}\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"OwnerAccountId\\": 1529600453335198,\\n \\"CostCenterId\\": 640403,\\n \\"IsSuccess\\": true\\n}","type":"json"}]',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BudgetName\\": \\"\\",\\n \\"RequestId\\": \\"03A59CD4-6C6B-1A62-B64C-F1F2AF7830F3\\"\\n}","type":"json"}]',
],
],
'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' => [
[
- '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',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateFundAccountTransfer'],
+ ],
+ 'createdAt' => '2025-12-05T11:34:07.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'business.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'business.aliyuncs.com',
+ ],
+ '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'],
+ ],
],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'business.aliyuncs.com',
+ 'ramActions' => [
+ [
+ 'apiName' => 'DescribeCouponItemList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCouponItemList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryCostByCostCenter',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckBudgetNameExists',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:CheckBudgetNameExists',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountCanWithdrawAmount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountCanTransferAmount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AllocateCostCenterResource',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:AllocateCostUnitResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInvoiceCandidate',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeQueryInvoice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCostCenter',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryCostCenterResource',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountLowAvailableAmountAlarm',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeFrInstances',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeFrInstance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryCostCenterRule',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFundAccount',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveCostCenterShareRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDeductLogs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeFrDeductLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyCostCenter',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInvoiceTitle',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeQueryInvoice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateReportDefinition',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyOssSub',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyCostCenterRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCostCenterRule',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCostCenterRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeCoupon',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCoupon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateInvoice',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bss:ApplyInvoice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteReportDefinition',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyOssSub',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeBudgets',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBudgets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetFundAccountLowAvailableAmountAlarm',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountAvailableAmount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFundAccountPayRelation',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCostCenter',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelFundAccountLowAvailableAmountAlarm',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'bss:ModifyAlarm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountCanRecycleAmount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeBillingAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryCostCenterShareRule',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryCostCenter',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeCostUnit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetOrderDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeOrderDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListReportDefinitions',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeOss',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountTransactionDetails',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bss:DescribeFund',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetOrders',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bssapi:QueryOrders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryMonthlySlaList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'bssapi:QueryMonthlySlaList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitSlaCouponApply',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'bssapi:SubmitSlaCouponApply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetFundAccountCreditAmount',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyCredit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFundAccountCanAllocateCreditAmount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyCredit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateFundAccountTransfer',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'efc:ModifyTransfer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'BssOpenApi', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];