summaryrefslogtreecommitdiff
path: root/data/en_us/agency
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/agency
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/agency')
-rw-r--r--data/en_us/agency/2022-12-16/api-docs.php9462
-rw-r--r--data/en_us/agency/2025-02-27/api-docs.php2087
2 files changed, 4853 insertions, 6696 deletions
diff --git a/data/en_us/agency/2022-12-16/api-docs.php b/data/en_us/agency/2022-12-16/api-docs.php
index 78d4146..a1a5a19 100644
--- a/data/en_us/agency/2022-12-16/api-docs.php
+++ b/data/en_us/agency/2022-12-16/api-docs.php
@@ -1,1145 +1,863 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Agency',
- 'version' => '2022-12-16',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Agency', 'version' => '2022-12-16'],
'directories' => [
[
- 'id' => 380448,
- 'title' => 'Customer Invitation',
+ 'children' => ['CreateCustomer', 'GetInviteStatus', 'GetUnassociatedCustomer', 'InviteSubAccount', 'ResendEmail', 'ListCountries'],
'type' => 'directory',
- 'children' => [
- 'CreateCustomer',
- 'GetInviteStatus',
- 'GetUnassociatedCustomer',
- 'InviteSubAccount',
- 'ResendEmail',
- 'ListCountries',
- ],
+ 'title' => 'Customer invitation',
],
[
- 'id' => 380449,
- 'title' => 'Customer Management',
+ 'children' => ['AutomaticWriteOff', 'CustomerQuotaRecordList', 'DeductOutstandingBalance', 'EditEndUserStatus', 'EditNewBuyStatus', 'EditZeroCreditShutdown', 'ExportCustomerQuotaRecord', 'ExportReversedDeductionHistory', 'GetAccountInfo', 'GetCreditInfo', 'GetPurchaseControlRecord', 'GetShutdownPolicyRecord', 'QueryReversedDeductionHistory', 'QueryAutomaticWriteOffChangeRecords', 'SetAccountInfo', 'SetCreditLine', 'SetWarningThreshold'],
'type' => 'directory',
- 'children' => [
- 'CustomerQuotaRecordList',
- 'DeductOutstandingBalance',
- 'EditEndUserStatus',
- 'EditNewBuyStatus',
- 'EditZeroCreditShutdown',
- 'ExportCustomerQuotaRecord',
- 'ExportReversedDeductionHistory',
- 'GetAccountInfo',
- 'GetCreditInfo',
- 'GetPurchaseControlRecord',
- 'GetShutdownPolicyRecord',
- 'QueryReversedDeductionHistory',
- 'SetAccountInfo',
- 'SetCreditLine',
- 'SetWarningThreshold',
- ],
+ 'title' => 'Customer account management',
],
[
- 'id' => 380450,
- 'title' => 'Finance Center',
+ 'children' => ['CancelSubscriptionBill', 'GetCommissionableProducts', 'GetCustomerOrders', 'GetDailyBill', 'GetMonthlyBill', 'SubscriptionBill'],
'type' => 'directory',
- 'children' => [
- 'CancelSubscriptionBill',
- 'GetCommissionableProducts',
- 'GetCustomerOrders',
- 'GetDailyBill',
- 'GetMonthlyBill',
- 'SubscriptionBill',
- ],
+ 'title' => 'User center',
],
[
- 'id' => 380451,
- 'title' => 'Coupon Management',
+ 'children' => ['GetTier2CouponApprovalDetail', 'ListTier2CouponApproval', 'CancelCoupon', 'CreateCouponTemplate', 'CouponApprovalStatusList', 'DeleteCouponTemplate', 'GetCouponTemplateDetail', 'GetCoupondeductProductCode', 'IssueCouponForCustomer', 'ListCouponUsage', 'QuotaListExportPaged'],
'type' => 'directory',
- 'children' => [
- 'GetTier2CouponApprovalDetail',
- 'ListTier2CouponApproval',
- 'CancelCoupon',
- 'CreateCouponTemplate',
- 'CouponApprovalStatusList',
- 'DeleteCouponTemplate',
- 'GetCouponTemplateDetail',
- 'GetCoupondeductProductCode',
- 'IssueCouponForCustomer',
- 'ListCouponUsage',
- 'QuotaListExportPaged',
- ],
+ 'title' => 'Coupon management',
],
[
- 'id' => 380454,
- 'title' => 'Others',
+ 'children' => ['ProcessApproval', 'ListExportTasks', 'InviteSubReseller'],
'type' => 'directory',
- 'children' => [
- 'ProcessApproval',
- 'ListExportTasks',
- ],
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateCustomer' => [
- 'summary' => 'This function is designed for create a customer who is to be invited.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AutomaticWriteOff' => [
+ 'summary' => 'Before the end-of-month settlement, you can enable the automatic write-off feature. When the consumed but unoffset quota reaches the specified automatic write-off amount, the amount is transferred to the offset quota and can be used for deduction.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'CustomerName',
+ 'name' => 'CustomerUid',
'in' => 'query',
- 'schema' => [
- 'description' => 'Customer\'s name.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'DoorBell Marketing',
- ],
+ 'schema' => ['description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'CustomerTrade',
+ 'name' => 'AutomaticWriteOffEnabled',
'in' => 'query',
- 'schema' => [
- 'description' => 'The industry that Customer\'s business belongs to. Please enumerate with Customer Trade.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '01',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to enable automatic write-off and set the automatic write-off amount. Valid values:'."\n"
+ .'- true: enables automatic write-off and sets the automatic write-off amount.'."\n"
+ .'- false: disables automatic write-off.', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
- 'name' => 'CustomerSubTrade',
+ 'name' => 'AutomaticWriteOffAmount',
'in' => 'query',
'schema' => [
- 'description' => 'The sub-industry that Customer\'s business belongs to. Please enumerate with Customer Trade.',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The automatic write-off amount. This parameter is required if automatic write-off is enabled. Valid values: 100, 500, and 1000.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'enum' => ['100', '500', '1000'],
'required' => false,
- 'example' => '0101',
- ],
- ],
- [
- 'name' => 'CustomerSource',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The source/channel that allow client to connected with us. Please enumerate with Customer Source.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'website',
+ 'example' => '100',
],
],
[
- 'name' => 'Nation',
+ 'name' => 'Language',
'in' => 'query',
'schema' => [
- 'description' => 'The region that Customer choose to launch the Cloud Service. Please use ListCountries to confirm the valid region list for current UID.',
+ 'title' => '',
+ 'description' => 'The language of the response. Default value: en. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'AR',
+ 'enum' => ['zh', 'en', 'ja'],
+ 'required' => false,
+ 'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Code indicating whether the call was successful.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Massage indicating whether the call was successful.',
- 'type' => 'string',
- 'example' => '12345',
- ],
- 'Data' => [
- 'description' => 'Data indicating whether a customer was successfully created. If it\'s "true", the Message contains CID.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'string',
- 'example' => 'A9B725C7-3DBD-576B-AC91-F6F22AB99A77',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call it self was successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6fc1309b17543600398356606d0096'],
+ 'Message' => ['title' => '', 'description' => 'The description of the result.', 'type' => 'string', 'example' => '成功'],
+ 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => '200'],
+ 'Data' => ['title' => '', 'description' => 'Indicates whether the setting is successful.', 'type' => 'boolean', 'example' => 'true'],
],
- 'description' => '',
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Set automatic write-off',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"12345\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A9B725C7-3DBD-576B-AC91-F6F22AB99A77\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'CreateCustomer',
- 'requestParamsDescription' => 'CustomerSourceEnum '."\n"
- .'- OFF_LINE_MEETING("Off_line_meeting","Offline conference"),'."\n"
- .'- WEBSITE("website","Official website"),'."\n"
- .'- OFFLINEMARKETTINGEVENT("OFFLINE_MARKETTING_EVENT","Marketing Event"), '."\n"
- .'- INTLENTERPRISE("intl_enterprise","international_Enterprise"),'."\n"
- .'- INTERNALTRANSFER("Internal_transfer","Internal referral"), '."\n"
- .'- EXTERNALCHANNEL("External_channel","External channel"), '."\n"
- .'- MOBAI("Mobai","Cold Call"), '."\n"
- .'- OLDCLIENTTOINTRODUCE("Old_client_to_introduce","Customer referral"), '."\n"
- .'- OTHER("Other","Other");'."\n"
- ."\n"
- .'CustomerSubTradeEnum'."\n"
- ."\n"
- .'- PHYSICALRETAILANDWHOLESALE("Physical retail and wholesale","0101","01"),'."\n"
- .'- ECOMMERCE("Ecommerce","0102","01"),'."\n"
- .'- LOGISTICSANDWAREHOUSING("Logistics and warehousing","0103","01"),'."\n"
- .'- TRAVELCULTURESPORTSANDENTERTAINMENT("Travel,culture, sports, and entertainment","0104","01"),'."\n"
- .'- CLOTHINGANDSHOESANDEDUCATIONANDSPORTSGOODS("Clothing and shoes, and education and sports goods","0105","01"), '."\n"
- .'- HOUSEHOLDAPPLIANCES("Household appliances","0106","01"),'."\n"
- .'- FOODBEVERAGEANDTOBACCO("Food, beverage and tobacco","0107","01"),'."\n"
- .'- AGRIBUSINESS("Agribusiness","0201","02"),'."\n"
- .'- STEELMANUFACTURING("Steel manufacturing","0202","02"),'."\n"
- .'- EQUIPMENTMANUFACTURING("Equipment manufacturing","0203","02"),'."\n"
- .'- GENERALINDUSTRIALPRODUCTSMANUFACTURING("General industrial products manufacturing","0204","02"), '."\n"
- .'- AUTOMOTIVEAUTOPARTSANDSERVICES("Automotive,auto parts and services","0205","02"),'."\n"
- .'- REALESTATEANDCONSTRUCTION("Real estate and construction","0206","02"),'."\n"
- .'- BANKING("Banking","0301","03"),'."\n"
- .'- INSURANCE("Insurance","0302","03"),'."\n"
- .'- SECURITIESANDCAPITALMARKET("Securities and capital market","0303","03"),'."\n"
- .'- FINANCIALSERVICES("Financial services","0304","03"),'."\n"
- .'- COMMUNICATIONANDISPS("Communication and ISPs","0401","04"),'."\n"
- .'- MEDIA("Media","0402","04"),'."\n"
- ."\n"
- .' - COMPUTERHARDWARE("Computer hardware","0403","04"),'."\n"
- ."\n"
- .'- COMPUTERSOFTWAREANDSERVICES("Computer software and services","0404","04"),'."\n"
- ."\n"
- .'- ONLINEGAMES("Online games","0405","04"),'."\n"
- .' '."\n"
- .'- INTERNETSERVICES("Internet services","0406","04"),'."\n"
- .' '."\n"
- .'- INTERNETOFTHINGSTECHNOLOGIESANDSERVICES("Internet of things technologies and services","0407","04"),'."\n"
- .' '."\n"
- .'- INTELLIGENTCONSUMERPRODUCTS("Intelligent consumer products","0408","04"),'."\n"
- .' '."\n"
- .'- ARTIFICIALINTELLIGENCE("Artificial intelligence","0409","04"),'."\n"
- .' '."\n"
- .'- POWERGRID("Power grid","0501","05"),'."\n"
- .' '."\n"
- .'- OILANDPETROCHEMICAL("Oil and petrochemical","0502","05"),'."\n"
- .' '."\n"
- .'- NONRENEWABLERESOURCES("Nonrenewable resources","0503","05"),'."\n"
- .' '."\n"
- .'- NEWENERGYANDRENEWABLERESOURCES("New energy and renewable resources","0504","05"),'."\n"
- .' '."\n"
- .'- CHEMICALINDUSTRY("Chemical industry","0505","05"),'."\n"
- .' '."\n"
- .'- GOVERNMENT("Government","0601","06"),'."\n"
- .'- CIVILMILITARYINTEGRATION("Civil military integration","0602","06"),'."\n"
- .' '."\n"
- .'- HEALTHCARE("Healthcare","0603","06"),'."\n"
- ."\n"
- .' - EDUCATIONANDRESEARCHINSTITUTIONS("Education and research institutions","0604","06"),'."\n"
- .' '."\n"
- .'- TRANSPORTATION("Transportation","0605","06"),'."\n"
- ."\n"
- .'- PUBLICSERVICE("Public service","0606","06"),'."\n"
- .' '."\n"
- .'- ONLINEMEDIA("Online media","040201","0402"),'."\n"
- .' '."\n"
- .'- RADIOANDTELEVISIONMEDIA("Radio and television media","040202","0402"),'."\n"
- .' '."\n"
- .'- VEHICLEMANUFACTURING("Vehicle manufacturing","020501","0205"),'."\n"
- .' '."\n"
- .'- AUTOPARTSMANUFACTURING("Auto parts manufacturing","020502","0205"),'."\n"
- .' '."\n"
- .'- INTERNETOFVEHICLESANDAUTOSERVICES("Internet of vehicles and auto services","020503","0205"),'."\n"
- .' '."\n"
- .'- JURIDICALDEPARTMENTS("Juridical departments","060101","0601"),'."\n"
- .' '."\n"
- .'- TAXAUTHORITIES("Tax authorities","060102","0601"),'."\n"
- .' '."\n"
- .'- CUSTOMS("Customs","060103","0601"),'."\n"
- ."\n"
- .'- LOCALGOVERNMENTS("Local governments","060104","0601"),'."\n"
- .' '."\n"
- .'- OTHERGOVERNMENTAGENCIES("Other government agencies","060105","0601"),'."\n"
- .' '."\n"
- .'- STEELANDMINING("Steel and mining","020201","0202"),'."\n"
- .' '."\n"
- .'- STEELMANUFACTURINGSUB("Steel manufacturing","020202","0202"),'."\n"
- .' '."\n"
- .'- TRAVELSERVICES("Travel services","010401","0104"),'."\n"
- .' '."\n"
- .'- HOTELSANDCATERINGSERVICES("Hotels and catering services","010402","0104"),'."\n"
- .' '."\n"
- .'- CULTURESPORTSANDENTERTAINMENT("Culture, sports, and entertainment","010403","0104"),'."\n"
- .' '."\n"
- .'- COMMUNICATIONEQUIPMENT("Communication equipment","040101","0401"),'."\n"
- .' '."\n"
- .'- ISPINTERNETSERVICEPROVIDER("ISP (Internet Service Provider)","040102","0401"),'."\n"
- .' '."\n"
- .'- COMMUNICATIONSERVICES("Communication services","040103","0401"),'."\n"
- .' '."\n"
- .'- ONLINESOCIALMEDIA("Online social media","040601","0406"),'."\n"
- .' '."\n"
- .'- ONLINEMARKETING("Online marketing","040602","0406"),'."\n"
- .' '."\n"
- .'- INTERNETPLATFORMS("Internet platforms","040603","0406"),'."\n"
- .' '."\n"
- .'- INTERNETINFORMATIONSERVICES("Internet information services","040604","0406"),'."\n"
- .' '."\n"
- .'- ONLINEEDUCATION("Online education","060401","0604"),'."\n"
- .' '."\n"
- .'- TRAININGANDEDUCATIONINSTITUTIONS("Training and education institutions","060402","0604"),'."\n"
- .' '."\n"
- .'- RESEARCHINSTITUTIONS("Research institutions","060403","0604"),'."\n"
- .' '."\n"
- .'- RAILWAYTRANSPORTATION("Railway transportation","060501","0605"),'."\n"
- .' '."\n"
- .'- ROADTRANSPORTATION("Road transportation","060502","0605"),'."\n"
- .' '."\n"
- .'- WATERTRANSPORTATION("Water transportation","060503","0605"),'."\n"
- .' '."\n"
- .'- AIRTRANSPORTATION("Air transportation","060504","0605"),'."\n"
- .' '."\n"
- .'- OTHERWAYSOFTRANSPORTATION("Other ways of transportation","060505","0605"),'."\n"
- .' '."\n"
- .'- FOODMANUFACTURING("Food manufacturing","010701","0107"),'."\n"
- .' '."\n"
- .'- ALCOHOLBEVERAGEANDREFINEDTEAMANUFACTURING("Alcohol,beverage, and refined tea manufacturing","010702","0107"),'."\n"
- .' '."\n"
- .'- TOBACCOMANUFACTURING("Tobacco manufacturing","010703","0107"),'."\n"
- .'- EXPLOITATIONOFNONRENEWABLERESOURCES("Exploitation of nonrenewable resources","050301","0503"),'."\n"
- .' '."\n"
- .'- PRODUCTIONANDSUPPLYOFNONRENEWABLERESOURCES("Production and supply of nonrenewable resources","050302","0503"),'."\n"
- .' '."\n"
- .'- MEDICALSERVICES("Medical services","060301","0603"),'."\n"
- .' '."\n"
- .'- HEALTHSERVICES("Health services","060302","0603"),'."\n"
- .' '."\n"
- .'- HEALTHCAREEQUIPMENT("Healthcare equipment","060303","0603"),'."\n"
- .' '."\n"
- .'- GENETICENGINEERING("Genetic engineering","060304","0603"),'."\n"
- .' '."\n"
- .'- DRUGSANDBIOTECHNOLOGY("Drugs and biotechnology","060305","0603");',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6fc1309b17543600398356606d0096\\",\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
- 'GetInviteStatus' => [
- 'summary' => 'Query invitation status of customer who have been created and invited.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CancelCoupon' => [
+ 'summary' => 'Invalidates a coupon.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InviteStatusList',
+ 'name' => 'CouponId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'inviteId list</br>'."\n"
- .'`Sub-levels <= 5`',
- 'type' => 'array',
- 'items' => [
- 'description' => 'inviteId list',
- 'type' => 'object',
- 'properties' => [
- 'InviteId' => [
- 'description' => 'Invitation ID, From interface InviteSubAccount',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 5,
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => 'The coupon ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '501001340370350', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Status Code. Error Code:'."\n"
- ."\n"
- .'- 3057 InviteId is empty',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The message returned.',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'InviteStatus' => [
- 'description' => 'The returned data.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => 'Result Code. Value Range:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 system error',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'The message returned.'."\n",
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'InviteStatusList' => [
- 'description' => 'List of Invitation Status result',
- 'type' => 'object',
- 'properties' => [
- 'GmtCreate' => [
- 'description' => 'The time of email been sent out.',
- 'type' => 'string',
- 'example' => '2018-02-12',
- ],
- 'Status' => [
- 'description' => 'Invitation Status:'."\n"
- .'* 0 No visit on registration URL'."\n"
- .'* 1 Successful Registration'."\n"
- .'* 2 Unsuccessful Registration'."\n"
- .'* 3 Registration URL have been visited, but no submitted sheet/ticket.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'SubAccountType' => [
- 'description' => 'Account Type:'."\n"
- .'- 1 Agency\'s End User'."\n"
- .'- 2 Reseller\'s End User'."\n"
- .'- 5 T2 Reseller Partner',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ParentId' => [
- 'description' => 'The parent organization ID.'."\n",
- 'type' => 'string',
- 'example' => '1093238769140523',
- ],
- 'AssociationSuccessTime' => [
- 'description' => 'The time that Distribution Customer successfully associated with Distributor.</br>'."\n"
- .'This value will be empty if there is no existing association.',
- 'type' => 'string',
- 'example' => '2018-02-13',
- ],
- 'Cid' => [
- 'description' => 'Distribution Customer\'s CID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567890123',
- ],
- 'Uid' => [
- 'description' => 'Distribution Customer\'s UID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567890123',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ ['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
+ ['errorCode' => 'ERROR_2311', 'errorMessage' => 'Coupon template does not exist.', 'description' => 'Coupon template does not exist'],
+ ['errorCode' => 'ERROR_1003', 'errorMessage' => 'No permission to operate the object.', 'description' => 'No permission to operate the object.'],
+ ['errorCode' => 'ERROR_2307', 'errorMessage' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InviteStatus\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"InviteStatusList\\": {\\n \\"GmtCreate\\": \\"2018-02-12\\",\\n \\"Status\\": 2,\\n \\"SubAccountType\\": \\"1\\",\\n \\"ParentId\\": \\"1093238769140523\\",\\n \\"AssociationSuccessTime\\": \\"2018-02-13\\",\\n \\"Cid\\": 1234567890123,\\n \\"Uid\\": 1234567890123\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'GetInviteStatus',
- ],
- 'GetUnassociatedCustomer' => [
- 'summary' => 'Query all the Unassociated Customer.',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Invalidate a coupon',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelCoupon'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:CancelCoupon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'CancelSubscriptionBill' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Pagination, current page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'SubscribeType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Pagination, record number on each page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'Subscription type.'."\n"
+ ."\n"
+ .'- PartnerBillingItemDetailForBillingPeriod: Billing item bill details.'."\n"
+ .'- PartnerBillingItemDetailMonthly: Billing item monthly bill.'."\n"
+ .'- PartnerInstanceDetailForBillingPeriod: Instance bill details.'."\n"
+ .'- PartnerInstanceDetailMonthly: Instance monthly bill.', 'type' => 'string', 'required' => true, 'example' => 'PartnerBillingItemDetailForBillingPeriod'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
+ 'Message' => ['title' => '', 'description' => 'The message returned.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
+ 'Data' => ['description' => 'The data returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => [
- 'description' => 'Error Code, Candidate Value：'."\n"
- .'* 200: OK'."\n"
- .'* 1109: System error',
+ 'title' => '',
+ 'description' => 'The status code.',
+ 'enumValueTitles' => [1008 => 'Unsubscription failed.', 'No subscription record exists.'],
'type' => 'string',
'example' => '200',
],
- 'Message' => [
- 'description' => 'Message information',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'PageInfo' => [
- 'description' => 'Pagination Information',
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'description' => 'Pagination, record number on each page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => 'Pagination, page volume in total.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'Page' => [
- 'description' => 'Pagination, current page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'InviteInfoList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'InviteInfo' => [
- 'description' => 'List of Invitation Information',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Invitation Information',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => 'Invitation Status:'."\n"
- .'* 0 No visit on registration URL'."\n"
- .'* 1 Successful Registration'."\n"
- .'* 2 Unsuccessful Registration'."\n"
- .'* 3 Registration URL have been visited, but no submitted sheet/ticket.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'GmtCreate' => [
- 'description' => 'The time of email been sent out.',
- 'type' => 'string',
- 'example' => '2023-05-10',
- ],
- 'AccountNickname' => [
- 'description' => 'The name of Customer who are to be invited.',
- 'type' => 'string',
- 'example' => 'My Client',
- ],
- 'Email' => [
- 'description' => 'The Email of Customer who are to be invited.',
- 'type' => 'string',
- 'example' => '12345@qq.com',
- ],
- 'InviteId' => [
- 'description' => 'Invitation ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '190',
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'string',
- 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F',
- ],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Cancel multi-level distribution bill subscription',
+ 'summary' => 'Unsubscribe from multi-level bills for international channel ecosystem partners.',
+ 'description' => 'Make sure that the caller is an international Alibaba Cloud master reseller partner.'."\n"
+ ."\n"
+ .'You can unsubscribe from one type of bill file at a time.'."\n"
+ ."\n"
+ .'After the corresponding bill type is unsubscribed, files are no longer pushed to the specified OSS space.'."\n"
+ ."\n"
+ .'**This content is published only on the international site.**',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"InviteInfoList\\": {\\n \\"InviteInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2023-05-10\\",\\n \\"AccountNickname\\": \\"我的客户\\",\\n \\"Email\\": \\"12345@qq.com\\",\\n \\"InviteId\\": 190\\n }\\n ]\\n },\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\"\\n}","type":"json"}]',
- 'title' => 'GetUnassociatedCustomer',
- ],
- 'InviteSubAccount' => [
- 'summary' => 'Initiate the Partner registration invitation.',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSubscriptionBill'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:CancelSubscriptionBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'CouponApprovalStatusList' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AccountInfoList',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => 'List of invited account information, less than 5 accounts at a time.</br>'."\n"
- .'`Sub-levels <= 5`',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SubAccountType' => [
- 'description' => 'The type of Sub Account</br>'."\n"
- ."\n"
- .'1 Agency\'s End User</br>'."\n"
- .'2 Reseller\'s End user</br>'."\n"
- .'5 Reseller\'s T2 Partner</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- 'EmailAddress' => [
- 'description' => 'The email address of End User, which will receive the invitation email.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345@163.com',
- ],
- 'AccountNickname' => [
- 'description' => 'The name of Sub Account:</br>'."\n"
- .'1. Use the official name of Company, if Sub Account is an enterprise.</br>'."\n"
- .'2. Use the official name of Partner, if Sub Account is a T2 reseller.</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'XXX Technology LTD.',
- ],
- 'CreditLine' => [
- 'description' => 'The total budget Credit of Sub Account that distributed by Partner.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100',
- ],
- 'Remark' => [
- 'description' => 'Description of Sub Account.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'The invitation to develop XX as a Sub Account',
- ],
- 'ZeroCreditShutdownPolicy' => [
- 'description' => 'Partner\'s Shutdown Policy Management for Sub Account.</br>'."\n"
- .'1: delayStop. The account have Shutdown-delay Privilege, After Shutdown-delay Credit is ran out, Alibaba Cloud will take over resources and keep the instance for 15 days. In addition, the instance will be released if Sub Account failed to pay the bill within these 15 days.</br>'."\n"
- .'2: noStop. Partner will manually manage Shutdown Status for Sub Account. Meanwhile, System would not manage the resource\'s life-circle of Sub Account.</br>'."\n"
- .'3: immediatelyStop. Once valid quota of Sub Account falls below 0 and be identified as defaulting account, it will trigger the instance shutdown immediately.</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- 'NewBuyStatus' => [
- 'description' => 'Initial Order Status</br>'."\n"
- .'1. ban：Ban the new purchase action--After End User finish registration and authorization, they can\'t issue Cloud Resource order immediately. Partner should manually update the "Order Control" settings as "Normal" to enable new order.</br>'."\n"
- .'2. normal：Normal--After End User finished registration and authorization, they can issue Cloud Resource order immediately.</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ban',
- ],
- 'CustomerId' => [
- 'description' => 'Customer ID, Returning ID from CreateCustomer API.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1234567',
- ],
- 'CustomerBd' => [
- 'title' => '客户商务经理',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 5,
- ],
+ 'schema' => ['description' => 'The coupon template ID.', 'type' => 'string', 'required' => false, 'example' => '5093156', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => '测试优惠券模板', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The coupon template status. Valid values:'."\n"
+ .'- **1**: Application withdrawn.'."\n"
+ .'- **2**: Under review.'."\n"
+ .'- **3**: Review rejected.'."\n"
+ .'- **4**: Review approved.'."\n"
+ .'- **5**: Review approved but issuance failed.'."\n"
+ .'- **6**: Automatically approved.'."\n"
+ .'- **7**: Automatically approved but issuance failed.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '0', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Error Code: </br>'."\n"
- .'• 200 OK</br>'."\n"
- .'• 1109 System Error</br>',
- 'type' => 'string',
- 'example' => '200',
- 'title' => 'Id of the request',
- ],
- 'Message' => [
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this ID.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Success' => [
- 'description' => 'Candidate Values: True/False, this value states if the current API calling action is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Results' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Result' => [
- 'description' => 'List of invitation sending results',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Details of Invitation Results',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => 'Error Code, 200 OK',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Message, Notes of Code',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Always true.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Result' => [
- 'description' => 'Returning Message of Invitation Results',
- 'type' => 'object',
- 'properties' => [
- 'RegUrl' => [
- 'description' => 'URL for Partner Customer Registration.',
- 'type' => 'string',
- 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL',
- ],
- 'Days' => [
- 'description' => 'Valid days of registration URL, count on daily basis.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'InviteId' => [
- 'description' => 'Invitation ID, The invitation status tracking code.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345',
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'S00000101-100040', 'title' => ''],
+ 'TemplateName' => ['description' => 'The coupon template name.', 'type' => 'string', 'example' => '模板名称', 'title' => ''],
+ 'TemplateStatus' => ['description' => 'The coupon template status. Valid values:'."\n"
+ .'- **1**: Application withdrawn.'."\n"
+ .'- **2**: Under review.'."\n"
+ .'- **3**: Review rejected.'."\n"
+ .'- **4**: Review approved.'."\n"
+ .'- **5**: Review approved but issuance failed.'."\n"
+ .'- **6**: Automatically approved.'."\n"
+ .'- **7**: Automatically approved but issuance failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'TimeOfRequest' => ['description' => 'The time when the application was submitted.', 'type' => 'string', 'example' => '2024-02-02 09:46:59', 'title' => ''],
+ 'IssuerAccount' => ['description' => 'The issuer account.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''],
+ 'Note' => ['description' => 'The approval comments.', 'type' => 'string', 'example' => '通过', 'title' => ''],
+ 'IssuerUid' => ['description' => 'The UID of the issuer account.', 'type' => 'string', 'example' => '5432738203821334', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Error3017',
- 'errorMessage' => 'customerRebateType is error, only invite reseller account.',
- ],
- [
- 'errorCode' => 'Error3008',
- 'errorMessage' => 'shutdown status is error.',
- ],
- [
- 'errorCode' => 'Error3009',
- 'errorMessage' => 'customerAccount is error.',
- ],
- [
- 'errorCode' => 'Error3010',
- 'errorMessage' => 'customerNick is empty.',
- ],
- [
- 'errorCode' => 'Error3011',
- 'errorMessage' => 'The length of customerNick greater than 50.',
- ],
- [
- 'errorCode' => 'Error3012',
- 'errorMessage' => 'cid is empty.',
- ],
- [
- 'errorCode' => 'Error3013',
- 'errorMessage' => 'customCredit is empty.',
- ],
- [
- 'errorCode' => 'Error3014',
- 'errorMessage' => 'customCredit is a maximum of 10.',
- ],
- [
- 'errorCode' => 'Error3015',
- 'errorMessage' => 'The current account is not a partner.',
- ],
- [
- 'errorCode' => 'Error3016',
- 'errorMessage' => 'customerRebateType is error, only invite agency account.',
- ],
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'Error3056',
- 'errorMessage' => 'The value of subAccountType error.',
- ],
- [
- 'errorCode' => 'Error3067',
- 'errorMessage' => 'Enterprise Customer Invitation Prohibition.',
- ],
- [
- 'errorCode' => 'Error3055',
- 'errorMessage' => 'subAccountType is null.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query coupon approval status list',
+ 'summary' => 'Queries the list of coupon approval statuses.',
+ 'description' => 'Make sure that the current caller identity is a distribution partner. '."\n"
+ .'<notice>Available only on the China site.</notice>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CouponApprovalStatusList'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:CouponApprovalStatusList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'InviteSubAccount',
- 'description' => 'The current API request rate for the Cloud Product has not been disclosed.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"S00000101-100040\\",\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"TemplateStatus\\": 2,\\n \\"TimeOfRequest\\": \\"2024-02-02 09:46:59\\",\\n \\"IssuerAccount\\": \\"test@test.aliyunid.com\\",\\n \\"Note\\": \\"通过\\",\\n \\"IssuerUid\\": \\"5432738203821334\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ResendEmail' => [
- 'summary' => 'Resend invitation email.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCouponTemplate' => [
+ 'summary' => 'Create Coupon Template',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'InviteId',
+ 'name' => 'TemplateName',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Template name'."\n"
+ .'Field length limit: 30', 'type' => 'string', 'required' => true, 'maxLength' => 30, 'example' => '模板名称'],
+ ],
+ [
+ 'name' => 'ReasonForApplication',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Reason for template application'."\n"
+ .'Field length limit: 100', 'type' => 'string', 'required' => true, 'maxLength' => 100, 'example' => '模板申请原因'],
+ ],
+ [
+ 'name' => 'CostBearer',
'in' => 'query',
'schema' => [
- 'description' => 'Invitation ID, from interface InviteSubAccount </br>'."\n"
- .'Note: This field type is Long, which may result in precision loss in serialization/deserialization process. Please ensure the value does not exceed 9007199254740991.',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'Coupon cost bearer'."\n"
+ .'● Partner: borne by the partner'."\n"
+ .'● Alibaba Cloud: borne by Alibaba Cloud',
+ 'type' => 'string',
+ 'required' => true,
+ 'enum' => ['Partner', 'Alibaba Cloud'],
+ 'example' => 'Partner',
+ ],
+ ],
+ [
+ 'name' => 'ApplicableProducts',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Applicable products'."\n"
+ .'● All Products: all products'."\n"
+ .'● Custom: custom selection',
+ 'type' => 'string',
+ 'required' => true,
+ 'enum' => ['All Products', 'Custom'],
+ 'example' => 'All Products',
+ ],
+ ],
+ [
+ 'name' => 'ProductType',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Product code list',
+ 'type' => 'array',
+ 'items' => ['description' => 'Product code. The return value from the deductible products API for international channel distribution coupons.', 'type' => 'string', 'required' => false, 'example' => 'code1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'LimitPerPerson',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Limit per person'."\n"
+ .'● Limited to 1: each person can claim only one coupon'."\n"
+ .'● Unlimited: no limit',
+ 'type' => 'string',
+ 'required' => true,
+ 'enum' => ['Limited to 1', 'Unlimited'],
+ 'example' => 'Unlimited',
+ ],
+ ],
+ [
+ 'name' => 'Value',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Face value'."\n"
+ .'Must be an integer', 'type' => 'string', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'ValidUntil',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Validity period'."\n"
+ .'● Validity Duration: from the date of coupon issuance'."\n"
+ .'● Custom Timeframe: custom time period',
+ 'type' => 'string',
'required' => true,
- 'example' => '176',
+ 'enum' => ['Validity Duration', 'Custom Timeframe'],
+ 'example' => 'Validity Duration',
],
],
+ [
+ 'name' => 'Vailddate',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Start date of the effective period'."\n"
+ .'Format: yyyy-MM-dd'."\n"
+ .'Example: 2024-08-26'."\n"
+ .'Required when the validity period is set to Custom Timeframe', 'type' => 'string', 'required' => false, 'example' => '2024-08-26'],
+ ],
+ [
+ 'name' => 'Expireddate',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'End date of the effective period'."\n"
+ .'Format: yyyy-MM-dd'."\n"
+ .'Example: 2024-08-26'."\n"
+ .'Required when the validity period is set to Custom Timeframe', 'type' => 'string', 'required' => false, 'example' => '2024-08-26'],
+ ],
+ [
+ 'name' => 'Vaildperioddays',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Duration in days for the relative time period'."\n"
+ .'Must be a positive integer'."\n"
+ .'Required when the validity period is set to Validity Duration', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PurchaseType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Order type',
+ 'type' => 'string',
+ 'enum' => ['ALL', 'Subscription', 'Pay-As-You-Go'],
+ 'required' => false,
+ 'example' => 'ALL',
+ ],
+ ],
+ [
+ 'name' => 'CouponDescription',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Coupon remarks'."\n"
+ .'Length limit: 100', 'type' => 'string', 'required' => false, 'maxLength' => 100, 'example' => '券备注信息'],
+ ],
+ [
+ 'name' => 'AcceptLanguage',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'Default value: none'."\n"
+ .'Chinese: zh-CN'."\n"
+ .'English: en-US'."\n"
+ .'Japanese: ja', 'type' => 'string', 'required' => true, 'example' => 'zh-CN'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code, Error code.</br>'."\n"
- .'Candidate Value: </br>'."\n"
- .'* 200: OK'."\n"
- .'* 1109: System error'."\n"
- .'* 3058: Frequent sending, the limit is 10 emails in every 5 minutes.'."\n"
- .'* 3057: InviteId is empty.'."\n"
- .'* 3060: Can\'t find sending record of given InviteId.'."\n"
- .'* 3061: Registration URL is expired, unable to resend.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Result message',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'],
+ 'Code' => ['title' => '', 'description' => 'Status code. 200 indicates success', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'Response data',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateName' => ['title' => '', 'description' => 'Coupon template name', 'type' => 'string', 'example' => '模板名称'],
+ 'ApplicableProducts' => [
+ 'title' => '',
+ 'description' => 'Applicable products'."\n"
+ .'● All Products: all products'."\n"
+ .'● Custom: custom selection',
+ 'type' => 'string',
+ 'enum' => ['Custom', 'All Products'],
+ 'example' => 'Custom',
+ ],
+ 'ProductType' => [
+ 'title' => '',
+ 'description' => 'Product code list',
+ 'type' => 'array',
+ 'items' => ['description' => 'Product code', 'type' => 'string', 'example' => 'code1', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Value' => ['description' => 'Face value', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ValidUntil' => [
+ 'title' => '',
+ 'description' => 'Validity period'."\n"
+ .'● Validity Duration: from the date of coupon issuance'."\n"
+ .'● Custom Timeframe: custom time period',
+ 'type' => 'string',
+ 'enum' => ['Validity Duration', 'Custom Timeframe'],
+ 'example' => 'Validity Duration',
+ ],
+ 'Vailddate' => ['title' => '', 'description' => 'Start date of the effective period'."\n"
+ .'Format: yyyy-MM-dd', 'type' => 'string', 'example' => '2024-01-01'],
+ 'Expireddate' => ['title' => '', 'description' => 'End date of the effective period'."\n"
+ .'Format: yyyy-MM-dd', 'type' => 'string', 'example' => '2024-01-01'],
+ 'Vaildperioddays' => ['description' => 'Duration in days for the relative time period', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-04-02 16:15:31'],
+ 'CostBearer' => [
+ 'title' => '',
+ 'description' => 'Coupon cost bearer'."\n"
+ .'● Partner: borne by the partner'."\n"
+ .'● Alibaba Cloud: borne by Alibaba Cloud',
+ 'type' => 'string',
+ 'enum' => ['Partner', 'Alibaba Cloud'],
+ 'example' => 'Partner',
+ ],
+ 'Status' => ['title' => '', 'description' => 'Status'."\n"
+ ."\n"
+ .'CREATED: Created'."\n"
+ .'APPROVING: Under review'."\n"
+ .'APPROVED: Approved'."\n"
+ .'UNAPPROVED: Not approved'."\n"
+ .'ABANDONED: Abandoned'."\n"
+ .'EXPIRED: Expired'."\n"
+ .'EXHAUSTED: Exhausted', 'type' => 'string', 'example' => 'APPROVED'],
+ 'CouponTemplateID' => ['title' => '', 'description' => 'Coupon template ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111111'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'Error3058',
- 'errorMessage' => 'Frequent email flow control limit 10 emails sent within 5 minutes.',
- ],
- [
- 'errorCode' => 'InvalidParam.InviteId.InvalidId',
- 'errorMessage' => 'No invitation record found based on inviteId.',
+ ['errorCode' => 'ERROR_3070', 'errorMessage' => 'CouponTemplateName must be entered.', 'description' => 'TemplateName name must be entered'],
+ ['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
+ ['errorCode' => 'ERROR_3091', 'errorMessage' => 'Coupon template name length over limit.', 'description' => 'Coupon template name length over limit（30 characters）.'],
+ ['errorCode' => 'ERROR_3071', 'errorMessage' => 'ApplicableProducts empty, please check.', 'description' => 'ApplicableProducts empty, please check.'],
+ ['errorCode' => 'ERROR_3094', 'errorMessage' => 'Applicable product type parameters are not legal.', 'description' => 'Applicable product type parameters are not legal'],
+ ['errorCode' => 'ERROR_3080', 'errorMessage' => 'Account empty, please check.', 'description' => 'Account is empty, please check'],
+ ['errorCode' => 'ERROR_3090', 'errorMessage' => 'You have no authority.', 'description' => 'You have no authority'],
+ ['errorCode' => 'ERROR_3085', 'errorMessage' => 'Product code is not in international channel partner coupons deductable product list.', 'description' => 'Product code is not in international channel partner coupons deductable product list.'],
+ ['errorCode' => 'ERROR_3072', 'errorMessage' => 'itemCodes empty, please check.', 'description' => 'ProductType is empty, please check'],
+ ['errorCode' => 'ERROR_3101', 'errorMessage' => 'PurchaseType empty, please check .', 'description' => 'PurchaseType empty, please check .'],
+ ['errorCode' => 'ERROR_3073', 'errorMessage' => 'amout empty, please check.', 'description' => 'Value empty, please check.'],
+ ['errorCode' => 'ERROR_3096', 'errorMessage' => 'Coupon value is illegal.', 'description' => 'Coupon value is illegal.'],
+ ['errorCode' => 'ERROR_3074', 'errorMessage' => 'personLimit empty, please check.', 'description' => 'LimitPerPerson empty, please check.'],
+ ['errorCode' => 'ERROR_3095', 'errorMessage' => 'The per-person limit is illegal.', 'description' => 'The per-person limit is illegal.'],
+ ['errorCode' => 'ERROR_3075', 'errorMessage' => 'applyReason empty, please check.', 'description' => 'ReasonForApplication empty, please check.'],
+ ['errorCode' => 'ERROR_3092', 'errorMessage' => 'Reason for template request length over limit.', 'description' => 'Reason for template request length over limit（100 characters）'],
+ ['errorCode' => 'ERROR_3098', 'errorMessage' => 'Coupon Remarks Information length over limit.', 'description' => 'Coupon Remarks Information length over limit（100 characters).'],
+ ['errorCode' => 'ERROR_3093', 'errorMessage' => 'Coupon cost-bearer parameters are not legal.', 'description' => 'Coupon cost-bearer parameters are not legal'],
+ ['errorCode' => 'ERROR_3076', 'errorMessage' => 'effDateType empty, please check.', 'description' => 'effDateType empty, please check.'],
+ ['errorCode' => 'ERROR_3078', 'errorMessage' => 'effDateFrom empty, please check.', 'description' => 'Vailddate empty, please check.'],
+ ['errorCode' => 'ERROR_3079', 'errorMessage' => 'effDateTo empty, please check.', 'description' => 'Expireddate empty, please check .'],
+ ['errorCode' => 'ERROR_3099', 'errorMessage' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'],
+ ['errorCode' => 'ERROR_3103', 'errorMessage' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"],
+ ['errorCode' => 'ERROR_3084', 'errorMessage' => 'Coupon cannot be valid for more than 180 days.', 'description' => 'Coupon cannot be valid for more than 180 days'],
+ ['errorCode' => 'ERROR_3077', 'errorMessage' => 'effDateDay empty, please check.', 'description' => 'Vaildperioddays empty, please check.'],
+ ['errorCode' => 'ERROR_3097', 'errorMessage' => 'Time type is illegal.', 'description' => 'Time type is illegal.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create Coupon Template',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-11T12:09:50.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCouponTemplate'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:CreateCouponTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'ResendEmail',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"ApplicableProducts\\": \\"Custom\\",\\n \\"ProductType\\": [\\n \\"code1\\"\\n ],\\n \\"Value\\": \\"1\\",\\n \\"ValidUntil\\": \\"Validity Duration\\",\\n \\"Vailddate\\": \\"2024-01-01\\",\\n \\"Expireddate\\": \\"2024-01-01\\",\\n \\"Vaildperioddays\\": \\"1\\",\\n \\"CreateTime\\": \\"2024-04-02 16:15:31\\",\\n \\"CostBearer\\": \\"Partner\\",\\n \\"Status\\": \\"APPROVED\\",\\n \\"CouponTemplateID\\": 111111\\n }\\n}","type":"json"}]',
],
- 'ListCountries' => [
- 'summary' => 'This function is available for all Distributors. It displays the corresponding region code information based on the operable countries as agreed in the Distributor\'s contract.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateCustomer' => [
+ 'summary' => 'Registers a customer to be invited.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'CustomerName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The customer name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DoorBell Marketing', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomerTrade',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The customer industry name.'."\n"
+ .'Use the Customer Trade enumeration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0205', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomerSubTrade',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The customer sub-industry.'."\n"
+ .'Use the Customer Sub Trade enumeration.', 'type' => 'string', 'required' => false, 'example' => '020501', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomerSource',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The customer source.'."\n"
+ .'Use the Customer Source enumeration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'website', 'title' => ''],
+ ],
+ [
+ 'name' => 'Nation',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region to which the customer belongs. Call ListCountries to obtain the list of available regions for the current UID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AR', 'title' => ''],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Error Code'."\n"
- .'* 200: OK'."\n"
- .'* 1109: System error',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Message information',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'string',
- 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => 'List of Region Code',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Region Code',
- 'type' => 'string',
- 'example' => 'AF',
- ],
- ],
+ 'Code' => ['description' => 'The code that indicates whether the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The same as the Code parameter.', 'type' => 'string', 'example' => '12345', 'title' => ''],
+ 'Data' => ['description' => 'Indicates whether the customer is created. If the value is true, the Message contains the CID.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => 'A9B725C7-3DBD-576B-AC91-F6F22AB99A77', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values:'."\n"
+ .'- True'."\n"
+ .'- False'."\n"
+ ."\n"
+ .'This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"12345\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A9B725C7-3DBD-576B-AC91-F6F22AB99A77\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Register a customer',
+ 'requestParamsDescription' => '### Valid values of CustomerSource'."\n"
+ .'> The following format is: field displayed on the page — input parameter value.'."\n"
+ .'- Off-line meeting — Off_line_meeting'."\n"
+ .'- Website — website'."\n"
+ .'- Offline marketing event — OFFLINE_MARKETTING_EVENT'."\n"
+ .'- International enterprise — intl_enterprise'."\n"
+ .'- Internal transfer — Internal_transfer'."\n"
+ .'- External channel — External_channel'."\n"
+ .'- Cold visit — Mobai'."\n"
+ .'- Referral from existing customer — Old_client_to_introduce'."\n"
+ .'- Other — Other'."\n"
+ .'- Customer allocation — ALLOCATE'."\n"
+ .'- Potential customer recommendation — PotentialRecommend.'."\n"
+ ."\n"
+ .'### Valid values of Customer Trade'."\n"
+ .'> The following four-digit input parameter codes are parent codes. Example: parent code = 0603 (four digits).'."\n"
+ .'If both customer sub trade and customer trade are specified, customer trade must be equal to the parent code of sub trade.'."\n"
+ .'- Retail and wholesale — 0101'."\n"
+ .'- E-commerce — 0102'."\n"
+ .'- Logistics and warehousing — 0103'."\n"
+ .'- Travel, culture, sports, and entertainment — 0104'."\n"
+ .'- Apparel, footwear, stationery, and sporting goods — 0105'."\n"
+ .'- Home appliances — 0106'."\n"
+ .'- Food, beverages, and tobacco — 0107'."\n"
+ .'- Agriculture — 0201'."\n"
+ .'- Steel manufacturing — 0202'."\n"
+ .'- Equipment manufacturing — 0203'."\n"
+ .'- General industrial manufacturing — 0204'."\n"
+ .'- Automobiles, auto parts, and services — 0205'."\n"
+ .'- Real estate and construction — 0206'."\n"
+ .'- Banking — 0301'."\n"
+ .'- Insurance — 0302'."\n"
+ .'- Securities and capital markets — 0303'."\n"
+ .'- Financial services — 0304'."\n"
+ .'- Telecommunications and carriers — 0401'."\n"
+ .'- Media — 0402'."\n"
+ .'- Computer hardware — 0403'."\n"
+ .'- Computer software and services — 0404'."\n"
+ .'- Internet gaming — 0405'."\n"
+ .'- Internet services — 0406'."\n"
+ .'- IoT technology and services — 0407'."\n"
+ .'- Smart consumer products — 0408'."\n"
+ .'- Artificial intelligence — 0409'."\n"
+ .'- Power grid — 0501'."\n"
+ .'- Oil and petrochemicals — 0502'."\n"
+ .'- Non-renewable resources — 0503'."\n"
+ .'- New energy and renewable energy — 0504'."\n"
+ .'- Chemical industry — 0505'."\n"
+ .'- Government — 0601'."\n"
+ .'- Civil-military integration — 0602'."\n"
+ .'- Healthcare — 0603'."\n"
+ .'- Education and research institutions — 0604'."\n"
+ .'- Transportation — 0605'."\n"
+ .'- Public services — 0606.'."\n"
+ ."\n"
+ .'### Valid values of customer sub trade'."\n"
+ ."\n"
+ .'> The customer sub trade code is a six-digit code (for example, 060304), and the parent code is a four-digit code (for example, 0603).'."\n"
+ .'If both sub trade and customer trade are specified, customer trade must be equal to the parent code of sub trade.'."\n"
+ ."\n"
+ .'- Media - Internet media — 040201 — 0402'."\n"
+ .'- Media - Broadcasting and media — 040202 — 0402'."\n"
+ .'- Automobiles, auto parts, and services - Vehicle manufacturing — 020501 — 0205'."\n"
+ .'- Automobiles, auto parts, and services - Auto parts manufacturing — 020502 — 0205'."\n"
+ .'- Automobiles, auto parts, and services - Connected vehicles and auto services — 020503 — 0205'."\n"
+ .'- Government - Public security, procuratorate, and court — 060101 — 0601'."\n"
+ .'- Government - Taxation — 060102 — 0601'."\n"
+ .'- Government - Customs — 060103 — 0601'."\n"
+ .'- Government - Local government — 060104 — 0601'."\n"
+ .'- Government - Other government agencies — 060105 — 0601'."\n"
+ .'- Steel manufacturing - Steel mining — 020201 — 0202'."\n"
+ .'- Steel manufacturing - Steel production — 020202 — 0202'."\n"
+ .'- Travel, culture, sports, and entertainment - Travel services — 010401 — 0104'."\n"
+ .'- Travel, culture, sports, and entertainment - Accommodation and catering — 010402 — 0104'."\n"
+ .'- Travel, culture, sports, and entertainment - Culture, sports, and entertainment — 010403 — 0104'."\n"
+ .'- Telecommunications and carriers - Telecommunications equipment — 040101 — 0401'."\n"
+ .'- Telecommunications and carriers - Carriers — 040102 — 0401'."\n"
+ .'- Telecommunications and carriers - Telecommunications services — 040103 — 0401'."\n"
+ .'- Internet services - Social networking — 040601 — 0406'."\n"
+ .'- Internet services - Internet marketing — 040602 — 0406'."\n"
+ .'- Internet services - Internet platforms — 040603 — 0406'."\n"
+ .'- Internet services - Internet information services — 040604 — 0406'."\n"
+ .'- Education and research institutions - Online education — 060401 — 0604'."\n"
+ .'- Education and research institutions - Training and educational institutions — 060402 — 0604'."\n"
+ .'- Education and research institutions - Research institutions — 060403 — 0604'."\n"
+ .'- Transportation - Railway transportation — 060501 — 0605'."\n"
+ .'- Transportation - Road transportation — 060502 — 0605'."\n"
+ .'- Transportation - Water transportation — 060503 — 0605'."\n"
+ .'- Transportation - Air transportation — 060504 — 0605'."\n"
+ .'- Transportation - Other transportation — 060505 — 0605'."\n"
+ .'- Food, beverages, and tobacco - Food manufacturing — 010701 — 0107'."\n"
+ .'- Food, beverages, and tobacco - Alcoholic beverages, drinks, and refined tea manufacturing — 010702 — 0107'."\n"
+ .'- Food, beverages, and tobacco - Tobacco products — 010703 — 0107'."\n"
+ .'- Non-renewable resources - Non-renewable energy extraction — 050301 — 0503'."\n"
+ .'- Non-renewable resources - Non-renewable energy production and supply — 050302 — 0503'."\n"
+ .'- Healthcare - Medical services — 060301 — 0603'."\n"
+ .'- Healthcare - Health services — 060302 — 0603'."\n"
+ .'- Healthcare - Medical and health equipment — 060303 — 0603'."\n"
+ .'- Healthcare - Genetic engineering — 060304 — 0603'."\n"
+ .'- Healthcare - Pharmaceuticals and biotechnology — 060305 — 0603.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomer'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'agency:CreateCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"AF\\"\\n ]\\n}","type":"json"}]',
- 'title' => 'ListCountries',
- 'description' => 'The current API request rate for cloud products has not been disclosed.',
],
'CustomerQuotaRecordList' => [
- 'summary' => 'Query quota adjustment list of Distribution Customer from International Site. Not available on Domestic Site.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1147,106 +865,48 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EndUserPk',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => 'Customer UID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5113766248601929',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5113766248601929'],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => 'Start Date Format: yyyy-MM-dd',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-01-02',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-01-02'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => 'End Date Format: yyyy-MM-dd',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-09-24',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-09-24'],
],
[
'name' => 'OperationType',
'in' => 'query',
- 'schema' => [
- 'title' => '操作类型'."\n"
- .'枚举'."\n"
- .'all 全部'."\n"
- .'quota_create 创建'."\n"
- .'quota_amount_adjust 额度调整',
- 'description' => 'Operation Type Enum</br>'."\n"
- .'all All types</br>'."\n"
- .'quota_create Create quota</br>'."\n"
- .'quota_amount_adjust Adjust the amount of quota</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'all',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n"
+ .'- all: all types'."\n"
+ .'- quota_create: creation'."\n"
+ .'- quota_amount_adjust: quota amount adjustment.', 'type' => 'string', 'required' => true, 'example' => 'all'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '分页每页记录数，最大值100',
- 'description' => 'Pagination, record number on each page. Maximum 100.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'title' => '分页，当前页码，从 1 开始',
- 'description' => 'Pagination, current page number, starting from 1.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => 'Multilingual Parameters, the default language is English.</br>'."\n"
- .'en: English</br>'."\n"
- .'zh: Chinese</br>'."\n"
- .'ja: Japanese </br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
+ .'- en: English'."\n"
+ .'- zh: Chinese'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
@@ -1254,159 +914,92 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Total' => [
- 'title' => '总条数',
- 'description' => 'Total volume',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => 'Current page number',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '当前每页条数',
- 'description' => 'Record number on each page',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Data' => [
- 'description' => 'Listed data of returning result',
+ 'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
- 'description' => 'Returning data',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'OperationSubmitType' => [
- 'title' => '操作发起方式'."\n"
- .'API/ACPN',
- 'description' => 'The way to submit the quota adjustment operation. API/ACPN',
- 'type' => 'string',
- 'example' => 'ACPN',
- ],
- 'OperationTime' => [
- 'title' => '操作时间',
- 'description' => 'The time of submit the quota adjustment operation.',
- 'type' => 'string',
- 'example' => '2023-12-15 10:34:36 UTC+8',
- ],
- 'OperationTypeDesc' => [
- 'title' => '变更类型描述',
- 'description' => 'The description of submitted quota adjustment operation.',
- 'type' => 'string',
- 'example' => 'Quota Adjustment',
- ],
- 'OperationUid' => [
- 'title' => '操作人uid',
- 'description' => 'The UID of operator(Partner\'s UID).',
- 'type' => 'string',
- 'example' => '5113766248601929',
- ],
- 'UpdateAfterAmount' => [
- 'title' => '变更后金额',
- 'description' => 'Updated quota amount',
- 'type' => 'string',
- 'example' => '121.00',
- ],
- 'UpdateAmount' => [
- 'title' => '变更金额',
- 'description' => 'The difference amount between updated quota and original quota.',
- 'type' => 'string',
- 'example' => '-100.00',
- ],
- 'UpdateBeforeAmount' => [
- 'title' => '变更前金额',
- 'description' => 'Original quota amount',
- 'type' => 'string',
- 'example' => '221.00',
- ],
- 'OperationTypeCode' => [
- 'title' => '变更类型code',
- 'description' => 'Operation Type Enum</br>'."\n"
- .'all All types</br>'."\n"
- .'quota_create Create quota</br>'."\n"
- .'quota_amount_adjust Adjust the amount of quota</br>',
- 'type' => 'string',
- 'example' => 'quota_amount_adjust',
- ],
+ 'OperationSubmitType' => ['title' => '', 'description' => 'The method by which the operation was submitted. Valid values: API and ACPN.', 'type' => 'string', 'example' => 'ACPN'],
+ 'OperationTime' => ['title' => '', 'description' => 'The time when the operation was performed.', 'type' => 'string', 'example' => '2023-12-15 10:34:36 UTC+8'],
+ 'OperationTypeDesc' => ['title' => '', 'description' => 'The description of the change type.', 'type' => 'string', 'example' => 'Quota Adjustment'],
+ 'OperationUid' => ['title' => '', 'description' => 'The UID of the operator.', 'type' => 'string', 'example' => '5113766248601929'],
+ 'UpdateAfterAmount' => ['title' => '', 'description' => 'The amount after the change.', 'type' => 'string', 'example' => '121.00'],
+ 'UpdateAmount' => ['title' => '', 'description' => 'The change amount.', 'type' => 'string', 'example' => '-100.00'],
+ 'UpdateBeforeAmount' => ['title' => '', 'description' => 'The amount before the change.', 'type' => 'string', 'example' => '221.00'],
+ 'OperationTypeCode' => ['title' => '', 'description' => 'The code of the change type. Valid values:'."\n"
+ .'- all: all types'."\n"
+ .'- quota_create: creation'."\n"
+ .'- quota_amount_adjust: quota amount adjustment.', 'type' => 'string', 'example' => 'quota_amount_adjust'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => 'ID of request',
- 'type' => 'string',
- 'example' => '2103a0ae16849855284594613d874e',
- ],
- 'Msg' => [
- 'title' => '返回结果描述',
- 'description' => 'Description of returning data',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Code' => [
- 'title' => '返回结果状态码，200是成功',
- 'description' => 'Status code of returning result, 200 means success.',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2103a0ae16849855284594613d874e'],
+ 'Msg' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query quota adjustment records of a distributor customer',
+ 'summary' => 'Queries the quota adjustment records of a distributor customer on the China site (Chinese mainland). This operation is available only for China site users.',
+ 'description' => 'The caller must be an Alibaba Cloud channel master distributor partner or an Alibaba Cloud channel distributor partner.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CustomerQuotaRecordList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:CustomerQuotaRecordList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36 UTC+8\\",\\n \\"OperationTypeDesc\\": \\"Quota Adjustment\\",\\n \\"OperationUid\\": \\"5113766248601929\\",\\n \\"UpdateAfterAmount\\": \\"121.00\\",\\n \\"UpdateAmount\\": \\"-100.00\\",\\n \\"UpdateBeforeAmount\\": \\"221.00\\",\\n \\"OperationTypeCode\\": \\"quota_amount_adjust\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a0ae16849855284594613d874e\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'CustomerQuotaRecordList',
],
'DeductOutstandingBalance' => [
- 'summary' => 'This API is used to offset the Deducted Credit of a Distribution Customer. For example, if the current Deducted Credit is 500 and the Available Credit is 1000, by offsetting 300, the Deducted Credit will then become 200, and the Available Credit becomes 1300.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Reduces the deducted credit of a reseller\'s customer. For example, if the current deducted credit is 500 and the available credit is 1000, a reduction of 300 changes the deducted credit to 200 and the available credit to 1300.'."\n"
+ .'Note: Sometimes the used credit of a customer may be negative. This indicates that no recovery of the used credit is needed. Wait for the customer to consume the credit. This occurs when a refund is issued while the customer\'s credit is fully used. As a result, the customer\'s credit increases beyond the original limit.'."\n"
+ .'For example, if the current maximum available credit of a customer is 1000 with no usage, and a refund of 300 occurs, the used credit becomes -300.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'description' => 'Account UID of Distribution Customer.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1133166938931507',
- ],
+ 'schema' => ['description' => 'The UID of the reseller\'s customer account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1133166938931507', 'title' => ''],
],
[
'name' => 'DeductAmount',
'in' => 'query',
- 'schema' => [
- 'description' => 'The Deducted Credit to be offset.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '300',
- ],
+ 'schema' => ['description' => 'The amount of deducted credit to reduce.', 'type' => 'string', 'required' => true, 'example' => '300', 'title' => ''],
],
],
'responses' => [
@@ -1414,60 +1007,123 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code. Value Range:'."\n"
- .'- 200 OK'."\n"
- .'- 1109 System Error',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Same as Code Parameter Value.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'200: OK.'."\n"
+ .'1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message. The value is the same as the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'This uid is not your EU.',
- ],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Reduce deducted credit',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T02:09:28.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeductOutstandingBalance'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:DeductOutstandingBalance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'DeductOutstandingBalance',
- 'description' => 'Note that sometimes you may find that the customer\'s Used Credit is negative. This indicates that there is no need to restore the Used Credit, and its ready for customer\'s usage. This phenomenon occurs because a refund is generated while the customer\'s credit is full, thereby triggered additional increasing on the customer\'s credit.'."\n"
- .'For example, if the customer\'s maximum Available Credit is 1000 with no usage, and a refund of 300 occurs, the Used Credit will become -300.',
],
- 'EditEndUserStatus' => [
- 'summary' => 'Set the after-shutdown instance status for post-pay End Users as a Reseller.',
- 'methods' => [
- 'get',
+ 'DeleteCouponTemplate' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6558410265670417297', 'title' => ''],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4'],
+ 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ERROR_1003', 'errorMessage' => 'No permission to operate the object.', 'description' => 'No permission to operate the object.'],
+ ['errorCode' => 'ERROR_2311', 'errorMessage' => 'Coupon template does not exist.', 'description' => 'Coupon template does not exist'],
+ ['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
+ ['errorCode' => 'ERROR_2310', 'errorMessage' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Invalidate a coupon template',
+ 'summary' => 'Invalidates a coupon template.',
+ 'description' => 'Make sure that the current caller is a distribution partner. '."\n"
+ .'<notice>Available only on the China site.</notice>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCouponTemplate'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:DeleteCouponTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'EditEndUserStatus' => [
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1475,114 +1131,79 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'title' => 'uid',
- 'description' => 'UID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1792155717328010',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer to be processed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1792155717328010'],
],
[
'name' => 'CreditStatus',
'in' => 'query',
- 'schema' => [
- 'title' => 'creditStatus',
- 'description' => 'Shutdown Status</br>'."\n"
- ."\n"
- .'- postPayFreeze, the account have been blocked</br>'."\n"
- ."\n"
- .'- postPayThaw, the account have been unlocked</br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'postPayFreeze',
- ],
+ 'schema' => ['title' => '', 'description' => '### Shutdown status'."\n"
+ ."\n"
+ .'- postPayFreeze: pay-as-you-go resource suspension'."\n"
+ .'- postPayThaw: pay-as-you-go resource resumption.', 'type' => 'string', 'required' => false, 'example' => 'postPayFreeze'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
+ 'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Msg' => [
- 'title' => 'msg',
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Message' => [
- 'title' => 'message',
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'Request ID</br>',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Data' => [
- 'title' => 'data',
- 'description' => 'Success or not</br>',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'Status Code</br>',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
+ 'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'The current customer does not belong to this partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Set the shutdown status of a customer instance',
+ 'summary' => 'Manages the shutdown status of pay-as-you-go instances for resold subordinate customers by Alibaba Cloud international channel master distributor partners and Alibaba Cloud international channel distributor partners.',
+ 'description' => 'The caller must be an Alibaba Cloud international channel master distributor partner or an Alibaba Cloud international channel distributor partner.'."\n"
+ ."\n"
+ .'**This content is published only on the China site (Chinese).**.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditEndUserStatus'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditEndUserStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'EditEndUserStatus',
- 'description' => 'The caller should be the Partner as identified in the Alibaba Cloud distribution model. </br>'."\n"
- .'**This content is only published on the international site. **',
],
'EditNewBuyStatus' => [
- 'summary' => 'Set the New Buy status for Sub-Customer as a Partner.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1590,114 +1211,79 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'title' => 'uid',
- 'description' => 'Customer UID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1133166938931507',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1133166938931507'],
],
[
'name' => 'NewBuyStatus',
'in' => 'query',
- 'schema' => [
- 'title' => 'newBuyStatus',
- 'description' => 'New Purchase Status</br>'."\n"
- ."\n"
- .'- cancelBan: Cancel the restriction for New Purchase request</br>'."\n"
- ."\n"
- .'- ban: ban the New Purchase request</br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cancelBan',
- ],
+ 'schema' => ['title' => '', 'description' => 'The new purchase status. Valid values:'."\n"
+ ."\n"
+ .'- cancelBan: allows new purchases'."\n"
+ .'- ban: prohibits new purchases.', 'type' => 'string', 'required' => false, 'example' => 'cancelBan'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
+ 'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Msg' => [
- 'title' => 'msg',
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Message' => [
- 'title' => 'message',
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'Request ID</br>',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Data' => [
- 'title' => 'data',
- 'description' => 'Success or not</br>',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'Status Code</br>',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
+ 'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'The current customer does not belong to this partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Modify customer new purchase status',
+ 'summary' => 'Sets the new purchase status of a subordinate reseller customer for an Alibaba Cloud reseller partner.',
+ 'description' => 'The caller must be an Alibaba Cloud reseller partner.'."\n"
+ ."\n"
+ .'**This content is published only on the China site.**.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditNewBuyStatus'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditNewBuyStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'EditNewBuyStatus',
- 'description' => 'The caller should be the Partner as identified in the Alibaba Cloud distribution model. </br>'."\n"
- .'**This content is only published on the international site. **',
],
'EditZeroCreditShutdown' => [
- 'summary' => 'Modify the End User\'s Shutdown Policy as a Reseller.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1705,120 +1291,89 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'title' => 'uid',
- 'description' => 'No Change History',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1263644979775567',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the distributor customer whose shutdown policy you want to modify.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1263644979775567'],
],
[
'name' => 'ShutdownPolicy',
'in' => 'query',
'schema' => [
- 'title' => 'shutdownPolicy',
- 'description' => 'UID',
+ 'title' => '',
+ 'description' => '### **Shutdown policy**'."\n"
+ .'For more information, refer to the official documentation: https://www.alibabacloud.com/help/zh/channel-platform/latest/shutdowndelayprivilege'."\n"
+ ."\n"
+ .'- **immediatelyStop**——When the active credit of the distributor customer account is less than 0, the account enters the overdue payment state. New resources cannot be purchased. Pay-as-you-go instances are stopped and no longer incur charges. Upfront instances can be used until they expire. After the instances remain stopped for 15 days, pay-as-you-go instances are released. Because of billing delays, credits may continue to be deducted even after instances are successfully stopped.'."\n"
+ .'- **delayStop**——The overdraft quota in the delayed shutdown policy is calculated by Alibaba Cloud based on the historical consumption of the account. The minimum overdraft quota is 600 USD, and instances can continue to run for approximately 15 days after the overdue payment occurs. The overdraft quota applies to pay-as-you-go products. After this policy is enabled, when the customer has an overdue payment (active credit < 0) and the overdue amount is within the overdraft quota, instance shutdown is not triggered. The overdraft quota is not the upper limit of the overdue amount. Because of billing delays, credits may continue to be deducted even after instances are successfully stopped. After the instances remain stopped for 15 days, pay-as-you-go instances are released. When the delayed shutdown quota <= remaining credit < 0, you can manually trigger an immediate shutdown.'."\n"
+ .'- **noStop**——If you select this option, instances are not stopped when the customer has an overdue payment. When the customer has an overdue payment (remaining credit < 0), instance shutdown is not triggered. There is no upper limit on the overdue amount. You must perform a manual operation of "Immediate Shutdown" in ACPN to change the instance status. Use this option with caution.',
+ 'enumValueTitles' => ['immediatelyStop' => 'immediatelyStop', 'noStop' => 'noStop', 'delayStop' => 'delayStop'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'immediatelyStop' => 'immediatelyStop',
- 'noStop' => 'noStop',
- 'delayStop' => 'delayStop',
- ],
- 'example' => 'Shutdown Policy</br>'."\n"
- ."\n"
- .'- immediatelyStop, The instances of the specified End User\'s account will be shutdown immediately once EU triggered the Shutdown Policy.</br>'."\n"
- ."\n"
- .'- delayStop, The instances of the specified End User\'s account will be shutdown later, even EU have triggered the Shutdown Policy.</br>'."\n"
- ."\n"
- .'- noStop, The instances of the specified End User\'s account will not be shutdown, after EU have triggered the Shutdown Policy.</br>',
+ 'example' => 'noStop',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
+ 'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Msg' => [
- 'title' => 'msg',
- 'description' => 'NO_STOP',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Message' => [
- 'title' => 'message',
- 'description' => 'Message</br>',
- 'type' => 'string',
- 'example' => 'Message</br>',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'success',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Data' => [
- 'title' => 'data',
- 'description' => 'Request ID</br>',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'Success or not</br>',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'The current customer does not belong to this partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Modify customer shutdown policy',
+ 'summary' => 'Modifies the shutdown policy of a subordinate customer by an Alibaba Cloud distributor partner or reseller partner.',
+ 'description' => 'The caller must be an Alibaba Cloud international channel distributor partner or an Alibaba Cloud international channel reseller partner.'."\n"
+ ."\n"
+ .'**This content is published only on the Chinese site.**.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditZeroCreditShutdown'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditZeroCreditShutdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'EditZeroCreditShutdown',
- 'description' => 'The caller should be the Partner as identified in the Alibaba Cloud distribution model. </br>'."\n"
- .'**This content is only published on the international site. **',
],
'ExportCustomerQuotaRecord' => [
- 'summary' => 'The ExportCustomerQuotaRecord interface corresponds to the export function of "Quota Adjust Details" on ACPN.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Exports the quota adjustment records of a distributor\'s customer, corresponding to the total budget adjustment details export feature on ACPN.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1826,157 +1381,99 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EndUserPk',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => 'Customer UID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5113766248601929',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5113766248601929'],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => 'Start Date Format: yyyy-MM-dd',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-11-10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-11-10'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => 'End Date Format: yyyy-MM-dd',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-12-24',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-12-24'],
],
[
'name' => 'OperationType',
'in' => 'query',
- 'schema' => [
- 'title' => '操作类型'."\n"
- .'枚举'."\n"
- .'all 全部'."\n"
- .'quota_create 创建'."\n"
- .'quota_amount_adjust 额度调整',
- 'description' => 'Operation Type Enum</br>'."\n"
- .'all All types</br>'."\n"
- .'quota_create Create quota</br>'."\n"
- .'quota_amount_adjust Adjust the amount of quota</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'all',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n"
+ .'- all: All operations.'."\n"
+ .'- quota_create: Creation.'."\n"
+ .'- quota_amount_adjust: Quota amount adjustment.', 'type' => 'string', 'required' => true, 'example' => 'all'],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => 'Multilingual Parameters, the default language is English.</br>'."\n"
- .'en: English</br>'."\n"
- .'zh: Chinese</br>'."\n"
- .'ja: Japanese </br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'ID of the Request',
- 'type' => 'string',
- 'example' => '210bc4b416874189683843905d9f9a',
- ],
- 'Msg' => [
- 'title' => '描述',
- 'description' => 'Description',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => 'Code',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210bc4b416874189683843905d9f9a'],
+ 'Msg' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => '200'],
'Data' => [
- 'title' => '数据',
- 'description' => 'Data',
+ 'title' => '',
+ 'description' => 'The data.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '导出任务id',
- 'description' => 'ID of Export task',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1231',
- ],
- 'Cost' => [
- 'title' => '预估耗时，单位分钟',
- 'description' => 'Estimated duration, in minutes.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Id' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231'],
+ 'Cost' => ['title' => '', 'description' => 'The estimated time required, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Export distributor customer quota records',
+ 'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomerQuotaRecord'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ExportCustomerQuotaRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 1231,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'Export Quota Adjust Details',
- 'description' => 'Caller must be a Partner from International Site, either Distribution or Reseller will do.',
],
'ExportReversedDeductionHistory' => [
- 'summary' => 'The ExportReversedDeductionHistory interface corresponds to the export function of "Quota Offsetting Details" on ACPN.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1984,189 +1481,114 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ExportUid',
'in' => 'query',
- 'schema' => [
- 'title' => '被导出的uid',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID for which the reversed deduction details are exported.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-01-01',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-05-01',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-05-01'],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- 'default' => 'en',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language of the exported content. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'asfasd123',
- ],
- 'Message' => [
- 'title' => '描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asfasd123'],
+ 'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
- 'title' => '数据',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '导出任务id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2131',
- ],
- 'Cost' => [
- 'title' => '预估耗时，单位分钟',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Id' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '2131'],
+ 'Cost' => ['title' => '', 'description' => 'The estimated duration, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Export reversed deduction details',
+ 'summary' => 'Exports the reversed deduction details from ACPN.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ExportReversedDeductionHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asfasd123\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 2131,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]',
- 'title' => 'Export Quota Offsetting Details',
],
'GetAccountInfo' => [
- 'summary' => 'Return Distribution Customer\'s account information.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Returns the account information of distributor customers.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'description' => 'Account UID of Distribution Customer. This parameter and the UserType parameter must have one filled. If this parameter is empty, then check all Distribution Customer accounts of the selected UserType.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1215848086704806',
- ],
+ 'schema' => ['description' => 'The UID of the distributor customer account. Either this parameter or the UserType parameter is required. If this parameter is left empty, all distributor customer accounts of the specified UserType are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1215848086704806', 'title' => ''],
],
[
'name' => 'UserType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Distribution Customer\'s Account Type:'."\n"
- .'- 1 End User'."\n"
- .'- 2 Enterprise'."\n"
- .'- 3 T2 Partner',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The type of the distributor customer account. Valid values:'."\n"
+ .'- 1: End User'."\n"
+ .'- 2: enterprise customer '."\n"
+ .'- 3: T2 partner.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'Pagination, current page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'Pagination, record number on each page, maximum 20.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '20',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Maximum value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -2174,348 +1596,123 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code - Error Code. Value Range:'."\n"
- .'- 200 OK'."\n"
- .'- 1109 System Error'."\n"
- .'- 3029: Invalid UID'."\n"
- .'- 3062: UID and UserType are both empty.'."\n"
- .'- 3063: UserType value out of range.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'message',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK'."\n"
+ .'- 1109: System Error'."\n"
+ .'- 3029: Invalid UID'."\n"
+ .'- 3062: Uid and UserType are both empty'."\n"
+ .'- 3063: UserType value out of range.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'message', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values: True and False. This does not indicate whether subsequent business operations are successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PageInfo' => [
- 'description' => 'Pagination Information',
+ 'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => 'Pagination, record number on each page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => 'Pagination, page volume in total.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'Page' => [
- 'description' => 'Pagination, current page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'Page' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'AccountInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccountInfo' => [
- 'description' => 'List of Account Information',
+ 'description' => 'The list of account information.',
'type' => 'array',
'items' => [
- 'description' => 'Account Information',
+ 'description' => 'The account information.',
'type' => 'object',
'properties' => [
- 'SubAccountType' => [
- 'description' => 'Account Type:'."\n"
- .'- 1 Agency\'s End User'."\n"
- .'- 2 Reseller\'s End User'."\n"
- .'- 3 Enterprise'."\n"
- .'- 4 T2 Agency Partner'."\n"
- .'- 5 T2 Reseller Partner'."\n"
- .'- 6 T2 Agency+Reseller Partner',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AssociationSuccessTime' => [
- 'description' => 'The time that Distribution Customer successfully associated with Distributor.',
- 'type' => 'string',
- 'example' => '2021-01-01',
- ],
- 'AccountNickname' => [
- 'description' => 'The name of Sub Account.'."\n"
- .'- Enterprise Customer: Name of Company'."\n"
- .'- T2 Reseller: Name of Partner',
- 'type' => 'string',
- 'example' => 'XXX Technology LTD. ',
- ],
- 'Email' => [
- 'description' => 'The E-mail of Distribution Customer.',
- 'type' => 'string',
- 'example' => '1234@qq.com'."\n",
- ],
- 'Remark' => [
- 'description' => 'Description of Distribution Customer.',
- 'type' => 'string',
- 'example' => 'Sub Account',
- ],
- 'Mobile' => [
- 'description' => 'The contact number of Distribution Customer.',
- 'type' => 'string',
- 'example' => '13641588680',
- ],
- 'AliyunId' => [
- 'description' => 'Alibaba Cloud Login name of Distribution Customer.',
- 'type' => 'string',
- 'example' => '1234@qq.com',
- ],
- 'Uid' => [
- 'description' => 'Account UID of Distribution Customer.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1415740779475837',
- ],
- 'Cid' => [
- 'description' => 'Account CID of Distribution Customer.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '61479572',
- ],
- 'DelayStatus' => [
- 'title' => '延停策略。取值三个如下'."\n"
- .'1、immediatelyStop，立即停机'."\n"
- .'2、delayStop，延迟停机。延迟停机额度见delayAmount字段'."\n"
- .'3、noStop，不停机',
- 'description' => 'There are a value for Shutdown Policy Management towards Sub Account.'."\n"
- .'- 1 immediatelyStop, immediately shutdown the instance once customer\'s quota is ran out.'."\n"
- .'- 2 delayStop, delay shutdown the instance until customer\'s Shutdown-delay Credit is ran out. Please refer to DelayAmount.'."\n"
- .'- 3 noStop, customer\'s instance status is rely on manual control instead of auto setting.',
- 'type' => 'string',
- 'example' => 'immediatelyStop',
- ],
- 'DelayAmount' => [
- 'title' => '当延停策略为delayStop（延迟停机）时，透支的额度',
- 'description' => 'When Shutdown Policy is delayStop, this number refer to Shutdown-delay Credit (overdraft limit).',
- 'type' => 'string',
- 'example' => '600',
- ],
- 'CustomerBd' => [
- 'title' => '客户商务经理',
- 'description' => 'Customer\'s Sales Manager',
- 'type' => 'string',
- 'example' => 'Tommy',
- ],
- 'NewBuyStatus' => [
- 'title' => '下单状态',
- 'description' => 'Purchase Control, Value Range:'."\n"
- .'- Purchase Forbidden'."\n"
- .'- Normal (Purchase is allowed)',
- 'type' => 'string',
- 'example' => 'Normal',
- ],
- 'CustomerAccountType' => [
- 'title' => '客户的账号类型，0个人，1企业',
- 'description' => 'Type of customer\'s account, 0 Individual, 1 Enterprise',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CustomerEnterpriseCertified' => [
- 'title' => '客户是否企业实名，0 否，1是',
- 'description' => 'Whether the customer has completed Enterprise Real-name Authentication, 0 No, 1 Yes',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RegisterCountryCode' => [
- 'title' => '客户的注册国家code',
- 'description' => 'The Country Code where the customer\'s account is registered.',
- 'type' => 'string',
- 'example' => 'CN',
- ],
+ 'SubAccountType' => ['description' => 'The account type. Valid values:'."\n"
+ .'- 1: end customer of Agency'."\n"
+ .'- 2: end customer of Reseller'."\n"
+ .'- 3: enterprise customer'."\n"
+ .'- 4: Agency-type T2 partner'."\n"
+ .'- 5: Reseller-type T2 partner'."\n"
+ .'- 6: Agency+Reseller-type T2 partner.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AssociationSuccessTime' => ['description' => 'The time when the distributor customer account was associated with the partner account to establish the distributor relationship.', 'type' => 'string', 'example' => '2021-01-01', 'title' => ''],
+ 'AccountNickname' => ['description' => 'The nickname of the distributor customer account. For enterprise customers, this is the company name. For T2 partners, this is the partner name.', 'type' => 'string', 'example' => 'XXX技术有限公司', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the distributor customer account.', 'type' => 'string', 'example' => '1234@qq.com'."\n", 'title' => ''],
+ 'Remark' => ['description' => 'The description of the distributor customer account.', 'type' => 'string', 'example' => '子账号', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile phone number of the distributor customer account.', 'type' => 'string', 'example' => '13641588680', 'title' => ''],
+ 'AliyunId' => ['description' => 'The Alibaba Cloud logon name of the distributor customer account.', 'type' => 'string', 'example' => '1234@qq.com', 'title' => ''],
+ 'Uid' => ['description' => 'The UID of the distributor customer account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1415740779475837', 'title' => ''],
+ 'Cid' => ['description' => 'The CID of the distributor customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '61479572', 'title' => ''],
+ 'DelayStatus' => ['title' => '', 'description' => 'The suspension policy. Valid values:'."\n"
+ .'- immediatelyStop: immediately suspends the account.'."\n"
+ .'- delayStop: suspends the account after a delay. The overdraft quota is specified by the DelayAmount field.'."\n"
+ .'- noStop: does not suspend the account.', 'type' => 'string', 'example' => 'immediatelyStop'],
+ 'DelayAmount' => ['title' => '', 'description' => 'The overdraft quota when the suspension policy is set to delayStop (delayed suspension).', 'type' => 'string', 'example' => '600'],
+ 'CustomerBd' => ['title' => '', 'description' => 'The business development manager of the customer.', 'type' => 'string', 'example' => '张三'],
+ 'NewBuyStatus' => ['title' => '', 'description' => 'The purchase status. Valid values:'."\n"
+ .'- Purchase Forbidden: purchasing is prohibited.'."\n"
+ .'- Normal: purchasing is allowed.', 'type' => 'string', 'example' => 'Normal'],
+ 'CustomerAccountType' => ['title' => '', 'description' => 'The account type of the customer. Valid values:'."\n"
+ .'- 0: individual'."\n"
+ .'- 1: enterprise.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CustomerEnterpriseCertified' => ['title' => '', 'description' => 'Indicates whether the customer has completed enterprise real-name verification. Valid values:'."\n"
+ .'- 0: no'."\n"
+ .'- 1: yes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RegisterCountryCode' => ['title' => '', 'description' => 'The country code of the customer registration country/region.', 'type' => 'string', 'example' => 'CN'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'Request id, a unique identifier generated by Alibaba Cloud for the request.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"AccountInfoList\\": {\\n \\"AccountInfo\\": [\\n {\\n \\"SubAccountType\\": 1,\\n \\"AssociationSuccessTime\\": \\"2021-01-01\\",\\n \\"AccountNickname\\": \\"XXX技术有限公司\\",\\n \\"Email\\": \\"1234@qq.com\\\\n\\",\\n \\"Remark\\": \\"子账号\\",\\n \\"Mobile\\": \\"13641588680\\",\\n \\"AliyunId\\": \\"1234@qq.com\\",\\n \\"Uid\\": 1415740779475837,\\n \\"Cid\\": 61479572,\\n \\"DelayStatus\\": \\"immediatelyStop\\",\\n \\"DelayAmount\\": \\"600\\",\\n \\"CustomerBd\\": \\"张三\\",\\n \\"NewBuyStatus\\": \\"Normal\\",\\n \\"CustomerAccountType\\": 1,\\n \\"CustomerEnterpriseCertified\\": 1,\\n \\"RegisterCountryCode\\": \\"CN\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'GetAccountInfo',
- ],
- 'GetCreditInfo' => [
- 'summary' => 'Query Credit Control information of Distribution Customers. The PopCreditInfoJson in the Return Parameter will be empty if the Distribution Customer is an Agency. This function is only available for Resellers and Distributors.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Message Information',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1792155717328010',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => 'success',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'string',
- 'example' => 'The data returned.'."\n",
- ],
- 'Success' => [
- 'description' => 'The Credit have been consumed by Sub Account, and haven\'t be paid.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => 'The Credit Line of Sub Account',
- 'type' => 'object',
- 'properties' => [
- 'OutstandingBalance' => [
- 'description' => 'The Credit Control status, Value Range:</br>'."\n"
- .'1. normal - Sub Account status is running as usual.'."\n"
- .'2. arrearsNotShutdown - Sub Account status is running as usual, but have outstanding bill(s).'."\n"
- .'3. shutdown - Sub Account status is down.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'CreditLine' => [
- 'description' => 'The Credit available to consume.',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'AccountStatus' => [
- 'description' => 'Percentage value, when the available credit limit is lower than this credit limit percentage, a notification E-mail will be sent to the main account.',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'AvailableCredit' => [
- 'description' => 'The systematic controlling policy for resource management, specifically when the available Credit of Sub Account falls to 0 or less.</br>'."\n"
- ."\n"
- .'- 1: delayStop. The account have Shutdown-delay Privilege, After Shutdown-delay Credit is ran out, Alibaba Cloud will take over resources and keep the instance for 15 days. In addition, the instance will be released if Sub Account failed to pay the bill within these 15 days.</br>'."\n"
- .'- 2: noStop. Partner will manually manage Shutdown Status for Sub Account. Meanwhile, System would not manage the resource\'s life-circle of Sub Account.</br>'."\n"
- .'- 3: immediatelyStop. Once valid quota of Sub Account falls below 0 and be identified as defaulting account, it will trigger the instance shutdown immediately.</br>',
- 'type' => 'string',
- 'example' => '800',
- ],
- 'AlarmThreshold' => [
- 'description' => 'Manage order operation.'."\n"
- .'- ban：Ban the new purchase action.'."\n"
- .'- normal：The account could raise new purchase order as usual.',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'ZeroCreditShutdownPolicy' => [
- 'description' => 'Obtain total unpaid amount on demo bill before simulated deduction.',
- 'type' => 'string',
- 'example' => 'delayStop',
- ],
- 'newBuyStatus' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'string',
- 'example' => 'ban',
- ],
- 'ConsumedUndeductedValue' => [
- 'title' => '获取模拟抵扣前虚账单未结清总额',
- 'description' => 'Consumed & Undeducted Value（Amount consumption at the current point in time and for which the quota has not been deducted）',
- 'type' => 'string',
- 'example' => '0.000000',
- ],
- 'PAYGFreezeStatus' => [
- 'type' => 'string',
- 'description' => 'PAYG Freeze Status'."\n"
- ."\n"
- .'freeze：freeze'."\n"
- ."\n"
- .'normal：normal',
- 'example' => 'normal',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'title' => 'Query distributor customer information',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-05T01:47:08.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountInfo'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OutstandingBalance\\": \\"200\\",\\n \\"CreditLine\\": \\"1000\\",\\n \\"AccountStatus\\": \\"normal\\",\\n \\"AvailableCredit\\": \\"800\\",\\n \\"AlarmThreshold\\": \\"20\\",\\n \\"ZeroCreditShutdownPolicy\\": \\"delayStop\\",\\n \\"newBuyStatus\\": \\"ban\\",\\n \\"ConsumedUndeductedValue\\": \\"0.000000\\",\\n \\"PAYGFreezeStatus\\": \\"normal\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'GetCreditInfo',
],
- 'GetPurchaseControlRecord' => [
- 'summary' => '下单控制记录查询',
+ 'GetCommissionableProducts' => [
+ 'summary' => 'Provides T1-tier international distribution partners with a list of all commission-eligible commodities that are in the "Active" or "Delisted" status. This operation is available only for international users and cannot be called on the China site.',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2523,352 +1720,135 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OperationTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始时间'."\n"
- .'为空则取半年内的数据'."\n"
- .'时间格式为 yyyy-MM-dd HH:mm:ss',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-12-15 10:34:36',
- ],
- ],
- [
- 'name' => 'CustomerUID',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '292828565558721922',
- ],
- ],
- [
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'title' => '页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The current page number for pagination. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'ListShowStatusList',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => 'RequestId',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ChangedType' => [
- 'title' => '变更类型'."\n"
- .'ban 禁止新购'."\n"
- .'cancelBan 取消禁止',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'cancelBan ' => '',
- 'ban ' => '',
- ],
- 'example' => 'ban ',
- ],
- 'OperationTime' => [
- 'title' => '操作时间（UTC+8）',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2023-12-15 10:34:36',
- ],
- 'OperationPath' => [
- 'title' => '操作发起方式',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACPN',
- ],
- 'Operator' => [
- 'title' => '操作人',
- 'description' => '',
- 'type' => 'string',
- 'example' => '292828565558721922',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'title' => '总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'description' => 'The list of display statuses for commission commodities.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The display status of a commission commodity.',
+ 'enumValueTitles' => ['PRE_ONLINE' => '待生效', 'OFF_ONLINE' => '已失效', 'ONLINE' => '生效中', 'OFFLINE' => '已下架'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["ONLINE","OFFLINE"]',
+ 'title' => '',
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": [\\n {\\n \\"ChangedType\\": \\"ban \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"292828565558721922\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- ],
- 'GetShutdownPolicyRecord' => [
- 'summary' => '查询延停策略修改记录',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'CommodityCodeList',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The commodity codes. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '"oceanbase_obpre_public_intl,savingplan_common_public_intl"', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
[
- 'name' => 'OperationTime',
+ 'name' => 'PipCodeList',
'in' => 'query',
- 'schema' => [
- 'title' => '起始时间'."\n"
- .'为空则取半年内的数据'."\n"
- .'时间格式为 yyyy-MM-dd HH:mm:ss',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-12-15 10:34:36',
- ],
+ 'schema' => ['description' => 'The product codes. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '"oceanbase"', 'title' => ''],
],
[
- 'name' => 'CustomerUID',
+ 'name' => 'RealStartMonth',
'in' => 'query',
- 'schema' => [
- 'title' => '客户id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '292828565558721922',
- ],
+ 'schema' => ['description' => 'The actual start month in the format of "yyyymm".', 'type' => 'string', 'required' => false, 'example' => '“202502”', 'title' => ''],
],
[
- 'name' => 'PageNo',
+ 'name' => 'RealEndMonth',
'in' => 'query',
- 'schema' => [
- 'title' => '页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The actual end month in the format of "yyyymm".', 'type' => 'string', 'required' => false, 'example' => '“202509”', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'FiscalYear',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'minimum' => '5',
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The fiscal year. If this parameter is left empty, the current fiscal year is used by default.', 'type' => 'string', 'required' => false, 'example' => '“FY26”', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '210e876f16704666020714468dab35',
- ],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The list of returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'CurrentPolicy' => [
- 'title' => '当前策略'."\n"
- .'immediatelyStop 欠费立即停机'."\n"
- .'delayStop 享受延停额度'."\n"
- .'noStop 欠费不停机',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'immediatelyStop ' => '',
- 'noStop ' => '',
- 'delayStop ' => '',
- ],
- 'example' => 'noStop ',
- ],
- 'PreviousPolicy' => [
- 'title' => '变更前策略'."\n"
- .'immediatelyStop 欠费立即停机'."\n"
- .'delayStop 享受延停额度'."\n"
- .'noStop 欠费不停机',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'immediatelyStop ' => '',
- 'noStop ' => '',
- 'delayStop ' => '',
- ],
- 'example' => 'immediatelyStop ',
- ],
- 'OperationTime' => [
- 'title' => '操作时间（UTC+8）',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2023-12-15 10:34:36',
- ],
- 'OperationPath' => [
- 'title' => '操作发起方式',
- 'description' => '',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'ALIYUN_BIZ' => '',
- 'API' => 'API',
- 'ACPN' => 'ACPN',
- ],
- 'example' => 'ACPN',
- ],
- 'Operator' => [
- 'title' => '操作人',
- 'description' => '',
- 'type' => 'string',
- 'example' => '11111111111',
- ],
+ 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => '“oceanbase_obpre_public_intl”', 'title' => ''],
+ 'CommodityName' => ['description' => 'The commodity name.', 'type' => 'string', 'example' => '“ApsaraDB for OceanBase Pre”', 'title' => ''],
+ 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => '“oceanbase”', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '“ApsaraDB for OceanBase”', 'title' => ''],
+ 'Status' => ['description' => 'The display status of the product.', 'type' => 'string', 'example' => '“ONLINE”', 'title' => ''],
+ 'ActualStartMonth' => ['description' => 'The actual start month in the format of "yyyymm".', 'type' => 'string', 'example' => '“202502”', 'title' => ''],
+ 'EndMonth' => ['description' => 'The actual end month in the format of "yyyymm".', 'type' => 'string', 'example' => '“202509”', 'title' => ''],
+ 'EligibleForCommission' => ['description' => 'Indicates whether the commodity is eligible for commission.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
+ 'EligibleForDiscount' => ['description' => 'Indicates whether the commodity is eligible for discount.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
+ 'SevenCoreProducts' => ['description' => 'Indicates whether the commodity is a core product.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
+ 'ProductCampaign' => ['description' => 'Indicates whether the commodity is a product line incentive commodity.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'title' => '总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5', 'title' => ''],
+ 'Code' => ['description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Valid values: True and False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": [\\n {\\n \\"CurrentPolicy\\": \\"noStop \\",\\n \\"PreviousPolicy\\": \\"immediatelyStop \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"11111111111\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- ],
- 'QueryReversedDeductionHistory' => [
- 'summary' => '额度冲减明细列表',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query commission commodity list',
+ 'description' => 'Make sure that the current caller account is a distribution partner. '."\n"
+ .'<notice>Available only for international users.</notice>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCommissionableProducts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"CommodityCode\\": \\"“oceanbase_obpre_public_intl”\\",\\n \\"CommodityName\\": \\"“ApsaraDB for OceanBase Pre”\\",\\n \\"ProductCode\\": \\"“oceanbase”\\",\\n \\"ProductName\\": \\"“ApsaraDB for OceanBase”\\",\\n \\"Status\\": \\"“ONLINE”\\",\\n \\"ActualStartMonth\\": \\"“202502”\\",\\n \\"EndMonth\\": \\"“202509”\\",\\n \\"EligibleForCommission\\": \\"Yes\\",\\n \\"EligibleForDiscount\\": \\"Yes\\",\\n \\"SevenCoreProducts\\": \\"Yes\\",\\n \\"ProductCampaign\\": \\"Yes\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetCouponTemplateDetail' => [
+ 'summary' => 'Query Coupon Template Details',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2876,860 +1856,298 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-07-31',
- ],
- ],
- [
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期'."\n"
- .'格式：yyyy-MM-dd',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-12-31',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页每页记录数，最大值100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'PageNo',
+ 'name' => 'TemplateId',
'in' => 'query',
- 'schema' => [
- 'title' => '分页，当前页码，从 1 开始',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Language',
- 'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- 'default' => 'en',
- ],
+ 'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5093156', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'title' => '总条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '当前每页条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'title' => '列表数据',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '列表数据',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OperationSubmitType' => [
- 'title' => '操作发起方式'."\n"
- .'API/ACPN',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ACPN',
- ],
- 'OperationTime' => [
- 'title' => '操作时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-11-01 10:22:11 UTC+8',
- ],
- 'OperationUid' => [
- 'title' => '操作人uid',
- 'description' => '',
- 'type' => 'string',
- 'example' => '132',
- ],
- 'OffsetAmount' => [
- 'title' => '冲减金额',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.00',
- ],
- ],
+ 'description' => 'The operation result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1576', 'title' => ''],
+ 'TemplateName' => ['description' => 'The coupon template name.', 'type' => 'string', 'example' => '模板名称', 'title' => ''],
+ 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-21 18:18:22', 'title' => ''],
+ 'ReasonForApplication' => ['description' => 'The reason for template application.', 'type' => 'string', 'example' => '测试的', 'title' => ''],
+ 'CostBearer' => ['description' => 'The coupon cost bearer.'."\n"
+ .'● cost_by_self: Borne by the partner.'."\n"
+ .'● aliyun_poc: Borne by Alibaba Cloud.', 'type' => 'string', 'example' => 'aliyun_poc', 'title' => ''],
+ 'ApplicableProducts' => ['description' => 'The applicable products.'."\n"
+ ."\n"
+ .'- UNIVERSAL: All products.'."\n"
+ ."\n"
+ .'- Specific product code.', 'type' => 'string', 'example' => 'UNIVERSAL', 'title' => ''],
+ 'LimitPerPerson' => ['description' => 'The limit of coupons per person.'."\n"
+ ."\n"
+ .'- 1: Limited to one coupon.'."\n"
+ ."\n"
+ .'- 0: Unlimited.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Denomination' => ['description' => 'The denomination.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'ValidUntilType' => ['description' => 'The validity period type.'."\n"
+ ."\n"
+ .'- 0: Relative time.'."\n"
+ .'- 1: Absolute time.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'ValidUntil' => ['description' => 'The validity period, used in conjunction with the validity type.'."\n"
+ ."\n"
+ .'- If the validity type is relative time, the validity period indicates the number of valid days.'."\n"
+ ."\n"
+ .'- If the validity type is absolute time, the validity period indicates a time range.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'PurchaseType' => ['description' => 'The order type.'."\n"
+ .'- ALL: Alibaba Cloud subscription.'."\n"
+ .'- BILLING: Alibaba Cloud pay-as-you-go billing.', 'type' => 'string', 'example' => 'ALL,BILLING', 'title' => ''],
+ 'CouponDescription' => ['description' => 'The coupon remarks.', 'type' => 'string', 'example' => '测试的', 'title' => ''],
+ 'Status' => ['description' => 'The status.'."\n"
+ ."\n"
+ .'- APPROVED: Approved.'."\n"
+ .'- ABANDONED: Abandoned.', 'type' => 'string', 'example' => 'APPROVED', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'asda1231as',
- ],
- 'Message' => [
- 'title' => '返回结果描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Code' => [
- 'title' => '返回结果状态码，200是成功',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2024-11-01 10:22:11 UTC+8\\",\\n \\"OperationUid\\": \\"132\\",\\n \\"OffsetAmount\\": \\"1.00\\"\\n }\\n ],\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
- 'title' => 'QueryReversedDeductionHistory',
- ],
- 'SetAccountInfo' => [
- 'summary' => 'This function is designed for Sub Account information maintenance, including Nickname and Remark.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
+ ['errorCode' => 'ERROR_1002', 'errorMessage' => 'No query permission.', 'description' => 'No query permission'],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AccountNickname',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Result Code:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 System error'."\n"
- .'* 3030 Sub Account Nickname exceeds maximum length, maximum length 150 bytes.'."\n"
- .'* 3031 Remark exceeds maximum length, maximum length 3000 bytes.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Message information',
- ],
- ],
- [
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'success',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- ],
- ],
- [
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Request ID, Alibaba Cloud will track errors with this.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1133166938931507',
- ],
- ],
- [
- 'name' => 'CustomerBd',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户商务经理',
- 'description' => 'Customer manager（limited 50 character）',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abc',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query Coupon Template Details',
+ 'description' => 'Ensure that the current calling account is a distribution partner.'."\n"
+ .'<notice>Available only for international use.</notice>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCouponTemplateDetail'],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCouponTemplateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'Error3030',
- 'errorMessage' => 'The maximum length of CustomNick is 150.',
- ],
- [
- 'errorCode' => 'Error3031',
- 'errorMessage' => 'The maximum length of FxDescription is 3000.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'SetAccountInfo',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TemplateId\\": 1576,\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"CreatedTime\\": \\"2024-11-21 18:18:22\\",\\n \\"ReasonForApplication\\": \\"测试的\\",\\n \\"CostBearer\\": \\"aliyun_poc\\",\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"LimitPerPerson\\": 1,\\n \\"Denomination\\": 100,\\n \\"ValidUntilType\\": \\"0\\",\\n \\"ValidUntil\\": \\"100\\",\\n \\"PurchaseType\\": \\"ALL,BILLING\\",\\n \\"CouponDescription\\": \\"测试的\\",\\n \\"Status\\": \\"APPROVED\\"\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'SetCreditLine' => [
- 'summary' => 'Set Credit Line for Distribution Customers. This function is only available for Resellers and Distributors.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetCoupondeductProductCode' => [
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The UID of Sub Account.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1263644979775567',
- ],
- ],
- [
- 'name' => 'CreditLine',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'description' => 'New Credit Line',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['title' => '', 'description' => 'Multi-language parameter. '."\n"
+ .'Default value: none.'."\n"
+ .' Chinese: zh-CN'."\n"
+ .' English: en-US.', 'type' => 'string', 'required' => true, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 system error'."\n"
- .'* 3040 Sub Account is in a frozen state and cannot be operated.'."\n"
- .'* 3041 Credit is not a proper number',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Same as Code parameter value'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
+ 'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'200: OK.', 'type' => 'string', 'example' => 'code', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductType' => ['description' => 'The product code.', 'type' => 'any', 'example' => 'code1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'Error3040',
- 'errorMessage' => 'The account is in a frozen state and cannot be operated.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'This uid is not your EU.',
- ],
+ ['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
+ ['errorCode' => 'ERROR_3210', 'errorMessage' => 'The current calling UID is not an international channel partner.', 'description' => 'The current calling UID is not an international channel partner'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'SetCreditLine',
- 'requestParamsDescription' => 'Reference Parameters: </br>'."\n"
- .'[GetCreditInfo](https://next.api.aliyun.com/api/Agency/2022-12-16/GetCreditInfo)',
- ],
- 'SetWarningThreshold' => [
- 'summary' => 'You can use this API to set the threshold for the use of credit control. When the customer credit control reaches below the threshold, it will pass through the notification email distributor. This feature is for Reseller and Distributor only.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query products eligible for international channel distribution coupon offset',
+ 'summary' => 'Queries the products that can be offset by international channel distribution coupons.',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-26T04:14:18.000Z', 'description' => 'Error codes changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCoupondeductProductCode'],
],
],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The UID of the partner‘s customer.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1792155717328010',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'WarningValue',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Percentage, 1 to 100. When the available credit limit is lower than the credit limit percentage, an email is sent to the main account.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '20',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => 'Result Code:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 System Error'."\n"
- .'* 3040 The Sub Account is frozen, the operation cannot be completed. '."\n"
- .'* 3044 Alert proportion value is not a number.'."\n"
- .'* 3045 Alert proportion value should between 1 to 100.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Same as Code parameter value'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True or False, which indicates whether the current API call itself is successful. does not represent the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCoupondeductProductCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
- [
- 'errorCode' => 'Error3040',
- 'errorMessage' => 'The account is in a frozen state and cannot be operated.',
- ],
- [
- 'errorCode' => 'Error3044',
- 'errorMessage' => 'The Value is not a number.',
- ],
- [
- 'errorCode' => 'Error3045',
- 'errorMessage' => 'The value must be between 1-100.',
- ],
- [
- 'errorCode' => 'InvalidParam.Uid.NotYourEu',
- 'errorMessage' => 'This uid is not your EU.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'SetWarningThreshold',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"code\\",\\n \\"Data\\": [\\n {\\n \\"ProductType\\": \\"code1\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'CancelSubscriptionBill' => [
- 'summary' => 'Cancels the subscription to multi-level bills as an Alibaba Cloud eco-partner.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetCreditInfo' => [
+ 'summary' => 'Queries the credit control information of a distributor customer. If the distributor customer is of the Agency type, the PopCreditInfoJson parameter in the response is empty. This feature is available only for Reseller and Distributor.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SubscribeType',
+ 'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the bill to which you want to cancel the subscription. Valid values: PartnerBillingItemDetailForBillingPeriod, PartnerBillingItemDetailMonthly, PartnerInstanceDetailForBillingPeriod, and PartnerInstanceDetailMonthly.'."\n",
- 'example' => 'PartnerBillingItemDetailForBillingPeriod',
- 'required' => true,
- 'title' => 'subscribeType',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1792155717328010', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => 'The message that is returned.'."\n",
- 'example' => 'Successful'."\n",
- 'title' => 'message',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'example' => '210e876f16704666020714468dab35',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values:'."\n"
+ .'- True: Successful.'."\n"
+ .'- False: Failed.'."\n"
+ ."\n"
+ .'This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => 'The data that is returned.'."\n",
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => 'The HTTP status code that is returned.'."\n",
- 'enumValueTitles' => [
- 1008 => '',
- '',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutstandingBalance' => ['description' => 'The credit amount consumed by the sub-account that has not yet been paid.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'CreditLine' => ['description' => 'The credit limit of the sub-account.', 'type' => 'string', 'example' => '1000', 'title' => ''],
+ 'AccountStatus' => ['description' => 'The credit control status of the sub-account. Valid values:'."\n"
+ .'1. normal: Normal.'."\n"
+ .'2. arrearsNotShutdown: The account has an overdue payment but is not shut down.'."\n"
+ .'3. shutdown: Shut down.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
+ 'AvailableCredit' => ['description' => 'The available credit.', 'type' => 'string', 'example' => '800', 'title' => ''],
+ 'AlarmThreshold' => ['description' => 'The percentage value. When the available credit drops below this percentage of the credit limit, an email notification is sent to the main account.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'ZeroCreditShutdownPolicy' => ['description' => 'The policy that the system uses to manage resources when the active credit is 0 or less. Valid values:'."\n"
+ ."\n"
+ .'1: delayStop. Alibaba Cloud takes over the resources. Instances are shut down after the credit is exhausted with a delay epoch. If payment is not made within 15 days, storage resources are released.'."\n"
+ ."\n"
+ .'2: noStop. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manage it manually.'."\n"
+ ."\n"
+ .'3: immediatelyStop. Instances are shut down immediately when the account enters the overdue payment state, which triggers instance shutdown.', 'type' => 'string', 'example' => 'delayStop', 'title' => ''],
+ 'newBuyStatus' => ['description' => 'The status that manages the purchase actions of the customer. Valid values:'."\n"
+ ."\n"
+ .'- ban: New purchases are prohibited.'."\n"
+ .'- cancelBan: Normal status.', 'type' => 'string', 'example' => 'ban', 'title' => ''],
+ 'ConsumedUndeductedValue' => ['title' => '', 'description' => 'The total outstanding amount of virtual bills before simulated deduction.', 'type' => 'string', 'example' => '0.000000'],
+ 'PAYGFreezeStatus' => ['description' => 'The freeze status of pay-as-you-go. Valid values:'."\n"
+ .'- freeze: Frozen.'."\n"
+ .'- normal: Normal.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
],
- 'example' => '200',
- 'title' => 'code',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'example' => 'true',
- 'title' => 'success',
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
- 'title' => 'result',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'description' => 'Make sure that you are a distributor of the Alibaba Cloud international ecosystem.'."\n"
- ."\n"
- .'You can call this operation to cancel the subscription to only one type of bill at a time.'."\n"
- ."\n"
- .'After the subscription to a type of bill is canceled, bills of this type are no longer pushed to the specified Object Storage Service (OSS) bucket.'."\n"
- ."\n"
- .'**This topic is published only on the international site (alibabacloud.com).'."\n",
- 'title' => 'CancelSubscriptionBill',
- ],
- 'GetCommissionableProducts' => [
- 'summary' => '提供返佣商品API',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OutstandingBalance\\": \\"200\\",\\n \\"CreditLine\\": \\"1000\\",\\n \\"AccountStatus\\": \\"normal\\",\\n \\"AvailableCredit\\": \\"800\\",\\n \\"AlarmThreshold\\": \\"20\\",\\n \\"ZeroCreditShutdownPolicy\\": \\"delayStop\\",\\n \\"newBuyStatus\\": \\"ban\\",\\n \\"ConsumedUndeductedValue\\": \\"0.000000\\",\\n \\"PAYGFreezeStatus\\": \\"normal\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Query budget status information of a distributor customer',
+ 'changeSet' => [
+ ['createdAt' => '2023-12-22T03:27:29.000Z', 'description' => 'Response parameters changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreditInfo'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'PageNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ListShowStatusList',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'PRE_ONLINE' => '',
- 'OFF_ONLINE' => '',
- 'ONLINE' => '',
- 'OFFLINE' => '',
- ],
- 'example' => '["ONLINE","OFFLINE"]',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCreditInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'CommodityCodeList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"oceanbase_obpre_public_intl,savingplan_common_public_intl"',
- ],
- ],
- [
- 'name' => 'PipCodeList',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '"oceanbase"',
- ],
- ],
- [
- 'name' => 'RealStartMonth',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“202502”',
- ],
- ],
- [
- 'name' => 'RealEndMonth',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“202509”',
- ],
- ],
- [
- 'name' => 'FiscalYear',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“FY26”',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CommodityCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“oceanbase_obpre_public_intl”',
- ],
- 'CommodityName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“ApsaraDB for OceanBase Pre”',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“oceanbase”',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“ApsaraDB for OceanBase”',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“ONLINE”',
- ],
- 'ActualStartMonth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“202502”',
- ],
- 'EndMonth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“202509”',
- ],
- 'EligibleForCommission' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Yes',
- ],
- 'EligibleForDiscount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Yes',
- ],
- 'SevenCoreProducts' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Yes',
- ],
- 'ProductCampaign' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Yes',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2103a30617045934095083027d88c5',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"CommodityCode\\": \\"“oceanbase_obpre_public_intl”\\",\\n \\"CommodityName\\": \\"“ApsaraDB for OceanBase Pre”\\",\\n \\"ProductCode\\": \\"“oceanbase”\\",\\n \\"ProductName\\": \\"“ApsaraDB for OceanBase”\\",\\n \\"Status\\": \\"“ONLINE”\\",\\n \\"ActualStartMonth\\": \\"“202502”\\",\\n \\"EndMonth\\": \\"“202509”\\",\\n \\"EligibleForCommission\\": \\"Yes\\",\\n \\"EligibleForDiscount\\": \\"Yes\\",\\n \\"SevenCoreProducts\\": \\"Yes\\",\\n \\"ProductCampaign\\": \\"Yes\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetCustomerOrders' => [
- 'summary' => '客户订单查询',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Queries customer orders on the China site (Chinese mainland). This operation can be called only on the Chinese mainland site.',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3737,55 +2155,38 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '209335720330622',
- ],
+ 'schema' => ['description' => 'The order ID. This parameter is optional.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '209335720330622', 'title' => ''],
],
[
'name' => 'CustomerAccount',
'in' => 'query',
- 'schema' => [
- 'title' => '客户账号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_123',
- ],
+ 'schema' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'required' => false, 'example' => 'test_123'],
],
[
'name' => 'CustomerUid',
'in' => 'query',
- 'schema' => [
- 'title' => '客户UID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
- 'title' => '订单类型：BUY、REFUND、UPGRADE、DOWNGRADE、REFUND、OTHERS',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order type. Valid values:'."\n"
+ .'- BUY: new purchase.'."\n"
+ .'- UPGRADE: upgrade.'."\n"
+ .'- DOWNGRADE: downgrade.'."\n"
+ .'- RENEW: renewal.'."\n"
+ .'- REFUND: refund.'."\n"
+ .'- OTHERS: other.',
+ 'enumValueTitles' => [],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [],
'example' => 'RENEW',
],
],
@@ -3793,12 +2194,15 @@
'name' => 'OrderStatus',
'in' => 'query',
'schema' => [
- 'title' => '订单状态：1 未支付；2 已废弃；3 已支付',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid.'."\n"
+ .'- 2: canceled.'."\n"
+ .'- 3: paid.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'enumValueTitles' => [],
'example' => '3',
],
],
@@ -3806,325 +2210,292 @@
'name' => 'TimeType',
'in' => 'query',
'schema' => [
- 'title' => '时间类型：1 支付时间；2 下单时间',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The time type. Valid values:'."\n"
+ .'- 1: payment time.'."\n"
+ .'- 2: order placement time.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [],
'example' => '2',
],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2024-08-13 00:00:00',
- 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time. This parameter is used together with TimeType. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'example' => '2024-08-13 00:00:00'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2024-08-23 00:00:00',
- 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time. This parameter is used together with TimeType. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'example' => '2024-08-23 00:00:00'],
],
[
'name' => 'CustomerManager',
'in' => 'query',
- 'schema' => [
- 'title' => '客户经理',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myBd',
- ],
+ 'schema' => ['title' => '', 'description' => 'The account manager.', 'type' => 'string', 'required' => false, 'example' => 'myBd'],
],
[
'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'title' => '产品明细code',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vm_intl',
- ],
+ 'schema' => ['title' => '', 'description' => 'The product detail code.', 'type' => 'string', 'required' => false, 'example' => 'vm_intl'],
],
[
'name' => 'OrderSource',
'in' => 'query',
'schema' => [
- 'title' => '订单来源：0 普通客户；1 企业客户；2 二级经销商',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order source. Valid values:'."\n"
+ .'- 0: regular customer.'."\n"
+ .'- 1: enterprise customer.'."\n"
+ .'- 2: secondary reseller.',
+ 'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'enumValueTitles' => [],
'example' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNo',
'in' => 'query',
'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '500',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Msg' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F'],
+ 'Message' => ['description' => 'The message. The value is the same as the Code parameter.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Msg' => ['description' => 'The message. The value is the same as the Code parameter.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 201: parameter exception.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Indicates whether the customer was created. If the value is true, the Message contains the CID.',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '236414227150922',
- ],
- 'CustomerAccount' => [
- 'title' => '客户账户',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_123',
- ],
- 'CustomerNo' => [
- 'title' => '客户UID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'ProductDetail' => [
- 'title' => '产品明细',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss',
- ],
- 'ProductType' => [
- 'title' => '产品明细code',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'snapshot',
- ],
- 'OrderType' => [
- 'title' => '订单类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BUY',
- ],
- 'OriginalCost' => [
- 'title' => '订单原价',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3.92',
- ],
- 'PretaxCost' => [
- 'title' => '应付金额',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3.92',
- ],
- 'OrderStatus' => [
- 'title' => '订单状态',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TimeToOrder' => [
- 'title' => '下单时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-08-13 13:02:02',
- ],
- 'PaymentTime' => [
- 'title' => '支付时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-08-13 13:02:02',
- ],
- 'PaymentMethod' => [
- 'title' => '付款方式',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3:32',
- ],
- 'CustomerManager' => [
- 'title' => '客户经理',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'myBd',
- ],
- 'OrderSource' => [
- 'title' => '订单来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
+ 'OrderId' => ['description' => 'The order ID. This parameter is optional.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922', 'title' => ''],
+ 'CustomerAccount' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123'],
+ 'CustomerNo' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'ProductDetail' => ['title' => '', 'description' => 'The product details.', 'type' => 'string', 'example' => 'oss'],
+ 'ProductType' => ['title' => '', 'description' => 'The product detail code.', 'type' => 'string', 'example' => 'snapshot'],
+ 'OrderType' => ['title' => '', 'description' => 'The order type. Valid values:'."\n"
+ .'- BUY: new purchase.'."\n"
+ .'- UPGRADE: upgrade.'."\n"
+ .'- DOWNGRADE: downgrade.'."\n"
+ .'- RENEW: renewal.'."\n"
+ .'- REFUND: refund.'."\n"
+ .'- OTHERS: other.', 'type' => 'string', 'example' => 'BUY'],
+ 'OriginalCost' => ['title' => '', 'description' => 'The original price of the order.', 'type' => 'number', 'format' => 'double', 'example' => '3.92'],
+ 'PretaxCost' => ['title' => '', 'description' => 'The payable amount.', 'type' => 'number', 'format' => 'double', 'example' => '3.92'],
+ 'OrderStatus' => ['title' => '', 'description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid.'."\n"
+ .'- 2: canceled.'."\n"
+ .'- 3: paid.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TimeToOrder' => ['title' => '', 'description' => 'The order placement time.', 'type' => 'string', 'example' => '2024-08-13 13:02:02'],
+ 'PaymentTime' => ['title' => '', 'description' => 'The payment time.', 'type' => 'string', 'example' => '2024-08-13 13:02:02'],
+ 'PaymentMethod' => ['title' => '', 'description' => 'The payment method.', 'type' => 'string', 'example' => '3:32'],
+ 'CustomerManager' => ['title' => '', 'description' => 'The account manager.', 'type' => 'string', 'example' => 'myBd'],
+ 'OrderSource' => ['title' => '', 'description' => 'The order source. Valid values:'."\n"
+ .'- 0: regular customer.'."\n"
+ .'- 1: enterprise customer.'."\n"
+ .'- 2: secondary reseller.', 'type' => 'string', 'example' => '0'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions',
- 'errorMessage' => 'No permissions for the operation.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query customer orders',
+ 'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel reseller partner.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T05:55:39.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrders'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCustomerOrders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"200\\",\\n \\"Msg\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"CustomerNo\\": 123456,\\n \\"ProductDetail\\": \\"oss\\",\\n \\"ProductType\\": \\"snapshot\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"OriginalCost\\": 3.92,\\n \\"PretaxCost\\": 3.92,\\n \\"OrderStatus\\": 3,\\n \\"TimeToOrder\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentTime\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentMethod\\": \\"3:32\\",\\n \\"CustomerManager\\": \\"myBd\\",\\n \\"OrderSource\\": \\"0\\"\\n }\\n ],\\n \\"PageSize\\": 1,\\n \\"PageNo\\": 1,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
'GetDailyBill' => [
- 'summary' => 'Issue Distributor\'s daily Bill. This function is only available for Resellers and Distributors.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Retrieves the daily bill of a distributor. This feature is available only for Resellers and Distributors.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Date',
'in' => 'query',
- 'schema' => [
- 'description' => 'Billing date. Format YYYY-MM-DD',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-11-24',
- ],
+ 'schema' => ['description' => 'Billing date. Format YYYY-MM-DD.', 'type' => 'string', 'required' => true, 'example' => '2022-11-24', 'title' => ''],
],
[
'name' => 'BillOwner',
'in' => 'query',
+ 'schema' => ['description' => 'The type of bill owner. Valid values:'."\n"
+ ."\n"
+ .'1: distribution partner account '."\n"
+ ."\n"
+ .'2: distribution customer account.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'BillType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The bill type. Valid values:'."\n"
+ ."\n"
+ .'- DailyOrder (Deprecated)'."\n"
+ ."\n"
+ .'- DailyBill (Deprecated)'."\n"
+ ."\n"
+ .'- DailyInstanceBill (Deprecated) '."\n"
+ .'- DailyInstanceBillV2.', 'type' => 'string', 'required' => true, 'example' => 'DailyInstanceBillV2', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'Bill Owner type. Value Range:</br>'."\n"
- .'1: Master account</br>'."\n"
- .'2: Sub account</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.'."\n"
+ .'- 3050: Bill type can only be DailyOrder, DailyBill, or DailyInstanceBill. '."\n"
+ .'- 3049: Invalid spending time format.'."\n"
+ .'- 3048: Bill owner can only be 1 or 2.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message corresponding to the Code value.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'BillLinkCSV' => ['description' => 'The download URL of the CSV file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
+ 'SpendingTime' => ['description' => 'The spending time, which corresponds to the specific billing date.', 'type' => 'string', 'example' => '20221201', 'title' => ''],
+ 'BillType' => ['description' => 'The bill type. Same as the BillType request parameter.', 'type' => 'string', 'example' => 'DailyInstanceBillV2', 'title' => ''],
+ 'BillOwner' => ['description' => 'The bill owner. Same as the BillOwner request parameter.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'BillLinkXLSX' => ['description' => 'The download URL of the XLSX file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillType\\": \\"DailyInstanceBillV2\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Distributor daily bill',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetDailyBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDailyBill'],
+ ],
+ ],
+ ],
+ 'GetInviteStatus' => [
+ 'summary' => 'Queries the invitation status of customers who have been registered and invited.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BillType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'InviteStatusList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'BillType. Value Range:</br>'."\n"
- ."\n"
- .'- DailyOrder(Deprecated)'."\n"
- .'- DailyBill (Deprecated)'."\n"
- .'- DailyInstanceBill (Deprecated)'."\n"
- .'- DailyInstanceBillV2',
- 'type' => 'string',
+ 'description' => 'inviteId list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'inviteId list',
+ 'type' => 'object',
+ 'properties' => [
+ 'InviteId' => ['description' => 'The invitation ID. Obtained from the InviteSubAccount operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => 'DailyInstanceBillV2',
+ 'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -4133,143 +2504,146 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 System error'."\n"
- .'* 3050 Bill Type can only be DailyOrder, DailyBill or DailyInstanceBill.'."\n"
- .'* 3049 Incorrect format of Spending Time.'."\n"
- .'* 3048 Bill Owner can only be 1 or 2.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Same as Code parameters.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The status code. Error code value: 3057: InviteId is empty.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => 'The returned data.',
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'BillLinkCSV' => [
- 'description' => 'The link to download CSV file, please use HTTP Protocol.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D',
- ],
- 'SpendingTime' => [
- 'description' => 'Spending Time, refer to the exact time of costuming.',
- 'type' => 'string',
- 'example' => '20221201',
- ],
- 'BillType' => [
- 'description' => 'Same as inserted parameter BillType.',
- 'type' => 'string',
- 'example' => 'DailyInstanceBillV2',
- ],
- 'BillOwner' => [
- 'description' => 'Same as inserted parameter BillOwner.',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'BillLinkXLSX' => [
- 'description' => 'The link to download XLSX file, please use HTTP Protocol.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n",
+ 'InviteStatus' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .' - 200: OK.'."\n"
+ .'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'InviteStatusList' => [
+ 'description' => 'The invitation record status result list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GmtCreate' => ['description' => 'The time when the invitation email was sent.', 'type' => 'string', 'example' => '2018-02-12', 'title' => ''],
+ 'Status' => ['description' => 'The invitation status. Valid values:'."\n"
+ .'- 0: The registration URL has not been visited.'."\n"
+ .'- 1: Registration failed.'."\n"
+ .'- 2: Registration succeeded.'."\n"
+ .'- 3: The registration URL has been visited but the form has not been submitted.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'SubAccountType' => ['description' => 'The account type. Valid values:'."\n"
+ .'- 1: Agency end customer.'."\n"
+ .'- 2: Reseller end customer.'."\n"
+ .'- 5: Reseller tier-2 partner.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'ParentId' => ['description' => 'The UID of the distributor to which the distribution customer account belongs.', 'type' => 'string', 'example' => '1093238769140523', 'title' => ''],
+ 'AssociationSuccessTime' => ['description' => 'The time when the distribution customer account was successfully associated with the distributor account. This value is empty if no association exists.', 'type' => 'string', 'example' => '2018-02-13', 'title' => ''],
+ 'Cid' => ['description' => 'The CID of the distribution customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''],
+ 'Uid' => ['description' => 'The UID of the distribution customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for troubleshooting.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InviteStatus\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"InviteStatusList\\": {\\n \\"GmtCreate\\": \\"2018-02-12\\",\\n \\"Status\\": 2,\\n \\"SubAccountType\\": \\"1\\",\\n \\"ParentId\\": \\"1093238769140523\\",\\n \\"AssociationSuccessTime\\": \\"2018-02-13\\",\\n \\"Cid\\": 1234567890123,\\n \\"Uid\\": 1234567890123\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Query invitation record status',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetInviteStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInviteStatus'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillType\\": \\"DailyInstanceBillV2\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
- 'title' => 'GetDailyBill',
],
'GetMonthlyBill' => [
- 'summary' => 'Issue Distributor\'s Monthly Bill. This function is only available for Resellers and Distributors.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Returns the monthly bill of a distributor.'."\n"
+ .'This feature is available only for Resellers and Distributors.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Month',
'in' => 'query',
- 'schema' => [
- 'description' => 'Billing Month, Format is YYYY-MM',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2022-11',
- ],
+ 'schema' => ['description' => 'Billing Month, Format is YYYY-MM.', 'type' => 'string', 'required' => true, 'example' => '2022-11', 'title' => ''],
],
[
'name' => 'BillOwner',
'in' => 'query',
- 'schema' => [
- 'description' => 'Bill Owner type. Value Range:</br>'."\n"
- .'1: Master account</br>'."\n"
- .'2: Sub account</br>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Bill Owner type.'."\n"
+ ."\n"
+ .' Value range:'."\n"
+ ."\n"
+ .'1: Master account '."\n"
+ ."\n"
+ .'2: Sub account.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'BillType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Value Range:'."\n"
- ."\n"
- .'- MonthlyInvoice'."\n"
- .'- MonthRefundInvoice'."\n"
- .'- MonthlySummary (Deprecated)'."\n"
- .'- MonthlyInstanceAddAdjustBill '."\n"
- .'- MonthlyInstanceRefundBill'."\n"
- .'- MonthlyAddAdjustInvoce'."\n"
- .'- MonthlyRefundAdjustInvoce '."\n"
- .'- MonthlyInstanceConsumeV2 '."\n"
- .'- MarginReportV2',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MonthlyInvoice',
- ],
+ 'schema' => ['description' => 'Value Range:'."\n"
+ ."\n"
+ .'MonthlyInvoice'."\n"
+ ."\n"
+ .'MonthRefundInvoice'."\n"
+ ."\n"
+ .'MonthlySummary (Deprecated)'."\n"
+ ."\n"
+ .'MonthlyInstanceAddAdjustBill '."\n"
+ ."\n"
+ .'MonthlyInstanceRefundBill'."\n"
+ ."\n"
+ .'MonthlyAddAdjustInvoce'."\n"
+ ."\n"
+ .'MonthlyRefundAdjustInvoce '."\n"
+ ."\n"
+ .'MonthlyInstanceConsumeV2 '."\n"
+ ."\n"
+ .'MarginReportV2.', 'type' => 'string', 'required' => true, 'example' => 'MonthlyInvoice', 'title' => ''],
],
],
'responses' => [
@@ -4277,302 +2651,304 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => 'Result Code:'."\n"
- .'* 200 OK'."\n"
- .'* 1109 System error'."\n"
- .'* 3030 Sub Account Nickname exceeds maximum length, maximum length 150 bytes.'."\n"
- .'* 3031 Remark exceeds maximum length, maximum length 3000 bytes.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Same as Code parameters.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Candidate Value: True/False, which indicates whether the current API call itself is successful. It does not guarantee the success of subsequent business operations.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code:'."\n"
+ .'- 200 OK'."\n"
+ .'- 1109 System error'."\n"
+ .'- 3030 Account nickname exceeds the maximum length of 150 bytes'."\n"
+ .'- 3031 Remark exceeds the maximum length of 3000 bytes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Same as the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Candidate values: True/False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'RefundInvoiceLink' => [
- 'description' => 'The URL to download refund invoice.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D',
- ],
- 'BillType' => [
- 'description' => 'Same as inserted parameter BillType.',
- 'type' => 'string',
- 'example' => 'MonthlyInvoice',
- ],
- 'InvoiceLink' => [
- 'description' => 'The URL to download invoice.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D',
- ],
- 'BillLinkCSV' => [
- 'description' => 'The link to download CSV file, please use HTTP Protocol.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D',
- ],
- 'RefundInvoiceFlag' => [
- 'description' => 'It states the existence of refund invoice. </br>'."\n"
- .'Candidate Values: True/False',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'SpendingTime' => [
- 'description' => 'Spending Time, refer to the exact time of costuming.',
- 'type' => 'string',
- 'example' => '20221201',
- ],
- 'BillOwner' => [
- 'description' => 'Same as inserted parameter BillOwner.',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'BillLinkXLSX' => [
- 'description' => 'The link to download XLSX file, please use HTTP Protocol.',
- 'type' => 'string',
- 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n",
- ],
+ 'RefundInvoiceLink' => ['description' => 'The URL for downloading the refund invoice.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
+ 'BillType' => ['description' => 'Same as the input parameter BillType.', 'type' => 'string', 'example' => 'MonthlyInvoice', 'title' => ''],
+ 'InvoiceLink' => ['description' => 'The URL for downloading the invoice.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
+ 'BillLinkCSV' => ['description' => 'The URL for downloading the CSV file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
+ 'RefundInvoiceFlag' => ['description' => 'Indicates whether a refund invoice exists. Valid values: True, False.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'SpendingTime' => ['description' => 'The spending time, which corresponds to the specific consumption time.', 'type' => 'string', 'example' => '20221201', 'title' => ''],
+ 'BillOwner' => ['description' => 'Same as the input parameter BillOwner.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'BillLinkXLSX' => ['description' => 'The URL for downloading the XLSX file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.',
- 'type' => 'string',
- 'example' => '210e876f16704666020714468dab35',
- ],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Error1109',
- 'errorMessage' => 'system error.',
- ],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RefundInvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillType\\": \\"MonthlyInvoice\\",\\n \\"InvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"RefundInvoiceFlag\\": true,\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\"\\n}","type":"json"}]',
- 'title' => 'GetMonthlyBill',
- ],
- 'SubscriptionBill' => [
- 'summary' => 'Generates the subscription to multi-level bills as an Alibaba Cloud eco-partner.',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Distributor monthly bill',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetMonthlyBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonthlyBill'],
+ ],
],
+ ],
+ 'GetPurchaseControlRecord' => [
+ 'summary' => 'Queries order control change records.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SubscribeBucket',
+ 'name' => 'OperationTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the Object Storage Service (OSS) bucket in which you want to store the bills.'."\n",
- 'example' => 'bill-bucket',
- 'required' => true,
- 'title' => 'subscribeType',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time. If left empty, data from the last six months is returned. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-12-15 10:34:36'],
],
[
- 'name' => 'BucketOwnerId',
+ 'name' => 'CustomerUID',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the user to which the OSS bucket belongs.'."\n"
- ."\n"
- .'If you are an eco-partner of Alibaba Cloud and you need to push the bills to the OSS bucket of a subordinate partner account, you must set this parameter to the ID of the subordinate partner account and grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subordinate partner account.'."\n"
- ."\n"
- .'If you are an eco-partner of Alibaba Cloud and you need to push the bills to the OSS bucket of your own account, your account must be granted the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission.'."\n",
- 'example' => '5569414254138836',
- 'format' => 'int64',
- 'required' => true,
- 'title' => 'callerMainUid',
- 'type' => 'integer',
- ],
+ 'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '292828565558721922'],
],
[
- 'name' => 'SubscribeType',
+ 'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the bill to which you want to subscribe. Valid values: PartnerBillingItemDetailForBillingPeriod, PartnerBillingItemDetailMonthly, PartnerInstanceDetailForBillingPeriod, and PartnerInstanceDetailMonthly.'."\n",
- 'example' => 'PartnerBillingItemDetailForBillingPeriod',
- 'required' => true,
- 'title' => 'popClientIP',
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'BeginBillingCycle',
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'example' => '20'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The start month from which the bills are pushed. Specify the value in the yyyy-MM format.'."\n"
- ."\n"
- .'After the subscription is generated, the system automatically pushes the bill data that is generated from the month that you specified to the current point in time. Data of up to six months can be pushed. The current month is included. If you subscribe to the bills for more than six months, the subscription is invalid.'."\n",
- 'example' => '2022-10',
- 'required' => true,
- 'title' => 'subscribeBucket',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChangedType' => [
+ 'title' => '',
+ 'description' => 'The change type. Valid values:'."\n"
+ .'- ban: new purchases are prohibited.'."\n"
+ .'- cancelBan: the purchase prohibition is canceled.',
+ 'enumValueTitles' => ['cancelBan ' => ' 取消禁止', 'ban ' => '禁止新购'],
+ 'type' => 'string',
+ 'example' => 'ban ',
+ ],
+ 'OperationTime' => ['title' => '', 'description' => 'The operation time (UTC+8).', 'type' => 'string', 'example' => '2023-12-15 10:34:36'],
+ 'OperationPath' => ['title' => '', 'description' => 'The method by which the operation was initiated.', 'type' => 'string', 'example' => 'ACPN'],
+ 'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '292828565558721922'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Code' => ['description' => 'The result code. Value range:'."\n"
+ .'- 200: OK.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": [\\n {\\n \\"ChangedType\\": \\"ban \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"292828565558721922\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Query order control change records',
+ 'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurchaseControlRecord'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:GetPurchaseControlRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'GetShutdownPolicyRecord' => [
+ 'summary' => 'Queries the modification records of the deferred shutdown policy.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BillFormat',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'OperationTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The file format of the bill. Valid values: csv and parquet.'."\n"
- ."\n"
- .'If you subscribe to the bills of multiple file formats, we recommend that you store the bills in different OSS buckets to prevent file overwriting.'."\n",
- 'example' => 'csv',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time. If left empty, data from the last six months is returned. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2025-12-15 10:34:36'],
],
[
- 'name' => 'SubscribeSegmentSize',
+ 'name' => 'CustomerUID',
'in' => 'query',
- 'schema' => [
- 'description' => 'The maximum rows in a single bill file. If the number of bill rows exceed the upper limit, the bill is automatically split into multiple files. The name of each split file is in the `uid_billType_billCycle_SquenceNo_fileNo` format.'."\n"
- ."\n"
- .'Files whose names are the same except for the fileNo field are of the same type and belong to the same billing cycle.'."\n",
- 'example' => '100000',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '292828565558721922'],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The 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, 'maximum' => '100', 'minimum' => '5', 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'The response parameters.'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => 'The message that is returned.'."\n",
- 'example' => 'Successful'."\n",
- 'title' => 'message',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35', 'title' => ''],
'Data' => [
- 'description' => 'The data that is returned.'."\n",
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'description' => 'The HTTP status code that is returned.'."\n",
- 'enumValueTitles' => [
- 1001 => 1671777800000,
- 1672729005000,
- 'Subscription Type'."\n"
- ."\n"
- .'PartnerBillingItemDetailForBillingPeriod——the billing item detail information for the relevant billing cycle.'."\n"
- ."\n"
- .'PartnerBillingItemDetailMonthly—the billing item detail information for the relevant billing cycle.'."\n"
- ."\n"
- .'PartnerInstanceDetailForBillingPeriod—the instance detail information for the relevant billing cycle.'."\n"
- ."\n"
- .'PartnerInstanceDetailMonthly—the instance detail information for the relevant billing cycle.',
- 'Request ID',
- 'The format of beginning month of providing billings information: yyyy-MM'."\n"
- ."\n"
- .'When setting the month information of the beginning billing cycle, the limited history would be provided about 6 months before, including the current month. If the setting out of this range the subscription task would be failed.',
- 'Successful or Not',
- 'The UID, belonging to the saving document OSS',
+ 'description' => 'Indicates whether the customer was created. If the value is true, the Message contains the CID.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CurrentPolicy' => [
+ 'title' => '',
+ 'description' => 'The current policy. Valid values:'."\n"
+ .'- immediatelyStop: immediate shutdown upon overdue payment.'."\n"
+ .'- delayStop: deferred shutdown quota applied.'."\n"
+ .'- noStop: no shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.CurrentPolicy.enum.immediatelyStop ]Immediate shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.CurrentPolicy.enum.noStop ]No shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.CurrentPolicy.enum.delayStop ]Deferred shutdown quota applied.',
+ 'enumValueTitles' => ['immediatelyStop ' => '欠费立即停机', 'noStop ' => '欠费不停机', 'delayStop ' => '享受延停额度'],
+ 'type' => 'string',
+ 'example' => 'noStop ',
+ ],
+ 'PreviousPolicy' => [
+ 'title' => '',
+ 'description' => 'The policy before the change. Valid values:'."\n"
+ .'- immediatelyStop: immediate shutdown upon overdue payment.'."\n"
+ .'- delayStop: deferred shutdown quota applied.'."\n"
+ .'- noStop: no shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.PreviousPolicy.enum.immediatelyStop ]Immediate shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.PreviousPolicy.enum.noStop ]No shutdown upon overdue payment.'."\n"
+ .'[_single.resp.200.props.Data.items.PreviousPolicy.enum.delayStop ]Deferred shutdown quota applied.',
+ 'enumValueTitles' => ['immediatelyStop ' => '欠费立即停机', 'noStop ' => '欠费不停机', 'delayStop ' => '享受延停额度 '],
+ 'type' => 'string',
+ 'example' => 'immediatelyStop ',
+ ],
+ 'OperationTime' => ['title' => '', 'description' => 'The operation time (UTC+8).', 'type' => 'string', 'example' => '2023-12-15 10:34:36'],
+ 'OperationPath' => [
+ 'title' => '',
+ 'description' => 'The method by which the operation was initiated. Valid values:'."\n"
+ .'- API: API.'."\n"
+ .'- ACPN: ACPN.'."\n"
+ .'- ALIYUN_BIZ: Alibaba Cloud internal.',
+ 'enumValueTitles' => ['ALIYUN_BIZ' => 'Alibaba Cloud internal.', 'API' => 'API', 'ACPN' => 'ACPN'],
+ 'type' => 'string',
+ 'example' => 'ACPN',
+ ],
+ 'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '11111111111'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'example' => '200',
- 'title' => 'code',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful.'."\n",
- 'example' => 'true',
- 'title' => 'success',
- 'type' => 'boolean',
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
- 'title' => 'result',
- 'type' => 'object',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'description' => '* Make sure that you are a distributor of the Alibaba Cloud international ecosystem.'."\n"
- .'* You can call this operation to subscribe to only one type of bill at a time.'."\n"
- .'* After the subscription to a type of bill is generated, the bill for the previous day is pushed on a daily basis from the next day. On the fifth day of each month, the full-data bill for the previous month is pushed.'."\n"
- .'* A daily bill may be delayed. The delayed bill is pushed the next day after it is generated. The delayed bill may contain the bill data that is delayed until the previous day. We recommend that you query the full-data bill for the previous month at the beginning of each month.'."\n"
- .'* Your account must be granted the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission.'."\n"
- .'* The following file name formats are supported for bills:'."\n"
- ."\n"
- .'```'."\n"
- ."\n"
- .'BillingItemDetailForBillingPeriod'."\n"
- .' '."\n"
- .'File name format of a daily bill: UID_PartnerBillingItemDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_BillingItemDetail_20190310_0001_01. '."\n"
- .' '."\n"
- .'File name format of a monthly full-data bill: UID_PartnerBillingItemDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetail_201903_0001_01. '."\n"
- ."\n"
- .'InstanceDetailForBillingPeriod'."\n"
- .' '."\n"
- .' File name format of a daily bill: UID_PartnerInstanceDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_InstanceDetail_20190310_0001_01. '."\n"
- .' '."\n"
- .'File name format of a monthly full-data bill: UID_PartnerInstanceDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetail_201903_1999-0001_01. '."\n"
- ."\n"
- .'BillingItemDetailMonthly'."\n"
- .' '."\n"
- .'File name format of a daily bill: UID_PartnerBillingItemDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetailMonthly_201903_0001_01. This bill contains the bill data that is generated from the beginning of the current month to the fifth day of the next month. '."\n"
- ."\n"
- .'InstanceDetailMonthly'."\n"
- .' '."\n"
- .'File name format of a daily bill: UID_PartnerInstanceDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetailMonthly_201903_0001_01. This bill contains the bill data that is generated from the beginning of the current month to the fifth day of the next month. '."\n"
- ."\n"
- .'The fileNo field exists only when the number of bill rows reaches the maximum rows in a single bill file and the bill is split into multiple files.'."\n"
- .'```'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": [\\n {\\n \\"CurrentPolicy\\": \\"noStop \\",\\n \\"PreviousPolicy\\": \\"immediatelyStop \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"11111111111\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Query deferred shutdown policy modification records',
+ 'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.'."\n"
."\n"
- .'**This topic is published only on the international site (alibabacloud.com).'."\n",
- 'title' => 'SubscriptionBill',
+ .'**This content is published only on the international site.**.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetShutdownPolicyRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetShutdownPolicyRecord'],
+ ],
+ ],
],
'GetTier2CouponApprovalDetail' => [
- 'summary' => '查询T2优惠券审批详情',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4580,154 +2956,99 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ApplicationSheetId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0b9a079e17691387754512757e6a1b',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0b9a079e17691387754512757e6a1b'],
+ 'Code' => ['description' => 'The response code. Valid values:'."\n"
+ .'- 200: Success.'."\n"
+ .'- Other values: error codes. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
- 'ApplicationSheetId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0b9a079e17691387754512757e6a1b',
- ],
- 'ApprovalStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'TotalAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100.00',
- ],
- 'RemainingQuota' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20.00',
- ],
- 'ApplicationReason' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'ApplicationSheetId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '0b9a079e17691387754512757e6a1b', 'title' => ''],
+ 'ApprovalStatus' => ['description' => 'The approval status. Valid values:'."\n"
+ .'- 1: Revoked.'."\n"
+ .'- 2: Pending approval.'."\n"
+ .'- 3: Rejected.'."\n"
+ .'- 4: Approved.'."\n"
+ .'- 5: Approved but issuance failed.'."\n"
+ .'- 8: Pending processing.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'TotalAmount' => ['description' => 'The application amount.', 'type' => 'string', 'example' => '100.00', 'title' => ''],
+ 'RemainingQuota' => ['description' => 'The estimated remaining partner new customer PoC coupon privilege quota after the coupons are issued.', 'type' => 'string', 'example' => '20.00', 'title' => ''],
+ 'ApplicationReason' => ['description' => 'The application reason.', 'type' => 'string', 'example' => '申请原因', 'title' => ''],
'ApplicantInfo' => [
- 'description' => '',
+ 'description' => 'The basic application information.',
'type' => 'object',
'properties' => [
- 'T2PartnerName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test account',
- ],
- 'T2PartnerUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5248516846402795',
- ],
- 'ApplicableProducts' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UNIVERSAL',
- ],
- 'ApplicationTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2026-01-21 11:24',
- ],
- 'ValidUntil' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2026-01-21 ~ 2199-12-31',
- ],
- 'OrderType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALL,BILLING',
- ],
+ 'T2PartnerName' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'test account', 'title' => ''],
+ 'T2PartnerUid' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'example' => '5248516846402795', 'title' => ''],
+ 'ApplicableProducts' => ['description' => 'The applicable products. Valid values:'."\n"
+ .'- UNIVERSAL: all products.'."\n"
+ .'- A specific commodity code.', 'type' => 'string', 'example' => 'UNIVERSAL', 'title' => ''],
+ 'ApplicationTime' => ['description' => 'The application time.', 'type' => 'string', 'example' => '2026-01-21 11:24', 'title' => ''],
+ 'ValidUntil' => ['description' => 'The validity period, which is the number of valid days or a valid time range.', 'type' => 'string', 'example' => '2026-01-21 ~ 2199-12-31', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type, which specifies the order type for coupon usage. Valid values:'."\n"
+ .'- ALL: Alibaba Cloud upfront.'."\n"
+ .'- BILLING: Alibaba Cloud pay-as-you-go bill.'."\n"
+ .'- ALL,BILLING: Alibaba Cloud upfront and Alibaba Cloud pay-as-you-go bill.', 'type' => 'string', 'example' => 'ALL,BILLING', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'CouponReceiptUidList' => [
- 'description' => '',
+ 'description' => 'The list of UIDs of customers who received the coupons.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Uid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1703016242044705',
- ],
- 'NominalValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100.00',
- ],
+ 'Uid' => ['description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1703016242044705', 'title' => ''],
+ 'NominalValue' => ['description' => 'The nominal value.', 'type' => 'string', 'example' => '100.00', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query secondary distributor coupon application details',
+ 'summary' => 'Queries the details of a coupon application submitted by a secondary distributor. This operation is applicable only to distributors.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ApplicationSheetId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"ApprovalStatus\\": \\"2\\",\\n \\"TotalAmount\\": \\"100.00\\",\\n \\"RemainingQuota\\": \\"20.00\\",\\n \\"ApplicationReason\\": \\"申请原因\\",\\n \\"ApplicantInfo\\": {\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516846402795,\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ValidUntil\\": \\"2026-01-21 ~ 2199-12-31\\",\\n \\"OrderType\\": \\"ALL,BILLING\\"\\n },\\n \\"CouponReceiptUidList\\": [\\n {\\n \\"Uid\\": 1703016242044705,\\n \\"NominalValue\\": \\"100.00\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '二级分销商优惠券申请单详情',
],
- 'ListTier2CouponApproval' => [
- 'summary' => 'T1查询T2优惠券申请列表',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetUnassociatedCustomer' => [
+ 'summary' => 'Retrieves all unassociated customers.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4735,761 +3056,571 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'T2PartnerName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test account',
- ],
- ],
- [
- 'name' => 'T2PartnerUid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '5248516956402795',
- ],
- ],
- [
- 'name' => 'ApprovalStatus',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
- ],
- [
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The current page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ApplicationSheetId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4',
- ],
+ 'schema' => ['description' => 'The number of records per page for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
+ 'Code' => ['description' => 'The error code. Valid values:'."\n"
+ .'200: OK.'."\n"
+ .'1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'Page' => ['description' => 'The current page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ApplicationSheetId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4',
- ],
- 'T2PartnerName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test account',
- ],
- 'T2PartnerUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5248516956402795',
- ],
- 'ApplicationTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2026-01-21 11:24',
- ],
- 'ApprovalStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TotalAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
+ 'InviteInfoList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'InviteInfo' => [
+ 'description' => 'The invitation information list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The invitation information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The invitation status. Valid values:'."\n"
+ .'- 0: The registration URL has not been visited.'."\n"
+ .'- 1: Registration succeeded.'."\n"
+ .'- 2: Registration failed.'."\n"
+ .'- 3: The registration URL has been visited but the form has not been submitted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The time when the invitation email was sent.', 'type' => 'string', 'example' => '2023-05-10', 'title' => ''],
+ 'AccountNickname' => ['description' => 'The name of the invited customer.', 'type' => 'string', 'example' => '我的客户', 'title' => ''],
+ 'Email' => ['description' => 'The email address of the invited customer.', 'type' => 'string', 'example' => '12345@qq.com', 'title' => ''],
+ 'InviteId' => ['description' => 'The invitation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationSheetId\\": \\"d54ca949-9b88-4514-add3-c6029c4027f4\\",\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516956402795,\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ApprovalStatus\\": \\"1\\",\\n \\"TotalAmount\\": \\"200\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '二级分销商优惠券审批列表',
- ],
- 'CancelCoupon' => [
- 'summary' => '作废优惠券',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"InviteInfoList\\": {\\n \\"InviteInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2023-05-10\\",\\n \\"AccountNickname\\": \\"我的客户\\",\\n \\"Email\\": \\"12345@qq.com\\",\\n \\"InviteId\\": 190\\n }\\n ]\\n },\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\"\\n}","type":"json"}]',
+ 'title' => 'Query unassociated customers',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetUnassociatedCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUnassociatedCustomer'],
+ ],
],
+ ],
+ 'InviteSubAccount' => [
+ 'summary' => 'Invites a customer to register as a partner customer.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CouponId',
+ 'name' => 'AccountInfoList',
'in' => 'query',
- 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The list of account information for the invitation. A maximum of five accounts can be invited at a time.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The account information for the invitation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SubAccountType' => ['description' => 'The type of the sub-account. Valid values:'."\n"
+ .'- 1: end user of Agency.'."\n"
+ .'- 2: end user of Reseller. '."\n"
+ .'- 5: T2 partner of Reseller.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
+ 'EmailAddress' => ['description' => 'The email address of the distribution customer account. The invitation email is sent to this address.', 'type' => 'string', 'required' => true, 'example' => '12345@163.com', 'title' => ''],
+ 'AccountNickname' => ['description' => 'The name of the distribution customer. Valid values:'."\n"
+ .'- If the distribution customer is an enterprise, this is the company name.'."\n"
+ .'- If the distribution customer is a T2 reseller partner, this is the partner name.', 'type' => 'string', 'required' => true, 'example' => 'XXX技术有限公司', 'title' => ''],
+ 'CreditLine' => ['description' => 'The total budget quota that the partner allocates to the distribution customer.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
+ 'Remark' => ['description' => 'The description of the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '发展xx为客户的邀请', 'title' => ''],
+ 'ZeroCreditShutdownPolicy' => ['description' => 'The shutdown policy that the partner manages for the distribution customer. Valid values:'."\n"
+ ."\n"
+ .'- 1: delayStop. Alibaba Cloud takes over the resources and the customer enjoys a delayed shutdown quota. When the delayed shutdown quota is exhausted, instance shutdown is triggered. If payment is not made within 15 days, storage resources are released.'."\n"
+ .'- 2: noStop. Manual management with no shutdown on overdue payment. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manually manage the instance shutdown status of the customer.'."\n"
+ .'- 3: immediatelyStop. Instances are immediately shut down on overdue payment. When the available quota of the customer account is less than 0, the account enters the overdue payment status and instance shutdown is triggered.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
+ 'NewBuyStatus' => ['description' => 'The initial order placement status. Valid values:'."\n"
+ ."\n"
+ .'- ban: Purchase is prohibited. After the customer is registered and associated, the customer cannot immediately place orders to purchase cloud resources. You must set the order control to normal before the customer can place orders.'."\n"
+ .'- normal: Normal. After the customer is registered and associated, the customer can immediately place orders to purchase cloud resources.', 'type' => 'string', 'required' => true, 'example' => 'ban', 'title' => ''],
+ 'CustomerId' => ['description' => 'The customer ID returned by the CreateCustomer API.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'title' => ''],
+ 'CustomerBd' => ['title' => '', 'description' => 'The account manager of the customer. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => '张三'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => '501001340370350',
+ 'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
+ 'Code' => ['description' => 'The fault code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System Error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for fault tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API invocation is successful. Valid values: True and False. This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Results' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Result' => [
+ 'description' => 'The list of invitation send results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The invitation result information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The fault code. 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned, which describes the fault code.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation is successful. The value is always true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The invitation result details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegUrl' => ['description' => 'The registration URL for the distribution customer.', 'type' => 'string', 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL', 'title' => ''],
+ 'Days' => ['description' => 'The validity period of the registration URL, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
+ 'InviteId' => ['description' => 'The invitation ID, which is used to query the invitation status.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ERROR_201',
- 'errorMessage' => 'Parameters are illegal and required fields are empty.',
- ],
- [
- 'errorCode' => 'ERROR_2311',
- 'errorMessage' => 'Coupon template does not exist.',
- ],
- [
- 'errorCode' => 'ERROR_1003',
- 'errorMessage' => 'No permission to operate the object.',
- ],
- [
- 'errorCode' => 'ERROR_2307',
- 'errorMessage' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.',
+ ['errorCode' => 'Error3017', 'errorMessage' => 'customerRebateType is error, only invite reseller account.', 'description' => 'customerRebateType is error，only invite reseller account.'],
+ ['errorCode' => 'Error3008', 'errorMessage' => 'shutdown status is error.', 'description' => 'shutdown status is error.'],
+ ['errorCode' => 'Error3009', 'errorMessage' => 'customerAccount is error.', 'description' => 'customerAccount is error.'],
+ ['errorCode' => 'Error3010', 'errorMessage' => 'customerNick is empty.', 'description' => 'customerNick is empty.'],
+ ['errorCode' => 'Error3011', 'errorMessage' => 'The length of customerNick greater than 50.', 'description' => 'The length of customerNick greater than 50. '],
+ ['errorCode' => 'Error3012', 'errorMessage' => 'cid is empty.', 'description' => 'cid is empty.'],
+ ['errorCode' => 'Error3013', 'errorMessage' => 'customCredit is empty.', 'description' => 'customCredit is empty.'],
+ ['errorCode' => 'Error3014', 'errorMessage' => 'customCredit is a maximum of 10.', 'description' => 'customCredit is a maximum of 10.'],
+ ['errorCode' => 'Error3015', 'errorMessage' => 'The current account is not a partner.', 'description' => 'The current account is not a distributor'],
+ ['errorCode' => 'Error3016', 'errorMessage' => 'customerRebateType is error, only invite agency account.', 'description' => 'customerRebateType is error，only invite agency account.'],
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'Error3056', 'errorMessage' => 'The value of subAccountType error.', 'description' => 'The value of subAccountType error'],
+ ['errorCode' => 'Error3067', 'errorMessage' => 'Enterprise Customer Invitation Prohibition.', 'description' => 'Enterprise Customer Invitation Prohibition.'],
+ ['errorCode' => 'Error3055', 'errorMessage' => 'subAccountType is null.', 'description' => 'subAccountType is empty'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Invite a distribution customer',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-10-13T09:19:15.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ['createdAt' => '2023-09-07T12:09:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:InviteSubAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InviteSubAccount'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '作废优惠券',
],
- 'CreateCouponTemplate' => [
- 'summary' => '创建优惠券模板',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'InviteSubReseller' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'TemplateName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '【模板名称】'."\n"
- .'字段长度限制 30',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- 'maxLength' => 30,
- ],
- ],
- [
- 'name' => 'ReasonForApplication',
- 'in' => 'query',
- 'schema' => [
- 'title' => '【模板申请原因】'."\n"
- .'字段长度限制100',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- 'maxLength' => 100,
- ],
- ],
- [
- 'name' => 'CostBearer',
- 'in' => 'query',
- 'schema' => [
- 'title' => '【优惠券成本承担方】'."\n"
- .'● Partner自行承担'."\n"
- .'● Alibaba Cloud阿里云承担成本',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Partner',
- 'enum' => [
- 'Partner',
- 'Alibaba Cloud',
- ],
- ],
- ],
- [
- 'name' => 'ApplicableProducts',
- 'in' => 'query',
- 'schema' => [
- 'title' => '【适用产品】'."\n"
- .'● All Products全部产品'."\n"
- .'● Custom自定义',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'All Products',
- 'enum' => [
- 'All Products',
- 'Custom',
- ],
- ],
- ],
- [
- 'name' => 'ProductType',
+ 'name' => 'AccountInfoList',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '【产品code列表】',
- 'description' => '',
+ 'description' => 'The list of account information for the invitation. A maximum of five accounts can be specified at a time.',
'type' => 'array',
'items' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The list of account information for the invitation. A maximum of five accounts can be specified at a time.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SubAccountType' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''],
+ 'EmailAddress' => ['description' => 'The email address to which the invitation email is sent.', 'type' => 'string', 'required' => false, 'example' => 'nejatox206@getasail.com', 'title' => ''],
+ 'AccountNickname' => ['description' => 'The name of the distribution customer.'."\n"
+ .'- If the distribution customer is an enterprise, this is the company name.'."\n"
+ .'- If the distribution customer is a T2 Reseller partner, this is the partner name.', 'type' => 'string', 'required' => false, 'example' => 'XXX技术有限公司', 'title' => ''],
+ 'CreditLine' => ['description' => 'The total budget quota that the partner allocates to the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''],
+ 'Remark' => ['description' => 'The description of the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '发展xx为客户的邀请', 'title' => ''],
+ 'ZeroCreditShutdownPolicy' => ['description' => 'The shutdown policy that the partner sets for the distribution customer.'."\n"
+ ."\n"
+ .'- 1: delayStop. The account uses the delayed shutdown quota for deferred instance shutdown. Alibaba Cloud takes over the resources. When the delayed shutdown quota is exhausted, instance shutdown is triggered. If the payment is not made within 15 days, storage resources are released.'."\n"
+ .'- 2: noStop. Manual management with no shutdown on overdue payment. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manually manage the instance shutdown status of the customer.'."\n"
+ .'- 3: immediatelyStop. Immediate shutdown on overdue payment. When the active quota of the customer account is less than 0, the account enters the overdue payment status and instance shutdown is triggered.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ 'NewBuyStatus' => ['description' => 'The initial order placement status. Valid values:'."\n"
+ ."\n"
+ .'- ban: Purchase is prohibited. After the customer is registered and associated, the customer cannot place orders to purchase cloud resources immediately. You must set the order control to Normal before the customer can place orders.'."\n"
+ .'- normal: Normal. After the customer is registered and associated, the customer can place orders to purchase cloud resources immediately.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''],
+ 'CustomerBd' => ['description' => 'The customer account manager. The value can be up to 50 characters in length.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
+ 'RegisterNation' => ['description' => 'The country or region of the invited T2 Reseller. The value must comply with the ISO 3166-1 alpha-2 code. You can call the ListCountries operation to query the contract coverage area list of the current UID.'."\n"
+ ."\n"
+ .'The system automatically determines whether the invitation is cross-region based on whether this parameter falls within the T1 contract coverage area.'."\n"
+ ."\n"
+ .'- If the invitation is cross-region, a cross-region invitation approval process is initiated. After the approval is granted, an invitation registration email is sent to the specified email address.'."\n"
+ .'- If the invitation is not cross-region, an invitation registration email is sent directly.', 'type' => 'string', 'required' => false, 'example' => 'SG', 'title' => ''],
+ 'CrossScopeRemark' => ['description' => 'The reason for applying for a cross-region association.', 'type' => 'string', 'required' => false, 'example' => 'XXX', 'title' => ''],
+ ],
'required' => false,
- 'example' => 'code1',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'LimitPerPerson',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '【每人限领张数】'."\n"
- .'● Limited to 1限领一张：'."\n"
- .'● Unlimited不限制',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Unlimited',
- 'enum' => [
- 'Limited to 1',
- 'Unlimited',
+ 'title' => '',
+ 'description' => 'Result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'message', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Results' => [
+ 'description' => 'The invitation result information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The invitation result information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The error code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The prompt message that describes the code.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Always true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Result' => [
+ 'description' => 'The invitation result details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegUrl' => ['description' => 'The registration URL of the T2 Reseller.', 'type' => 'string', 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'title' => ''],
+ 'Days' => ['description' => 'The validity period of the registration URL, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
+ 'InviteId' => ['description' => 'The invitation ID, which is used to query the invitation status.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error3015', 'errorMessage' => 'The current account is not a partner.', 'description' => 'The current account is not a distributor'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Invite T2 resellers',
+ 'summary' => 'Invites T2 Reseller sub-accounts in batch as a T1 partner.',
+ 'description' => '1. The caller of this operation must be a channel master reseller partner on Alibaba Cloud International Website.'."\n"
+ .'2. The system automatically determines whether the invitation is cross-region based on whether the RegisterNation parameter falls within the T1 contract coverage area. You can call the ListCountries operation to query the contract coverage area.'."\n"
+ .'- If the invitation is cross-region, a cross-region invitation approval process is initiated. After Alibaba Cloud approves the request, an invitation registration email is sent to the specified email address.'."\n"
+ .'- If the invitation is not cross-region, an invitation registration email is sent directly.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'IssueCouponForCustomer' => [
+ 'summary' => 'Issues coupons.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Value',
- 'in' => 'query',
- 'schema' => [
- 'title' => '【面额】'."\n"
- .'必须为整数',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'ValidUntil',
+ 'name' => 'CouponTemplateId',
'in' => 'query',
- 'schema' => [
- 'title' => '【有效期】'."\n"
- .'● Validity Duration:自发券之日起'."\n"
- .'● Custom Timeframe:自定义时间段',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Validity Duration',
- 'enum' => [
- 'Validity Duration',
- 'Custom Timeframe',
- ],
- ],
+ 'schema' => ['title' => '', 'description' => 'The ID of the coupon template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5075915'],
],
[
- 'name' => 'Vailddate',
+ 'name' => 'Uidlist',
'in' => 'query',
- 'schema' => [
- 'title' => '【生效时间的开始时间】'."\n"
- .'yyyy-MM-dd 格式'."\n"
- .'如 2024-08-26 '."\n"
- .'有效期选择 自定义时间段 必填',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-08-26',
- ],
+ 'schema' => ['title' => '', 'description' => 'The list of UIDs, separated by commas (,). Example: 111,2222.', 'type' => 'string', 'required' => true, 'example' => '111,2222'],
],
[
- 'name' => 'Expireddate',
+ 'name' => 'AcceptLanguage',
'in' => 'query',
- 'schema' => [
- 'title' => '【生效时间的结束时间】'."\n"
- .'yyyy-MM-dd 格式'."\n"
- .'如 2024-08-26 '."\n"
- .'有效期选择 自定义时间段 必填',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-08-26',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Default value: none. Valid values:'."\n"
+ .'- zh-CN: Chinese.'."\n"
+ .'- en-US: English.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
- 'name' => 'Vaildperioddays',
+ 'name' => 'IsUseBenefit',
'in' => 'query',
- 'schema' => [
- 'title' => '【相对时间的持续多少天‘】'."\n"
- .'限制为正整数'."\n"
- .'有效期选择 自发券之日起 必填',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether to use the POC coupon quota. Valid values:'."\n"
+ .'- true: Uses the POC coupon quota. If all submitted accounts are marked as approval-exempt, the current coupon application skips the approval process, and the POC coupon quota in your partner benefit package is deducted.'."\n"
+ .'- false: Does not use the POC coupon quota. Regardless of the approval-exempt status of the submitted accounts, your POC coupon privilege quota remains unchanged. In this case, the application follows the standard coupon application approval process.', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'PurchaseType',
+ 'name' => 'ApplicationReason',
'in' => 'query',
+ 'schema' => ['title' => '', 'type' => 'string', 'example' => '为客户XXX审批优惠券，该客户是XXXX', 'maxLength' => 500, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '【订单类型】',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ALL',
- 'enum' => [
- 'ALL',
- 'Subscription',
- 'Pay-As-You-Go',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'code', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CouponTemplateId' => ['title' => '', 'description' => 'The ID of the coupon template.', 'type' => 'integer', 'format' => 'int64', 'example' => '5075915'],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-05 18:24:07', 'title' => ''],
+ 'Uidlist' => ['description' => 'The list of UIDs to which coupons are issued.', 'type' => 'string', 'example' => '111,2222'."\n", 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
+ ['errorCode' => 'ERROR_3081', 'errorMessage' => 'couponTemplateId empty, please check.', 'description' => 'couponTemplateId empty, please check.'],
+ ['errorCode' => 'ERROR_3082', 'errorMessage' => 'Uidlist empty, please check .', 'description' => 'Uidlist is empty, please check'],
+ ['errorCode' => 'ERROR_3080', 'errorMessage' => 'Account empty, please check.', 'description' => 'Account is empty, please check'],
+ ['errorCode' => 'ERROR_3090', 'errorMessage' => 'You have no authority.', 'description' => 'You have no authority'],
+ ['errorCode' => 'ERROR_3088', 'errorMessage' => 'Coupon template expired, unable to issue coupon.', 'description' => 'Coupon template expired, unable to issue coupon'],
+ ['errorCode' => 'ERROR_3102', 'errorMessage' => 'This coupon template ID was not created by this account.', 'description' => 'This coupon template ID was not created by this account.'],
+ ['errorCode' => 'ERROR_3089', 'errorMessage' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'],
+ ['errorCode' => 'ERROR_3086', 'errorMessage' => 'The current uid does not have a distribution relationship and cannot issue a coupon.', 'description' => ''],
+ ['errorCode' => 'ERROR_3087', 'errorMessage' => 'The current uid is not the end user identity, can not issue coupons.', 'description' => 'The current uid is not the end user identity, can not issue coupons.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Issue coupons',
+ 'changeSet' => [
+ ['createdAt' => '2025-02-20T10:29:00.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IssueCouponForCustomer'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CouponDescription',
- 'in' => 'query',
- 'schema' => [
- 'title' => '券备注信息'."\n"
- .'长度限制100',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'maxLength' => 100,
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:IssueCouponForCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"code\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"data\\": {\\n \\"CouponTemplateId\\": 5075915,\\n \\"CreateTime\\": \\"2024-03-05 18:24:07\\",\\n \\"Uidlist\\": \\"111,2222\\\\n\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ListCountries' => [
+ 'summary' => 'Queries the list of serviceable regions. This feature is available to all distributors. The response returns region codes based on the serviceable countries specified in the distributor contract.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AcceptLanguage',
- 'in' => 'query',
- 'schema' => [
- 'title' => ' 默认值:无'."\n"
- .' 中文：zh-CN'."\n"
- .' 英文：en-US'."\n"
- .' 日文：ja',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'zh-CN',
- ],
+ 'AK' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2103a30617045934095083027d88c5',
- ],
- 'Code' => [
- 'title' => '状态码 200 成功',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The error code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TemplateName' => [
- 'title' => '优惠券模版名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ApplicableProducts' => [
- 'title' => '【适用产品】'."\n"
- .'● All Products全部产品'."\n"
- .'● Custom自定义',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Custom',
- 'enum' => [
- 'Custom',
- 'All Products',
- ],
- ],
- 'ProductType' => [
- 'title' => '【产品code列表】',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'code1',
- ],
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ValidUntil' => [
- 'title' => '【有效期】'."\n"
- .'● Validity Duration:自发券之日起'."\n"
- .'● Custom Timeframe:自定义时间段',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Validity Duration',
- 'enum' => [
- 'Validity Duration',
- 'Custom Timeframe',
- ],
- ],
- 'Vailddate' => [
- 'title' => '【生效时间的开始时间】'."\n"
- .'yyyy-MM-dd 格式',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-01-01',
- ],
- 'Expireddate' => [
- 'title' => '【生效时间的结束时间】'."\n"
- .'yyyy-MM-dd 格式',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-01-01',
- ],
- 'Vaildperioddays' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-04-02 16:15:31',
- ],
- 'CostBearer' => [
- 'title' => '【优惠券成本承担方】'."\n"
- .'● Partner自行承担'."\n"
- .'● Alibaba Cloud阿里云承担成本',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Partner',
- 'enum' => [
- 'Partner',
- 'Alibaba Cloud',
- ],
- ],
- 'Status' => [
- 'title' => '状态'."\n"
- ."\n"
- .'CREATED 已创建 '."\n"
- .'APPROVING 审核中'."\n"
- .'APPROVED已批准'."\n"
- .'UNAPPROVED 未批准'."\n"
- .'ABANDONED 已作废'."\n"
- .'EXPIRED 已过期'."\n"
- .'EXHAUSTED 已用完'."\n"
- .' ',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'APPROVED',
- ],
- 'CouponTemplateID' => [
- 'title' => '优惠券模版ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '111111',
- ],
- ],
+ 'description' => 'The list of region codes.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The region code.', 'type' => 'string', 'example' => 'AF', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ERROR_3070',
- 'errorMessage' => 'CouponTemplateName must be entered.',
- ],
- [
- 'errorCode' => 'ERROR_3100',
- 'errorMessage' => 'System exceptions, please submit a work order.',
- ],
- [
- 'errorCode' => 'ERROR_3091',
- 'errorMessage' => 'Coupon template name length over limit.',
- ],
- [
- 'errorCode' => 'ERROR_3071',
- 'errorMessage' => 'ApplicableProducts empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3094',
- 'errorMessage' => 'Applicable product type parameters are not legal.',
- ],
- [
- 'errorCode' => 'ERROR_3080',
- 'errorMessage' => 'Account empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3090',
- 'errorMessage' => 'You have no authority.',
- ],
- [
- 'errorCode' => 'ERROR_3085',
- 'errorMessage' => 'Product code is not in international channel partner coupons deductable product list.',
- ],
- [
- 'errorCode' => 'ERROR_3072',
- 'errorMessage' => 'itemCodes empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3101',
- 'errorMessage' => 'PurchaseType empty, please check .',
- ],
- [
- 'errorCode' => 'ERROR_3073',
- 'errorMessage' => 'amout empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3096',
- 'errorMessage' => 'Coupon value is illegal.',
- ],
- [
- 'errorCode' => 'ERROR_3074',
- 'errorMessage' => 'personLimit empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3095',
- 'errorMessage' => 'The per-person limit is illegal.',
- ],
- [
- 'errorCode' => 'ERROR_3075',
- 'errorMessage' => 'applyReason empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3092',
- 'errorMessage' => 'Reason for template request length over limit.',
- ],
- [
- 'errorCode' => 'ERROR_3098',
- 'errorMessage' => 'Coupon Remarks Information length over limit.',
- ],
- [
- 'errorCode' => 'ERROR_3093',
- 'errorMessage' => 'Coupon cost-bearer parameters are not legal.',
- ],
- [
- 'errorCode' => 'ERROR_3076',
- 'errorMessage' => 'effDateType empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3078',
- 'errorMessage' => 'effDateFrom empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3079',
- 'errorMessage' => 'effDateTo empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3099',
- 'errorMessage' => 'The start of the coupon\'s effective time cannot be earlier than the current time.',
- ],
- [
- 'errorCode' => 'ERROR_3103',
- 'errorMessage' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.',
- ],
- [
- 'errorCode' => 'ERROR_3084',
- 'errorMessage' => 'Coupon cannot be valid for more than 180 days.',
- ],
- [
- 'errorCode' => 'ERROR_3077',
- 'errorMessage' => 'effDateDay empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3097',
- 'errorMessage' => 'Time type is illegal.',
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"AF\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query serviceable region list',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListCountries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCountries'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"ApplicableProducts\\": \\"Custom\\",\\n \\"ProductType\\": [\\n \\"code1\\"\\n ],\\n \\"Value\\": \\"1\\",\\n \\"ValidUntil\\": \\"Validity Duration\\",\\n \\"Vailddate\\": \\"2024-01-01\\",\\n \\"Expireddate\\": \\"2024-01-01\\",\\n \\"Vaildperioddays\\": \\"1\\",\\n \\"CreateTime\\": \\"2024-04-02 16:15:31\\",\\n \\"CostBearer\\": \\"Partner\\",\\n \\"Status\\": \\"APPROVED\\",\\n \\"CouponTemplateID\\": 111111\\n }\\n}","type":"json"}]',
- 'title' => '创建优惠券模板',
- 'translator' => 'machine',
],
- 'CouponApprovalStatusList' => [
- 'summary' => '优惠券审批状态列表',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListCouponUsage' => [
+ 'summary' => 'Queries the coupon usage after a distribution partner issues coupons.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5497,272 +3628,255 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'Account',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5093156',
- ],
+ 'schema' => ['title' => '', 'description' => 'The Alibaba Cloud customer account.', 'type' => 'string', 'required' => false, 'example' => 'oqevfbveuadcrduzmf@ttirv.net'],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['title' => '', 'description' => 'The coupon status. Valid values: </br>'."\n"
+ .'AVAILABLE: Normal. </br>'."\n"
+ .'EXHAUSTED: Exhausted. </br>'."\n"
+ .'EXPIRED: Expired. </br>'."\n"
+ .'ABANDONED: Abandoned. </br>.', 'type' => 'string', 'required' => false, 'example' => 'AVAILABLE'],
],
[
- 'name' => 'TemplateStatus',
+ 'name' => 'Page',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number. </br> '."\n"
+ .'Default value: 1. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false],
],
[
- 'name' => 'PageNo',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. </br>'."\n"
+ .'Default value: 20. Maximum value: 50. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'default' => '20', 'required' => false],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '50',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The Alibaba Cloud account UID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1133166938931507'],
+ ],
+ [
+ 'name' => 'CouponTemplateId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5075915', 'title' => ''],
+ ],
+ [
+ 'name' => 'T2PartnerUid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The T2 partner UID, such as 123456789.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456768', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
+ 'Code' => ['description' => 'The status code of the operation.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['title' => '', 'description' => 'The message returned by the operation.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => 'The request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The data entries.',
'type' => 'object',
'properties' => [
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'S00000101-100040',
- ],
- 'TemplateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TemplateStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'TimeOfRequest' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-02-02 09:46:59',
- ],
- 'IssuerAccount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test@test.aliyunid.com',
- ],
- 'Note' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'IssuerUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5432738203821334',
- ],
+ 'CouponTemplateId' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '503802', 'title' => ''],
+ 'CouponId' => ['description' => 'The coupon ID.', 'type' => 'string', 'example' => '59226280', 'title' => ''],
+ 'Amount' => ['description' => 'The face value of the coupon.', 'type' => 'number', 'format' => 'double', 'example' => '200', 'title' => ''],
+ 'Balance' => ['description' => 'The remaining balance.', 'type' => 'number', 'format' => 'double', 'example' => '0.01', 'title' => ''],
+ 'EffDate' => ['description' => 'The validity period of the coupon.', 'type' => 'string', 'example' => '2023-04-06 00:00:00 ~ 2023-04-07 00:00:00', 'title' => ''],
+ 'Status' => ['description' => 'The coupon status. Valid values: </br>'."\n"
+ .'AVAILABLE: Normal. </br>'."\n"
+ .'EXHAUSTED: Exhausted. </br>'."\n"
+ .'EXPIRED: Expired. </br>'."\n"
+ .'ABANDONED: Abandoned. </br>.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''],
+ 'Account' => ['description' => 'The Alibaba Cloud account.', 'type' => 'string', 'example' => 'oqevfbveuadcrduzmf@ttirv.net', 'title' => ''],
+ 'PublishDate' => ['description' => 'The time when the coupon was issued.', 'type' => 'string', 'example' => '2023-04-06 19:32:10'."\n", 'title' => ''],
+ 'Uid' => ['description' => 'The Alibaba Cloud UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1647668856741998', 'title' => ''],
+ 'T2PartnerUid' => ['description' => 'The UID of the tier-2 distributor.', 'type' => 'string', 'example' => '5248516956402795', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageInfo\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 300\\n },\\n \\"Data\\": [\\n {\\n \\"CouponTemplateId\\": 503802,\\n \\"CouponId\\": \\"59226280\\",\\n \\"Amount\\": 200,\\n \\"Balance\\": 0.01,\\n \\"EffDate\\": \\"2023-04-06 00:00:00 ~ 2023-04-07 00:00:00\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Account\\": \\"oqevfbveuadcrduzmf@ttirv.net\\",\\n \\"PublishDate\\": \\"2023-04-06 19:32:10\\\\n\\",\\n \\"Uid\\": 1647668856741998,\\n \\"T2PartnerUid\\": \\"5248516956402795\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query coupon usage list',
+ 'description' => 'Ensure that the current caller identity is a distribution partner. '."\n"
+ .'<notice>Available only on the China site.</notice>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCouponUsage'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListCouponUsage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"S00000101-100040\\",\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"TemplateStatus\\": 2,\\n \\"TimeOfRequest\\": \\"2024-02-02 09:46:59\\",\\n \\"IssuerAccount\\": \\"test@test.aliyunid.com\\",\\n \\"Note\\": \\"通过\\",\\n \\"IssuerUid\\": \\"5432738203821334\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '优惠券审批状态列表查询',
],
- 'DeleteCouponTemplate' => [
- 'summary' => '作废优惠券模板',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListExportTasks' => [
+ 'summary' => 'Queries the list of exported files.',
+ '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' => 'TemplateId',
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
+ ],
+ [
+ 'name' => 'SceneCode',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'description' => 'The export scenario code. Valid values:'."\n"
+ .'- intlCustomerQuotaRecord: customer management, quota transaction export.'."\n"
+ .'- intlExportUsageDeductHistory: customer management, deduction details export.',
+ 'type' => 'string',
'required' => true,
- 'example' => '6558410265670417297',
+ 'example' => 'intlExportUsageDeductHistory',
+ 'enum' => ['intlExportUsageDeductHistory', 'intlCustomerQuotaRecord'],
],
],
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12343', 'required' => false],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asda1231as'],
+ 'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Message' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The returned list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-01 10:22:11'."\n"],
+ 'Status' => ['title' => '', 'description' => 'The task status display.', 'type' => 'string', 'example' => 'Export Success'],
+ 'StatusCode' => ['title' => '', 'description' => 'The task status code. Valid values:'."\n"
+ .'- 2: exporting.'."\n"
+ .'- 3: export succeeded.'."\n"
+ .'- -1: export failed.', 'type' => 'string', 'example' => '3'],
+ 'Url' => ['title' => '', 'description' => 'The file download URL.', 'type' => 'string', 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057'],
+ 'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'null'],
+ 'Id' => ['title' => '', 'description' => 'The export task ID, which is a unique identifier.', 'type' => 'integer', 'format' => 'int64', 'example' => '12355'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ERROR_1003',
- 'errorMessage' => 'No permission to operate the object.',
- ],
- [
- 'errorCode' => 'ERROR_2311',
- 'errorMessage' => 'Coupon template does not exist.',
- ],
- [
- 'errorCode' => 'ERROR_201',
- 'errorMessage' => 'Parameters are illegal and required fields are empty.',
- ],
- [
- 'errorCode' => 'ERROR_2310',
- 'errorMessage' => 'The template has a coupon that is being approved so the template cannot be canceled.',
- ],
+ ['errorCode' => 'InvalidRequest.ExportTask.SceneCodeError', 'errorMessage' => 'The exporting scenario is incorrect.', 'description' => 'Export Scene Error'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2024-11-01 10:22:11\\\\n\\",\\n \\"Status\\": \\"Export Success\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"null\\",\\n \\"Id\\": 12355\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query exported file list',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T08:25:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-11-05T09:01:00.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListExportTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '作废优惠券模板',
],
- 'GetCouponTemplateDetail' => [
- 'summary' => '查询优惠券模板详情',
+ 'ListTier2CouponApproval' => [
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5770,452 +3884,258 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'T2PartnerName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5093156',
- ],
+ 'schema' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'required' => false, 'example' => 'test account', 'title' => ''],
+ ],
+ [
+ 'name' => 'T2PartnerUid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5248516956402795', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApprovalStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The approval status. Valid values:'."\n"
+ .'- 1: Revoked.'."\n"
+ .'- 2: Pending approval.'."\n"
+ .'- 3: Rejected.'."\n"
+ .'- 4: Approved.'."\n"
+ .'- 5: Approved but failed to issue.'."\n"
+ .'- 8: To be processed.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApplicationSheetId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => false, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1576',
- ],
- 'TemplateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-11-21 18:18:22',
- ],
- 'ReasonForApplication' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CostBearer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyun_poc',
- ],
- 'ApplicableProducts' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'UNIVERSAL',
- ],
- 'LimitPerPerson' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Denomination' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'ValidUntilType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'ValidUntil' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'PurchaseType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ALL,BILLING',
- ],
- 'CouponDescription' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'APPROVED',
+ 'description' => 'The returned data object.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationSheetId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
+ 'T2PartnerName' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'test account', 'title' => ''],
+ 'T2PartnerUid' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'example' => '5248516956402795', 'title' => ''],
+ 'ApplicationTime' => ['description' => 'The time when the application was submitted.', 'type' => 'string', 'example' => '2026-01-21 11:24', 'title' => ''],
+ 'ApprovalStatus' => ['description' => 'The approval status. Valid values:'."\n"
+ ."\n"
+ .'- 1: Revoked.'."\n"
+ .'- 2: Pending approval.'."\n"
+ .'- 3: Rejected.'."\n"
+ .'- 4: Approved.'."\n"
+ .'- 5: Approved but failed to issue.'."\n"
+ .'- 8: To be processed.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'TotalAmount' => ['description' => 'The application amount.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ERROR_201',
- 'errorMessage' => 'Parameters are illegal and required fields are empty.',
- ],
- [
- 'errorCode' => 'ERROR_1002',
- 'errorMessage' => 'No query permission.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'List secondary distributor coupon approvals',
+ 'summary' => 'Queries the list of coupon applications submitted by secondary distributors on behalf of their end users. This operation is applicable only to primary distributors.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TemplateId\\": 1576,\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"CreatedTime\\": \\"2024-11-21 18:18:22\\",\\n \\"ReasonForApplication\\": \\"测试的\\",\\n \\"CostBearer\\": \\"aliyun_poc\\",\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"LimitPerPerson\\": 1,\\n \\"Denomination\\": 100,\\n \\"ValidUntilType\\": \\"0\\",\\n \\"ValidUntil\\": \\"100\\",\\n \\"PurchaseType\\": \\"ALL,BILLING\\",\\n \\"CouponDescription\\": \\"测试的\\",\\n \\"Status\\": \\"APPROVED\\"\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询优惠券模板详情',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationSheetId\\": \\"d54ca949-9b88-4514-add3-c6029c4027f4\\",\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516956402795,\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ApprovalStatus\\": \\"1\\",\\n \\"TotalAmount\\": \\"200\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'GetCoupondeductProductCode' => [
- 'summary' => '国际渠道分销优惠券可抵扣产品',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ProcessApproval' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'ApplicationSheetId',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数 '."\n"
- .'默认值:无'."\n"
- .' 中文：zh-CN'."\n"
- .' 英文：en-US',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['description' => 'The ID of the application form.', 'type' => 'string', 'required' => true, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApprovalAction',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The approval action. Valid values:'."\n"
+ .'- Approve: approved.'."\n"
+ .'- Reject: rejected.', 'type' => 'string', 'required' => true, 'example' => 'Approve', 'title' => ''],
+ ],
+ [
+ 'name' => 'ApprovalComments',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The approval comments.', 'type' => 'string', 'required' => true, 'maxLength' => 500, 'minLength' => 1, 'example' => '同意', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '210e876f16704666020714468dab35',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'code',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ProductType' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => 'code1',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'Data' => ['description' => 'The approval result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ERROR_3100',
- 'errorMessage' => 'System exceptions, please submit a work order.',
- ],
- [
- 'errorCode' => 'ERROR_3210',
- 'errorMessage' => 'The current calling UID is not an international channel partner.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Approve a general approval process',
+ 'summary' => 'Approves a process that requires partner approval. This operation is applicable only to distributors.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"code\\",\\n \\"Data\\": [\\n {\\n \\"ProductType\\": \\"code1\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '国际渠道分销优惠券可抵扣产品',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
- 'IssueCouponForCustomer' => [
- 'summary' => '发放优惠券',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryAutomaticWriteOffChangeRecords' => [
+ 'summary' => 'Queries the change records of the automatic write-off quota. Paging is supported.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'CouponTemplateId',
+ 'name' => 'CustomerUid',
'in' => 'query',
- 'schema' => [
- 'title' => '优惠券模版ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '5075915',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
- 'name' => 'Uidlist',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => 'uid列表'."\n"
- .'用,分割 如 111,2222',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '111,2222',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => false, 'example' => '2026-06-20'],
],
[
- 'name' => 'AcceptLanguage',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .' 默认值:无'."\n"
- .' 中文：zh-CN'."\n"
- .' 英文：en-US',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh-CN',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => false, 'example' => '2026-05-20'],
],
[
- 'name' => 'IsUseBenefit',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '是否使用权益（已作废）'."\n"
- .'如：true/false',
- 'type' => 'boolean',
- 'deprecated' => true,
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
- 'name' => 'ApplicationReason',
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Language',
'in' => 'query',
'schema' => [
- 'title' => '申请原因'."\n"
- .'如：为客户XXX申请优惠券',
+ 'title' => '',
+ 'description' => 'The language parameter. If not specified, the default value is en. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.',
'type' => 'string',
- 'example' => '为客户XXX审批优惠券，该客户是XXXX',
- 'maxLength' => 500,
+ 'enum' => ['zh', 'en', 'ja'],
+ 'required' => false,
+ 'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'code',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CouponTemplateId' => [
- 'title' => '优惠券模版ID',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5075915',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-03-05 18:24:07',
- ],
- 'Uidlist' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '111,2222'."\n",
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8cd24f2917797624314748873d0096'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => '成功'],
+ 'Data' => [
+ 'description' => 'The list of query results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The query result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChangeContent' => ['title' => '', 'description' => 'The content of the operation.', 'type' => 'string', 'example' => '开启自动销账并选择 500 USD'],
+ 'OperationTime' => ['title' => '', 'description' => 'The time of the operation.', 'type' => 'string', 'example' => '2023-12-15 10:34:36 UTC+8'],
+ 'OperateId' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '12312312'],
+ 'OperateSource' => ['title' => '', 'description' => 'The description of how the operation was initiated.', 'type' => 'string', 'example' => 'API'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ERROR_3100',
- 'errorMessage' => 'System exceptions, please submit a work order.',
- ],
- [
- 'errorCode' => 'ERROR_3081',
- 'errorMessage' => 'couponTemplateId empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3082',
- 'errorMessage' => 'Uidlist empty, please check .',
- ],
- [
- 'errorCode' => 'ERROR_3080',
- 'errorMessage' => 'Account empty, please check.',
- ],
- [
- 'errorCode' => 'ERROR_3090',
- 'errorMessage' => 'You have no authority.',
- ],
- [
- 'errorCode' => 'ERROR_3088',
- 'errorMessage' => 'Coupon template expired, unable to issue coupon.',
- ],
- [
- 'errorCode' => 'ERROR_3102',
- 'errorMessage' => 'This coupon template ID was not created by this account.',
- ],
- [
- 'errorCode' => 'ERROR_3089',
- 'errorMessage' => 'Coupon template issuance limit exceeded, unable to issue coupon.',
- ],
- [
- 'errorCode' => 'ERROR_3086',
- 'errorMessage' => 'The current uid does not have a distribution relationship and cannot issue a coupon.',
- ],
- [
- 'errorCode' => 'ERROR_3087',
- 'errorMessage' => 'The current uid is not the end user identity, can not issue coupons.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query automatic write-off change records',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"code\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"data\\": {\\n \\"CouponTemplateId\\": 5075915,\\n \\"CreateTime\\": \\"2024-03-05 18:24:07\\",\\n \\"Uidlist\\": \\"111,2222\\\\n\\"\\n }\\n}","type":"json"}]',
- 'title' => '发放优惠券',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8cd24f2917797624314748873d0096\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"ChangeContent\\": \\"开启自动销账并选择 500 USD\\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36 UTC+8\\",\\n \\"OperateId\\": \\"12312312\\",\\n \\"OperateSource\\": \\"API\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ListCouponUsage' => [
- 'summary' => '优惠券使用量列表查询',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryReversedDeductionHistory' => [
+ 'summary' => 'Queries the credit offset details for a specified customer.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6223,241 +4143,104 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Account',
+ 'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'title' => '收券账号，如：abc@test.com',
- 'description' => '阿里云客户账号',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oqevfbveuadcrduzmf@ttirv.net',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
- 'name' => 'Status',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '优惠券状态',
- 'description' => '优惠券状态 </br>'."\n"
- .'AVAILABLE 正常 </br>'."\n"
- .'EXHAUSTED 已用完 </br>'."\n"
- .'EXPIRED 已过期 </br>'."\n"
- .'ABANDONED 已作废 </br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AVAILABLE',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-07-31'],
],
[
- 'name' => 'Page',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '分页页号，如：1',
- 'description' => '页码</br> '."\n"
- .' 默认值为1 最小值1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-12-31'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '分页大小，如：20',
- 'description' => '分页行数 </br>'."\n"
- .' 默认值20 最大值50 最小值1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '50',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'Uid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '收券账号uid',
- 'description' => '阿里云账号uid',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1133166938931507',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
],
[
- 'name' => 'CouponTemplateId',
+ 'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => '优惠券模版id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '5075915',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'T2PartnerUid',
+ 'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => 'T2伙伴uid'."\n"
- .'如：123456789',
- 'description' => 'T2伙伴uid'."\n"
- .'如：123456789',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456768',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Valid values:'."\n"
+ .'- en: English'."\n"
+ .'- zh: Chinese'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回对象',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '接口状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => 'Id of the request',
- 'description' => '接口返回提示信息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '接口请求id返回问题提供查询使用',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'PageInfo' => [
- 'description' => '分页信息',
- 'type' => 'object',
- 'properties' => [
- 'Page' => [
- 'description' => '分页，当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页，每页数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Total' => [
- 'description' => '分页，总量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '300',
- ],
- ],
- ],
+ 'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
+ 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Data' => [
- 'description' => '返回数据',
+ 'title' => '',
+ 'description' => 'The list data.',
'type' => 'array',
'items' => [
- 'description' => '数据',
+ 'title' => '',
+ 'description' => 'The list data.',
'type' => 'object',
'properties' => [
- 'CouponTemplateId' => [
- 'description' => '优惠券模版id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '503802',
- ],
- 'CouponId' => [
- 'description' => '优惠券id',
- 'type' => 'string',
- 'example' => '59226280',
- ],
- 'Amount' => [
- 'description' => '优惠券面额',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '200',
- ],
- 'Balance' => [
- 'description' => '余额',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.01',
- ],
- 'EffDate' => [
- 'description' => '优惠券有效期',
- 'type' => 'string',
- 'example' => '2023-04-06 00:00:00 ~ 2023-04-07 00:00:00',
- ],
- 'Status' => [
- 'description' => '优惠券状态 </br>'."\n"
- .'AVAILABLE 正常 </br>'."\n"
- .'EXHAUSTED 已用完 </br>'."\n"
- .'EXPIRED 已过期 </br>'."\n"
- .'ABANDONED 已作废 </br>',
- 'type' => 'string',
- 'example' => 'AVAILABLE',
- ],
- 'Account' => [
- 'description' => '阿里云账号',
- 'type' => 'string',
- 'example' => 'oqevfbveuadcrduzmf@ttirv.net',
- ],
- 'PublishDate' => [
- 'description' => '优惠券发放时间',
- 'type' => 'string',
- 'example' => '2023-04-06 19:32:10'."\n",
- ],
- 'Uid' => [
- 'description' => '阿里云uid',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1647668856741998',
- ],
- 'T2PartnerUid' => [
- 'type' => 'string',
- 'description' => '二级分销商Uid',
- 'example' => '5248516956402795',
- ],
+ 'OperationSubmitType' => ['title' => '', 'description' => 'The method by which the operation was submitted. Valid values: API and ACPN.', 'type' => 'string', 'example' => 'ACPN'],
+ 'OperationTime' => ['title' => '', 'description' => 'The time when the operation was performed.', 'type' => 'string', 'example' => '2024-11-01 10:22:11 UTC+8'],
+ 'OperationUid' => ['title' => '', 'description' => 'The UID of the operator.', 'type' => 'string', 'example' => '132'],
+ 'OffsetAmount' => ['title' => '', 'description' => 'The offset amount.', 'type' => 'string', 'example' => '1.00'],
],
+ 'example' => '',
],
+ 'example' => '',
],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asda1231as'],
+ 'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query credit offset details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:QueryReversedDeductionHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageInfo\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 300\\n },\\n \\"Data\\": [\\n {\\n \\"CouponTemplateId\\": 503802,\\n \\"CouponId\\": \\"59226280\\",\\n \\"Amount\\": 200,\\n \\"Balance\\": 0.01,\\n \\"EffDate\\": \\"2023-04-06 00:00:00 ~ 2023-04-07 00:00:00\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Account\\": \\"oqevfbveuadcrduzmf@ttirv.net\\",\\n \\"PublishDate\\": \\"2023-04-06 19:32:10\\\\n\\",\\n \\"Uid\\": 1647668856741998,\\n \\"T2PartnerUid\\": \\"5248516956402795\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '优惠券使用量列表查询',
- 'description' => '确保当前调用账号身份为分销伙伴 '."\n"
- .'<notice>仅国际提供></notice>',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2024-11-01 10:22:11 UTC+8\\",\\n \\"OperationUid\\": \\"132\\",\\n \\"OffsetAmount\\": \\"1.00\\"\\n }\\n ],\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'QuotaListExportPaged' => [
- 'summary' => 'Check the result of export quota list as a Distribution Customer from International Site. Only available on International Site.',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Queries the results of quota journal export tasks for international distribution users. This operation can be called only on the China site (Chinese mainland).',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6465,473 +4248,1246 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '分页页码，从1开始',
- 'description' => 'Pagination, current page number, starting from 1.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，最大100',
- 'description' => 'Pagination, record number on each page, maximum 100.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => 'Multilingual Parameters, the default language is English.</br>'."\n"
- .'en: English</br>'."\n"
- .'zh: Chinese</br>'."\n"
- .'ja: Japanese </br>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
+ .'- en: English.'."\n"
+ .'- zh: Chinese.'."\n"
+ .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => 'ID of the Request',
- 'type' => 'string',
- 'example' => '210e876f16704666020714468dab35',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => 'Total volume',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => 'Current page number',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '当前每页条数',
- 'description' => 'Record number on each page',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Msg' => [
- 'title' => '返回结果描述',
- 'description' => 'Description of returning result',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Code' => [
- 'title' => '返回结果状态码，200是成功',
- 'description' => 'Status code of returning result, 200 means success.',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
+ 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['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'],
+ 'Msg' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
- 'description' => 'Listed data of returning result',
+ 'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
- 'description' => 'Response data',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'FileName' => [
- 'title' => '文件名称',
- 'description' => 'File Name',
- 'type' => 'string',
- 'example' => '5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => 'Create Time',
- 'type' => 'string',
- 'example' => '2023-12-21 21:31:57 UTC+8',
- ],
- 'Status' => [
- 'title' => '任务状态展示',
- 'description' => 'Display of Task Status',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'StatusCode' => [
- 'title' => '任务状态code枚举'."\n"
- .'2：导出中'."\n"
- .'3：导出成功'."\n"
- .'-1：导出失败',
- 'description' => 'Task Status Enum</br>'."\n"
- .'2: Exporting</br>'."\n"
- .'3: Export Success</br>'."\n"
- .'-1: Export Fail</br>',
- 'type' => 'string',
- 'example' => 'Export Success',
- ],
- 'Url' => [
- 'title' => '文件下载链接',
- 'description' => 'The link to download exported file.',
- 'type' => 'string',
- 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057',
- ],
- 'Message' => [
- 'title' => '提示信息',
- 'description' => 'Notification Message',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2023-12-21 21:31:57 UTC+8'],
+ 'Status' => ['title' => '', 'description' => 'The task status display.', 'type' => 'string', 'example' => '3'],
+ 'StatusCode' => ['title' => '', 'description' => 'The task status code. Valid values:'."\n"
+ .'- 2: exporting.'."\n"
+ .'- 3: export succeeded.'."\n"
+ .'- -1: export failed.', 'type' => 'string', 'example' => 'Export Success'],
+ 'Url' => ['title' => '', 'description' => 'The file download URL.', 'type' => 'string', 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057'],
+ 'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2023-12-21 21:31:57 UTC+8\\",\\n \\"Status\\": \\"3\\",\\n \\"StatusCode\\": \\"Export Success\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'QuotaListExportPaged',
- 'description' => 'Caller must be a Partner from International Site, either Distribution or Reseller will do.',
- ],
- 'ProcessApproval' => [
- 'summary' => '审批流审批通用接口',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'title' => 'View quota journal export results',
+ 'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:QuotaListExportPaged',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuotaListExportPaged'],
+ ],
],
+ ],
+ 'ResendEmail' => [
+ 'summary' => 'Resends an invitation email.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ApplicationSheetId',
+ 'name' => 'InviteId',
'in' => 'query',
+ 'schema' => ['description' => 'The invitation ID, obtained from the InviteSbuAccount operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '176', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code.'."\n"
+ .'Error code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.'."\n"
+ .'- 3058: Emails are sent too frequently. A maximum of 10 emails can be sent within 5 minutes.'."\n"
+ .'- 3057: InviteId is empty.'."\n"
+ .'- 3060: No sending record found for the specified InviteId.'."\n"
+ .'- 3061: The registration URL has expired and the email cannot be resent.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'Error3058', 'errorMessage' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'],
+ ['errorCode' => 'InvalidParam.InviteId.InvalidId', 'errorMessage' => 'No invitation record found based on inviteId.', 'description' => 'No invitation record found based on request ID'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Resend invitation email',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T07:28:43.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResendEmail'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ApprovalAction',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:ResendEmail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SetAccountInfo' => [
+ 'summary' => 'Updates sub-account information, including the nickname and remarks.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AccountNickname',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The nickname of the sub-account. For enterprise customers, this is the company name. For T2 partners, this is the partner name.', 'type' => 'string', 'required' => false, 'example' => '我的账号', 'title' => ''],
+ ],
+ [
+ 'name' => 'Remark',
'in' => 'query',
+ 'schema' => ['description' => 'The description of the sub-account.', 'type' => 'string', 'required' => false, 'example' => '测试的账号', 'title' => ''],
+ ],
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1133166938931507', 'title' => ''],
+ ],
+ [
+ 'name' => 'CustomerBd',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The customer business manager. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => '张三'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: A system error occurred.'."\n"
+ .'- 3030: The account nickname exceeds the maximum length of 150 bytes.'."\n"
+ .'- 3031: The remark exceeds the maximum length of 3000 bytes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Valid values: True and False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Approve',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'Error3030', 'errorMessage' => 'The maximum length of CustomNick is 150.', 'description' => 'Maximum CustomNick length is 150'],
+ ['errorCode' => 'Error3031', 'errorMessage' => 'The maximum length of FxDescription is 3000.', 'description' => 'Maximum FxDescription length is 3000'],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Update sub-account information',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccountInfo'],
+ ],
+ ],
+ ],
+ 'SetCreditLine' => [
+ 'summary' => 'Sets the credit limit for a reseller customer. This feature is available only for Resellers and Distributors.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ApprovalComments',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'Uid',
'in' => 'query',
+ 'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1263644979775567', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreditLine',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The new credit limit.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.'."\n"
+ .'- 3040: The sub-account is frozen and the operation cannot be completed.'."\n"
+ .'- 3041: The credit limit is not a number.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message that corresponds to the result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the API call is successful. Valid values: True and False. This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
'example' => '',
- 'maxLength' => 500,
- 'minLength' => 1,
],
],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'Error3040', 'errorMessage' => 'The account is in a frozen state and cannot be operated.', 'description' => 'The account is in a frozen state and cannot be operated.'],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Set credit limit for a reseller customer',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetCreditLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCreditLine'],
+ ],
+ ],
+ ],
+ 'SetWarningThreshold' => [
+ 'summary' => 'Sets the credit usage threshold. When a customer\'s available credit falls below the threshold, the reseller is notified by email. This feature is available only for Resellers and Distributors.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'Uid',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The UID of the reseller customer account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1792155717328010', 'title' => ''],
+ ],
+ [
+ 'name' => 'WarningValue',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The percentage value. Valid values: 1 to 100. When the available credit drops below this percentage of the total credit limit, an alert email is sent to the reseller partner account.', 'type' => 'string', 'required' => true, 'example' => '20', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'id of request',
- 'type' => 'string',
- 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result code. Valid values:'."\n"
+ .'- 200: OK.'."\n"
+ .'- 1109: System error.'."\n"
+ .'- 3040: The sub-account is frozen and the operation cannot be completed.'."\n"
+ .'- 3044: The alert percentage value is not a number.'."\n"
+ .'- 3045: The alert percentage value must be from 1 to 100.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message that corresponds to the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current API call was successful. Valid values: True and False. This does not indicate whether the subsequent business operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
+ ['errorCode' => 'Error3040', 'errorMessage' => 'The account is in a frozen state and cannot be operated.', 'description' => 'The account is in a frozen state and cannot be operated.'],
+ ['errorCode' => 'Error3044', 'errorMessage' => 'The Value is not a number.', 'description' => 'Value is not a number'],
+ ['errorCode' => 'Error3045', 'errorMessage' => 'The value must be between 1-100.', 'description' => 'Value must be between 1-100'],
+ ['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
+ ['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '通用的审批流程审批',
- ],
- 'ListExportTasks' => [
- 'summary' => 'Query the list of exported files.',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
+ 'title' => 'Set credit usage threshold for a reseller customer',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetWarningThreshold',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWarningThreshold'],
+ ],
],
+ ],
+ 'SubscriptionBill' => [
+ 'summary' => 'Subscribes to multi-level ecosystem partner bills on Alibaba Cloud International and generates bill files to OSS.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PageNo',
+ 'name' => 'SubscribeBucket',
'in' => 'query',
- 'schema' => [
- 'title' => '分页页码，从1开始',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The name of the OSS bucket for storing bill files.', 'type' => 'string', 'required' => true, 'example' => 'bill-bucket'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'BucketOwnerId',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，最大100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UID of the account that owns the OSS bucket for storing files.'."\n"
+ ."\n"
+ .'If a partner subscribes and needs to push files to the OSS bucket of a subordinate partner account, this account must be a subordinate partner account of the partner account. Grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subordinate partner account. '."\n"
+ ."\n"
+ .'If a partner subscribes and pushes files to the partner account\'s own OSS bucket, grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the partner account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5569414254138836'],
],
[
- 'name' => 'Language',
+ 'name' => 'SubscribeType',
'in' => 'query',
- 'schema' => [
- 'title' => '多语言参数'."\n"
- .'en：英文'."\n"
- .'zh：中文'."\n"
- .'ja：日文',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- 'default' => 'en',
- ],
+ 'schema' => ['title' => '', 'description' => 'The subscription type. Valid values: '."\n"
+ .'- PartnerBillingItemDetailForBillingPeriod: billing item detail.'."\n"
+ .'- PartnerBillingItemDetailMonthly: billing item monthly bill.'."\n"
+ .'- PartnerInstanceDetailForBillingPeriod: instance bill detail.'."\n"
+ .'- PartnerInstanceDetailMonthly: instance monthly bill.', 'type' => 'string', 'required' => true, 'example' => 'PartnerBillingItemDetailForBillingPeriod'],
],
[
- 'name' => 'SceneCode',
+ 'name' => 'BeginBillingCycle',
'in' => 'query',
- 'schema' => [
- 'title' => '导出场景code'."\n"
- .'intlCustomerQuotaRecord：客户管理，quota流水导出'."\n"
- .'intlExportUsageDeductHistory：客户管理，冲减明细导出',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'intlExportUsageDeductHistory',
- 'enum' => [
- 'intlExportUsageDeductHistory',
- 'intlCustomerQuotaRecord',
- ],
- ],
+ 'schema' => ['title' => '', 'description' => 'The billing month from which to start pushing bills. Format: yyyy-MM.'."\n"
+ ."\n"
+ .'After a successful subscription, the system automatically pushes data from the start billing cycle to the current time. Data for up to the last six months (including the current month) can be pushed. If the specified month exceeds this range, the subscription is invalid.', 'type' => 'string', 'required' => true, 'example' => '2022-10'],
],
[
- 'name' => 'Id',
+ 'name' => 'BillFormat',
'in' => 'query',
- 'schema' => [
- 'title' => '导出任务id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12343',
- ],
+ 'schema' => ['description' => 'The bill file format. Valid values:'."\n"
+ .'- csv'."\n"
+ .'- parquet'."\n"
+ ."\n"
+ .'If you subscribe to multiple file types, use separate buckets to avoid file overwriting.', 'type' => 'string', 'required' => true, 'example' => 'csv', 'title' => ''],
+ ],
+ [
+ 'name' => 'SubscribeSegmentSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The row count threshold for a single bill file. If the number of rows exceeds this threshold, the file is automatically split into multiple files. The naming convention for split files is `uid_billType_billCycle_SquenceNo_fileNo`.'."\n"
+ ."\n"
+ .'All information in the file names is identical except for fileNo. These files belong to the same billing cycle and the same file type but are split into multiple files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'asda1231as',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '当前每页条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Message' => [
- 'title' => '返回结果描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
+ 'Message' => ['title' => '', 'description' => 'The message returned.', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Data' => ['description' => 'The data returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => [
- 'title' => '返回结果状态码，200是成功',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The status code.',
+ 'enumValueTitles' => [1001 => 'Invalid subscription bill type.', 'Invalid subscription file type.', 'Invalid start push date.', 'Subscription failed.', 'No subscription permission.', 'Subscription record already exists.', 'Invalid bucket.'],
'type' => 'string',
'example' => '200',
],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'title' => '文件名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-11-01 10:22:11'."\n",
- ],
- 'Status' => [
- 'title' => '任务状态展示',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Export Success',
- ],
- 'StatusCode' => [
- 'title' => '任务状态code枚举'."\n"
- .'2：导出中'."\n"
- .'3：导出成功'."\n"
- .'-1：导出失败',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'Url' => [
- 'title' => '文件下载链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057',
- ],
- 'Message' => [
- 'title' => '提示信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'Id' => [
- 'title' => '导出任务id，唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12355',
- ],
- ],
- ],
- ],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest.ExportTask.SceneCodeError',
- 'errorMessage' => 'The exporting scenario is incorrect.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Subscribe to ecosystem partner bills',
+ 'description' => '- Ensure that the caller is an Alibaba Cloud international master reseller partner.'."\n"
+ .'- A user can subscribe to one type of bill file at a time.'."\n"
+ .'- After subscription, bill files generated on the previous day are pushed daily starting from the next day. On the 5th of each month, full bill files for the previous billing cycle are pushed.'."\n"
+ .'- Bill files generated on a daily basis may be delayed. Delayed bill files are pushed the day after they are generated and may include bills that were delayed from earlier days. Pull the full files for the previous month at the beginning of each month.'."\n"
+ .'- Grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subscribing user.'."\n"
+ .'- File names.'."\n"
+ ."\n"
+ .'```.'."\n"
+ ."\n"
+ .'BillingItemDetailForBillingPeriod (Billing item detail)'."\n"
+ .' '."\n"
+ .'Daily push file name format: UID_PartnerBillingItemDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_BillingItemDetail_20190310_0001_01.'."\n"
+ .' '."\n"
+ .'Full file name format at the beginning of the next month: UID_PartnerBillingItemDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetail_201903_0001_01.'."\n"
+ ."\n"
+ .'InstanceDetailForBillingPeriod (Instance bill detail)'."\n"
+ .' '."\n"
+ .' Daily push file name format: UID_PartnerInstanceDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_InstanceDetail_20190310_0001_01.'."\n"
+ .' '."\n"
+ .'Full file name format at the beginning of the next month: UID_PartnerInstanceDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetail_201903_1999-0001_01.'."\n"
+ ."\n"
+ .'BillingItemDetailMonthly (Billing item monthly bill)'."\n"
+ .' '."\n"
+ .'Daily push file name format: UID_PartnerBillingItemDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetailMonthly_201903_0001_01. This file is updated daily with full data from the beginning of the month to the current day, until the 5th of the next month.'."\n"
+ ."\n"
+ .'InstanceDetailMonthly (Instance monthly bill)'."\n"
+ .' '."\n"
+ .'Daily push file name format: UID_PartnerInstanceDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetailMonthly_201903_0001_01. This file is updated daily with full data from the beginning of the month to the current day, until the 5th of the next month.'."\n"
+ ."\n"
+ .'fileNo exists only when the number of bill rows reaches the split threshold and the file is split.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'**This content is published only on the Chinese site.**.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-10T06:15:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-12-29T13:32:00.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubscriptionBill'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:SubscriptionBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2024-11-01 10:22:11\\\\n\\",\\n \\"Status\\": \\"Export Success\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"null\\",\\n \\"Id\\": 12355\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'Querying the Common Export File List',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.ap-southeast-1.aliyuncs.com', 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.aliyuncs.com', 'endpoint' => 'agency.aliyuncs.com', 'vpc' => 'agency-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Error1109', 'message' => 'system error.', 'http_code' => 400, 'description' => 'System exception'],
+ ['code' => 'Error3008', 'message' => 'shutdown status is error.', 'http_code' => 400, 'description' => 'shutdown status is error.'],
+ ['code' => 'Error3009', 'message' => 'customerAccount is error.', 'http_code' => 400, 'description' => 'customerAccount is error.'],
+ ['code' => 'Error3010', 'message' => 'customerNick is empty.', 'http_code' => 400, 'description' => 'customerNick is empty.'],
+ ['code' => 'Error3011', 'message' => 'The length of customerNick greater than 50.', 'http_code' => 400, 'description' => 'The length of customerNick greater than 50. '],
+ ['code' => 'Error3012', 'message' => 'cid is empty.', 'http_code' => 400, 'description' => 'cid is empty.'],
+ ['code' => 'Error3013', 'message' => 'customCredit is empty.', 'http_code' => 400, 'description' => 'customCredit is empty.'],
+ ['code' => 'Error3014', 'message' => 'customCredit is a maximum of 10.', 'http_code' => 400, 'description' => 'customCredit is a maximum of 10.'],
+ ['code' => 'Error3015', 'message' => 'The current account is not a partner.', 'http_code' => 400, 'description' => 'The current account is not a distributor'],
+ ['code' => 'Error3016', 'message' => 'customerRebateType is error, only invite agency account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite agency account.'],
+ ['code' => 'Error3017', 'message' => 'customerRebateType is error, only invite reseller account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite reseller account.'],
+ ['code' => 'Error3030', 'message' => 'The maximum length of CustomNick is 150.', 'http_code' => 400, 'description' => 'Maximum CustomNick length is 150'],
+ ['code' => 'Error3031', 'message' => 'The maximum length of FxDescription is 3000.', 'http_code' => 400, 'description' => 'Maximum FxDescription length is 3000'],
+ ['code' => 'Error3040', 'message' => 'The account is in a frozen state and cannot be operated.', 'http_code' => 400, 'description' => 'The account is in a frozen state and cannot be operated.'],
+ ['code' => 'Error3043', 'message' => 'The range of ShutdownStatus can only be 1 and 2.', 'http_code' => 400, 'description' => 'The range of ShutdownStatus can only be 1 and 2'],
+ ['code' => 'Error3044', 'message' => 'The Value is not a number.', 'http_code' => 400, 'description' => 'Value is not a number'],
+ ['code' => 'Error3045', 'message' => 'The value must be between 1-100.', 'http_code' => 400, 'description' => 'Value must be between 1-100'],
+ ['code' => 'Error3051', 'message' => 'input accounStatus value error, It must be 1,2,3.', 'http_code' => 400, 'description' => 'Wrong value for input AccounStatus, must be 1,2 or 3'],
+ ['code' => 'Error3052', 'message' => 'Your account is currently frozen and cannot be unfrozen for the following customer operations.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Error3055', 'message' => 'subAccountType is null.', 'http_code' => 400, 'description' => 'subAccountType is empty'],
+ ['code' => 'Error3056', 'message' => 'The value of subAccountType error.', 'http_code' => 400, 'description' => 'The value of subAccountType error'],
+ ['code' => 'Error3058', 'message' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'http_code' => 400, 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'],
+ ['code' => 'Error3067', 'message' => 'Enterprise Customer Invitation Prohibition.', 'http_code' => 400, 'description' => 'Enterprise Customer Invitation Prohibition.'],
+ ['code' => 'ERROR_1002', 'message' => 'No query permission.', 'http_code' => 400, 'description' => 'No query permission'],
+ ['code' => 'ERROR_1003', 'message' => 'No permission to operate the object.', 'http_code' => 400, 'description' => 'No permission to operate the object.'],
+ ['code' => 'ERROR_201', 'message' => 'Parameters are illegal and required fields are empty.', 'http_code' => 400, 'description' => 'Parameters are illegal and required fields are empty.'],
+ ['code' => 'ERROR_2307', 'message' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'http_code' => 400, 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'],
+ ['code' => 'ERROR_2310', 'message' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'http_code' => 400, 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'],
+ ['code' => 'ERROR_2311', 'message' => 'Coupon template does not exist.', 'http_code' => 400, 'description' => 'Coupon template does not exist'],
+ ['code' => 'ERROR_3070', 'message' => 'CouponTemplateName must be entered.', 'http_code' => 400, 'description' => 'TemplateName name must be entered'],
+ ['code' => 'ERROR_3071', 'message' => 'ApplicableProducts empty, please check.', 'http_code' => 400, 'description' => 'ApplicableProducts empty, please check.'],
+ ['code' => 'ERROR_3072', 'message' => 'itemCodes empty, please check.', 'http_code' => 400, 'description' => 'ProductType is empty, please check'],
+ ['code' => 'ERROR_3073', 'message' => 'amout empty, please check.', 'http_code' => 400, 'description' => 'Value empty, please check.'],
+ ['code' => 'ERROR_3074', 'message' => 'personLimit empty, please check.', 'http_code' => 400, 'description' => 'LimitPerPerson empty, please check.'],
+ ['code' => 'ERROR_3075', 'message' => 'applyReason empty, please check.', 'http_code' => 400, 'description' => 'ReasonForApplication empty, please check.'],
+ ['code' => 'ERROR_3076', 'message' => 'effDateType empty, please check.', 'http_code' => 400, 'description' => 'effDateType empty, please check.'],
+ ['code' => 'ERROR_3077', 'message' => 'effDateDay empty, please check.', 'http_code' => 400, 'description' => 'Vaildperioddays empty, please check.'],
+ ['code' => 'ERROR_3078', 'message' => 'effDateFrom empty, please check.', 'http_code' => 400, 'description' => 'Vailddate empty, please check.'],
+ ['code' => 'ERROR_3079', 'message' => 'effDateTo empty, please check.', 'http_code' => 400, 'description' => 'Expireddate empty, please check .'],
+ ['code' => 'ERROR_3080', 'message' => 'Account empty, please check.', 'http_code' => 400, 'description' => 'Account is empty, please check'],
+ ['code' => 'ERROR_3081', 'message' => 'couponTemplateId empty, please check.', 'http_code' => 400, 'description' => 'couponTemplateId empty, please check.'],
+ ['code' => 'ERROR_3082', 'message' => 'Uidlist empty, please check .', 'http_code' => 400, 'description' => 'Uidlist is empty, please check'],
+ ['code' => 'ERROR_3084', 'message' => 'Coupon cannot be valid for more than 180 days.', 'http_code' => 400, 'description' => 'Coupon cannot be valid for more than 180 days'],
+ ['code' => 'ERROR_3085', 'message' => 'Product code is not in international channel partner coupons deductable product list.', 'http_code' => 400, 'description' => 'Product code is not in international channel partner coupons deductable product list.'],
+ ['code' => 'ERROR_3087', 'message' => 'The current uid is not the end user identity, can not issue coupons.', 'http_code' => 400, 'description' => 'The current uid is not the end user identity, can not issue coupons.'],
+ ['code' => 'ERROR_3088', 'message' => 'Coupon template expired, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template expired, unable to issue coupon'],
+ ['code' => 'ERROR_3089', 'message' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'],
+ ['code' => 'ERROR_3090', 'message' => 'You have no authority.', 'http_code' => 400, 'description' => 'You have no authority'],
+ ['code' => 'ERROR_3091', 'message' => 'Coupon template name length over limit.', 'http_code' => 400, 'description' => 'Coupon template name length over limit（30 characters）.'],
+ ['code' => 'ERROR_3092', 'message' => 'Reason for template request length over limit.', 'http_code' => 400, 'description' => 'Reason for template request length over limit（100 characters）'],
+ ['code' => 'ERROR_3093', 'message' => 'Coupon cost-bearer parameters are not legal.', 'http_code' => 400, 'description' => 'Coupon cost-bearer parameters are not legal'],
+ ['code' => 'ERROR_3094', 'message' => 'Applicable product type parameters are not legal.', 'http_code' => 400, 'description' => 'Applicable product type parameters are not legal'],
+ ['code' => 'ERROR_3095', 'message' => 'The per-person limit is illegal.', 'http_code' => 400, 'description' => 'The per-person limit is illegal.'],
+ ['code' => 'ERROR_3096', 'message' => 'Coupon value is illegal.', 'http_code' => 400, 'description' => 'Coupon value is illegal.'],
+ ['code' => 'ERROR_3097', 'message' => 'Time type is illegal.', 'http_code' => 400, 'description' => 'Time type is illegal.'],
+ ['code' => 'ERROR_3098', 'message' => 'Coupon Remarks Information length over limit.', 'http_code' => 400, 'description' => 'Coupon Remarks Information length over limit（100 characters).'],
+ ['code' => 'ERROR_3099', 'message' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'],
+ ['code' => 'ERROR_3100', 'message' => 'System exceptions, please submit a work order.', 'http_code' => 400, 'description' => 'System exceptions, please submit a work order.'],
+ ['code' => 'ERROR_3101', 'message' => 'PurchaseType empty, please check .', 'http_code' => 400, 'description' => 'PurchaseType empty, please check .'],
+ ['code' => 'ERROR_3102', 'message' => 'This coupon template ID was not created by this account.', 'http_code' => 400, 'description' => 'This coupon template ID was not created by this account.'],
+ ['code' => 'ERROR_3103', 'message' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"],
+ ['code' => 'ERROR_3210', 'message' => 'The current calling UID is not an international channel partner.', 'http_code' => 400, 'description' => 'The current calling UID is not an international channel partner'],
+ ['code' => 'InvalidParam.InviteId.InvalidId', 'message' => 'No invitation record found based on inviteId.', 'http_code' => 400, 'description' => 'No invitation record found based on request ID'],
+ ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'This uid is not your EU.', 'http_code' => 400, 'description' => 'This user is not your distribution customer'],
+ ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'The current customer does not belong to this partner.', 'http_code' => 400, 'description' => 'Current customer does not belong to this partner'],
+ ['code' => 'InvalidParam.Uid.QuotaListEndDateNullError', 'message' => 'No End Time.', 'http_code' => 400, 'description' => 'End time is empty'],
+ ['code' => 'InvalidParam.Uid.QuotaListStartDateNullError', 'message' => 'No Start Time.', 'http_code' => 400, 'description' => 'The start time is empty.'],
+ ['code' => 'InvalidRequest.ExportTask.SceneCodeError', 'message' => 'The exporting scenario is incorrect.', 'http_code' => 400, 'description' => 'Export Scene Error'],
+ ['code' => 'InvalidRequest.ExportTask.SceneCodeNull', 'message' => 'The exporting scenario is empty.', 'http_code' => 400, 'description' => 'The exported scene is empty.'],
+ ['code' => 'InvalidRequest.NoPermissions', 'message' => 'No permissions for the operation.', 'http_code' => 400, 'description' => 'You do not have permission to perform this operation.'],
+ ['code' => 'InvalidRequest.NoPermissions.NotPartner', 'message' => 'The current caller is not a partner.', 'http_code' => 400, 'description' => 'The current caller is not an eco-partner'],
+ ['code' => 'InvalidRequest.NoPermissions.RamNoPermission', 'message' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'http_code' => 400, 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListExportTasks'],
+ ],
+ 'createdAt' => '2025-11-27T08:25:45.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListExportTasks'],
+ ],
+ 'createdAt' => '2025-11-05T09:01:09.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'agency.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetAccountInfo'],
+ ],
+ 'createdAt' => '2024-11-05T01:47:16.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetCoupondeductProductCode'],
+ ],
+ 'createdAt' => '2024-09-26T04:14:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateCouponTemplate'],
+ ],
+ 'createdAt' => '2024-09-11T12:09:57.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetAccountInfo'],
+ ['description' => 'Request parameters changed', 'api' => 'InviteSubAccount'],
+ ['description' => 'Request parameters changed', 'api' => 'SetAccountInfo'],
+ ],
+ 'createdAt' => '2024-04-18T06:55:35.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetCreditInfo'],
+ ],
+ 'createdAt' => '2023-12-22T03:27:36.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'InviteSubAccount'],
+ ],
+ 'createdAt' => '2023-10-13T09:19:47.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'InviteSubAccount'],
+ ],
+ 'createdAt' => '2023-09-07T12:09:10.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'SubscriptionBill'],
+ ],
+ 'createdAt' => '2022-12-29T13:32:39.000Z',
+ 'description' => '添加设置信控接口',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCouponTemplate'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomerQuotaRecord'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccountInfo'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeductOutstandingBalance'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditNewBuyStatus'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCountries'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CouponApprovalStatusList'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuotaListExportPaged'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInviteStatus'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCouponTemplateDetail'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetShutdownPolicyRecord'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubscriptionBill'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUnassociatedCustomer'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountInfo'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWarningThreshold'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCoupondeductProductCode'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResendEmail'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDailyBill'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCouponUsage'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditEndUserStatus'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreditInfo'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSubscriptionBill'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelCoupon'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InviteSubAccount'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCreditLine'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurchaseControlRecord'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrders'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCouponTemplate'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditZeroCreditShutdown'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CustomerQuotaRecordList'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomer'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonthlyBill'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IssueCouponForCustomer'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Agency',
+ 'productName' => 'Alibaba Cloud Channel Partner',
+ 'ramCodes' => ['agency'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeductOutstandingBalance',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:DeductOutstandingBalance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCouponUsage',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListCouponUsage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EditEndUserStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditEndUserStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCouponTemplate',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:CreateCouponTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetShutdownPolicyRecord',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetShutdownPolicyRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPurchaseControlRecord',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:GetPurchaseControlRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InviteSubReseller',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:InviteSubReseller',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetWarningThreshold',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetWarningThreshold',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetCreditLine',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetCreditLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CustomerQuotaRecordList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:CustomerQuotaRecordList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCoupondeductProductCode',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCoupondeductProductCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListExportTasks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListExportTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubscriptionBill',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:SubscriptionBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetMonthlyBill',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetMonthlyBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCreditInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCreditInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InviteSubAccount',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:InviteSubAccount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetAccountInfo',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:SetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateCustomer',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'agency:CreateCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCouponTemplateDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCouponTemplateDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CouponApprovalStatusList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:CouponApprovalStatusList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryReversedDeductionHistory',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:QueryReversedDeductionHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelSubscriptionBill',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:CancelSubscriptionBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomerOrders',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCustomerOrders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EditZeroCreditShutdown',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditZeroCreditShutdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCommissionableProducts',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCommissionableProducts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInviteStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetInviteStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDailyBill',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetDailyBill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelCoupon',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:CancelCoupon',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAccountInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResendEmail',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:ResendEmail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCouponTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:DeleteCouponTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportReversedDeductionHistory',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ExportReversedDeductionHistory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportCustomerQuotaRecord',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ExportCustomerQuotaRecord',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EditNewBuyStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'agency:EditNewBuyStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QuotaListExportPaged',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:QuotaListExportPaged',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetUnassociatedCustomer',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetUnassociatedCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCountries',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:ListCountries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'IssueCouponForCustomer',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:IssueCouponForCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
diff --git a/data/en_us/agency/2025-02-27/api-docs.php b/data/en_us/agency/2025-02-27/api-docs.php
index 920de17..9cc37ab 100644
--- a/data/en_us/agency/2025-02-27/api-docs.php
+++ b/data/en_us/agency/2025-02-27/api-docs.php
@@ -1,32 +1,15 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Agency',
- 'version' => '2025-02-27',
- ],
- 'directories' => [
- 'GetBillDetailFileList',
- 'GetSubPartnerOrderList',
- 'GetSubPartnerList',
- 'GetRenewalRateList',
- 'GetCustomerOrderList',
- 'GetCommissionDetailFileList',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Agency', 'version' => '2025-02-27'],
+ 'directories' => ['GetBillDetailFileList', 'GetCommissionDetailFileList', 'GetCustomerOrderList', 'GetIntlCommissionDetailFileList', 'GetRenewalRateList', 'GetSubPartnerList', 'GetSubPartnerOrderList'],
'components' => [
'schemas' => [],
],
'apis' => [
'GetBillDetailFileList' => [
- 'summary' => '查询账单导出文件',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -34,169 +17,120 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BillMonth',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '202502',
- 'pattern' => '^\\d+$',
- ],
+ 'schema' => ['description' => 'The billing month.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d+$', 'example' => '202502', 'title' => ''],
],
[
'name' => 'OssAccessKeyId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''],
],
[
'name' => 'OssAccessKeySecret',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''],
],
[
'name' => 'OssSecurityToken',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken', 'title' => ''],
],
[
'name' => 'OssBucketName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName', 'title' => ''],
],
[
'name' => 'OssEndpoint',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The endpoint of the region where the OSS bucket for file sharing is located.', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com', 'title' => ''],
],
[
'name' => 'OssRegion',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The region where the OSS bucket is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '210bc4b416874189683843905d9f9a',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210bc4b416874189683843905d9f9a'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'BillMonth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '202502',
- ],
- 'FileName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'FileUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1',
- ],
- 'Status' => [
- 'type' => 'string',
- ],
+ 'BillMonth' => ['description' => 'The billing month.', 'type' => 'string', 'example' => '202502', 'title' => ''],
+ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '账单202502021112', 'title' => ''],
+ 'Type' => ['description' => 'The type. Valid values: customer acquisition or channel expansion.', 'type' => 'string', 'example' => '拓渠', 'title' => ''],
+ 'FileUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1', 'title' => ''],
+ 'Status' => ['description' => 'The OSS file push status. Valid values:'."\n"
+ .'- 1: pending'."\n"
+ .'- 2: processing'."\n"
+ .'- 3: completed.', 'type' => 'string', 'example' => '3', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Msg' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Msg' => ['description' => 'Same as Message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query exported bill files',
+ 'summary' => 'Queries exported bill files.',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-04-17T02:40:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBillDetailFileList'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetBillDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileName\\": \\"账单202502021112\\",\\n \\"Type\\": \\"拓渠\\",\\n \\"FileUrl\\": \\"aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"Status\\": \\"3\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Msg\\": \\"成功\\"\\n}","type":"json"}]',
],
- 'GetSubPartnerOrderList' => [
- 'summary' => '查询拓渠订单',
+ 'GetCommissionDetailFileList' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -204,391 +138,380 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SubPartnerUid',
+ 'name' => 'BillMonth',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123432311',
- ],
+ 'schema' => ['description' => 'The billing month.', 'type' => 'string', 'required' => false, 'example' => '202501', 'title' => ''],
],
[
- 'name' => 'SubPartnerName',
+ 'name' => 'OssAccessKeyId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssAccessKeySecret',
'in' => 'query',
+ 'schema' => ['description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssSecurityToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssEndpoint',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The endpoint of the region where the Object Storage Service (OSS) bucket corresponding to the file sharing resides.', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com', 'title' => ''],
+ ],
+ [
+ 'name' => 'OssRegion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region where the OSS bucket resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'code', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PartnerUid' => ['description' => 'The UID of the partner.', 'type' => 'string', 'example' => '1112332432', 'title' => ''],
+ 'BillMonth' => ['description' => 'The billing month.', 'type' => 'string', 'example' => '202502', 'title' => ''],
+ 'FileList' => [
+ 'description' => 'The file list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The file list object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CommissionPolicyName' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '参考【APS佣金查询下载功能】的政策名称', 'title' => ''],
+ 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'example' => '总代政策为拓渠、普通政策为拓客', 'title' => ''],
+ 'FileUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1', 'title' => ''],
+ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '佣金202502021112', 'title' => ''],
+ 'BucketSyncStatus' => ['description' => 'The push status of the OSS file. Valid values: Processing, Succeeded, or Failed.', 'type' => 'string', 'example' => '处理中', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query partner commission details',
+ 'summary' => 'Queries the commission details of a partner.',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommissionDetailFileList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCommissionDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetCustomerOrderList' => [
+ 'summary' => 'Queries partner customer acquisition orders.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '10'],
+ ],
+ [
+ 'name' => 'CustomerUid',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'required' => false],
+ ],
+ [
+ 'name' => 'CustomerAccount',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123', 'required' => false],
+ ],
+ [
+ 'name' => 'RamAccountForCustomerManager',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The employee who follows up with the customer.', 'type' => 'string', 'example' => '1234532', 'required' => false],
+ ],
[
'name' => 'ProjectId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '202501101023',
- ],
+ 'schema' => ['title' => '', 'description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502002231', 'required' => false],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '209335720330622',
- ],
+ 'schema' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '13595216', 'required' => false],
],
[
'name' => 'OrderTypeList',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of order types.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order type. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, OTHERS.',
'type' => 'string',
- 'required' => false,
'example' => 'BUY',
+ 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'],
+ 'required' => false,
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'OrderStatus',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid'."\n"
+ .'- 2: canceled'."\n"
+ .'- 3: paid.',
'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '3',
- 'minimum' => '1',
+ 'format' => 'int32',
'example' => '3',
+ 'enum' => ['1', '2', '3'],
+ 'required' => false,
],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The payment type. Valid values:'."\n"
+ .'- 1: non-delegated payment'."\n"
+ .'- 2: delegated payment.',
'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '2',
- 'minimum' => '1',
+ 'format' => 'int32',
'example' => '1',
+ 'enum' => ['1', '2'],
+ 'required' => false,
],
],
[
'name' => 'ProductCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'required' => false],
],
[
'name' => 'ProductName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '弹性计算', 'required' => false],
],
[
'name' => 'OrderCreateAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1727789348000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727789348000', 'required' => false],
],
[
'name' => 'OrderCreateBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1741008566000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741008566000', 'required' => false],
],
[
'name' => 'OrderPayAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1727789348000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727789348000', 'required' => false],
],
[
'name' => 'OrderPayBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1741008566000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741008566000', 'required' => false],
],
[
'name' => 'PayAmountAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The minimum actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'required' => false],
],
[
'name' => 'PayAmountBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'PageNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '500',
- 'minimum' => '10',
- 'example' => '20',
- ],
+ 'schema' => ['title' => '', 'description' => 'The maximum actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '1000', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => 'MaxResults本次请求所返回的最大记录条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The returned object.',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '236414227150922',
- ],
+ 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922'],
'OrderType' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order type. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, OTHERS.',
'type' => 'string',
'example' => 'BUY',
+ 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'],
],
'OrderStatus' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid'."\n"
+ .'- 2: paid'."\n"
+ .'- 3: canceled.',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
+ 'enum' => ['1', '2', '3'],
],
'PayType' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The payment type. Valid values:'."\n"
+ .'- 1: non-delegated payment'."\n"
+ .'- 2: delegated payment.',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
- ],
- 'Price' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3750',
- ],
- 'DiscountedPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3750',
- ],
- 'AmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '3750',
- ],
- 'DeductedAmountByCoupons' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
- 'AmountDiscount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreatedAt' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-07-07 07:52:22',
- ],
- 'PaidAt' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2024-07-07 07:52:22',
- ],
- 'SubPartnerUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1123132',
- ],
- 'SubPartnerName' => [
- 'description' => '',
- 'type' => 'string',
+ 'enum' => ['1', '2'],
+ ],
+ 'Price' => ['title' => '', 'description' => 'The original price or list price.', 'type' => 'number', 'format' => 'double', 'example' => '29137'],
+ 'DiscountedPrice' => ['title' => '', 'description' => 'The discounted price.', 'type' => 'number', 'format' => 'double', 'example' => '29137'],
+ 'AmountDue' => ['title' => '', 'description' => 'The actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '29137'],
+ 'DeductedAmountByCoupons' => ['title' => '', 'description' => 'The coupon amount.', 'type' => 'number', 'format' => 'double', 'example' => '0'],
+ 'AmountDiscount' => ['title' => '', 'description' => 'The order discount.', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'slb'],
+ 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => 'slb'],
+ 'CreatedAt' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2019-01-24 14:20:40'],
+ 'PaidAt' => ['title' => '', 'description' => 'The payment time.', 'type' => 'string', 'example' => '2019-01-24 14:20:40'],
+ 'CustomerUid' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'CustomerAccount' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123'],
+ 'RamAccountForCustomerManagers' => [
+ 'description' => 'The employee who follows up with the customer.',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => 'The employee who follows up with the customer.', 'type' => 'string', 'example' => '12345678'],
+ 'title' => '',
'example' => '',
],
- 'ProjectId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202502233443',
- ],
- 'CustomerClassification' => [
- 'type' => 'string',
- ],
+ 'CustomerClassification' => ['title' => '', 'description' => 'The customer classification.', 'type' => 'string', 'example' => 'C类'],
+ 'ProjectId' => ['title' => '', 'description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502230421'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['title' => '', 'description' => 'The message.', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query partner customer acquisition orders',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrderList'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCustomerOrderList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetSubPartnerList' => [
- 'summary' => '查询二级分销商列表',
+ 'GetIntlCommissionDetailFileList' => [
+ 'summary' => 'Downloads the commission details of an international partner.',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -596,188 +519,126 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SubPartnerPid',
+ 'name' => 'BillMonth',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2323431211',
- ],
+ 'schema' => ['title' => '', 'description' => 'The bill month.', 'type' => 'string', 'required' => true, 'example' => '202502'],
],
[
- 'name' => 'SubPartnerCompanyName',
+ 'name' => 'OssAccessKeyId',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['title' => '', 'description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourAccessKeyID'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'OssAccessKeySecret',
'in' => 'query',
- 'schema' => [
- 'title' => '分页索引，从第一页开始',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourAccessKeySecret'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'OssSecurityToken',
'in' => 'query',
- 'schema' => [
- 'title' => '每页返回个数，最大支持100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourSecurityToken'],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'yourBucketName'],
+ ],
+ [
+ 'name' => 'OssEndpoint',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The endpoint of the region where the Object Storage Service (OSS) bucket for file sharing resides.', 'type' => 'string', 'required' => true, 'example' => 'http://oss-cn-beijing.aliyuncs.com'],
+ ],
+ [
+ 'name' => 'OssRegion',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The region where the current OSS bucket resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页返回的二级分销商个数，最大100',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100',
- ],
- 'SubPartnerList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CompanyName' => [
- 'title' => '二级分销商名称',
- 'type' => 'string',
- ],
- 'Pid' => [
- 'title' => '二级分销商pid',
- 'type' => 'string',
- ],
- 'MasterAccount' => [
- 'title' => '二级分销商主账号名称',
- 'type' => 'string',
- ],
- 'MasterUid' => [
- 'title' => '二级分销商主账号UID',
- 'type' => 'string',
- ],
- 'Province' => [
- 'title' => '注册地省份',
- 'type' => 'string',
- ],
- 'City' => [
- 'title' => '注册地城市',
- 'type' => 'string',
- ],
- 'District' => [
- 'title' => '注册地区县',
- 'type' => 'string',
- ],
- 'Address' => [
- 'title' => '注册地详细地址',
- 'type' => 'string',
- ],
- 'AgreementStatus' => [
- 'title' => '合约状态编码',
- 'type' => 'string',
- ],
- 'AgreementStatusDesc' => [
- 'title' => '合约状态描述',
- 'type' => 'string',
- ],
- 'JoinTime' => [
- 'title' => '首次入驻时间',
- 'type' => 'string',
- ],
- 'Contact' => [
- 'title' => '联系人名称',
- 'type' => 'string',
+ 'RequestId' => ['title' => '', 'description' => 'RequestId', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'],
+ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => 'The data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PartnerUid' => ['title' => '', 'description' => 'The UID of the partner.', 'type' => 'string', 'example' => '1112332432'],
+ 'BillMonth' => ['title' => '', 'description' => 'The bill month.', 'type' => 'string', 'example' => '202502'],
+ 'FileList' => [
+ 'title' => '',
+ 'description' => 'The file list object.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'The file list object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CommissionPolicyName' => ['title' => '', 'description' => 'The commission policy name.', 'type' => 'string', 'example' => '202606_FY27_TEST'],
+ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '202606_FY27_TEST_4397912340.xlsx'],
+ 'BucketSyncStatus' => [
+ 'title' => '',
+ 'description' => 'The OSS file push status. Valid values: init, processing, succeeded, or failed.',
+ 'enumValueTitles' => ['处理失败' => 'FAIL', '初始化状态' => 'INIT', '处理成功' => 'SUCCESS', '处理中' => 'PROCESSING'],
+ 'type' => 'string',
+ 'example' => 'PROCESSING',
+ ],
+ ],
+ 'example' => '',
],
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
'example' => '',
],
+ 'Message' => ['title' => '', 'description' => 'The message information.', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Download international partner commission bill',
+ 'description' => 'Ensure that the current caller identity is a T1 distribution partner. '."\n"
+ .'<notice>Available only for international site.</notice>.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:GetIntlCommissionDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"202606_FY27_TEST\\",\\n \\"FileName\\": \\"202606_FY27_TEST_4397912340.xlsx\\",\\n \\"BucketSyncStatus\\": \\"PROCESSING\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetRenewalRateList' => [
- 'summary' => '查询伙伴续费率',
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -785,245 +646,104 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'FiscalYearAndQuarter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025Q4',
- ],
+ 'schema' => ['description' => 'The fiscal year and quarter.', 'type' => 'string', 'required' => true, 'example' => '2025Q4', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
- 'FiscalYearAndQuarter' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2025Q4',
- ],
- 'MasterPid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'P123423453',
- ],
- 'MasterPidName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'FinalRenewalRate' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
- 'FinalRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalOtherBillAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalCustomerRenewalRate' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
- 'FinalCustomerRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalCustomerRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'CustomerAdjustedRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'CustomerOtherBillAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalSubPartnerRenewalRate' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.85',
- ],
- 'FinalSubPartnerRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'FinalSubPartnerRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SubPartnerAdjustedRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SubPartnerOtherBillAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialFinalRenewRatio' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.7',
- ],
- 'SpecialFinalRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialFinalRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialCustomerRenewRatio' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.7',
- ],
- 'SpecialCustomerRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialCustomerRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialSubPartnerRenewRatio' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.8',
- ],
- 'SpecialSubPartnerRenewalAmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'SpecialSubPartnerRenewedAmount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
+ 'FiscalYearAndQuarter' => ['description' => 'The fiscal year and quarter.', 'type' => 'string', 'example' => '2025Q4', 'title' => ''],
+ 'MasterPid' => ['description' => 'The partner PID.', 'type' => 'string', 'example' => 'P123423453', 'title' => ''],
+ 'MasterPidName' => ['description' => 'The partner PID name.', 'type' => 'string', 'example' => 'XX有限公司', 'title' => ''],
+ 'FinalRenewalRate' => ['description' => 'The final commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''],
+ 'FinalRenewalAmountDue' => ['description' => 'The final amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalRenewedAmount' => ['description' => 'The final renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalOtherBillAmount' => ['description' => 'The total amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalCustomerRenewalRate' => ['description' => 'The customer acquisition commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''],
+ 'FinalCustomerRenewalAmountDue' => ['description' => 'The customer acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalCustomerRenewedAmount' => ['description' => 'The customer acquisition renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'CustomerAdjustedRenewalAmountDue' => ['description' => 'The adjusted customer acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'CustomerOtherBillAmount' => ['description' => 'The customer acquisition amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalSubPartnerRenewalRate' => ['description' => 'The sub-partner acquisition commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.85', 'title' => ''],
+ 'FinalSubPartnerRenewalAmountDue' => ['description' => 'The sub-partner acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'FinalSubPartnerRenewedAmount' => ['description' => 'The sub-partner acquisition renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SubPartnerAdjustedRenewalAmountDue' => ['description' => 'The adjusted sub-partner acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SubPartnerOtherBillAmount' => ['description' => 'The sub-partner acquisition amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialFinalRenewRatio' => ['description' => 'The final quarterly commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.7', 'title' => ''],
+ 'SpecialFinalRenewalAmountDue' => ['description' => 'The final quarterly commission amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialFinalRenewedAmount' => ['description' => 'The final quarterly commission renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialCustomerRenewRatio' => ['description' => 'The customer acquisition commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.7', 'title' => ''],
+ 'SpecialCustomerRenewalAmountDue' => ['description' => 'The customer acquisition amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialCustomerRenewedAmount' => ['description' => 'The customer acquisition renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialSubPartnerRenewRatio' => ['description' => 'The sub-partner acquisition commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.8', 'title' => ''],
+ 'SpecialSubPartnerRenewalAmountDue' => ['description' => 'The sub-partner acquisition amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'SpecialSubPartnerRenewedAmount' => ['description' => 'The sub-partner acquisition renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query partner renewal rate',
+ 'summary' => 'Queries the partner renewal rate.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenewalRateList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetRenewalRateList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"FiscalYearAndQuarter\\": \\"2025Q4\\",\\n \\"MasterPid\\": \\"P123423453\\",\\n \\"MasterPidName\\": \\"XX有限公司\\",\\n \\"FinalRenewalRate\\": 0.9,\\n \\"FinalRenewalAmountDue\\": 100,\\n \\"FinalRenewedAmount\\": 100,\\n \\"FinalOtherBillAmount\\": 100,\\n \\"FinalCustomerRenewalRate\\": 0.9,\\n \\"FinalCustomerRenewalAmountDue\\": 100,\\n \\"FinalCustomerRenewedAmount\\": 100,\\n \\"CustomerAdjustedRenewalAmountDue\\": 100,\\n \\"CustomerOtherBillAmount\\": 100,\\n \\"FinalSubPartnerRenewalRate\\": 0.85,\\n \\"FinalSubPartnerRenewalAmountDue\\": 100,\\n \\"FinalSubPartnerRenewedAmount\\": 100,\\n \\"SubPartnerAdjustedRenewalAmountDue\\": 100,\\n \\"SubPartnerOtherBillAmount\\": 100,\\n \\"SpecialFinalRenewRatio\\": 0.7,\\n \\"SpecialFinalRenewalAmountDue\\": 100,\\n \\"SpecialFinalRenewedAmount\\": 100,\\n \\"SpecialCustomerRenewRatio\\": 0.7,\\n \\"SpecialCustomerRenewalAmountDue\\": 100,\\n \\"SpecialCustomerRenewedAmount\\": 100,\\n \\"SpecialSubPartnerRenewRatio\\": 0.8,\\n \\"SpecialSubPartnerRenewalAmountDue\\": 100,\\n \\"SpecialSubPartnerRenewedAmount\\": 100\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetCustomerOrderList' => [
- 'summary' => '查询伙伴拓客订单',
+ 'GetSubPartnerList' => [
'path' => '',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1031,627 +751,508 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
+ 'name' => 'SubPartnerPid',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The PID of the secondary partner.', 'type' => 'string', 'example' => '2323431211', 'required' => false, 'title' => ''],
+ ],
+ [
+ 'name' => 'SubPartnerCompanyName',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => 'The company name of the secondary partner.', 'type' => 'string', 'example' => 'xxx有限公司', 'required' => false, 'title' => ''],
+ ],
+ [
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '500',
- 'minimum' => '10',
- 'example' => '10',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Total' => ['title' => '', 'description' => 'The total number of entries that match the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'string', 'example' => '1'],
+ 'PageSize' => ['title' => '', 'description' => 'The number of secondary distributors returned per page. Maximum value: 100.', 'type' => 'string', 'required' => true, 'example' => '100'],
+ 'SubPartnerList' => [
+ 'description' => 'The list of secondary distributors.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CompanyName' => ['title' => '', 'description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'xxx有限公司'],
+ 'Pid' => ['title' => '', 'description' => 'The PID of the secondary distributor.', 'type' => 'string', 'example' => 'P123456'],
+ 'MasterAccount' => ['title' => '', 'description' => 'The name of the primary account of the secondary distributor.', 'type' => 'string', 'example' => 'xxxxxx有限公司主账号'."\n"],
+ 'MasterUid' => ['title' => '', 'description' => 'The UID of the primary account of the secondary distributor.', 'type' => 'string', 'example' => '123456'],
+ 'Province' => ['title' => '', 'description' => 'The province of the registered address.', 'type' => 'string', 'example' => '浙江省'],
+ 'City' => ['title' => '', 'description' => 'The city of the registered address.', 'type' => 'string', 'example' => '杭州市'],
+ 'District' => ['title' => '', 'description' => 'The district or county of the registered address.', 'type' => 'string', 'example' => '西湖区'],
+ 'Address' => ['title' => '', 'description' => 'The detailed registered address.', 'type' => 'string', 'example' => 'xxx街道xxx号'],
+ 'AgreementStatus' => [
+ 'title' => '',
+ 'description' => 'The agreement status code.',
+ 'enumValueTitles' => ['RESTRICTED_OPENING' => 'restricted opening period.', 'CALM_DOWN_PERIOD' => 'cooling-off period.', 'ACTIVE_PERIOD' => 'active period.'],
+ 'type' => 'string',
+ 'example' => 'ACTIVE_PERIOD',
+ ],
+ 'AgreementStatusDesc' => ['title' => '', 'description' => 'The description of the agreement status.', 'type' => 'string', 'example' => '生效期'],
+ 'JoinTime' => ['title' => '', 'description' => 'The time when the secondary distributor first joined.', 'type' => 'string', 'example' => '2000-01-01'],
+ 'Contact' => ['title' => '', 'description' => 'The name of the contact.', 'type' => 'string', 'example' => '张三'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query secondary distributors',
+ 'summary' => 'Queries the list of secondary distributors.',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-27T08:12:31.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerList'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'CustomerUid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetSubPartnerList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]',
+ ],
+ 'GetSubPartnerOrderList' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CustomerAccount',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'SubPartnerUid',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_123',
- ],
+ 'schema' => ['description' => 'The UID of the secondary partner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123432311', 'title' => ''],
],
[
- 'name' => 'RamAccountForCustomerManager',
+ 'name' => 'SubPartnerName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1234532',
- ],
+ 'schema' => ['description' => 'The name of the secondary partner.', 'type' => 'string', 'required' => false, 'example' => 'XXX有限公司', 'title' => ''],
],
[
'name' => 'ProjectId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '202502002231',
- ],
+ 'schema' => ['description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '202501101023', 'title' => ''],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13595216',
- ],
+ 'schema' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '209335720330622', 'title' => ''],
],
[
'name' => 'OrderTypeList',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of order types.'."\n"
+ .'Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, and OTHERS.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BUY',
- 'enum' => [
- 'BUY',
- 'UPGRADE',
- 'DOWNGRADE',
- 'RENEW',
- 'REFUND',
- 'OTHERS',
- ],
- ],
+ 'items' => ['description' => 'The list of order types. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, and OTHERS.', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'OrderStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- 'enum' => [
- '1',
- '2',
- '3',
- ],
- ],
+ 'schema' => ['description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid'."\n"
+ .'- 2: paid'."\n"
+ .'- 3: voided.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '3', 'minimum' => '1', 'required' => false, 'example' => '3', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
- ],
+ 'schema' => ['description' => 'The payment type. Valid values:'."\n"
+ .'- 1: non-delegated payment'."\n"
+ .'- 2: delegated payment.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '2', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ProductCode',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''],
],
[
'name' => 'ProductName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The product name.', 'type' => 'string', 'required' => false, 'example' => '弹性计算', 'title' => ''],
],
[
'name' => 'OrderCreateAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1727789348000',
- ],
+ 'schema' => ['description' => 'The start timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => ''],
],
[
'name' => 'OrderCreateBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1741008566000',
- ],
+ 'schema' => ['description' => 'The end timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => ''],
],
[
'name' => 'OrderPayAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1727789348000',
- ],
+ 'schema' => ['description' => 'The start timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => ''],
],
[
'name' => 'OrderPayBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1741008566000',
- ],
+ 'schema' => ['description' => 'The end timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => ''],
],
[
'name' => 'PayAmountAfter',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The minimum actual payment amount.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PayAmountBefore',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'schema' => ['description' => 'The maximum actual payment amount.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Total' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Total' => ['title' => '', 'description' => 'The total number of entries that meet the query conditions. This is an optional parameter and is not returned by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
+ 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '236414227150922',
- ],
- 'OrderType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'BUY',
- 'enum' => [
- 'BUY',
- 'UPGRADE',
- 'DOWNGRADE',
- 'RENEW',
- 'REFUND',
- 'OTHERS',
- ],
- ],
- 'OrderStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- 'enum' => [
- '1',
- '2',
- '3',
- ],
- ],
- 'PayType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
- ],
- 'Price' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '29137',
- ],
- 'DiscountedPrice' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '29137',
- ],
- 'AmountDue' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '29137',
- ],
- 'DeductedAmountByCoupons' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
- 'AmountDiscount' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'ProductCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'slb',
- ],
- 'ProductName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'slb',
- ],
- 'CreatedAt' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-01-24 14:20:40',
- ],
- 'PaidAt' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-01-24 14:20:40',
- ],
- 'CustomerUid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'CustomerAccount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test_123',
- ],
- 'RamAccountForCustomerManagers' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12345678',
- ],
- ],
- 'CustomerClassification' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ProjectId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202502230421',
- ],
+ 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922', 'title' => ''],
+ 'OrderType' => ['description' => 'The order type. Valid values:'."\n"
+ .'- BUY: new purchase'."\n"
+ .'- UPGRADE: upgrade'."\n"
+ .'- DOWNGRADE: downgrade'."\n"
+ .'- RENEW: renewal'."\n"
+ .'- REFUND: refund'."\n"
+ .'- OTHERS: other.', 'type' => 'string', 'example' => 'BUY', 'title' => ''],
+ 'OrderStatus' => ['description' => 'The order status. Valid values:'."\n"
+ .'- 1: unpaid'."\n"
+ .'- 2: deprecated'."\n"
+ .'- 3: paid.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'PayType' => ['description' => 'The payment type. Valid values:'."\n"
+ .'- 1: non-delegated payment'."\n"
+ .'- 2: delegated payment.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Price' => ['description' => 'The original price or list price.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''],
+ 'DiscountedPrice' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''],
+ 'AmountDue' => ['description' => 'The actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''],
+ 'DeductedAmountByCoupons' => ['description' => 'The coupon amount.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''],
+ 'AmountDiscount' => ['description' => 'The order discount.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''],
+ 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '弹性计算', 'title' => ''],
+ 'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-07-07 07:52:22', 'title' => ''],
+ 'PaidAt' => ['description' => 'The payment time.', 'type' => 'string', 'example' => '2024-07-07 07:52:22', 'title' => ''],
+ 'SubPartnerUid' => ['description' => 'The UID of the secondary partner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1123132', 'title' => ''],
+ 'SubPartnerName' => ['description' => 'The name of the secondary partner.', 'type' => 'string', 'example' => 'xxx有限公司', 'title' => ''],
+ 'ProjectId' => ['description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502233443', 'title' => ''],
+ 'CustomerClassification' => ['description' => 'The customer classification.', 'type' => 'string', 'example' => 'C类', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'AccessDeniedDetail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2103a30617045934095083027d88c5',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
- ],
+ ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'],
+ ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- ],
- 'GetCommissionDetailFileList' => [
- 'summary' => '查询伙伴佣金明细',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query channel expansion orders',
+ 'summary' => 'Queries channel expansion orders.',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T12:18:35.000Z', 'description' => 'Response parameters changed'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerOrderList'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'BillMonth',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '202501',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'OssAccessKeyId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetSubPartnerOrderList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- [
- 'name' => 'OssAccessKeySecret',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.ap-southeast-1.aliyuncs.com', 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.aliyuncs.com', 'endpoint' => 'agency.aliyuncs.com', 'vpc' => 'agency-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Error1109', 'message' => 'system error.', 'http_code' => 400, 'description' => 'System exception'],
+ ['code' => 'Error3008', 'message' => 'shutdown status is error.', 'http_code' => 400, 'description' => 'shutdown status is error.'],
+ ['code' => 'Error3009', 'message' => 'customerAccount is error.', 'http_code' => 400, 'description' => 'customerAccount is error.'],
+ ['code' => 'Error3010', 'message' => 'customerNick is empty.', 'http_code' => 400, 'description' => 'customerNick is empty.'],
+ ['code' => 'Error3011', 'message' => 'The length of customerNick greater than 50.', 'http_code' => 400, 'description' => 'The length of customerNick greater than 50. '],
+ ['code' => 'Error3012', 'message' => 'cid is empty.', 'http_code' => 400, 'description' => 'cid is empty.'],
+ ['code' => 'Error3013', 'message' => 'customCredit is empty.', 'http_code' => 400, 'description' => 'customCredit is empty.'],
+ ['code' => 'Error3014', 'message' => 'customCredit is a maximum of 10.', 'http_code' => 400, 'description' => 'customCredit is a maximum of 10.'],
+ ['code' => 'Error3015', 'message' => 'The current account is not a partner.', 'http_code' => 400, 'description' => 'The current account is not a distributor'],
+ ['code' => 'Error3016', 'message' => 'customerRebateType is error, only invite agency account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite agency account.'],
+ ['code' => 'Error3017', 'message' => 'customerRebateType is error, only invite reseller account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite reseller account.'],
+ ['code' => 'Error3030', 'message' => 'The maximum length of CustomNick is 150.', 'http_code' => 400, 'description' => 'Maximum CustomNick length is 150'],
+ ['code' => 'Error3031', 'message' => 'The maximum length of FxDescription is 3000.', 'http_code' => 400, 'description' => 'Maximum FxDescription length is 3000'],
+ ['code' => 'Error3040', 'message' => 'The account is in a frozen state and cannot be operated.', 'http_code' => 400, 'description' => 'The account is in a frozen state and cannot be operated.'],
+ ['code' => 'Error3043', 'message' => 'The range of ShutdownStatus can only be 1 and 2.', 'http_code' => 400, 'description' => 'The range of ShutdownStatus can only be 1 and 2'],
+ ['code' => 'Error3044', 'message' => 'The Value is not a number.', 'http_code' => 400, 'description' => 'Value is not a number'],
+ ['code' => 'Error3045', 'message' => 'The value must be between 1-100.', 'http_code' => 400, 'description' => 'Value must be between 1-100'],
+ ['code' => 'Error3051', 'message' => 'input accounStatus value error, It must be 1,2,3.', 'http_code' => 400, 'description' => 'Wrong value for input AccounStatus, must be 1,2 or 3'],
+ ['code' => 'Error3052', 'message' => 'Your account is currently frozen and cannot be unfrozen for the following customer operations.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Error3055', 'message' => 'subAccountType is null.', 'http_code' => 400, 'description' => 'subAccountType is empty'],
+ ['code' => 'Error3056', 'message' => 'The value of subAccountType error.', 'http_code' => 400, 'description' => 'The value of subAccountType error'],
+ ['code' => 'Error3058', 'message' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'http_code' => 400, 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'],
+ ['code' => 'Error3067', 'message' => 'Enterprise Customer Invitation Prohibition.', 'http_code' => 400, 'description' => 'Enterprise Customer Invitation Prohibition.'],
+ ['code' => 'ERROR_1002', 'message' => 'No query permission.', 'http_code' => 400, 'description' => 'No query permission'],
+ ['code' => 'ERROR_1003', 'message' => 'No permission to operate the object.', 'http_code' => 400, 'description' => 'No permission to operate the object.'],
+ ['code' => 'ERROR_201', 'message' => 'Parameters are illegal and required fields are empty.', 'http_code' => 400, 'description' => 'Parameters are illegal and required fields are empty.'],
+ ['code' => 'ERROR_2307', 'message' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'http_code' => 400, 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'],
+ ['code' => 'ERROR_2310', 'message' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'http_code' => 400, 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'],
+ ['code' => 'ERROR_2311', 'message' => 'Coupon template does not exist.', 'http_code' => 400, 'description' => 'Coupon template does not exist'],
+ ['code' => 'ERROR_3070', 'message' => 'CouponTemplateName must be entered.', 'http_code' => 400, 'description' => 'TemplateName name must be entered'],
+ ['code' => 'ERROR_3071', 'message' => 'ApplicableProducts empty, please check.', 'http_code' => 400, 'description' => 'ApplicableProducts empty, please check.'],
+ ['code' => 'ERROR_3072', 'message' => 'itemCodes empty, please check.', 'http_code' => 400, 'description' => 'ProductType is empty, please check'],
+ ['code' => 'ERROR_3073', 'message' => 'amout empty, please check.', 'http_code' => 400, 'description' => 'Value empty, please check.'],
+ ['code' => 'ERROR_3074', 'message' => 'personLimit empty, please check.', 'http_code' => 400, 'description' => 'LimitPerPerson empty, please check.'],
+ ['code' => 'ERROR_3075', 'message' => 'applyReason empty, please check.', 'http_code' => 400, 'description' => 'ReasonForApplication empty, please check.'],
+ ['code' => 'ERROR_3076', 'message' => 'effDateType empty, please check.', 'http_code' => 400, 'description' => 'effDateType empty, please check.'],
+ ['code' => 'ERROR_3077', 'message' => 'effDateDay empty, please check.', 'http_code' => 400, 'description' => 'Vaildperioddays empty, please check.'],
+ ['code' => 'ERROR_3078', 'message' => 'effDateFrom empty, please check.', 'http_code' => 400, 'description' => 'Vailddate empty, please check.'],
+ ['code' => 'ERROR_3079', 'message' => 'effDateTo empty, please check.', 'http_code' => 400, 'description' => 'Expireddate empty, please check .'],
+ ['code' => 'ERROR_3080', 'message' => 'Account empty, please check.', 'http_code' => 400, 'description' => 'Account is empty, please check'],
+ ['code' => 'ERROR_3081', 'message' => 'couponTemplateId empty, please check.', 'http_code' => 400, 'description' => 'couponTemplateId empty, please check.'],
+ ['code' => 'ERROR_3082', 'message' => 'Uidlist empty, please check .', 'http_code' => 400, 'description' => 'Uidlist is empty, please check'],
+ ['code' => 'ERROR_3084', 'message' => 'Coupon cannot be valid for more than 180 days.', 'http_code' => 400, 'description' => 'Coupon cannot be valid for more than 180 days'],
+ ['code' => 'ERROR_3085', 'message' => 'Product code is not in international channel partner coupons deductable product list.', 'http_code' => 400, 'description' => 'Product code is not in international channel partner coupons deductable product list.'],
+ ['code' => 'ERROR_3087', 'message' => 'The current uid is not the end user identity, can not issue coupons.', 'http_code' => 400, 'description' => 'The current uid is not the end user identity, can not issue coupons.'],
+ ['code' => 'ERROR_3088', 'message' => 'Coupon template expired, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template expired, unable to issue coupon'],
+ ['code' => 'ERROR_3089', 'message' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'],
+ ['code' => 'ERROR_3090', 'message' => 'You have no authority.', 'http_code' => 400, 'description' => 'You have no authority'],
+ ['code' => 'ERROR_3091', 'message' => 'Coupon template name length over limit.', 'http_code' => 400, 'description' => 'Coupon template name length over limit（30 characters）.'],
+ ['code' => 'ERROR_3092', 'message' => 'Reason for template request length over limit.', 'http_code' => 400, 'description' => 'Reason for template request length over limit（100 characters）'],
+ ['code' => 'ERROR_3093', 'message' => 'Coupon cost-bearer parameters are not legal.', 'http_code' => 400, 'description' => 'Coupon cost-bearer parameters are not legal'],
+ ['code' => 'ERROR_3094', 'message' => 'Applicable product type parameters are not legal.', 'http_code' => 400, 'description' => 'Applicable product type parameters are not legal'],
+ ['code' => 'ERROR_3095', 'message' => 'The per-person limit is illegal.', 'http_code' => 400, 'description' => 'The per-person limit is illegal.'],
+ ['code' => 'ERROR_3096', 'message' => 'Coupon value is illegal.', 'http_code' => 400, 'description' => 'Coupon value is illegal.'],
+ ['code' => 'ERROR_3097', 'message' => 'Time type is illegal.', 'http_code' => 400, 'description' => 'Time type is illegal.'],
+ ['code' => 'ERROR_3098', 'message' => 'Coupon Remarks Information length over limit.', 'http_code' => 400, 'description' => 'Coupon Remarks Information length over limit（100 characters).'],
+ ['code' => 'ERROR_3099', 'message' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'],
+ ['code' => 'ERROR_3100', 'message' => 'System exceptions, please submit a work order.', 'http_code' => 400, 'description' => 'System exceptions, please submit a work order.'],
+ ['code' => 'ERROR_3101', 'message' => 'PurchaseType empty, please check .', 'http_code' => 400, 'description' => 'PurchaseType empty, please check .'],
+ ['code' => 'ERROR_3102', 'message' => 'This coupon template ID was not created by this account.', 'http_code' => 400, 'description' => 'This coupon template ID was not created by this account.'],
+ ['code' => 'ERROR_3103', 'message' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"],
+ ['code' => 'ERROR_3210', 'message' => 'The current calling UID is not an international channel partner.', 'http_code' => 400, 'description' => 'The current calling UID is not an international channel partner'],
+ ['code' => 'InvalidParam.InviteId.InvalidId', 'message' => 'No invitation record found based on inviteId.', 'http_code' => 400, 'description' => 'No invitation record found based on request ID'],
+ ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'This uid is not your EU.', 'http_code' => 400, 'description' => 'This user is not your distribution customer'],
+ ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'The current customer does not belong to this partner.', 'http_code' => 400, 'description' => 'Current customer does not belong to this partner'],
+ ['code' => 'InvalidParam.Uid.QuotaListEndDateNullError', 'message' => 'No End Time.', 'http_code' => 400, 'description' => 'End time is empty'],
+ ['code' => 'InvalidParam.Uid.QuotaListStartDateNullError', 'message' => 'No Start Time.', 'http_code' => 400, 'description' => 'The start time is empty.'],
+ ['code' => 'InvalidRequest.ExportTask.SceneCodeError', 'message' => 'The exporting scenario is incorrect.', 'http_code' => 400, 'description' => 'Export Scene Error'],
+ ['code' => 'InvalidRequest.ExportTask.SceneCodeNull', 'message' => 'The exporting scenario is empty.', 'http_code' => 400, 'description' => 'The exported scene is empty.'],
+ ['code' => 'InvalidRequest.NoPermissions', 'message' => 'No permissions for the operation.', 'http_code' => 400, 'description' => 'You do not have permission to perform this operation.'],
+ ['code' => 'InvalidRequest.NoPermissions.NotPartner', 'message' => 'The current caller is not a partner.', 'http_code' => 400, 'description' => 'The current caller is not an eco-partner'],
+ ['code' => 'InvalidRequest.NoPermissions.RamNoPermission', 'message' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'http_code' => 400, 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommissionDetailFileList'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenewalRateList'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerOrderList'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerList'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBillDetailFileList'],
+ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrderList'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Agency',
+ 'productName' => 'Alibaba Cloud Channel Partner',
+ 'ramCodes' => ['agency'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetIntlCommissionDetailFileList',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'agency:GetIntlCommissionDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'OssSecurityToken',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetCommissionDetailFileList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCommissionDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'OssBucketName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetSubPartnerOrderList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetSubPartnerOrderList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'OssEndpoint',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetRenewalRateList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetRenewalRateList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'OssRegion',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetBillDetailFileList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetBillDetailFileList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4',
- ],
- 'Code' => [
- 'description' => 'code',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'PartnerUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1112332432',
- ],
- 'BillMonth' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '202502',
- ],
- 'FileList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CommissionPolicyName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'FileType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'FileUrl' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1',
- ],
- 'FileName' => [
- 'type' => 'string',
- ],
- 'BucketSyncStatus' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'GetCustomerOrderList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetCustomerOrderList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner',
- 'errorMessage' => 'The current caller is not a partner.',
- ],
- [
- 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission',
- 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.',
+ [
+ 'apiName' => 'GetSubPartnerList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'agency:GetSubPartnerList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'agency.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:02:37 +0000