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/2025-02-27 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/agency/2025-02-27')
| -rw-r--r-- | data/en_us/agency/2025-02-27/api-docs.php | 1657 |
1 files changed, 1657 insertions, 0 deletions
diff --git a/data/en_us/agency/2025-02-27/api-docs.php b/data/en_us/agency/2025-02-27/api-docs.php new file mode 100644 index 0000000..920de17 --- /dev/null +++ b/data/en_us/agency/2025-02-27/api-docs.php @@ -0,0 +1,1657 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Agency', + 'version' => '2025-02-27', + ], + 'directories' => [ + 'GetBillDetailFileList', + 'GetSubPartnerOrderList', + 'GetSubPartnerList', + 'GetRenewalRateList', + 'GetCustomerOrderList', + 'GetCommissionDetailFileList', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetBillDetailFileList' => [ + 'summary' => '查询账单导出文件', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '202502', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'OssAccessKeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssAccessKeySecret', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssSecurityToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BillMonth' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202502', + ], + 'FileName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FileUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileName\\": \\"账单202502021112\\",\\n \\"Type\\": \\"拓渠\\",\\n \\"FileUrl\\": \\"aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"Status\\": \\"3\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Msg\\": \\"成功\\"\\n}","type":"json"}]', + ], + 'GetSubPartnerOrderList' => [ + 'summary' => '查询拓渠订单', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubPartnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123432311', + ], + ], + [ + 'name' => 'SubPartnerName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '202501101023', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '209335720330622', + ], + ], + [ + 'name' => 'OrderTypeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + 'required' => false, + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '3', + 'minimum' => '1', + 'example' => '3', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'OrderCreateAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727789348000', + ], + ], + [ + 'name' => 'OrderCreateBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1741008566000', + ], + ], + [ + 'name' => 'OrderPayAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727789348000', + ], + ], + [ + 'name' => 'OrderPayBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1741008566000', + ], + ], + [ + 'name' => 'PayAmountAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayAmountBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '10', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '236414227150922', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BUY', + ], + 'OrderStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PayType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Price' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3750', + ], + 'DiscountedPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3750', + ], + 'AmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '3750', + ], + 'DeductedAmountByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AmountDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ecs', + ], + 'ProductName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-07-07 07:52:22', + ], + 'PaidAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-07-07 07:52:22', + ], + 'SubPartnerUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1123132', + ], + 'SubPartnerName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202502233443', + ], + 'CustomerClassification' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetSubPartnerList' => [ + 'summary' => '查询二级分销商列表', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubPartnerPid', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2323431211', + ], + ], + [ + 'name' => 'SubPartnerCompanyName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页索引,从第一页开始', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回个数,最大支持100', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页返回的二级分销商个数,最大100', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + 'SubPartnerList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CompanyName' => [ + 'title' => '二级分销商名称', + 'type' => 'string', + ], + 'Pid' => [ + 'title' => '二级分销商pid', + 'type' => 'string', + ], + 'MasterAccount' => [ + 'title' => '二级分销商主账号名称', + 'type' => 'string', + ], + 'MasterUid' => [ + 'title' => '二级分销商主账号UID', + 'type' => 'string', + ], + 'Province' => [ + 'title' => '注册地省份', + 'type' => 'string', + ], + 'City' => [ + 'title' => '注册地城市', + 'type' => 'string', + ], + 'District' => [ + 'title' => '注册地区县', + 'type' => 'string', + ], + 'Address' => [ + 'title' => '注册地详细地址', + 'type' => 'string', + ], + 'AgreementStatus' => [ + 'title' => '合约状态编码', + 'type' => 'string', + ], + 'AgreementStatusDesc' => [ + 'title' => '合约状态描述', + 'type' => 'string', + ], + 'JoinTime' => [ + 'title' => '首次入驻时间', + 'type' => 'string', + ], + 'Contact' => [ + 'title' => '联系人名称', + 'type' => 'string', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + ], + 'GetRenewalRateList' => [ + 'summary' => '查询伙伴续费率', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FiscalYearAndQuarter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025Q4', + ], + ], + ], + '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' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FiscalYearAndQuarter' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025Q4', + ], + 'MasterPid' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'P123423453', + ], + 'MasterPidName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FinalRenewalRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + ], + 'FinalRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalOtherBillAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalCustomerRenewalRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + ], + 'FinalCustomerRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalCustomerRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'CustomerAdjustedRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'CustomerOtherBillAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalSubPartnerRenewalRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.85', + ], + 'FinalSubPartnerRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FinalSubPartnerRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SubPartnerAdjustedRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SubPartnerOtherBillAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialFinalRenewRatio' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.7', + ], + 'SpecialFinalRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialFinalRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialCustomerRenewRatio' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.7', + ], + 'SpecialCustomerRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialCustomerRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialSubPartnerRenewRatio' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.8', + ], + 'SpecialSubPartnerRenewalAmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SpecialSubPartnerRenewedAmount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"FiscalYearAndQuarter\\": \\"2025Q4\\",\\n \\"MasterPid\\": \\"P123423453\\",\\n \\"MasterPidName\\": \\"XX有限公司\\",\\n \\"FinalRenewalRate\\": 0.9,\\n \\"FinalRenewalAmountDue\\": 100,\\n \\"FinalRenewedAmount\\": 100,\\n \\"FinalOtherBillAmount\\": 100,\\n \\"FinalCustomerRenewalRate\\": 0.9,\\n \\"FinalCustomerRenewalAmountDue\\": 100,\\n \\"FinalCustomerRenewedAmount\\": 100,\\n \\"CustomerAdjustedRenewalAmountDue\\": 100,\\n \\"CustomerOtherBillAmount\\": 100,\\n \\"FinalSubPartnerRenewalRate\\": 0.85,\\n \\"FinalSubPartnerRenewalAmountDue\\": 100,\\n \\"FinalSubPartnerRenewedAmount\\": 100,\\n \\"SubPartnerAdjustedRenewalAmountDue\\": 100,\\n \\"SubPartnerOtherBillAmount\\": 100,\\n \\"SpecialFinalRenewRatio\\": 0.7,\\n \\"SpecialFinalRenewalAmountDue\\": 100,\\n \\"SpecialFinalRenewedAmount\\": 100,\\n \\"SpecialCustomerRenewRatio\\": 0.7,\\n \\"SpecialCustomerRenewalAmountDue\\": 100,\\n \\"SpecialCustomerRenewedAmount\\": 100,\\n \\"SpecialSubPartnerRenewRatio\\": 0.8,\\n \\"SpecialSubPartnerRenewalAmountDue\\": 100,\\n \\"SpecialSubPartnerRenewedAmount\\": 100\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetCustomerOrderList' => [ + 'summary' => '查询伙伴拓客订单', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'RamAccountForCustomerManager', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1234532', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '202502002231', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13595216', + ], + ], + [ + 'name' => 'OrderTypeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'DOWNGRADE', + 'RENEW', + 'REFUND', + 'OTHERS', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'OrderCreateAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727789348000', + ], + ], + [ + 'name' => 'OrderCreateBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1741008566000', + ], + ], + [ + 'name' => 'OrderPayAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727789348000', + ], + ], + [ + 'name' => 'OrderPayBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1741008566000', + ], + ], + [ + 'name' => 'PayAmountAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayAmountBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '236414227150922', + ], + 'OrderType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'DOWNGRADE', + 'RENEW', + 'REFUND', + 'OTHERS', + ], + ], + 'OrderStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'enum' => [ + '1', + '2', + '3', + ], + ], + 'PayType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + 'Price' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '29137', + ], + 'DiscountedPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '29137', + ], + 'AmountDue' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '29137', + ], + 'DeductedAmountByCoupons' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'AmountDiscount' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'ProductCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'slb', + ], + 'ProductName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'slb', + ], + 'CreatedAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-01-24 14:20:40', + ], + 'PaidAt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-01-24 14:20:40', + ], + 'CustomerUid' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'CustomerAccount' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test_123', + ], + 'RamAccountForCustomerManagers' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12345678', + ], + ], + 'CustomerClassification' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '202502230421', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2103a30617045934095083027d88c5', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetCommissionDetailFileList' => [ + 'summary' => '查询伙伴佣金明细', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '202501', + ], + ], + [ + 'name' => 'OssAccessKeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssAccessKeySecret', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssSecurityToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => 'code', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PartnerUid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1112332432', + ], + 'BillMonth' => [ + 'description' => '', + 'type' => 'string', + 'example' => '202502', + ], + 'FileList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CommissionPolicyName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FileType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FileUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1', + ], + 'FileName' => [ + 'type' => 'string', + ], + 'BucketSyncStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'agency.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', + ], + ], +]; |
