diff options
Diffstat (limited to 'data/en_us/agency/2025-02-27/api-docs.php')
| -rw-r--r-- | data/en_us/agency/2025-02-27/api-docs.php | 2087 |
1 files changed, 844 insertions, 1243 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 index 920de17..9cc37ab 100644 --- a/data/en_us/agency/2025-02-27/api-docs.php +++ b/data/en_us/agency/2025-02-27/api-docs.php @@ -1,32 +1,15 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Agency', - 'version' => '2025-02-27', - ], - 'directories' => [ - 'GetBillDetailFileList', - 'GetSubPartnerOrderList', - 'GetSubPartnerList', - 'GetRenewalRateList', - 'GetCustomerOrderList', - 'GetCommissionDetailFileList', - ], + 'info' => ['style' => 'RPC', 'product' => 'Agency', 'version' => '2025-02-27'], + 'directories' => ['GetBillDetailFileList', 'GetCommissionDetailFileList', 'GetCustomerOrderList', 'GetIntlCommissionDetailFileList', 'GetRenewalRateList', 'GetSubPartnerList', 'GetSubPartnerOrderList'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetBillDetailFileList' => [ - 'summary' => '查询账单导出文件', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34,169 +17,120 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BillMonth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '202502', - 'pattern' => '^\\d+$', - ], + 'schema' => ['description' => 'The billing month.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d+$', 'example' => '202502', 'title' => ''], ], [ 'name' => 'OssAccessKeyId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''], ], [ 'name' => 'OssAccessKeySecret', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''], ], [ 'name' => 'OssSecurityToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken', 'title' => ''], ], [ 'name' => 'OssBucketName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName', 'title' => ''], ], [ 'name' => 'OssEndpoint', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The endpoint of the region where the OSS bucket for file sharing is located.', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com', 'title' => ''], ], [ 'name' => 'OssRegion', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The region where the OSS bucket is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '210bc4b416874189683843905d9f9a', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210bc4b416874189683843905d9f9a'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'BillMonth' => [ - 'description' => '', - 'type' => 'string', - 'example' => '202502', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FileUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1', - ], - 'Status' => [ - 'type' => 'string', - ], + 'BillMonth' => ['description' => 'The billing month.', 'type' => 'string', 'example' => '202502', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '账单202502021112', 'title' => ''], + 'Type' => ['description' => 'The type. Valid values: customer acquisition or channel expansion.', 'type' => 'string', 'example' => '拓渠', 'title' => ''], + 'FileUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1', 'title' => ''], + 'Status' => ['description' => 'The OSS file push status. Valid values:'."\n" + .'- 1: pending'."\n" + .'- 2: processing'."\n" + .'- 3: completed.', 'type' => 'string', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Msg' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Msg' => ['description' => 'Same as Message.', 'type' => 'string', 'example' => '成功', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query exported bill files', + 'summary' => 'Queries exported bill files.', + 'changeSet' => [ + ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-17T02:40:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBillDetailFileList'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetBillDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileName\\": \\"账单202502021112\\",\\n \\"Type\\": \\"拓渠\\",\\n \\"FileUrl\\": \\"aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"Status\\": \\"3\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Msg\\": \\"成功\\"\\n}","type":"json"}]', ], - 'GetSubPartnerOrderList' => [ - 'summary' => '查询拓渠订单', + 'GetCommissionDetailFileList' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -204,391 +138,380 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SubPartnerUid', + 'name' => 'BillMonth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123432311', - ], + 'schema' => ['description' => 'The billing month.', 'type' => 'string', 'required' => false, 'example' => '202501', 'title' => ''], ], [ - 'name' => 'SubPartnerName', + 'name' => 'OssAccessKeyId', + 'in' => 'query', + 'schema' => ['description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''], + ], + [ + 'name' => 'OssAccessKeySecret', 'in' => 'query', + 'schema' => ['description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''], + ], + [ + 'name' => 'OssSecurityToken', + 'in' => 'query', + 'schema' => ['description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken', 'title' => ''], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName', 'title' => ''], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['description' => 'The endpoint of the region where the Object Storage Service (OSS) bucket corresponding to the file sharing resides.', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => ['description' => 'The region where the OSS bucket resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'Code' => ['description' => 'code', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PartnerUid' => ['description' => 'The UID of the partner.', 'type' => 'string', 'example' => '1112332432', 'title' => ''], + 'BillMonth' => ['description' => 'The billing month.', 'type' => 'string', 'example' => '202502', 'title' => ''], + 'FileList' => [ + 'description' => 'The file list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The file list object.', + 'type' => 'object', + 'properties' => [ + 'CommissionPolicyName' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '参考【APS佣金查询下载功能】的政策名称', 'title' => ''], + 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'example' => '总代政策为拓渠、普通政策为拓客', 'title' => ''], + 'FileUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '佣金202502021112', 'title' => ''], + 'BucketSyncStatus' => ['description' => 'The push status of the OSS file. Valid values: Processing, Succeeded, or Failed.', 'type' => 'string', 'example' => '处理中', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query partner commission details', + 'summary' => 'Queries the commission details of a partner.', + 'changeSet' => [ + ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommissionDetailFileList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetCustomerOrderList' => [ + 'summary' => 'Queries partner customer acquisition orders.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '10'], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'required' => false], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123', 'required' => false], + ], + [ + 'name' => 'RamAccountForCustomerManager', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The employee who follows up with the customer.', 'type' => 'string', 'example' => '1234532', 'required' => false], + ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '202501101023', - ], + 'schema' => ['title' => '', 'description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502002231', 'required' => false], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '209335720330622', - ], + 'schema' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '13595216', 'required' => false], ], [ 'name' => 'OrderTypeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of order types.', 'type' => 'array', 'items' => [ - 'description' => '', + 'title' => '', + 'description' => 'The order type. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, OTHERS.', 'type' => 'string', - 'required' => false, 'example' => 'BUY', + 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'], + 'required' => false, ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'OrderStatus', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The order status. Valid values:'."\n" + .'- 1: unpaid'."\n" + .'- 2: canceled'."\n" + .'- 3: paid.', 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '3', - 'minimum' => '1', + 'format' => 'int32', 'example' => '3', + 'enum' => ['1', '2', '3'], + 'required' => false, ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The payment type. Valid values:'."\n" + .'- 1: non-delegated payment'."\n" + .'- 2: delegated payment.', 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '2', - 'minimum' => '1', + 'format' => 'int32', 'example' => '1', + 'enum' => ['1', '2'], + 'required' => false, ], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'required' => false], ], [ 'name' => 'ProductName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => '弹性计算', 'required' => false], ], [ 'name' => 'OrderCreateAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['title' => '', 'description' => 'The start timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727789348000', 'required' => false], ], [ 'name' => 'OrderCreateBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['title' => '', 'description' => 'The end timestamp for order creation. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741008566000', 'required' => false], ], [ 'name' => 'OrderPayAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['title' => '', 'description' => 'The start timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727789348000', 'required' => false], ], [ 'name' => 'OrderPayBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['title' => '', 'description' => 'The end timestamp for order payment. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741008566000', 'required' => false], ], [ 'name' => 'PayAmountAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The minimum actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'required' => false], ], [ 'name' => 'PayAmountBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '500', - 'minimum' => '10', - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The maximum actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '1000', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '236414227150922', - ], + 'OrderId' => ['title' => '', 'description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922'], 'OrderType' => [ - 'description' => '', + 'title' => '', + 'description' => 'The order type. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, OTHERS.', 'type' => 'string', 'example' => 'BUY', + 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'], ], 'OrderStatus' => [ - 'description' => '', + 'title' => '', + 'description' => 'The order status. Valid values:'."\n" + .'- 1: unpaid'."\n" + .'- 2: paid'."\n" + .'- 3: canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', + 'enum' => ['1', '2', '3'], ], 'PayType' => [ - 'description' => '', + 'title' => '', + 'description' => 'The payment type. Valid values:'."\n" + .'- 1: non-delegated payment'."\n" + .'- 2: delegated payment.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', - ], - 'Price' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '3750', - ], - 'DiscountedPrice' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '3750', - ], - 'AmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '3750', - ], - 'DeductedAmountByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AmountDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9', - ], - 'ProductCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs', - ], - 'ProductName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-07 07:52:22', - ], - 'PaidAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-07 07:52:22', - ], - 'SubPartnerUid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1123132', - ], - 'SubPartnerName' => [ - 'description' => '', - 'type' => 'string', + 'enum' => ['1', '2'], + ], + 'Price' => ['title' => '', 'description' => 'The original price or list price.', 'type' => 'number', 'format' => 'double', 'example' => '29137'], + 'DiscountedPrice' => ['title' => '', 'description' => 'The discounted price.', 'type' => 'number', 'format' => 'double', 'example' => '29137'], + 'AmountDue' => ['title' => '', 'description' => 'The actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '29137'], + 'DeductedAmountByCoupons' => ['title' => '', 'description' => 'The coupon amount.', 'type' => 'number', 'format' => 'double', 'example' => '0'], + 'AmountDiscount' => ['title' => '', 'description' => 'The order discount.', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'ProductCode' => ['title' => '', 'description' => 'The product code.', 'type' => 'string', 'example' => 'slb'], + 'ProductName' => ['title' => '', 'description' => 'The product name.', 'type' => 'string', 'example' => 'slb'], + 'CreatedAt' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2019-01-24 14:20:40'], + 'PaidAt' => ['title' => '', 'description' => 'The payment time.', 'type' => 'string', 'example' => '2019-01-24 14:20:40'], + 'CustomerUid' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'CustomerAccount' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123'], + 'RamAccountForCustomerManagers' => [ + 'description' => 'The employee who follows up with the customer.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The employee who follows up with the customer.', 'type' => 'string', 'example' => '12345678'], + 'title' => '', 'example' => '', ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202502233443', - ], - 'CustomerClassification' => [ - 'type' => 'string', - ], + 'CustomerClassification' => ['title' => '', 'description' => 'The customer classification.', 'type' => 'string', 'example' => 'C类'], + 'ProjectId' => ['title' => '', 'description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502230421'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The message.', 'type' => 'string', 'example' => 'success'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query partner customer acquisition orders', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrderList'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCustomerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetSubPartnerList' => [ - 'summary' => '查询二级分销商列表', + 'GetIntlCommissionDetailFileList' => [ + 'summary' => 'Downloads the commission details of an international partner.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -596,188 +519,126 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SubPartnerPid', + 'name' => 'BillMonth', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2323431211', - ], + 'schema' => ['title' => '', 'description' => 'The bill month.', 'type' => 'string', 'required' => true, 'example' => '202502'], ], [ - 'name' => 'SubPartnerCompanyName', + 'name' => 'OssAccessKeyId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The AccessKey ID used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourAccessKeyID'], ], [ - 'name' => 'PageNo', + 'name' => 'OssAccessKeySecret', 'in' => 'query', - 'schema' => [ - 'title' => '分页索引，从第一页开始', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The AccessKey secret used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourAccessKeySecret'], ], [ - 'name' => 'PageSize', + 'name' => 'OssSecurityToken', 'in' => 'query', - 'schema' => [ - 'title' => '每页返回个数，最大支持100', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The STS token used to upload files to OSS.', 'type' => 'string', 'required' => true, 'example' => 'yourSecurityToken'], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'yourBucketName'], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The endpoint of the region where the Object Storage Service (OSS) bucket for file sharing resides.', 'type' => 'string', 'required' => true, 'example' => 'http://oss-cn-beijing.aliyuncs.com'], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region where the current OSS bucket resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNo' => [ - 'title' => '当前页码', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页返回的二级分销商个数，最大100', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100', - ], - 'SubPartnerList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CompanyName' => [ - 'title' => '二级分销商名称', - 'type' => 'string', - ], - 'Pid' => [ - 'title' => '二级分销商pid', - 'type' => 'string', - ], - 'MasterAccount' => [ - 'title' => '二级分销商主账号名称', - 'type' => 'string', - ], - 'MasterUid' => [ - 'title' => '二级分销商主账号UID', - 'type' => 'string', - ], - 'Province' => [ - 'title' => '注册地省份', - 'type' => 'string', - ], - 'City' => [ - 'title' => '注册地城市', - 'type' => 'string', - ], - 'District' => [ - 'title' => '注册地区县', - 'type' => 'string', - ], - 'Address' => [ - 'title' => '注册地详细地址', - 'type' => 'string', - ], - 'AgreementStatus' => [ - 'title' => '合约状态编码', - 'type' => 'string', - ], - 'AgreementStatusDesc' => [ - 'title' => '合约状态描述', - 'type' => 'string', - ], - 'JoinTime' => [ - 'title' => '首次入驻时间', - 'type' => 'string', - ], - 'Contact' => [ - 'title' => '联系人名称', - 'type' => 'string', + 'RequestId' => ['title' => '', 'description' => 'RequestId', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'title' => '', + 'description' => 'The data.', + 'type' => 'object', + 'properties' => [ + 'PartnerUid' => ['title' => '', 'description' => 'The UID of the partner.', 'type' => 'string', 'example' => '1112332432'], + 'BillMonth' => ['title' => '', 'description' => 'The bill month.', 'type' => 'string', 'example' => '202502'], + 'FileList' => [ + 'title' => '', + 'description' => 'The file list object.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The file list object.', + 'type' => 'object', + 'properties' => [ + 'CommissionPolicyName' => ['title' => '', 'description' => 'The commission policy name.', 'type' => 'string', 'example' => '202606_FY27_TEST'], + 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '202606_FY27_TEST_4397912340.xlsx'], + 'BucketSyncStatus' => [ + 'title' => '', + 'description' => 'The OSS file push status. Valid values: init, processing, succeeded, or failed.', + 'enumValueTitles' => ['处理失败' => 'FAIL', '初始化状态' => 'INIT', '处理成功' => 'SUCCESS', '处理中' => 'PROCESSING'], + 'type' => 'string', + 'example' => 'PROCESSING', + ], + ], + 'example' => '', ], + 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', 'example' => '', ], + 'Message' => ['title' => '', 'description' => 'The message information.', 'type' => 'string', 'example' => 'SUCCESS'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Download international partner commission bill', + 'description' => 'Ensure that the current caller identity is a T1 distribution partner. '."\n" + .'<notice>Available only for international site.</notice>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'agency:GetIntlCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"202606_FY27_TEST\\",\\n \\"FileName\\": \\"202606_FY27_TEST_4397912340.xlsx\\",\\n \\"BucketSyncStatus\\": \\"PROCESSING\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetRenewalRateList' => [ - 'summary' => '查询伙伴续费率', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -785,245 +646,104 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'FiscalYearAndQuarter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025Q4', - ], + 'schema' => ['description' => 'The fiscal year and quarter.', 'type' => 'string', 'required' => true, 'example' => '2025Q4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ - 'FiscalYearAndQuarter' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025Q4', - ], - 'MasterPid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'P123423453', - ], - 'MasterPidName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FinalRenewalRate' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9', - ], - 'FinalRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalOtherBillAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalCustomerRenewalRate' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.9', - ], - 'FinalCustomerRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalCustomerRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'CustomerAdjustedRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'CustomerOtherBillAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalSubPartnerRenewalRate' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.85', - ], - 'FinalSubPartnerRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'FinalSubPartnerRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SubPartnerAdjustedRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SubPartnerOtherBillAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialFinalRenewRatio' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.7', - ], - 'SpecialFinalRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialFinalRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialCustomerRenewRatio' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.7', - ], - 'SpecialCustomerRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialCustomerRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialSubPartnerRenewRatio' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.8', - ], - 'SpecialSubPartnerRenewalAmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], - 'SpecialSubPartnerRenewedAmount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - ], + 'FiscalYearAndQuarter' => ['description' => 'The fiscal year and quarter.', 'type' => 'string', 'example' => '2025Q4', 'title' => ''], + 'MasterPid' => ['description' => 'The partner PID.', 'type' => 'string', 'example' => 'P123423453', 'title' => ''], + 'MasterPidName' => ['description' => 'The partner PID name.', 'type' => 'string', 'example' => 'XX有限公司', 'title' => ''], + 'FinalRenewalRate' => ['description' => 'The final commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''], + 'FinalRenewalAmountDue' => ['description' => 'The final amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalRenewedAmount' => ['description' => 'The final renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalOtherBillAmount' => ['description' => 'The total amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalCustomerRenewalRate' => ['description' => 'The customer acquisition commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''], + 'FinalCustomerRenewalAmountDue' => ['description' => 'The customer acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalCustomerRenewedAmount' => ['description' => 'The customer acquisition renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'CustomerAdjustedRenewalAmountDue' => ['description' => 'The adjusted customer acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'CustomerOtherBillAmount' => ['description' => 'The customer acquisition amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalSubPartnerRenewalRate' => ['description' => 'The sub-partner acquisition commission renewal rate.', 'type' => 'number', 'format' => 'double', 'example' => '0.85', 'title' => ''], + 'FinalSubPartnerRenewalAmountDue' => ['description' => 'The sub-partner acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'FinalSubPartnerRenewedAmount' => ['description' => 'The sub-partner acquisition renewed amount.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SubPartnerAdjustedRenewalAmountDue' => ['description' => 'The adjusted sub-partner acquisition amount due for renewal.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SubPartnerOtherBillAmount' => ['description' => 'The sub-partner acquisition amount for new purchases, upgrades, and refunds.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialFinalRenewRatio' => ['description' => 'The final quarterly commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.7', 'title' => ''], + 'SpecialFinalRenewalAmountDue' => ['description' => 'The final quarterly commission amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialFinalRenewedAmount' => ['description' => 'The final quarterly commission renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialCustomerRenewRatio' => ['description' => 'The customer acquisition commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.7', 'title' => ''], + 'SpecialCustomerRenewalAmountDue' => ['description' => 'The customer acquisition amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialCustomerRenewedAmount' => ['description' => 'The customer acquisition renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialSubPartnerRenewRatio' => ['description' => 'The sub-partner acquisition commission renewal rate including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '0.8', 'title' => ''], + 'SpecialSubPartnerRenewalAmountDue' => ['description' => 'The sub-partner acquisition amount due for renewal including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], + 'SpecialSubPartnerRenewedAmount' => ['description' => 'The sub-partner acquisition renewed amount including special approvals.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query partner renewal rate', + 'summary' => 'Queries the partner renewal rate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenewalRateList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetRenewalRateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"FiscalYearAndQuarter\\": \\"2025Q4\\",\\n \\"MasterPid\\": \\"P123423453\\",\\n \\"MasterPidName\\": \\"XX有限公司\\",\\n \\"FinalRenewalRate\\": 0.9,\\n \\"FinalRenewalAmountDue\\": 100,\\n \\"FinalRenewedAmount\\": 100,\\n \\"FinalOtherBillAmount\\": 100,\\n \\"FinalCustomerRenewalRate\\": 0.9,\\n \\"FinalCustomerRenewalAmountDue\\": 100,\\n \\"FinalCustomerRenewedAmount\\": 100,\\n \\"CustomerAdjustedRenewalAmountDue\\": 100,\\n \\"CustomerOtherBillAmount\\": 100,\\n \\"FinalSubPartnerRenewalRate\\": 0.85,\\n \\"FinalSubPartnerRenewalAmountDue\\": 100,\\n \\"FinalSubPartnerRenewedAmount\\": 100,\\n \\"SubPartnerAdjustedRenewalAmountDue\\": 100,\\n \\"SubPartnerOtherBillAmount\\": 100,\\n \\"SpecialFinalRenewRatio\\": 0.7,\\n \\"SpecialFinalRenewalAmountDue\\": 100,\\n \\"SpecialFinalRenewedAmount\\": 100,\\n \\"SpecialCustomerRenewRatio\\": 0.7,\\n \\"SpecialCustomerRenewalAmountDue\\": 100,\\n \\"SpecialCustomerRenewedAmount\\": 100,\\n \\"SpecialSubPartnerRenewRatio\\": 0.8,\\n \\"SpecialSubPartnerRenewalAmountDue\\": 100,\\n \\"SpecialSubPartnerRenewedAmount\\": 100\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetCustomerOrderList' => [ - 'summary' => '查询伙伴拓客订单', + 'GetSubPartnerList' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1031,627 +751,508 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'SubPartnerPid', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The PID of the secondary partner.', 'type' => 'string', 'example' => '2323431211', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SubPartnerCompanyName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The company name of the secondary partner.', 'type' => 'string', 'example' => 'xxx有限公司', 'required' => false, 'title' => ''], + ], + [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '500', - 'minimum' => '10', - 'example' => '10', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of entries that match the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of secondary distributors returned per page. Maximum value: 100.', 'type' => 'string', 'required' => true, 'example' => '100'], + 'SubPartnerList' => [ + 'description' => 'The list of secondary distributors.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CompanyName' => ['title' => '', 'description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'xxx有限公司'], + 'Pid' => ['title' => '', 'description' => 'The PID of the secondary distributor.', 'type' => 'string', 'example' => 'P123456'], + 'MasterAccount' => ['title' => '', 'description' => 'The name of the primary account of the secondary distributor.', 'type' => 'string', 'example' => 'xxxxxx有限公司主账号'."\n"], + 'MasterUid' => ['title' => '', 'description' => 'The UID of the primary account of the secondary distributor.', 'type' => 'string', 'example' => '123456'], + 'Province' => ['title' => '', 'description' => 'The province of the registered address.', 'type' => 'string', 'example' => '浙江省'], + 'City' => ['title' => '', 'description' => 'The city of the registered address.', 'type' => 'string', 'example' => '杭州市'], + 'District' => ['title' => '', 'description' => 'The district or county of the registered address.', 'type' => 'string', 'example' => '西湖区'], + 'Address' => ['title' => '', 'description' => 'The detailed registered address.', 'type' => 'string', 'example' => 'xxx街道xxx号'], + 'AgreementStatus' => [ + 'title' => '', + 'description' => 'The agreement status code.', + 'enumValueTitles' => ['RESTRICTED_OPENING' => 'restricted opening period.', 'CALM_DOWN_PERIOD' => 'cooling-off period.', 'ACTIVE_PERIOD' => 'active period.'], + 'type' => 'string', + 'example' => 'ACTIVE_PERIOD', + ], + 'AgreementStatusDesc' => ['title' => '', 'description' => 'The description of the agreement status.', 'type' => 'string', 'example' => '生效期'], + 'JoinTime' => ['title' => '', 'description' => 'The time when the secondary distributor first joined.', 'type' => 'string', 'example' => '2000-01-01'], + 'Contact' => ['title' => '', 'description' => 'The name of the contact.', 'type' => 'string', 'example' => '张三'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query secondary distributors', + 'summary' => 'Queries the list of secondary distributors.', + 'changeSet' => [ + ['createdAt' => '2025-03-27T08:12:31.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CustomerUid', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + ], + 'GetSubPartnerOrderList' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CustomerAccount', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'SubPartnerUid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test_123', - ], + 'schema' => ['description' => 'The UID of the secondary partner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123432311', 'title' => ''], ], [ - 'name' => 'RamAccountForCustomerManager', + 'name' => 'SubPartnerName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1234532', - ], + 'schema' => ['description' => 'The name of the secondary partner.', 'type' => 'string', 'required' => false, 'example' => 'XXX有限公司', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '202502002231', - ], + 'schema' => ['description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '202501101023', 'title' => ''], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13595216', - ], + 'schema' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '209335720330622', 'title' => ''], ], [ 'name' => 'OrderTypeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of order types.'."\n" + .'Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, and OTHERS.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BUY', - 'enum' => [ - 'BUY', - 'UPGRADE', - 'DOWNGRADE', - 'RENEW', - 'REFUND', - 'OTHERS', - ], - ], + 'items' => ['description' => 'The list of order types. Valid values: BUY, UPGRADE, DOWNGRADE, RENEW, REFUND, and OTHERS.', 'type' => 'string', 'required' => false, 'example' => 'BUY', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'OrderStatus', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'enum' => [ - '1', - '2', - '3', - ], - ], + 'schema' => ['description' => 'The order status. Valid values:'."\n" + .'- 1: unpaid'."\n" + .'- 2: paid'."\n" + .'- 3: voided.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '3', 'minimum' => '1', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - '2', - ], - ], + 'schema' => ['description' => 'The payment type. Valid values:'."\n" + .'- 1: non-delegated payment'."\n" + .'- 2: delegated payment.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '2', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ 'name' => 'ProductName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The product name.', 'type' => 'string', 'required' => false, 'example' => '弹性计算', 'title' => ''], ], [ 'name' => 'OrderCreateAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => 'The start timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => ''], ], [ 'name' => 'OrderCreateBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => 'The end timestamp of the order creation time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => ''], ], [ 'name' => 'OrderPayAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => 'The start timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => ''], ], [ 'name' => 'OrderPayBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => 'The end timestamp of the order payment time range. The time range cannot exceed 6 months. The order creation time range and the order payment time range cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => ''], ], [ 'name' => 'PayAmountAfter', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The minimum actual payment amount.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PayAmountBefore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The maximum actual payment amount.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Total' => ['title' => '', 'description' => 'The total number of entries that meet the query conditions. This is an optional parameter and is not returned by default.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '236414227150922', - ], - 'OrderType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BUY', - 'enum' => [ - 'BUY', - 'UPGRADE', - 'DOWNGRADE', - 'RENEW', - 'REFUND', - 'OTHERS', - ], - ], - 'OrderStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'enum' => [ - '1', - '2', - '3', - ], - ], - 'PayType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'enum' => [ - '1', - '2', - ], - ], - 'Price' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '29137', - ], - 'DiscountedPrice' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '29137', - ], - 'AmountDue' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '29137', - ], - 'DeductedAmountByCoupons' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - ], - 'AmountDiscount' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'ProductCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'slb', - ], - 'ProductName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'slb', - ], - 'CreatedAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-01-24 14:20:40', - ], - 'PaidAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-01-24 14:20:40', - ], - 'CustomerUid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'CustomerAccount' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_123', - ], - 'RamAccountForCustomerManagers' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345678', - ], - ], - 'CustomerClassification' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202502230421', - ], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922', 'title' => ''], + 'OrderType' => ['description' => 'The order type. Valid values:'."\n" + .'- BUY: new purchase'."\n" + .'- UPGRADE: upgrade'."\n" + .'- DOWNGRADE: downgrade'."\n" + .'- RENEW: renewal'."\n" + .'- REFUND: refund'."\n" + .'- OTHERS: other.', 'type' => 'string', 'example' => 'BUY', 'title' => ''], + 'OrderStatus' => ['description' => 'The order status. Valid values:'."\n" + .'- 1: unpaid'."\n" + .'- 2: deprecated'."\n" + .'- 3: paid.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'PayType' => ['description' => 'The payment type. Valid values:'."\n" + .'- 1: non-delegated payment'."\n" + .'- 2: delegated payment.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Price' => ['description' => 'The original price or list price.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''], + 'DiscountedPrice' => ['description' => 'The discounted price.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''], + 'AmountDue' => ['description' => 'The actual payment amount.', 'type' => 'number', 'format' => 'double', 'example' => '3750', 'title' => ''], + 'DeductedAmountByCoupons' => ['description' => 'The coupon amount.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'AmountDiscount' => ['description' => 'The order discount.', 'type' => 'number', 'format' => 'double', 'example' => '0.9', 'title' => ''], + 'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '弹性计算', 'title' => ''], + 'CreatedAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-07-07 07:52:22', 'title' => ''], + 'PaidAt' => ['description' => 'The payment time.', 'type' => 'string', 'example' => '2024-07-07 07:52:22', 'title' => ''], + 'SubPartnerUid' => ['description' => 'The UID of the secondary partner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1123132', 'title' => ''], + 'SubPartnerName' => ['description' => 'The name of the secondary partner.', 'type' => 'string', 'example' => 'xxx有限公司', 'title' => ''], + 'ProjectId' => ['description' => 'The opportunity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202502233443', 'title' => ''], + 'CustomerClassification' => ['description' => 'The customer classification.', 'type' => 'string', 'example' => 'C类', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2103a30617045934095083027d88c5', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => 'The current caller is not an eco-partner'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'GetCommissionDetailFileList' => [ - 'summary' => '查询伙伴佣金明细', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query channel expansion orders', + 'summary' => 'Queries channel expansion orders.', + 'changeSet' => [ + ['createdAt' => '2025-05-29T12:18:35.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerOrderList'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'BillMonth', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '202501', - ], - ], + 'ramActions' => [ [ - 'name' => 'OssAccessKeyId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - [ - 'name' => 'OssAccessKeySecret', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.ap-southeast-1.aliyuncs.com', 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.aliyuncs.com', 'endpoint' => 'agency.aliyuncs.com', 'vpc' => 'agency-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'Error1109', 'message' => 'system error.', 'http_code' => 400, 'description' => 'System exception'], + ['code' => 'Error3008', 'message' => 'shutdown status is error.', 'http_code' => 400, 'description' => 'shutdown status is error.'], + ['code' => 'Error3009', 'message' => 'customerAccount is error.', 'http_code' => 400, 'description' => 'customerAccount is error.'], + ['code' => 'Error3010', 'message' => 'customerNick is empty.', 'http_code' => 400, 'description' => 'customerNick is empty.'], + ['code' => 'Error3011', 'message' => 'The length of customerNick greater than 50.', 'http_code' => 400, 'description' => 'The length of customerNick greater than 50. '], + ['code' => 'Error3012', 'message' => 'cid is empty.', 'http_code' => 400, 'description' => 'cid is empty.'], + ['code' => 'Error3013', 'message' => 'customCredit is empty.', 'http_code' => 400, 'description' => 'customCredit is empty.'], + ['code' => 'Error3014', 'message' => 'customCredit is a maximum of 10.', 'http_code' => 400, 'description' => 'customCredit is a maximum of 10.'], + ['code' => 'Error3015', 'message' => 'The current account is not a partner.', 'http_code' => 400, 'description' => 'The current account is not a distributor'], + ['code' => 'Error3016', 'message' => 'customerRebateType is error, only invite agency account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite agency account.'], + ['code' => 'Error3017', 'message' => 'customerRebateType is error, only invite reseller account.', 'http_code' => 400, 'description' => 'customerRebateType is error，only invite reseller account.'], + ['code' => 'Error3030', 'message' => 'The maximum length of CustomNick is 150.', 'http_code' => 400, 'description' => 'Maximum CustomNick length is 150'], + ['code' => 'Error3031', 'message' => 'The maximum length of FxDescription is 3000.', 'http_code' => 400, 'description' => 'Maximum FxDescription length is 3000'], + ['code' => 'Error3040', 'message' => 'The account is in a frozen state and cannot be operated.', 'http_code' => 400, 'description' => 'The account is in a frozen state and cannot be operated.'], + ['code' => 'Error3043', 'message' => 'The range of ShutdownStatus can only be 1 and 2.', 'http_code' => 400, 'description' => 'The range of ShutdownStatus can only be 1 and 2'], + ['code' => 'Error3044', 'message' => 'The Value is not a number.', 'http_code' => 400, 'description' => 'Value is not a number'], + ['code' => 'Error3045', 'message' => 'The value must be between 1-100.', 'http_code' => 400, 'description' => 'Value must be between 1-100'], + ['code' => 'Error3051', 'message' => 'input accounStatus value error, It must be 1,2,3.', 'http_code' => 400, 'description' => 'Wrong value for input AccounStatus, must be 1,2 or 3'], + ['code' => 'Error3052', 'message' => 'Your account is currently frozen and cannot be unfrozen for the following customer operations.', 'http_code' => 400, 'description' => ''], + ['code' => 'Error3055', 'message' => 'subAccountType is null.', 'http_code' => 400, 'description' => 'subAccountType is empty'], + ['code' => 'Error3056', 'message' => 'The value of subAccountType error.', 'http_code' => 400, 'description' => 'The value of subAccountType error'], + ['code' => 'Error3058', 'message' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'http_code' => 400, 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'], + ['code' => 'Error3067', 'message' => 'Enterprise Customer Invitation Prohibition.', 'http_code' => 400, 'description' => 'Enterprise Customer Invitation Prohibition.'], + ['code' => 'ERROR_1002', 'message' => 'No query permission.', 'http_code' => 400, 'description' => 'No query permission'], + ['code' => 'ERROR_1003', 'message' => 'No permission to operate the object.', 'http_code' => 400, 'description' => 'No permission to operate the object.'], + ['code' => 'ERROR_201', 'message' => 'Parameters are illegal and required fields are empty.', 'http_code' => 400, 'description' => 'Parameters are illegal and required fields are empty.'], + ['code' => 'ERROR_2307', 'message' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'http_code' => 400, 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'], + ['code' => 'ERROR_2310', 'message' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'http_code' => 400, 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'], + ['code' => 'ERROR_2311', 'message' => 'Coupon template does not exist.', 'http_code' => 400, 'description' => 'Coupon template does not exist'], + ['code' => 'ERROR_3070', 'message' => 'CouponTemplateName must be entered.', 'http_code' => 400, 'description' => 'TemplateName name must be entered'], + ['code' => 'ERROR_3071', 'message' => 'ApplicableProducts empty, please check.', 'http_code' => 400, 'description' => 'ApplicableProducts empty, please check.'], + ['code' => 'ERROR_3072', 'message' => 'itemCodes empty, please check.', 'http_code' => 400, 'description' => 'ProductType is empty, please check'], + ['code' => 'ERROR_3073', 'message' => 'amout empty, please check.', 'http_code' => 400, 'description' => 'Value empty, please check.'], + ['code' => 'ERROR_3074', 'message' => 'personLimit empty, please check.', 'http_code' => 400, 'description' => 'LimitPerPerson empty, please check.'], + ['code' => 'ERROR_3075', 'message' => 'applyReason empty, please check.', 'http_code' => 400, 'description' => 'ReasonForApplication empty, please check.'], + ['code' => 'ERROR_3076', 'message' => 'effDateType empty, please check.', 'http_code' => 400, 'description' => 'effDateType empty, please check.'], + ['code' => 'ERROR_3077', 'message' => 'effDateDay empty, please check.', 'http_code' => 400, 'description' => 'Vaildperioddays empty, please check.'], + ['code' => 'ERROR_3078', 'message' => 'effDateFrom empty, please check.', 'http_code' => 400, 'description' => 'Vailddate empty, please check.'], + ['code' => 'ERROR_3079', 'message' => 'effDateTo empty, please check.', 'http_code' => 400, 'description' => 'Expireddate empty, please check .'], + ['code' => 'ERROR_3080', 'message' => 'Account empty, please check.', 'http_code' => 400, 'description' => 'Account is empty, please check'], + ['code' => 'ERROR_3081', 'message' => 'couponTemplateId empty, please check.', 'http_code' => 400, 'description' => 'couponTemplateId empty, please check.'], + ['code' => 'ERROR_3082', 'message' => 'Uidlist empty, please check .', 'http_code' => 400, 'description' => 'Uidlist is empty, please check'], + ['code' => 'ERROR_3084', 'message' => 'Coupon cannot be valid for more than 180 days.', 'http_code' => 400, 'description' => 'Coupon cannot be valid for more than 180 days'], + ['code' => 'ERROR_3085', 'message' => 'Product code is not in international channel partner coupons deductable product list.', 'http_code' => 400, 'description' => 'Product code is not in international channel partner coupons deductable product list.'], + ['code' => 'ERROR_3087', 'message' => 'The current uid is not the end user identity, can not issue coupons.', 'http_code' => 400, 'description' => 'The current uid is not the end user identity, can not issue coupons.'], + ['code' => 'ERROR_3088', 'message' => 'Coupon template expired, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template expired, unable to issue coupon'], + ['code' => 'ERROR_3089', 'message' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'], + ['code' => 'ERROR_3090', 'message' => 'You have no authority.', 'http_code' => 400, 'description' => 'You have no authority'], + ['code' => 'ERROR_3091', 'message' => 'Coupon template name length over limit.', 'http_code' => 400, 'description' => 'Coupon template name length over limit（30 characters）.'], + ['code' => 'ERROR_3092', 'message' => 'Reason for template request length over limit.', 'http_code' => 400, 'description' => 'Reason for template request length over limit（100 characters）'], + ['code' => 'ERROR_3093', 'message' => 'Coupon cost-bearer parameters are not legal.', 'http_code' => 400, 'description' => 'Coupon cost-bearer parameters are not legal'], + ['code' => 'ERROR_3094', 'message' => 'Applicable product type parameters are not legal.', 'http_code' => 400, 'description' => 'Applicable product type parameters are not legal'], + ['code' => 'ERROR_3095', 'message' => 'The per-person limit is illegal.', 'http_code' => 400, 'description' => 'The per-person limit is illegal.'], + ['code' => 'ERROR_3096', 'message' => 'Coupon value is illegal.', 'http_code' => 400, 'description' => 'Coupon value is illegal.'], + ['code' => 'ERROR_3097', 'message' => 'Time type is illegal.', 'http_code' => 400, 'description' => 'Time type is illegal.'], + ['code' => 'ERROR_3098', 'message' => 'Coupon Remarks Information length over limit.', 'http_code' => 400, 'description' => 'Coupon Remarks Information length over limit（100 characters).'], + ['code' => 'ERROR_3099', 'message' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'], + ['code' => 'ERROR_3100', 'message' => 'System exceptions, please submit a work order.', 'http_code' => 400, 'description' => 'System exceptions, please submit a work order.'], + ['code' => 'ERROR_3101', 'message' => 'PurchaseType empty, please check .', 'http_code' => 400, 'description' => 'PurchaseType empty, please check .'], + ['code' => 'ERROR_3102', 'message' => 'This coupon template ID was not created by this account.', 'http_code' => 400, 'description' => 'This coupon template ID was not created by this account.'], + ['code' => 'ERROR_3103', 'message' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"], + ['code' => 'ERROR_3210', 'message' => 'The current calling UID is not an international channel partner.', 'http_code' => 400, 'description' => 'The current calling UID is not an international channel partner'], + ['code' => 'InvalidParam.InviteId.InvalidId', 'message' => 'No invitation record found based on inviteId.', 'http_code' => 400, 'description' => 'No invitation record found based on request ID'], + ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'This uid is not your EU.', 'http_code' => 400, 'description' => 'This user is not your distribution customer'], + ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'The current customer does not belong to this partner.', 'http_code' => 400, 'description' => 'Current customer does not belong to this partner'], + ['code' => 'InvalidParam.Uid.QuotaListEndDateNullError', 'message' => 'No End Time.', 'http_code' => 400, 'description' => 'End time is empty'], + ['code' => 'InvalidParam.Uid.QuotaListStartDateNullError', 'message' => 'No Start Time.', 'http_code' => 400, 'description' => 'The start time is empty.'], + ['code' => 'InvalidRequest.ExportTask.SceneCodeError', 'message' => 'The exporting scenario is incorrect.', 'http_code' => 400, 'description' => 'Export Scene Error'], + ['code' => 'InvalidRequest.ExportTask.SceneCodeNull', 'message' => 'The exporting scenario is empty.', 'http_code' => 400, 'description' => 'The exported scene is empty.'], + ['code' => 'InvalidRequest.NoPermissions', 'message' => 'No permissions for the operation.', 'http_code' => 400, 'description' => 'You do not have permission to perform this operation.'], + ['code' => 'InvalidRequest.NoPermissions.NotPartner', 'message' => 'The current caller is not a partner.', 'http_code' => 400, 'description' => 'The current caller is not an eco-partner'], + ['code' => 'InvalidRequest.NoPermissions.RamNoPermission', 'message' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'http_code' => 400, 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommissionDetailFileList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenewalRateList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerOrderList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBillDetailFileList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrderList'], + ], + ], + 'ram' => [ + 'productCode' => 'Agency', + 'productName' => 'Alibaba Cloud Channel Partner', + 'ramCodes' => ['agency'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetIntlCommissionDetailFileList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'agency:GetIntlCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssSecurityToken', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + ], + [ + 'apiName' => 'GetCommissionDetailFileList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssBucketName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + ], + [ + 'apiName' => 'GetSubPartnerOrderList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssEndpoint', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + ], + [ + 'apiName' => 'GetRenewalRateList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetRenewalRateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssRegion', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + ], + [ + 'apiName' => 'GetBillDetailFileList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetBillDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', - ], - 'Code' => [ - 'description' => 'code', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PartnerUid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1112332432', - ], - 'BillMonth' => [ - 'description' => '', - 'type' => 'string', - 'example' => '202502', - ], - 'FileList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CommissionPolicyName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FileType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FileUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1', - ], - 'FileName' => [ - 'type' => 'string', - ], - 'BucketSyncStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'GetCustomerOrderList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCustomerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + [ + 'apiName' => 'GetSubPartnerList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'agency.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |