diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/agency/2025-02-27/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/agency/2025-02-27/api-docs.php')
| -rw-r--r-- | data/zh_cn/agency/2025-02-27/api-docs.php | 2143 |
1 files changed, 811 insertions, 1332 deletions
diff --git a/data/zh_cn/agency/2025-02-27/api-docs.php b/data/zh_cn/agency/2025-02-27/api-docs.php index b44e988..11901c9 100644 --- a/data/zh_cn/agency/2025-02-27/api-docs.php +++ b/data/zh_cn/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', 'GetSubPartnerOrderList', 'GetSubPartnerList', 'GetRenewalRateList', 'GetCustomerOrderList', 'GetCommissionDetailFileList', 'GetIntlCommissionDetailFileList'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetBillDetailFileList' => [ - 'summary' => '查询账单导出文件。', 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34,82 +17,42 @@ ], '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' => '月份', 'type' => 'string', 'required' => true, 'example' => '202502', 'pattern' => '^\\d+$'], ], [ 'name' => 'OssAccessKeyId', 'in' => 'query', - 'schema' => [ - 'description' => '上传文件到OSS使用的AccessKeyID', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeyID', - ], + 'schema' => ['description' => '上传文件到OSS使用的AccessKeyID', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID'], ], [ 'name' => 'OssAccessKeySecret', 'in' => 'query', - 'schema' => [ - 'description' => '上传文件到OSS使用的AccessKeySecret', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeySecret', - ], + 'schema' => ['description' => '上传文件到OSS使用的AccessKeySecret', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret'], ], [ 'name' => 'OssSecurityToken', 'in' => 'query', - 'schema' => [ - 'description' => '上传文件到OSS使用的STS token', - 'type' => 'string', - 'required' => false, - 'example' => 'yourSecurityToken', - ], + 'schema' => ['description' => '上传文件到OSS使用的STS token', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken'], ], [ 'name' => 'OssBucketName', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS存储空间。', - 'type' => 'string', - 'required' => false, - 'example' => 'yourBucketName', - ], + 'schema' => ['description' => 'OSS存储空间。', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName'], ], [ 'name' => 'OssEndpoint', 'in' => 'query', - 'schema' => [ - 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', - 'type' => 'string', - 'required' => false, - 'example' => 'http://oss-cn-beijing.aliyuncs.com', - ], + 'schema' => ['description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com'], ], [ 'name' => 'OssRegion', 'in' => 'query', - 'schema' => [ - 'description' => '当前OSS Bucket 所属地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '当前OSS Bucket 所属地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], ], 'responses' => [ @@ -119,22 +62,9 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '210bc4b416874189683843905d9f9a', - ], - 'Code' => [ - 'description' => '状态code', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '提示信息', - 'type' => 'string', - 'example' => '成功', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210bc4b416874189683843905d9f9a'], + 'Code' => ['description' => '状态code', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => '成功'], 'Data' => [ 'description' => '返回数据', 'type' => 'array', @@ -142,76 +72,57 @@ 'description' => '返回数据', 'type' => 'object', 'properties' => [ - 'BillMonth' => [ - 'description' => '月份', - 'type' => 'string', - 'example' => '202502', - ], - 'FileName' => [ - 'description' => '文件名称', - 'type' => 'string', - 'example' => '账单202502021112', - ], - 'Type' => [ - 'description' => '类型：拓客、拓渠', - 'type' => 'string', - 'example' => '拓渠', - ], - 'FileUrl' => [ - 'description' => '文件urk', - 'type' => 'string', - 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1', - ], - 'Status' => [ - 'description' => 'OSS文件推送状态。1：待处理，2：处理中，3：完成', - 'type' => 'string', - 'example' => '3', - ], + 'BillMonth' => ['description' => '月份', 'type' => 'string', 'example' => '202502'], + 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => '账单202502021112'], + 'Type' => ['description' => '类型：拓客、拓渠', 'type' => 'string', 'example' => '拓渠'], + 'FileUrl' => ['description' => '文件urk', 'type' => 'string', 'example' => 'aps.ailyun.com/file/download?resourceId=1234&type=1'], + 'Status' => ['description' => 'OSS文件推送状态。1：待处理，2：处理中，3：完成', 'type' => 'string', 'example' => '3'], ], ], ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Msg' => [ - 'description' => '同message', - 'type' => 'string', - 'example' => '成功', - ], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Msg' => ['description' => '同message', 'type' => 'string', 'example' => '成功'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询账单导出文件', + 'summary' => '查询账单导出文件。', + 'changeSet' => [ + ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-04-17T02:40:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBillDetailFileList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetBillDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', '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"}]', - 'title' => '查询账单导出文件', ], - 'GetSubPartnerOrderList' => [ - 'summary' => '查询拓渠订单。', + 'GetCommissionDetailFileList' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -219,87 +130,200 @@ ], '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' => '二级伙伴UID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123432311', - ], + 'schema' => ['description' => '账单月份', 'type' => 'string', 'required' => false, 'example' => '202501'], ], [ - 'name' => 'SubPartnerName', + 'name' => 'OssAccessKeyId', 'in' => 'query', + 'schema' => ['description' => '上传文件到OSS使用的AccessKeyID', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID'], + ], + [ + 'name' => 'OssAccessKeySecret', + 'in' => 'query', + 'schema' => ['description' => '上传文件到OSS使用的AccessKeySecret', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret'], + ], + [ + 'name' => 'OssSecurityToken', + 'in' => 'query', + 'schema' => ['description' => '上传文件到OSS使用的STS token', 'type' => 'string', 'required' => false, 'example' => 'yourSecurityToken'], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => ['description' => 'OSS存储空间', 'type' => 'string', 'required' => false, 'example' => 'yourBucketName'], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', 'type' => 'string', 'required' => false, 'example' => 'http://oss-cn-beijing.aliyuncs.com'], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => ['description' => '当前OSS Bucket 所属地域', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '二级伙伴名称', - 'type' => 'string', - 'required' => false, - 'example' => 'XXX有限公司', + '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' => '伙伴uid', 'type' => 'string', 'example' => '1112332432'], + 'BillMonth' => ['description' => '账单月份', 'type' => 'string', 'example' => '202502'], + 'FileList' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件列表对象', + 'type' => 'object', + 'properties' => [ + 'CommissionPolicyName' => ['description' => '政策名称', 'type' => 'string', 'example' => '参考【APS佣金查询下载功能】的政策名称'], + 'FileType' => ['description' => '文件类型', 'type' => 'string', 'example' => '总代政策为拓渠、普通政策为拓客'], + 'FileUrl' => ['description' => '文件url', 'type' => 'string', 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1'], + 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => '佣金202502021112'], + 'BucketSyncStatus' => ['description' => 'OSS文件推送状态：处理中、处理成功、处理失败', 'type' => 'string', 'example' => '处理中'], + ], + ], + ], + ], + ], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => '成功'], + 'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询伙伴佣金明细', + 'summary' => '查询伙伴佣金明细。', + 'changeSet' => [ + ['createdAt' => '2025-04-23T01:39:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + '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' => '全部资源', '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' => '查询伙伴拓客订单。', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => '页号'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '10', 'title' => '分页大小'], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => ['description' => '客户UID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => '客户UID'], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => ['description' => '客户账号', 'type' => 'string', 'required' => false, 'example' => 'test_123', 'title' => '客户账号'], + ], + [ + 'name' => 'RamAccountForCustomerManager', + 'in' => 'query', + 'schema' => ['description' => '客户跟进员工', 'type' => 'string', 'required' => false, 'example' => '1234532', 'title' => '客户跟进员工'], + ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '商机ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '202501101023', - ], + 'schema' => ['description' => '商机ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '202502002231', 'title' => '商机ID'], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '订单号', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '209335720330622', - ], + 'schema' => ['description' => '订单号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13595216', 'title' => '订单号'], ], [ 'name' => 'OrderTypeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '订单类型列表。'."\n" - .'订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" - .'RENEW、REFUND、OTHERS', + 'description' => '订单类型列表', 'type' => 'array', 'items' => [ - 'description' => '订单类型列表。 订单类型包括：BUY、UPGRADE、DOWNGRADE、 RENEW、REFUND、OTHERS', + 'description' => '订单类型：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', 'type' => 'string', 'required' => false, 'example' => 'BUY', + 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'], + 'title' => '订单类型列表', ], 'required' => false, + 'title' => '订单类型列表', ], ], [ 'name' => 'OrderStatus', 'in' => 'query', 'schema' => [ - 'description' => '订单状态。包括：'."\n" - .'1：未支付'."\n" - .'2：已支付'."\n" - .'3：作废', + 'description' => '订单状态：'."\n" + .'- 1 未支付'."\n" + .'- 2 已废弃'."\n" + .'- 3 已支付', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => false, - 'maximum' => '3', - 'minimum' => '1', 'example' => '3', + 'enum' => ['1', '2', '3'], + 'title' => '订单状态：'."\n" + .'- 1 未支付'."\n" + .'- 2 已废弃'."\n" + .'- 3 已支付', ], ], [ @@ -310,127 +334,62 @@ .'1：非代付；'."\n" .'2：代付', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => false, - 'maximum' => '2', - 'minimum' => '1', 'example' => '1', + 'enum' => ['1', '2'], + 'title' => '支付类型：'."\n" + .'1：非代付；'."\n" + .'2：代付', ], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品code', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '产品code', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => '产品code'], ], [ 'name' => 'ProductName', 'in' => 'query', - 'schema' => [ - 'description' => '产品名称', - 'type' => 'string', - 'required' => false, - 'example' => '弹性计算', - ], + 'schema' => ['description' => '产品名称。', 'type' => 'string', 'required' => false, 'example' => '弹性计算', 'title' => '产品名称。'], ], [ 'name' => 'OrderCreateAfter', 'in' => 'query', - 'schema' => [ - 'description' => '"订单创建开始时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空"', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => '订单创建开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => '订单创建开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空'], ], [ 'name' => 'OrderCreateBefore', 'in' => 'query', - 'schema' => [ - 'description' => '订单创建截至时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => '订单创建截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => '订单创建截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空'], ], [ 'name' => 'OrderPayAfter', 'in' => 'query', - 'schema' => [ - 'description' => '订单支付开始时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => '订单支付开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000', 'title' => '订单支付开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空'], ], [ 'name' => 'OrderPayBefore', 'in' => 'query', - 'schema' => [ - 'description' => '订单支付截至时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => '订单支付截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000', 'title' => '订单支付截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空'], ], [ 'name' => 'PayAmountAfter', 'in' => 'query', - 'schema' => [ - 'description' => '实付起始金额', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实付起始金额', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => '实付起始金额'], ], [ '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' => ['description' => '实付截至金额', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1000', 'title' => '实付截至金额'], ], ], 'responses' => [ @@ -440,74 +399,39 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - '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' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => '总条数'], + 'PageNo' => ['description' => '页号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '页号'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '分页大小'], 'Data' => [ 'description' => '返回数据', 'type' => 'array', 'items' => [ - 'description' => '返回数据对象', + 'description' => '返回对象', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '订单Id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '236414227150922', - ], + 'OrderId' => ['description' => '订单号', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922', 'title' => '订单号'], 'OrderType' => [ - 'description' => '订单类型:'."\n" - .'- BUY: 新购'."\n" - .'- UPGRADE: 升级'."\n" - .'- DOWNGRADE: 降级'."\n" - .'- RENEW: 续费'."\n" - .'- REFUND: 退款'."\n" - .'- OTHERS: 其他', + 'description' => '订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', 'type' => 'string', 'example' => 'BUY', + 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'REFUND', 'OTHERS'], + 'title' => '订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', ], 'OrderStatus' => [ - 'description' => '订单状态：'."\n" - .'- 1 未支付'."\n" - .'- 2 已废弃'."\n" - .'- 3 已支付', + 'description' => '订单状态。包括：'."\n" + .'1：未支付'."\n" + .'2：已支付'."\n" + .'3：作废', 'type' => 'integer', 'format' => 'int32', 'example' => '3', + 'enum' => ['1', '2', '3'], + 'title' => '订单状态。包括：'."\n" + .'1：未支付'."\n" + .'2：已支付'."\n" + .'3：作废', ], 'PayType' => [ 'description' => '支付类型：'."\n" @@ -516,119 +440,79 @@ 'type' => 'integer', 'format' => 'int32', 'example' => '1', + 'enum' => ['1', '2'], + 'title' => '支付类型：'."\n" + .'1：非代付；'."\n" + .'2：代付', ], - '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' => '产品code', - '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' => '二级伙伴UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1123132', - ], - 'SubPartnerName' => [ - 'description' => '二级伙伴名称', - 'type' => 'string', - 'example' => 'xxx有限公司', - ], - 'ProjectId' => [ - 'description' => '商机ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202502233443', - ], - 'CustomerClassification' => [ - 'description' => '客户分类', - 'type' => 'string', - 'example' => 'C类', + 'Price' => ['description' => '原价/目录价', 'type' => 'number', 'format' => 'double', 'example' => '29137', 'title' => '原价/目录价'], + 'DiscountedPrice' => ['description' => '折扣价', 'type' => 'number', 'format' => 'double', 'example' => '29137', 'title' => '折扣价'], + 'AmountDue' => ['description' => '实付金额', 'type' => 'number', 'format' => 'double', 'example' => '29137', 'title' => '实付金额'], + 'DeductedAmountByCoupons' => ['description' => '代金券金额', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => '代金券金额'], + 'AmountDiscount' => ['description' => '订单折扣', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => '订单折扣'], + 'ProductCode' => ['description' => '产品code', 'type' => 'string', 'example' => 'slb', 'title' => '产品code'], + 'ProductName' => ['description' => '产品名称', 'type' => 'string', 'example' => 'slb', 'title' => '产品名称'], + 'CreatedAt' => ['description' => '创建时间', 'type' => 'string', 'example' => '2019-01-24 14:20:40', 'title' => '创建时间'], + 'PaidAt' => ['description' => '支付时间', 'type' => 'string', 'example' => '2019-01-24 14:20:40', 'title' => '支付时间'], + 'CustomerUid' => ['description' => '客户UID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => '客户UID'], + 'CustomerAccount' => ['description' => '客户账户', 'type' => 'string', 'example' => 'test_123', 'title' => '客户账户'], + 'RamAccountForCustomerManagers' => [ + 'description' => '客户跟进员工', + 'type' => 'array', + 'items' => ['description' => '客户跟进员工', 'type' => 'string', 'example' => '12345678', 'title' => '客户跟进员工'], + 'title' => '客户跟进员工', ], + 'CustomerClassification' => ['description' => '客户分类', 'type' => 'string', 'example' => 'C类', 'title' => '客户分类'], + 'ProjectId' => ['description' => '商机ID', 'type' => 'integer', 'format' => 'int64', 'example' => '202502230421', 'title' => '商机ID'], ], + 'title' => '返回对象', ], + 'title' => '返回对象', ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200', 'title' => '状态码'], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => 'success', 'title' => '提示信息'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => 'HTTP状态码'], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息', 'type' => 'string', 'example' => 'None', 'title' => '访问被拒绝详细信息'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5', 'title' => '请求ID'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true', 'title' => '是否成功'], ], ], ], ], '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' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询伙伴拓客订单', + '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"}]', - 'title' => '查询拓渠订单', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCustomerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', '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' => '下载国际伙伴佣金明细', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -636,219 +520,121 @@ ], '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' => '二级伙伴PID', - 'type' => 'string', - 'required' => false, - 'example' => '2323431211', - ], + 'schema' => ['title' => '账单月份', 'description' => '账单月份', 'type' => 'string', 'required' => true, 'example' => '202502'], ], [ - 'name' => 'SubPartnerCompanyName', + 'name' => 'OssAccessKeyId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '二级伙伴公司名称', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx有限公司', - ], + 'schema' => ['title' => '上传文件到OSS使用的AccessKeyID', 'description' => '上传文件到OSS使用的AccessKeyID', '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' => '上传文件到OSS使用的AccessKeySecret', 'description' => '上传文件到OSS使用的AccessKeySecret', 'type' => 'string', 'required' => true, 'example' => 'yourAccessKeySecret'], ], [ - 'name' => 'PageSize', + 'name' => 'OssSecurityToken', 'in' => 'query', - 'schema' => [ - 'title' => '每页返回个数，最大支持100', - 'description' => '每页返回个数，最大支持100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '上传文件到OSS使用的STS token', 'description' => '上传文件到OSS使用的STS token', 'type' => 'string', 'required' => true, 'example' => 'yourSecurityToken'], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => ['title' => 'OSS存储空间', 'description' => 'OSS存储空间', 'type' => 'string', 'required' => true, 'example' => 'yourBucketName'], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['title' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', 'type' => 'string', 'required' => true, 'example' => 'http://oss-cn-beijing.aliyuncs.com'], + ], + [ + 'name' => 'OssRegion', + 'in' => 'query', + 'schema' => ['title' => '当前OSS Bucket 所属地域', 'description' => '当前OSS Bucket 所属地域', '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' => '每页返回的二级分销商个数，最大100', - 'type' => 'string', - 'required' => true, - 'example' => '100', - ], - 'SubPartnerList' => [ - 'description' => '二级分销商列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CompanyName' => [ - 'title' => '二级分销商名称', - 'description' => '二级分销商名称', - 'type' => 'string', - 'example' => 'xxx有限公司', - ], - 'Pid' => [ - 'title' => '二级分销商pid', - 'description' => '二级分销商pid', - 'type' => 'string', - 'example' => 'P123456', - ], - 'MasterAccount' => [ - 'title' => '二级分销商主账号名称', - 'description' => '二级分销商主账号名称', - 'type' => 'string', - 'example' => 'xxxxxx有限公司主账号'."\n", - ], - 'MasterUid' => [ - 'title' => '二级分销商主账号UID', - 'description' => '二级分销商主账号UID', - 'type' => 'string', - 'example' => '123456', - ], - 'Province' => [ - 'title' => '注册地省份', - 'description' => '注册地省份', - 'type' => 'string', - 'example' => '浙江省', - ], - 'City' => [ - 'title' => '注册地城市', - 'description' => '注册地城市', - 'type' => 'string', - 'example' => '杭州市', - ], - 'District' => [ - 'title' => '注册地区县', - 'description' => '注册地区县', - 'type' => 'string', - 'example' => '西湖区', - ], - 'Address' => [ - 'title' => '注册地详细地址', - 'description' => '注册地详细地址', - 'type' => 'string', - 'example' => 'xxx街道xxx号', - ], - 'AgreementStatus' => [ - 'title' => '合约状态编码', - 'description' => '合约状态编码', - 'type' => 'string', - 'enumValueTitles' => [ - 'RESTRICTED_OPENING' => '受限开通期', - 'CALM_DOWN_PERIOD' => '冷静期', - 'ACTIVE_PERIOD' => '生效期', + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'], + 'Code' => ['title' => '返回code', 'description' => '状态code', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'title' => '返回数据对象', + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'PartnerUid' => ['title' => '伙伴uid', 'description' => '伙伴uid', 'type' => 'string', 'example' => '1112332432'], + 'BillMonth' => ['title' => '账单月份', 'description' => '账单月份', 'type' => 'string', 'example' => '202502'], + 'FileList' => [ + 'title' => '文件列表对象', + 'description' => '文件列表对象', + 'type' => 'array', + 'items' => [ + 'title' => '文件列表对象', + 'description' => '文件列表对象', + 'type' => 'object', + 'properties' => [ + 'CommissionPolicyName' => ['title' => '政策名称', 'description' => '政策名称', 'type' => 'string', 'example' => '202606_FY27_TEST'], + 'FileName' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'example' => '202606_FY27_TEST_4397912340.xlsx'], + 'BucketSyncStatus' => [ + 'title' => 'OSS文件推送状态：初始化状态，处理中，处理成功，处理失败', + 'description' => 'OSS文件推送状态：初始化状态、处理中、处理成功、处理失败', + 'type' => 'string', + 'enumValueTitles' => ['处理失败' => 'FAIL', '初始化状态' => 'INIT', '处理成功' => 'SUCCESS', '处理中' => 'PROCESSING'], + 'example' => 'PROCESSING', + ], ], - 'example' => 'ACTIVE_PERIOD', - ], - 'AgreementStatusDesc' => [ - 'title' => '合约状态描述', - 'description' => '合约状态描述', - 'type' => 'string', - 'example' => '生效期', - ], - 'JoinTime' => [ - 'title' => '首次入驻时间', - 'description' => '首次入驻时间', - 'type' => 'string', - 'example' => '2000-01-01', - ], - 'Contact' => [ - 'title' => '联系人名称', - 'description' => '联系人名称', - 'type' => 'string', - 'example' => '张三', ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', - ], - 'Success' => [ - 'description' => '调用是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '提示信息', - 'type' => 'string', - 'example' => '成功', - ], + 'Message' => ['title' => '结果信息', 'description' => 'message信息', 'type' => 'string', 'example' => 'SUCCESS'], + 'Success' => ['title' => '调用是否成功。', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], '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' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '下载国际伙伴佣金账单', + 'description' => '确保当前调用账号身份为T1分销伙伴 '."\n" + .'<notice>仅国际提供></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"}]', - 'title' => '查询二级分销商列表', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'agency:GetIntlCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', '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' => [], @@ -856,21 +642,12 @@ ], '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' => '财年季度', 'type' => 'string', 'required' => true, 'example' => '2025Q4'], ], ], 'responses' => [ @@ -880,22 +657,9 @@ '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' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => '成功'], 'Data' => [ 'description' => '返回数据', 'type' => 'array', @@ -903,199 +667,74 @@ 'description' => '返回数据对象', 'type' => 'object', 'properties' => [ - 'FiscalYearAndQuarter' => [ - 'description' => '财年季度', - 'type' => 'string', - 'example' => '2025Q4', - ], - 'MasterPid' => [ - 'description' => '伙伴PID', - 'type' => 'string', - 'example' => 'P123423453', - ], - 'MasterPidName' => [ - 'description' => '伙伴PID名称', - 'type' => 'string', - 'example' => 'XX有限公司', - ], - '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' => '财年季度', 'type' => 'string', 'example' => '2025Q4'], + 'MasterPid' => ['description' => '伙伴PID', 'type' => 'string', 'example' => 'P123423453'], + 'MasterPidName' => ['description' => '伙伴PID名称', 'type' => 'string', 'example' => 'XX有限公司'], + 'FinalRenewalRate' => ['description' => '最终佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], + 'FinalRenewalAmountDue' => ['description' => '最终应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalRenewedAmount' => ['description' => '最终已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalOtherBillAmount' => ['description' => '新升后退金额总计', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalCustomerRenewalRate' => ['description' => '拓客佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], + 'FinalCustomerRenewalAmountDue' => ['description' => '拓客应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalCustomerRenewedAmount' => ['description' => '拓客已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'CustomerAdjustedRenewalAmountDue' => ['description' => '拓客调整后应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'CustomerOtherBillAmount' => ['description' => '拓客新升后退金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalSubPartnerRenewalRate' => ['description' => '拓渠佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.85'], + 'FinalSubPartnerRenewalAmountDue' => ['description' => '拓渠应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'FinalSubPartnerRenewedAmount' => ['description' => '拓渠已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SubPartnerAdjustedRenewalAmountDue' => ['description' => '拓渠调整后应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SubPartnerOtherBillAmount' => ['description' => '拓渠新升后退', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialFinalRenewRatio' => ['description' => '含特批最终季度佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.7'], + 'SpecialFinalRenewalAmountDue' => ['description' => '含特批最终季度佣金应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialFinalRenewedAmount' => ['description' => '含特批最终季度佣金已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialCustomerRenewRatio' => ['description' => '含特批拓客佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.7'], + 'SpecialCustomerRenewalAmountDue' => ['description' => '含特批拓客应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialCustomerRenewedAmount' => ['description' => '含特批拓客已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialSubPartnerRenewRatio' => ['description' => '含特批拓渠佣金续费率', 'type' => 'number', 'format' => 'double', 'example' => '0.8'], + 'SpecialSubPartnerRenewalAmountDue' => ['description' => '含特批拓渠应续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], + 'SpecialSubPartnerRenewedAmount' => ['description' => '含特批拓渠已续金额', 'type' => 'number', 'format' => 'double', 'example' => '100'], ], ], ], - 'Success' => [ - 'description' => '调用是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询伙伴续费率', + 'summary' => '查询伙伴续费率。', + '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' => '全部资源', '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"}]', - 'title' => '查询伙伴续费率', ], - 'GetCustomerOrderList' => [ - 'summary' => '查询伙伴拓客订单。', + 'GetSubPartnerList' => [ 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1103,240 +742,222 @@ ], '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' => '二级伙伴PID', 'type' => 'string', 'required' => false, 'example' => '2323431211'], + ], + [ + 'name' => 'SubPartnerCompanyName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '二级伙伴公司名称', 'type' => 'string', 'required' => false, 'example' => 'xxx有限公司'], + ], + [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['title' => '分页索引，从第一页开始', 'description' => '分页索引，从第一页开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['title' => '每页返回个数，最大支持100', 'description' => '每页返回个数，最大支持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' => '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' => '每页返回的二级分销商个数，最大100', 'type' => 'string', 'required' => true, 'example' => '100'], + 'SubPartnerList' => [ + 'description' => '二级分销商列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CompanyName' => ['title' => '二级分销商名称', 'description' => '二级分销商名称', 'type' => 'string', 'example' => 'xxx有限公司'], + 'Pid' => ['title' => '二级分销商pid', 'description' => '二级分销商pid', 'type' => 'string', 'example' => 'P123456'], + 'MasterAccount' => ['title' => '二级分销商主账号名称', 'description' => '二级分销商主账号名称', 'type' => 'string', 'example' => 'xxxxxx有限公司主账号'."\n"], + 'MasterUid' => ['title' => '二级分销商主账号UID', 'description' => '二级分销商主账号UID', 'type' => 'string', 'example' => '123456'], + 'Province' => ['title' => '注册地省份', 'description' => '注册地省份', 'type' => 'string', 'example' => '浙江省'], + 'City' => ['title' => '注册地城市', 'description' => '注册地城市', 'type' => 'string', 'example' => '杭州市'], + 'District' => ['title' => '注册地区县', 'description' => '注册地区县', 'type' => 'string', 'example' => '西湖区'], + 'Address' => ['title' => '注册地详细地址', 'description' => '注册地详细地址', 'type' => 'string', 'example' => 'xxx街道xxx号'], + 'AgreementStatus' => [ + 'title' => '合约状态编码', + 'description' => '合约状态编码', + 'type' => 'string', + 'enumValueTitles' => ['RESTRICTED_OPENING' => '受限开通期', 'CALM_DOWN_PERIOD' => '冷静期', 'ACTIVE_PERIOD' => '生效期'], + 'example' => 'ACTIVE_PERIOD', + ], + 'AgreementStatusDesc' => ['title' => '合约状态描述', 'description' => '合约状态描述', 'type' => 'string', 'example' => '生效期'], + 'JoinTime' => ['title' => '首次入驻时间', 'description' => '首次入驻时间', 'type' => 'string', 'example' => '2000-01-01'], + 'Contact' => ['title' => '联系人名称', 'description' => '联系人名称', 'type' => 'string', 'example' => '张三'], + ], + 'description' => '', + ], + ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => '成功'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询二级分销商列表', + 'summary' => '查询二级分销商列表。', + 'changeSet' => [ + ['createdAt' => '2025-03-27T08:12:31.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubPartnerList'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CustomerUid', - 'in' => 'query', - 'schema' => [ - 'description' => '客户UID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', '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' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'CustomerAccount', + 'name' => 'SubPartnerUid', 'in' => 'query', - 'schema' => [ - 'description' => '客户账号', - 'type' => 'string', - 'required' => false, - 'example' => 'test_123', - ], + 'schema' => ['description' => '二级伙伴UID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123432311'], ], [ - 'name' => 'RamAccountForCustomerManager', + 'name' => 'SubPartnerName', 'in' => 'query', - 'schema' => [ - 'description' => '客户跟进员工', - 'type' => 'string', - 'required' => false, - 'example' => '1234532', - ], + 'schema' => ['description' => '二级伙伴名称', 'type' => 'string', 'required' => false, 'example' => 'XXX有限公司'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '商机ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '202502002231', - ], + 'schema' => ['description' => '商机ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '202501101023'], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '订单号', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13595216', - ], + 'schema' => ['description' => '订单号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '209335720330622'], ], [ 'name' => 'OrderTypeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '订单类型列表', + 'description' => '订单类型列表。'."\n" + .'订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', 'type' => 'array', - 'items' => [ - 'description' => '订单类型：BUY、UPGRADE、DOWNGRADE、'."\n" - .'RENEW、REFUND、OTHERS', - 'type' => 'string', - 'required' => false, - 'example' => 'BUY', - 'enum' => [ - 'BUY', - 'UPGRADE', - 'DOWNGRADE', - 'RENEW', - 'REFUND', - 'OTHERS', - ], - ], + 'items' => ['description' => '订单类型列表。 订单类型包括：BUY、UPGRADE、DOWNGRADE、 RENEW、REFUND、OTHERS', 'type' => 'string', 'required' => false, 'example' => 'BUY'], 'required' => false, ], ], [ 'name' => 'OrderStatus', 'in' => 'query', - 'schema' => [ - 'description' => '订单状态：'."\n" - .'- 1 未支付'."\n" - .'- 2 已废弃'."\n" - .'- 3 已支付', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'enum' => [ - '1', - '2', - '3', - ], - ], + 'schema' => ['description' => '订单状态。包括：'."\n" + .'1：未支付'."\n" + .'2：已支付'."\n" + .'3：作废', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '3', 'minimum' => '1', 'example' => '3'], ], [ 'name' => 'PayType', 'in' => 'query', - 'schema' => [ - 'description' => '支付类型：'."\n" - .'1：非代付；'."\n" - .'2：代付', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - '2', - ], - ], + 'schema' => ['description' => '支付类型：'."\n" + .'1：非代付；'."\n" + .'2：代付', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'example' => '1'], ], [ 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品code', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => '产品code', 'type' => 'string', 'required' => false, 'example' => 'ecs'], ], [ 'name' => 'ProductName', 'in' => 'query', - 'schema' => [ - 'description' => '产品名称。', - 'type' => 'string', - 'required' => false, - 'example' => '弹性计算', - ], + 'schema' => ['description' => '产品名称', 'type' => 'string', 'required' => false, 'example' => '弹性计算'], ], [ 'name' => 'OrderCreateAfter', 'in' => 'query', - 'schema' => [ - 'description' => '订单创建开始时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => '"订单创建开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空"', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000'], ], [ 'name' => 'OrderCreateBefore', 'in' => 'query', - 'schema' => [ - 'description' => '订单创建截至时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => '订单创建截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000'], ], [ 'name' => 'OrderPayAfter', 'in' => 'query', - 'schema' => [ - 'description' => '订单支付开始时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1727789348000', - ], + 'schema' => ['description' => '订单支付开始时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727789348000'], ], [ 'name' => 'OrderPayBefore', 'in' => 'query', - 'schema' => [ - 'description' => '订单支付截至时间戳。时间范围不超过6个月'."\n" - .'订单创建时间范围与订单支付时间范围不可同时为空', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1741008566000', - ], + 'schema' => ['description' => '订单支付截至时间戳。时间范围不超过6个月'."\n" + .'订单创建时间范围与订单支付时间范围不可同时为空', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1741008566000'], ], [ 'name' => 'PayAmountAfter', 'in' => 'query', - 'schema' => [ - 'description' => '实付起始金额', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实付起始金额', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PayAmountBefore', 'in' => 'query', - 'schema' => [ - 'description' => '实付截至金额', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => '实付截至金额', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '10', 'example' => '20'], ], ], 'responses' => [ @@ -1346,418 +967,276 @@ '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' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'], + 'PageNo' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '提示信息', 'type' => 'string', 'example' => '成功'], 'Data' => [ 'description' => '返回数据', 'type' => 'array', 'items' => [ - 'description' => '返回对象', + 'description' => '返回数据对象', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '订单号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '236414227150922', - ], - 'OrderType' => [ - 'description' => '订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" - .'RENEW、REFUND、OTHERS', - 'type' => 'string', - 'example' => 'BUY', - 'enum' => [ - 'BUY', - 'UPGRADE', - 'DOWNGRADE', - 'RENEW', - 'REFUND', - 'OTHERS', - ], - ], - 'OrderStatus' => [ - 'description' => '订单状态。包括：'."\n" - .'1：未支付'."\n" - .'2：已支付'."\n" - .'3：作废', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'enum' => [ - '1', - '2', - '3', - ], - ], - 'PayType' => [ - 'description' => '支付类型：'."\n" - .'1：非代付；'."\n" - .'2：代付', - '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' => '产品code', - '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' => '客户UID', - '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' => 'C类', - ], - 'ProjectId' => [ - 'description' => '商机ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202502230421', - ], + 'OrderId' => ['description' => '订单Id', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922'], + 'OrderType' => ['description' => '订单类型:'."\n" + .'- BUY: 新购'."\n" + .'- UPGRADE: 升级'."\n" + .'- DOWNGRADE: 降级'."\n" + .'- RENEW: 续费'."\n" + .'- REFUND: 退款'."\n" + .'- OTHERS: 其他', 'type' => 'string', 'example' => 'BUY'], + 'OrderStatus' => ['description' => '订单状态：'."\n" + .'- 1 未支付'."\n" + .'- 2 已废弃'."\n" + .'- 3 已支付', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PayType' => ['description' => '支付类型：'."\n" + .'1：非代付；'."\n" + .'2：代付', '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' => '产品code', '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' => '二级伙伴UID', 'type' => 'integer', 'format' => 'int64', 'example' => '1123132'], + 'SubPartnerName' => ['description' => '二级伙伴名称', 'type' => 'string', 'example' => 'xxx有限公司'], + 'ProjectId' => ['description' => '商机ID', 'type' => 'integer', 'format' => 'int64', 'example' => '202502233443'], + 'CustomerClassification' => ['description' => '客户分类', 'type' => 'string', 'example' => 'C类'], ], ], ], - 'Code' => [ - 'description' => '状态码', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '提示信息', - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息', - 'type' => 'string', - 'example' => 'None', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2103a30617045934095083027d88c5', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', - 'errorMessage' => 'The current caller is not a partner.', - ], - [ - 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', - 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', - ], + ['errorCode' => 'InvalidRequest.NoPermissions.NotPartner', 'errorMessage' => 'The current caller is not a partner.', 'description' => '当前调用者不是生态伙伴'], + ['errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'description' => '无权操作，请检查Ram账号权限配置'], ], ], - '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"}]', - 'title' => '查询伙伴拓客订单', - ], - 'GetCommissionDetailFileList' => [ - 'summary' => '查询伙伴佣金明细。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询拓渠订单', + 'summary' => '查询拓渠订单。', + 'changeSet' => [ + ['createdAt' => '2025-05-29T12:18:35.000Z', 'description' => '响应参数发生变更'], ], - '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' => [ - 'description' => '上传文件到OSS使用的AccessKeyID', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeyID', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'OssAccessKeySecret', - 'in' => 'query', - 'schema' => [ - 'description' => '上传文件到OSS使用的AccessKeySecret', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeySecret', + ], + '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'agency.ap-southeast-1.aliyuncs.com', 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '系统异常'], + ['code' => 'Error3008', 'message' => 'shutdown status is error.', 'http_code' => 400, 'description' => 'shutdown status字段错误'], + ['code' => 'Error3009', 'message' => 'customerAccount is error.', 'http_code' => 400, 'description' => 'customerAccount字段错误'], + ['code' => 'Error3010', 'message' => 'customerNick is empty.', 'http_code' => 400, 'description' => 'customerNick字段为空'], + ['code' => 'Error3011', 'message' => 'The length of customerNick greater than 50.', 'http_code' => 400, 'description' => 'customerNick字段长度大于50'], + ['code' => 'Error3012', 'message' => 'cid is empty.', 'http_code' => 400, 'description' => 'cid 字段为空'], + ['code' => 'Error3013', 'message' => 'customCredit is empty.', 'http_code' => 400, 'description' => 'customCredit字段错误'], + ['code' => 'Error3014', 'message' => 'customCredit is a maximum of 10.', 'http_code' => 400, 'description' => 'customCredit最大为10'], + ['code' => 'Error3015', 'message' => 'The current account is not a partner.', 'http_code' => 400, 'description' => '当前账号不是分销商'], + ['code' => 'Error3016', 'message' => 'customerRebateType is error, only invite agency account.', 'http_code' => 400, 'description' => 'customerRebateType字段错误,只能发展agency的客户'], + ['code' => 'Error3017', 'message' => 'customerRebateType is error, only invite reseller account.', 'http_code' => 400, 'description' => 'customerRebateType字段错误,只能发展reseller的客户'], + ['code' => 'Error3030', 'message' => 'The maximum length of CustomNick is 150.', 'http_code' => 400, 'description' => 'CustomNick最大长度为150'], + ['code' => 'Error3031', 'message' => 'The maximum length of FxDescription is 3000.', 'http_code' => 400, 'description' => 'FxDescription最大长度为3000'], + ['code' => 'Error3040', 'message' => 'The account is in a frozen state and cannot be operated.', 'http_code' => 400, 'description' => '账号出于冻结状态，不能操作'], + ['code' => 'Error3043', 'message' => 'The range of ShutdownStatus can only be 1 and 2.', 'http_code' => 400, 'description' => 'ShutdownStatus的值域只能是1和2'], + ['code' => 'Error3044', 'message' => 'The Value is not a number.', 'http_code' => 400, 'description' => '值不是数字'], + ['code' => 'Error3045', 'message' => 'The value must be between 1-100.', 'http_code' => 400, 'description' => '值必须在1-100'], + ['code' => 'Error3051', 'message' => 'input accounStatus value error, It must be 1,2,3.', 'http_code' => 400, 'description' => '输入AccounStatus的值错误，必须为1，2或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为空'], + ['code' => 'Error3056', 'message' => 'The value of subAccountType error.', 'http_code' => 400, 'description' => 'subAccountType的值错误'], + ['code' => 'Error3058', 'message' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'http_code' => 400, 'description' => '频繁发送邮件流控限制 5分钟内发送10份邮件'], + ['code' => 'Error3067', 'message' => 'Enterprise Customer Invitation Prohibition.', 'http_code' => 400, 'description' => '禁止邀请企业客户'], + ['code' => 'ERROR_1002', 'message' => 'No query permission.', 'http_code' => 400, 'description' => '无查询权限'], + ['code' => 'ERROR_1003', 'message' => 'No permission to operate the object.', 'http_code' => 400, 'description' => '无该对象操作权限'], + ['code' => 'ERROR_201', 'message' => 'Parameters are illegal and required fields are empty.', 'http_code' => 400, 'description' => '参数不合法，必填项为空'], + ['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' => '优惠券非正常状态或为阿里云承担成本的优惠券不可作废'], + ['code' => 'ERROR_2310', 'message' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'http_code' => 400, 'description' => '优惠券模板存在审批中的发放记录，不可取消'], + ['code' => 'ERROR_2311', 'message' => 'Coupon template does not exist.', 'http_code' => 400, 'description' => '优惠券模板不存在'], + ['code' => 'ERROR_3070', 'message' => 'CouponTemplateName must be entered.', 'http_code' => 400, 'description' => '模板名称 必须输入'], + ['code' => 'ERROR_3071', 'message' => 'ApplicableProducts empty, please check.', 'http_code' => 400, 'description' => '适用产品为空，请检查'], + ['code' => 'ERROR_3072', 'message' => 'itemCodes empty, please check.', 'http_code' => 400, 'description' => '自定义产品为空，请检查'], + ['code' => 'ERROR_3073', 'message' => 'amout empty, please check.', 'http_code' => 400, 'description' => '面额为空，请检查'], + ['code' => 'ERROR_3074', 'message' => 'personLimit empty, please check.', 'http_code' => 400, 'description' => '每人限领为空，请检查'], + ['code' => 'ERROR_3075', 'message' => 'applyReason empty, please check.', 'http_code' => 400, 'description' => '模版申请原因为空，请检查'], + ['code' => 'ERROR_3076', 'message' => 'effDateType empty, please check.', 'http_code' => 400, 'description' => '时间类型为空，请检查'], + ['code' => 'ERROR_3077', 'message' => 'effDateDay empty, please check.', 'http_code' => 400, 'description' => '生效持续时间为空，请检查'], + ['code' => 'ERROR_3078', 'message' => 'effDateFrom empty, please check.', 'http_code' => 400, 'description' => '生效时间的开始时间为空，请检查'], + ['code' => 'ERROR_3079', 'message' => 'effDateTo empty, please check.', 'http_code' => 400, 'description' => '生效时间的结束时间为空，请检查'], + ['code' => 'ERROR_3080', 'message' => 'Account empty, please check.', 'http_code' => 400, 'description' => '认证账号为空，请检查'], + ['code' => 'ERROR_3081', 'message' => 'couponTemplateId empty, please check.', 'http_code' => 400, 'description' => '优惠券模版ID为空，请检查'], + ['code' => 'ERROR_3082', 'message' => 'Uidlist empty, please check .', 'http_code' => 400, 'description' => 'uid列表为空，请检查'], + ['code' => 'ERROR_3084', 'message' => 'Coupon cannot be valid for more than 180 days.', 'http_code' => 400, 'description' => '阿里云承担成本优惠券最大有效期为180天'], + ['code' => 'ERROR_3085', 'message' => 'Product code is not in international channel partner coupons deductable product list.', 'http_code' => 400, 'description' => '产品code不在国际渠道可售卖范围'], + ['code' => 'ERROR_3087', 'message' => 'The current uid is not the end user identity, can not issue coupons.', 'http_code' => 400, 'description' => '当前uid非终端客户身份，无法发放优惠券'], + ['code' => 'ERROR_3088', 'message' => 'Coupon template expired, unable to issue coupon.', 'http_code' => 400, 'description' => '优惠券模板过期，无法发放优惠券'], + ['code' => 'ERROR_3089', 'message' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'http_code' => 400, 'description' => '优惠券模板发放超过限制，无法发放优惠券'], + ['code' => 'ERROR_3090', 'message' => 'You have no authority.', 'http_code' => 400, 'description' => '当前登录账号没有发放优惠券的权限'], + ['code' => 'ERROR_3091', 'message' => 'Coupon template name length over limit.', 'http_code' => 400, 'description' => '优惠券模版名字长度过长（30）'], + ['code' => 'ERROR_3092', 'message' => 'Reason for template request length over limit.', 'http_code' => 400, 'description' => '模板申请原因长度过长（100）'], + ['code' => 'ERROR_3093', 'message' => 'Coupon cost-bearer parameters are not legal.', 'http_code' => 400, 'description' => '优惠券成本承担方参数不合法'], + ['code' => 'ERROR_3094', 'message' => 'Applicable product type parameters are not legal.', 'http_code' => 400, 'description' => '适用产品类型参数不合法'], + ['code' => 'ERROR_3095', 'message' => 'The per-person limit is illegal.', 'http_code' => 400, 'description' => '每人限领不合法 '], + ['code' => 'ERROR_3096', 'message' => 'Coupon value is illegal.', 'http_code' => 400, 'description' => '面额不合法 （不是正整数）'], + ['code' => 'ERROR_3097', 'message' => 'Time type is illegal.', 'http_code' => 400, 'description' => '时间类型不合法'], + ['code' => 'ERROR_3098', 'message' => 'Coupon Remarks Information length over limit.', 'http_code' => 400, 'description' => ' 券备注信息过长（100）'], + ['code' => 'ERROR_3099', 'message' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => '优惠券生效时间的开始时间不能早于当前时间'], + ['code' => 'ERROR_3100', 'message' => 'System exceptions, please submit a work order.', 'http_code' => 400, 'description' => '系统通用异常，请提交工单'], + ['code' => 'ERROR_3101', 'message' => 'PurchaseType empty, please check .', 'http_code' => 400, 'description' => '订单类型为空，请检查'], + ['code' => 'ERROR_3102', 'message' => 'This coupon template ID was not created by this account.', 'http_code' => 400, 'description' => '该优惠券模板ID不是此账号创建'], + ['code' => 'ERROR_3103', 'message' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => '优惠券生效时间的结束时间不能早于当前时间'], + ['code' => 'ERROR_3210', 'message' => 'The current calling UID is not an international channel partner.', 'http_code' => 400, 'description' => '当前调用UID不是国际渠道伙伴'], + ['code' => 'InvalidParam.InviteId.InvalidId', 'message' => 'No invitation record found based on inviteId.', 'http_code' => 400, 'description' => '根据请求ID没有找到邀请记录'], + ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'This uid is not your EU.', 'http_code' => 400, 'description' => '该用户不是您的分销客户'], + ['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'The current customer does not belong to this partner.', 'http_code' => 400, 'description' => '当前客户不归属于此伙伴'], + ['code' => 'InvalidParam.Uid.QuotaListEndDateNullError', 'message' => 'No End Time.', 'http_code' => 400, 'description' => '结束时间为空'], + ['code' => 'InvalidParam.Uid.QuotaListStartDateNullError', 'message' => 'No Start Time.', 'http_code' => 400, 'description' => '开始时间为空。'], + ['code' => 'InvalidRequest.ExportTask.SceneCodeError', 'message' => 'The exporting scenario is incorrect.', 'http_code' => 400, 'description' => '导出场景错误'], + ['code' => 'InvalidRequest.ExportTask.SceneCodeNull', 'message' => 'The exporting scenario is empty.', 'http_code' => 400, 'description' => '导出场景为空。'], + ['code' => 'InvalidRequest.NoPermissions', 'message' => 'No permissions for the operation.', 'http_code' => 400, 'description' => '没有执行此操作的权限。'], + ['code' => 'InvalidRequest.NoPermissions.NotPartner', 'message' => 'The current caller is not a partner.', 'http_code' => 400, 'description' => '当前调用者不是生态伙伴'], + ['code' => 'InvalidRequest.NoPermissions.RamNoPermission', 'message' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'http_code' => 400, 'description' => '无权操作，请检查Ram账号权限配置'], + ], + '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' => '阿里云生态伙伴', + 'ramCodes' => ['agency'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetIntlCommissionDetailFileList', + 'description' => '下载国际伙伴佣金账单', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'agency:GetIntlCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OssSecurityToken', - 'in' => 'query', - 'schema' => [ - 'description' => '上传文件到OSS使用的STS token', - 'type' => 'string', - 'required' => false, - 'example' => 'yourSecurityToken', + ], + [ + 'apiName' => 'GetCommissionDetailFileList', + 'description' => '查询伙伴佣金明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetCommissionDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OssBucketName', - 'in' => 'query', - 'schema' => [ - 'description' => 'OSS存储空间', - 'type' => 'string', - 'required' => false, - 'example' => 'yourBucketName', + ], + [ + 'apiName' => 'GetSubPartnerOrderList', + 'description' => '查询拓渠订单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetSubPartnerOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OssEndpoint', - 'in' => 'query', - 'schema' => [ - 'description' => '文件共享对应的对象存储（OSS）Bucket所在地域节点', - 'type' => 'string', - 'required' => false, - 'example' => 'http://oss-cn-beijing.aliyuncs.com', + ], + [ + 'apiName' => 'GetRenewalRateList', + 'description' => '查询伙伴续费率', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetRenewalRateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'OssRegion', - 'in' => 'query', - 'schema' => [ - 'description' => '当前OSS Bucket 所属地域', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + ], + [ + 'apiName' => 'GetBillDetailFileList', + 'description' => '查询账单导出文件', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'agency:GetBillDetailFileList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Agency', 'resourceType' => '全部资源', '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' => '伙伴uid', - 'type' => 'string', - 'example' => '1112332432', - ], - 'BillMonth' => [ - 'description' => '账单月份', - 'type' => 'string', - 'example' => '202502', - ], - 'FileList' => [ - 'description' => '文件列表', - 'type' => 'array', - 'items' => [ - 'description' => '文件列表对象', - 'type' => 'object', - 'properties' => [ - 'CommissionPolicyName' => [ - 'description' => '政策名称', - 'type' => 'string', - 'example' => '参考【APS佣金查询下载功能】的政策名称', - ], - 'FileType' => [ - 'description' => '文件类型', - 'type' => 'string', - 'example' => '总代政策为拓渠、普通政策为拓客', - ], - 'FileUrl' => [ - 'description' => '文件url', - 'type' => 'string', - 'example' => ' aps.ailyun.com/file/download?resourceId=1234&type=1', - ], - 'FileName' => [ - 'description' => '文件名称', - 'type' => 'string', - 'example' => '佣金202502021112', - ], - 'BucketSyncStatus' => [ - 'description' => 'OSS文件推送状态：处理中、处理成功、处理失败', - 'type' => 'string', - 'example' => '处理中', - ], - ], - ], - ], - ], - ], - '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' => '全部资源', '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' => '全部资源', '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"}]', - 'title' => '查询伙伴佣金明细', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'agency.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |