diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/agency/2022-12-16/api-docs.php | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/agency/2022-12-16/api-docs.php')
| -rw-r--r-- | data/en_us/agency/2022-12-16/api-docs.php | 6937 |
1 files changed, 6937 insertions, 0 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 new file mode 100644 index 0000000..78d4146 --- /dev/null +++ b/data/en_us/agency/2022-12-16/api-docs.php @@ -0,0 +1,6937 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Agency', + 'version' => '2022-12-16', + ], + 'directories' => [ + [ + 'id' => 380448, + 'title' => 'Customer Invitation', + 'type' => 'directory', + 'children' => [ + 'CreateCustomer', + 'GetInviteStatus', + 'GetUnassociatedCustomer', + 'InviteSubAccount', + 'ResendEmail', + 'ListCountries', + ], + ], + [ + 'id' => 380449, + 'title' => 'Customer Management', + 'type' => 'directory', + 'children' => [ + 'CustomerQuotaRecordList', + 'DeductOutstandingBalance', + 'EditEndUserStatus', + 'EditNewBuyStatus', + 'EditZeroCreditShutdown', + 'ExportCustomerQuotaRecord', + 'ExportReversedDeductionHistory', + 'GetAccountInfo', + 'GetCreditInfo', + 'GetPurchaseControlRecord', + 'GetShutdownPolicyRecord', + 'QueryReversedDeductionHistory', + 'SetAccountInfo', + 'SetCreditLine', + 'SetWarningThreshold', + ], + ], + [ + 'id' => 380450, + 'title' => 'Finance Center', + 'type' => 'directory', + 'children' => [ + 'CancelSubscriptionBill', + 'GetCommissionableProducts', + 'GetCustomerOrders', + 'GetDailyBill', + 'GetMonthlyBill', + 'SubscriptionBill', + ], + ], + [ + 'id' => 380451, + 'title' => 'Coupon Management', + 'type' => 'directory', + 'children' => [ + 'GetTier2CouponApprovalDetail', + 'ListTier2CouponApproval', + 'CancelCoupon', + 'CreateCouponTemplate', + 'CouponApprovalStatusList', + 'DeleteCouponTemplate', + 'GetCouponTemplateDetail', + 'GetCoupondeductProductCode', + 'IssueCouponForCustomer', + 'ListCouponUsage', + 'QuotaListExportPaged', + ], + ], + [ + 'id' => 380454, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'ProcessApproval', + 'ListExportTasks', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateCustomer' => [ + 'summary' => 'This function is designed for create a customer who is to be invited.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CustomerName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Customer\'s name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DoorBell Marketing', + ], + ], + [ + 'name' => 'CustomerTrade', + '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', + ], + ], + [ + 'name' => 'CustomerSubTrade', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sub-industry that Customer\'s business belongs to. Please enumerate with Customer Trade.', + 'type' => 'string', + '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', + ], + ], + [ + 'name' => 'Nation', + '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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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' => '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");', + ], + 'GetInviteStatus' => [ + 'summary' => 'Query invitation status of customer who have been created and invited.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InviteStatusList', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination, current page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination, record number on each page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Error Code, Candidate Value：'."\n" + .'* 200: OK'."\n" + .'* 1109: System error', + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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\\": \\"[email protected]\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountInfoList', + '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' => '[email protected]', + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + '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', + ], + '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.', + ], + 'ResendEmail' => [ + 'summary' => 'Resend invitation email.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InviteId', + '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', + 'required' => true, + 'example' => '176', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + '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', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页每页记录数，最大值100', + 'description' => 'Pagination, record number on each page. Maximum 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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Data' => [ + 'description' => 'Listed data of returning result', + 'type' => 'array', + 'items' => [ + 'description' => 'Returning 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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + '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', + ], + ], + [ + 'name' => 'DeductAmount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Deducted Credit to be offset.', + 'type' => 'string', + 'required' => true, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'This uid is not your EU.', + ], + ], + ], + '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' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'ShutdownPolicy', + 'in' => 'query', + 'schema' => [ + 'title' => 'shutdownPolicy', + 'description' => 'UID', + '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>', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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' => '210bc4b416874189683843905d9f9a', + ], + 'Msg' => [ + 'title' => '描述', + 'description' => 'Description', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'Code', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ExportUid', + '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-01-01', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '导出任务id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2131', + ], + 'Cost' => [ + 'title' => '预估耗时，单位分钟', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination, current page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + ], + ], + ], + 'AccountInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountInfo' => [ + 'description' => 'List of Account Information', + 'type' => 'array', + 'items' => [ + 'description' => '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' => '[email protected]'."\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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'Request id, a unique identifier generated by Alibaba Cloud for the request.', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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\\": \\"[email protected]\\\\n\\",\\n \\"Remark\\": \\"子账号\\",\\n \\"Mobile\\": \\"13641588680\\",\\n \\"AliyunId\\": \\"[email protected]\\",\\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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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' => '下单控制记录查询', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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' => '2025-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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '5', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'asda1231as', + ], + 'Message' => [ + 'title' => '返回结果描述', + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'SetCreditLine' => [ + 'summary' => 'Set Credit Line for Distribution Customers. This function is only available 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 Sub Account.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1263644979775567', + ], + ], + [ + 'name' => 'CreditLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'New Credit Line', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + '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', + ], + 'CancelSubscriptionBill' => [ + 'summary' => 'Cancels the subscription to multi-level bills as an Alibaba Cloud eco-partner.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeType', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + 'Data' => [ + 'description' => 'The data that is returned.'."\n", + 'example' => 'true', + 'type' => 'boolean', + ], + 'Code' => [ + 'description' => 'The HTTP status code that is returned.'."\n", + 'enumValueTitles' => [ + 1008 => '', + '', + ], + 'example' => '200', + 'title' => 'code', + 'type' => 'string', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'example' => 'true', + 'title' => 'success', + 'type' => 'boolean', + ], + ], + 'title' => 'result', + 'type' => 'object', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + '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"]', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '209335720330622', + ], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => [ + 'title' => '客户账号', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => [ + 'title' => '客户UID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'title' => '订单类型：BUY、REFUND、UPGRADE、DOWNGRADE、REFUND、OTHERS', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'RENEW', + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '订单状态：1 未支付；2 已废弃；3 已支付', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '3', + ], + ], + [ + 'name' => 'TimeType', + 'in' => 'query', + 'schema' => [ + 'title' => '时间类型：1 支付时间；2 下单时间', + 'description' => '', + '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}$', + ], + ], + [ + '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}$', + ], + ], + [ + 'name' => 'CustomerManager', + 'in' => 'query', + 'schema' => [ + 'title' => '客户经理', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'myBd', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => '产品明细code', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'vm_intl', + ], + ], + [ + 'name' => 'OrderSource', + 'in' => 'query', + 'schema' => [ + 'title' => '订单来源：0 普通客户；1 企业客户；2 二级经销商', + 'description' => '', + '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', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + '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' => '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', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'BillType', + 'in' => 'query', + 'schema' => [ + 'description' => 'BillType. Value Range:</br>'."\n" + ."\n" + .'- DailyOrder(Deprecated)'."\n" + .'- DailyBill (Deprecated)'."\n" + .'- DailyInstanceBill (Deprecated)'."\n" + .'- DailyInstanceBillV2', + 'type' => 'string', + 'required' => true, + 'example' => 'DailyInstanceBillV2', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + '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", + ], + ], + ], + 'RequestId' => [ + 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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' => 'GetDailyBill', + ], + 'GetMonthlyBill' => [ + 'summary' => 'Issue Distributor\'s Monthly Bill. This function is only available for Resellers and Distributors.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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", + ], + ], + ], + 'RequestId' => [ + 'description' => 'Request ID, the unique request identifier generated by Alibaba Cloud.', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeBucket', + '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', + ], + ], + [ + 'name' => 'BucketOwnerId', + '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', + ], + ], + [ + 'name' => 'SubscribeType', + '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', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'BillFormat', + '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', + ], + ], + [ + 'name' => 'SubscribeSegmentSize', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + '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', + ], + 'example' => '200', + 'title' => 'code', + 'type' => 'string', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'example' => 'true', + 'title' => 'success', + 'type' => 'boolean', + ], + ], + 'title' => 'result', + 'type' => 'object', + ], + ], + ], + '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" + ."\n" + .'**This topic is published only on the international site (alibabacloud.com).'."\n", + 'title' => 'SubscriptionBill', + ], + 'GetTier2CouponApprovalDetail' => [ + 'summary' => '查询T2优惠券审批详情', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Data' => [ + 'description' => '', + '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' => '', + ], + 'ApplicantInfo' => [ + 'description' => '', + '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', + ], + ], + ], + 'CouponReceiptUidList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703016242044705', + ], + 'NominalValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100.00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + ], + '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', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '501001340370350', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + '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', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '【产品code列表】', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'code1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'LimitPerPerson', + 'in' => 'query', + 'schema' => [ + 'title' => '【每人限领张数】'."\n" + .'● Limited to 1限领一张：'."\n" + .'● Unlimited不限制', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Unlimited', + 'enum' => [ + 'Limited to 1', + 'Unlimited', + ], + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'title' => '【面额】'."\n" + .'必须为整数', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ValidUntil', + 'in' => 'query', + 'schema' => [ + 'title' => '【有效期】'."\n" + .'● Validity Duration:自发券之日起'."\n" + .'● Custom Timeframe:自定义时间段', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Validity Duration', + 'enum' => [ + 'Validity Duration', + 'Custom Timeframe', + ], + ], + ], + [ + 'name' => 'Vailddate', + 'in' => 'query', + 'schema' => [ + 'title' => '【生效时间的开始时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-26', + ], + ], + [ + 'name' => 'Expireddate', + 'in' => 'query', + 'schema' => [ + 'title' => '【生效时间的结束时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-26', + ], + ], + [ + 'name' => 'Vaildperioddays', + 'in' => 'query', + 'schema' => [ + 'title' => '【相对时间的持续多少天‘】'."\n" + .'限制为正整数'."\n" + .'有效期选择 自发券之日起 必填', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PurchaseType', + 'in' => 'query', + 'schema' => [ + 'title' => '【订单类型】', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + 'enum' => [ + 'ALL', + 'Subscription', + 'Pay-As-You-Go', + ], + ], + ], + [ + 'name' => 'CouponDescription', + 'in' => 'query', + 'schema' => [ + 'title' => '券备注信息'."\n" + .'长度限制100', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + 'maxLength' => 100, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => ' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US'."\n" + .' 日文：ja', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-CN', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '5093156', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '[email protected]', + ], + 'Note' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'IssuerUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5432738203821334', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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\\": \\"[email protected]\\",\\n \\"Note\\": \\"通过\\",\\n \\"IssuerUid\\": \\"5432738203821334\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '优惠券审批状态列表查询', + ], + 'DeleteCouponTemplate' => [ + 'summary' => '作废优惠券模板', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '6558410265670417297', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Data' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询优惠券模板详情', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5093156', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_201', + 'errorMessage' => 'Parameters are illegal and required fields are empty.', + ], + [ + 'errorCode' => 'ERROR_1002', + 'errorMessage' => 'No query permission.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询优惠券模板详情', + ], + 'GetCoupondeductProductCode' => [ + 'summary' => '国际渠道分销优惠券可抵扣产品', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数 '."\n" + .'默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-CN', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '国际渠道分销优惠券可抵扣产品', + ], + 'IssueCouponForCustomer' => [ + 'summary' => '发放优惠券', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponTemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券模版ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5075915', + ], + ], + [ + 'name' => 'Uidlist', + 'in' => 'query', + 'schema' => [ + 'title' => 'uid列表'."\n" + .'用,分割 如 111,2222', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111,2222', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'IsUseBenefit', + 'in' => 'query', + 'schema' => [ + 'title' => '是否使用权益（已作废）'."\n" + .'如：true/false', + 'type' => 'boolean', + 'deprecated' => true, + ], + ], + [ + 'name' => 'ApplicationReason', + 'in' => 'query', + 'schema' => [ + 'title' => '申请原因'."\n" + .'如：为客户XXX申请优惠券', + 'type' => 'string', + 'example' => '为客户XXX审批优惠券，该客户是XXXX', + 'maxLength' => 500, + ], + ], + ], + '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' => '', + '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", + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + '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' => '发放优惠券', + ], + 'ListCouponUsage' => [ + 'summary' => '优惠券使用量列表查询', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'title' => '收券账号，如：[email protected]', + 'description' => '阿里云客户账号', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券状态', + 'description' => '优惠券状态 </br>'."\n" + .'AVAILABLE 正常 </br>'."\n" + .'EXHAUSTED 已用完 </br>'."\n" + .'EXPIRED 已过期 </br>'."\n" + .'ABANDONED 已作废 </br>', + 'type' => 'string', + 'required' => false, + 'example' => 'AVAILABLE', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页号，如：1', + 'description' => '页码</br> '."\n" + .' 默认值为1 最小值1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'CouponTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模版id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5075915', + ], + ], + [ + 'name' => 'T2PartnerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'T2伙伴uid'."\n" + .'如：123456789', + 'description' => 'T2伙伴uid'."\n" + .'如：123456789', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456768', + ], + ], + ], + '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', + ], + ], + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小，最大100', + 'description' => 'Pagination, record number on each page, maximum 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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'Data' => [ + 'description' => 'Listed data of returning result', + 'type' => 'array', + 'items' => [ + 'description' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + [ + 'name' => 'ApprovalAction', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Approve', + ], + ], + [ + 'name' => 'ApprovalComments', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'maxLength' => 500, + 'minLength' => 1, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，从1开始', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小，最大100', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'default' => 'en', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'title' => '导出场景code'."\n" + .'intlCustomerQuotaRecord：客户管理，quota流水导出'."\n" + .'intlExportUsageDeductHistory：客户管理，冲减明细导出', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'intlExportUsageDeductHistory', + 'enum' => [ + 'intlExportUsageDeductHistory', + 'intlCustomerQuotaRecord', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '导出任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12343', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + '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', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.ExportTask.SceneCodeError', + 'errorMessage' => 'The exporting scenario is incorrect.', + ], + ], + ], + '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' => 'Querying the Common Export File List', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'agency.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', + ], + ], +]; |