diff options
Diffstat (limited to 'data/zh_cn/agency')
| -rw-r--r-- | data/zh_cn/agency/2022-12-16/api-docs.php | 7116 | ||||
| -rw-r--r-- | data/zh_cn/agency/2025-02-27/api-docs.php | 1763 |
2 files changed, 8879 insertions, 0 deletions
diff --git a/data/zh_cn/agency/2022-12-16/api-docs.php b/data/zh_cn/agency/2022-12-16/api-docs.php new file mode 100644 index 0000000..1c81064 --- /dev/null +++ b/data/zh_cn/agency/2022-12-16/api-docs.php @@ -0,0 +1,7116 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Agency', + 'version' => '2022-12-16', + ], + 'directories' => [ + [ + 'id' => 380448, + 'title' => '客户邀请', + 'type' => 'directory', + 'children' => [ + 'CreateCustomer', + 'GetInviteStatus', + 'GetUnassociatedCustomer', + 'InviteSubAccount', + 'ResendEmail', + 'ListCountries', + ], + ], + [ + 'id' => 380449, + 'title' => '客户账号管理', + 'type' => 'directory', + 'children' => [ + 'CustomerQuotaRecordList', + 'DeductOutstandingBalance', + 'EditEndUserStatus', + 'EditNewBuyStatus', + 'EditZeroCreditShutdown', + 'ExportCustomerQuotaRecord', + 'ExportReversedDeductionHistory', + 'GetAccountInfo', + 'GetCreditInfo', + 'GetPurchaseControlRecord', + 'GetShutdownPolicyRecord', + 'QueryReversedDeductionHistory', + 'SetAccountInfo', + 'SetCreditLine', + 'SetWarningThreshold', + ], + ], + [ + 'id' => 380450, + 'title' => '费用中心', + 'type' => 'directory', + 'children' => [ + 'CancelSubscriptionBill', + 'GetCommissionableProducts', + 'GetCustomerOrders', + 'GetDailyBill', + 'GetMonthlyBill', + 'SubscriptionBill', + ], + ], + [ + 'id' => 380451, + 'title' => '优惠券管理', + 'type' => 'directory', + 'children' => [ + 'GetTier2CouponApprovalDetail', + 'ListTier2CouponApproval', + 'CancelCoupon', + 'CreateCouponTemplate', + 'CouponApprovalStatusList', + 'DeleteCouponTemplate', + 'GetCouponTemplateDetail', + 'GetCoupondeductProductCode', + 'IssueCouponForCustomer', + 'ListCouponUsage', + 'QuotaListExportPaged', + ], + ], + [ + 'id' => 380454, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ProcessApproval', + 'ListExportTasks', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateCustomer' => [ + 'summary' => '此功能用来报备一个待邀请的客户。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CustomerName', + 'in' => 'query', + 'schema' => [ + 'description' => '客户姓名', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DoorBell Marketing', + ], + ], + [ + 'name' => 'CustomerTrade', + 'in' => 'query', + 'schema' => [ + 'description' => '客户行业名称'."\n" + .'请使用Customer Trade枚举', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0205', + ], + ], + [ + 'name' => 'CustomerSubTrade', + 'in' => 'query', + 'schema' => [ + 'description' => '客户子行业'."\n" + .'请使用Customer Sub Trade枚举', + 'type' => 'string', + 'required' => false, + 'example' => '020501', + ], + ], + [ + 'name' => 'CustomerSource', + 'in' => 'query', + 'schema' => [ + 'description' => '客户来源'."\n" + .'请使用Customer Source枚举', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'website', + ], + ], + [ + 'name' => 'Nation', + 'in' => 'query', + 'schema' => [ + 'description' => '客户所属区域 请使用ListCountries获取当前UID可作业区域列表', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '告知调用是否成功的代码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数', + 'type' => 'string', + 'example' => '12345', + ], + 'Data' => [ + 'description' => '告知是否成功创建客户，如果为true，则Message中为CID', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => 'A9B725C7-3DBD-576B-AC91-F6F22AB99A77', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后 续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"12345\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A9B725C7-3DBD-576B-AC91-F6F22AB99A77\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '报备客户', + 'requestParamsDescription' => '### CustomerSource可选值'."\n" + .'> 下列格式为：页面对应字段——入参'."\n" + .'- 线下会议——Off_line_meeting'."\n" + .'- 官网——website'."\n" + .'- 市场营销活动——OFFLINE_MARKETTING_EVENT'."\n" + .'- 国际百科——intl_enterprise'."\n" + .'- 内部转介绍——Internal_transfer'."\n" + .'- 外部渠道——External_channel'."\n" + .'- 陌拜——Mobai'."\n" + .'- 老客户转介绍——Old_client_to_introduce'."\n" + .'- 其他——Other'."\n" + .'- 客户分配——ALLOCATE'."\n" + .'- 潜客推荐——PotentialRecommend'."\n" + ."\n" + .'### Customer Trade可选值'."\n" + .'>下列四位入参码为parent code，例：parent code=0603（四位）'."\n" + .'如customer sub trade和constomer trade都需填入，customer trade必须等于sub trade的parent code'."\n" + .'- 实体零售与批发——0101'."\n" + .'- 电子商务——0102'."\n" + .'- 物流和仓储——0103'."\n" + .'- 旅行、文化、体育和娱乐——0104'."\n" + .'- 服饰鞋帽、文教和体育用品——0105'."\n" + .'- 家用电器——0106'."\n" + .'- 食品、饮料和烟草——0107'."\n" + .'- 农业综合——0201'."\n" + .'- 钢铁制造——0202'."\n" + .'- 设备制造——0203'."\n" + .'- 通用工业品制造——0204'."\n" + .'- 汽车、汽车配件和服务——0205'."\n" + .'- 房地产和建筑——0206'."\n" + .'- 银行——0301'."\n" + .'- 保险——0302'."\n" + .'- 证券和资本市场——0303'."\n" + .'- 金融服务——0304'."\n" + .'- 通讯和运营商——0401'."\n" + .'- 媒体——0402'."\n" + .'- 计算机硬件设备——0403'."\n" + .'- 计算机软件和服务——0404'."\n" + .'- 互联网游戏——0405'."\n" + .'- 互联网服务——0406'."\n" + .'- 物联网技术和服务——0407'."\n" + .'- 智能消费品——0408'."\n" + .'- 人工智能——0409'."\n" + .'- 电网——0501'."\n" + .'- 石油石化——0502'."\n" + .'- 不可再生资源——0503'."\n" + .'- 新能源和可再生能源——0504'."\n" + .'- 化工——0505'."\n" + .'- 政府——0601'."\n" + .'- 军民融合——0602'."\n" + .'- 医疗健康——0603'."\n" + .'- 教育和科研机构——0604'."\n" + .'- 交通运输——0605'."\n" + .'- 公共服务——0606'."\n" + ."\n" + .'### customer sub trade可选值'."\n" + ."\n" + .'> customer sub trade code=060304（六位），parent code=0603（四位）'."\n" + .'如sub trade和constomer trade都填入，customer trade必须等于sub trade的parentcode'."\n" + ."\n" + .'- 媒体-互联网媒体——040201——0402'."\n" + .'- 媒体-广电传媒——040202——0402'."\n" + .'- 汽车、汽车配件和服务-汽车整车制造业——020501——0205'."\n" + .'- 汽车、汽车配件和服务-汽车配件制造业——020502——0205'."\n" + .'- 汽车、汽车配件和服务-车联网和汽车服务——020503——0205'."\n" + .'- 政府-公检法机关——060101——0601'."\n" + .'- 政府-税务——060102——0601'."\n" + .'- 政府-海关——060103——0601'."\n" + .'- 政府-地方政府——060104——0601'."\n" + .'- 政府-其他政府机构——060105——0601'."\n" + .'- 钢铁制造-钢铁采矿业——020201——0202'."\n" + .'- 钢铁制造-钢铁制造业——020202——0202'."\n" + .'- 旅行、文化、体育和娱乐-旅行服务——010401——0104'."\n" + .'- 旅行、文化、体育和娱乐-住宿和餐饮——010402——0104'."\n" + .'- 旅行、文化、体育和娱乐-文化体育和娱乐——010403——0104'."\n" + .'- 通讯和运营商-通讯设备——040101——0401'."\n" + .'- 通讯和运营商-运营商——040102——0401'."\n" + .'- 通讯和运营商-通信服务——040103——0401'."\n" + .'- 互联网服务-互联网社交——040601——0406'."\n" + .'- 互联网服务-互联网营销——040602——0406'."\n" + .'- 互联网服务-互联网平台——040603——0406'."\n" + .'- 互联网服务-互联网信息服务——040604——0406'."\n" + .'- 教育和科研机构-在线教育——060401——0604'."\n" + .'- 教育和科研机构-培训和教育机构——060402——0604'."\n" + .'- 教育和科研机构-科研机构——060403——0604'."\n" + .'- 交通运输-铁路运输——060501——0605"),'."\n" + .'- 交通运输-道路运输——060502——0605'."\n" + .'- 交通运输-水上运输——060503——0605'."\n" + .'- 交通运输-航空运输——060504——0605'."\n" + .'- 交通运输-其他运输——060505——0605'."\n" + .'- 食品、饮料和烟草-食品制造业——010701——0107'."\n" + .'- 食品、饮料和烟草-酒、饮料喝精制茶制造业——010702——0107'."\n" + .'- 食品、饮料和烟草-烟草制品业——010703——0107'."\n" + .'- 不可再生资源-不可再生能源开采——050301——0503'."\n" + .'- 不可再生资源-不可再生能源生产和供应——050302——0503'."\n" + .'- 医疗健康-医疗服务——060301——0603'."\n" + .'- 医疗健康-健康服务——060302——0603'."\n" + .'- 医疗健康-医疗健康设备——060303——0603'."\n" + .'- 医疗健康-基因工程——060304——0603'."\n" + .'- 医疗健康-药物和生物科技——060305——0603', + ], + 'GetInviteStatus' => [ + 'summary' => '查询已报备已发出邀请客户的邀请状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InviteStatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'inviteId list', + 'type' => 'array', + 'items' => [ + 'description' => 'inviteId list', + 'type' => 'object', + 'properties' => [ + 'InviteId' => [ + 'description' => '邀请ID，来自接口 InviteSubAccount', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码 错误代码值: 3057: InviteId为空', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InviteStatus' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果码'."\n" + .'取值范围:'."\n" + .' - 200 OK'."\n" + .'- 1109 系统错误', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InviteStatusList' => [ + 'description' => '邀请记录状态结果list', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '发送邀请邮件的时间', + 'type' => 'string', + 'example' => '2018-02-12', + ], + 'Status' => [ + 'description' => '邀请状态:'."\n" + .'- 0 未访问注册URL'."\n" + .'- 1 注册失败'."\n" + .'- 2 成功注册'."\n" + .'- 3 已访问注册URL但是没有提交表单', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SubAccountType' => [ + 'description' => '账户类型:'."\n" + .'- 1 Agency的终端客户'."\n" + .'- 2 Reseller的终端客户'."\n" + .'- 5 Reseller类型2级伙伴', + 'type' => 'string', + 'example' => '1', + ], + 'ParentId' => [ + 'description' => '分销客户账户所属分销商UID。', + 'type' => 'string', + 'example' => '1093238769140523', + ], + 'AssociationSuccessTime' => [ + 'description' => '分销客户账户成功关联分销商账户的时间。如果没有关联则为空。', + 'type' => 'string', + 'example' => '2018-02-13', + ], + 'Cid' => [ + 'description' => '分销客户CID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + 'Uid' => [ + 'description' => '分销客户UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567890123', + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InviteStatus\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"InviteStatusList\\": {\\n \\"GmtCreate\\": \\"2018-02-12\\",\\n \\"Status\\": 2,\\n \\"SubAccountType\\": \\"1\\",\\n \\"ParentId\\": \\"1093238769140523\\",\\n \\"AssociationSuccessTime\\": \\"2018-02-13\\",\\n \\"Cid\\": 1234567890123,\\n \\"Uid\\": 1234567890123\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '查询邀请记录状态', + ], + 'GetUnassociatedCustomer' => [ + 'summary' => '获取所有未关联的客户。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页，当前页', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页，每页记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误代码，候选值:'."\n" + .'200: OK'."\n" + .'1109: 系统错误', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后 续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PageInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页，每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '分页，总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Page' => [ + 'description' => '分页，当前页', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'InviteInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InviteInfo' => [ + 'description' => '邀请信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '邀请信息', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '邀请状态:'."\n" + .'- 0 未访问注册URL'."\n" + .'- 1 成功注册'."\n" + .'- 2 注册失败'."\n" + .'- 3 已访问注册URL但是没有提交表单', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtCreate' => [ + 'description' => '发送邮件的时间', + 'type' => 'string', + 'example' => '2023-05-10', + ], + 'AccountNickname' => [ + 'description' => '被邀请客户名称', + 'type' => 'string', + 'example' => '我的客户', + ], + 'Email' => [ + 'description' => '被邀请者email', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'InviteId' => [ + 'description' => '邀请ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '190', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"InviteInfoList\\": {\\n \\"InviteInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2023-05-10\\",\\n \\"AccountNickname\\": \\"我的客户\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"InviteId\\": 190\\n }\\n ]\\n },\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\"\\n}","type":"json"}]', + 'title' => '查询未关联的客户', + ], + 'InviteSubAccount' => [ + 'summary' => '邀请注册成为伙伴客户', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountInfoList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '邀请账号信息列表，一次小于等于5个', + 'type' => 'array', + 'items' => [ + 'description' => '邀请账号信息', + 'type' => 'object', + 'properties' => [ + 'SubAccountType' => [ + 'description' => '子账号类型:'."\n" + .'- 1: Agency 的 End user'."\n" + .'- 2: Reseller 的End user '."\n" + .'- 5: Reseller 的T2伙伴', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'EmailAddress' => [ + 'description' => '分销客户账户的邮件地址，要发送邀请邮件到这里', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + 'AccountNickname' => [ + 'description' => '分销客户的名称:'."\n" + .'- 当是分销客户是一家企业时，为企业的公司名称'."\n" + .'- 当是分销客户是T2 reseller伙伴时，为伙伴名称', + 'type' => 'string', + 'required' => true, + 'example' => 'XXX技术有限公司', + ], + 'CreditLine' => [ + 'description' => '伙伴分配给分销客户的总预算额度(quota)', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + 'Remark' => [ + 'description' => '分销客户描述', + 'type' => 'string', + 'required' => false, + 'example' => '发展xx为客户的邀请', + ], + 'ZeroCreditShutdownPolicy' => [ + 'description' => '伙伴对分销客户的停机策略管理。'."\n" + ."\n" + .'- 1: delayStop 享受延停额度延迟停机：阿里云接管资源，延停额度耗尽是触发实例停机，再15天还未付费，则会释放存储资源。'."\n" + .'- 2: noStop手工管理欠费不停机,：系统不会管理子账号的资源生命周期。伙伴需要手工管理客户的实例停机状态。 '."\n" + .'- 3：immediatelyStop 欠费立停，客户账号可用额度小于0账号进入欠费状态触发实例停机。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'NewBuyStatus' => [ + 'description' => '初始下单状态：'."\n" + ."\n" + .'- ban：禁购--客户注册关联成功后不可立即下单购买云资源，需要在后续将“下单控制”配置为“正常”才可以下单。'."\n" + .'- normal：正常--客户注册关联成功后可立即下单购买云资源。', + 'type' => 'string', + 'required' => true, + 'example' => 'ban', + ], + 'CustomerId' => [ + 'description' => 'Customer Id 从CreateCustomer API返回的', + 'type' => 'string', + 'required' => true, + 'example' => '1234567', + ], + 'CustomerBd' => [ + 'title' => '客户商务经理', + 'description' => '客户商务经理（限50字符）', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误代码: '."\n" + .'- 200 OK'."\n" + .'- 1109 System Error', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => '邀请发送结果列表', + 'type' => 'array', + 'items' => [ + 'description' => '邀请结果信息', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误代码，200 OK', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息，code说明', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '总是为真', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '邀请结果返回信息', + 'type' => 'object', + 'properties' => [ + 'RegUrl' => [ + 'description' => '分销客户注册URL', + 'type' => 'string', + 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL', + ], + 'Days' => [ + 'description' => '注册URL地址的有效期限，按天算', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'InviteId' => [ + 'description' => 'Invitation ID，用来查询邀请状态的', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error3017', + 'errorMessage' => 'customerRebateType is error, only invite reseller account.', + ], + [ + 'errorCode' => 'Error3008', + 'errorMessage' => 'shutdown status is error.', + ], + [ + 'errorCode' => 'Error3009', + 'errorMessage' => 'customerAccount is error.', + ], + [ + 'errorCode' => 'Error3010', + 'errorMessage' => 'customerNick is empty.', + ], + [ + 'errorCode' => 'Error3011', + 'errorMessage' => 'The length of customerNick greater than 50.', + ], + [ + 'errorCode' => 'Error3012', + 'errorMessage' => 'cid is empty.', + ], + [ + 'errorCode' => 'Error3013', + 'errorMessage' => 'customCredit is empty.', + ], + [ + 'errorCode' => 'Error3014', + 'errorMessage' => 'customCredit is a maximum of 10.', + ], + [ + 'errorCode' => 'Error3015', + 'errorMessage' => 'The current account is not a partner.', + ], + [ + 'errorCode' => 'Error3016', + 'errorMessage' => 'customerRebateType is error, only invite agency account.', + ], + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'Error3056', + 'errorMessage' => 'The value of subAccountType error.', + ], + [ + 'errorCode' => 'Error3067', + 'errorMessage' => 'Enterprise Customer Invitation Prohibition.', + ], + [ + 'errorCode' => 'Error3055', + 'errorMessage' => 'subAccountType is null.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '邀请分销客户', + ], + 'ResendEmail' => [ + 'summary' => '重新发送邀请邮件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InviteId', + 'in' => 'query', + 'schema' => [ + 'description' => '邀请ID，来自接口 InviteSbuAccount', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '176', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果码'."\n" + .'错误代码，候选值:'."\n" + .'200: OK'."\n" + .'1109: 系统错误'."\n" + .'3058: 发送过于频繁，限定5分钟10封邮件 3057: InviteId 为空'."\n" + .'3060: 找不到InviteId的发送记录'."\n" + .'3061: 注册URL过期，无法重发', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '结果信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后续 业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'Error3058', + 'errorMessage' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', + ], + [ + 'errorCode' => 'InvalidParam.InviteId.InvalidId', + 'errorMessage' => 'No invitation record found based on inviteId.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '重新发送邀请邮件', + ], + 'ListCountries' => [ + 'summary' => '此功能对所有分销商开放。根据分销商合同内约定的可作业国家信息展示对应区域代码信息', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后 续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '区域代码的列表', + 'type' => 'array', + 'items' => [ + 'description' => '区域代码', + 'type' => 'string', + 'example' => 'AF', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"AF\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询可作业区域范围列表', + ], + 'CustomerQuotaRecordList' => [ + 'summary' => '查询国际站分销客户quota调整流水，只针对国际用户。国内站无法调用', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserPk', + 'in' => 'query', + 'schema' => [ + 'title' => '客户uid', + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5113766248601929', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-02', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-09-24', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型'."\n" + .'枚举'."\n" + .'all 全部'."\n" + .'quota_create 创建'."\n" + .'quota_amount_adjust 额度调整', + 'description' => '操作类型'."\n" + .'枚举'."\n" + .'all 全部'."\n" + .'quota_create 创建'."\n" + .'quota_amount_adjust 额度调整', + 'type' => 'string', + 'required' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页每页记录数，最大值100', + 'description' => '分页每页记录数，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页，当前页码，从 1 开始', + 'description' => '分页，当前页码，从 1 开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数，默认英文'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '当前每页条数', + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'description' => '返回结果列表数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'OperationSubmitType' => [ + 'title' => '操作发起方式'."\n" + .'API/ACPN', + 'description' => '操作发起方式'."\n" + .'API/ACPN', + 'type' => 'string', + 'example' => 'ACPN', + ], + 'OperationTime' => [ + 'title' => '操作时间', + 'description' => '操作时间', + 'type' => 'string', + 'example' => '2023-12-15 10:34:36 UTC+8', + ], + 'OperationTypeDesc' => [ + 'title' => '变更类型描述', + 'description' => '变更类型描述', + 'type' => 'string', + 'example' => 'Quota Adjustment', + ], + 'OperationUid' => [ + 'title' => '操作人uid', + 'description' => '操作人uid', + 'type' => 'string', + 'example' => '5113766248601929', + ], + 'UpdateAfterAmount' => [ + 'title' => '变更后金额', + 'description' => '变更后金额', + 'type' => 'string', + 'example' => '121.00', + ], + 'UpdateAmount' => [ + 'title' => '变更金额', + 'description' => '变更金额', + 'type' => 'string', + 'example' => '-100.00', + ], + 'UpdateBeforeAmount' => [ + 'title' => '变更前金额', + 'description' => '变更前金额', + 'type' => 'string', + 'example' => '221.00', + ], + 'OperationTypeCode' => [ + 'title' => '变更类型code', + 'description' => '变更类型code'."\n" + .'枚举：all 全部，quota_create 创建，quota_amount_adjust 额度调整', + 'type' => 'string', + 'example' => 'quota_amount_adjust', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '2103a0ae16849855284594613d874e', + ], + 'Msg' => [ + 'title' => '返回结果描述', + 'description' => '返回结果描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36 UTC+8\\",\\n \\"OperationTypeDesc\\": \\"Quota Adjustment\\",\\n \\"OperationUid\\": \\"5113766248601929\\",\\n \\"UpdateAfterAmount\\": \\"121.00\\",\\n \\"UpdateAmount\\": \\"-100.00\\",\\n \\"UpdateBeforeAmount\\": \\"221.00\\",\\n \\"OperationTypeCode\\": \\"quota_amount_adjust\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a0ae16849855284594613d874e\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '查询国际站分销客户quota调整流水', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。', + ], + 'DeductOutstandingBalance' => [ + 'summary' => '此API用来冲减分销客户已被抵扣的额度。例如当前已抵扣额度为500，可用额度是1000。通过冲减，冲减了300， 之后已抵扣额度就变为200，可用额度变为1300。'."\n" + .'注意，有时候会发现客户的已用额度为负数。此时说明无需对客户已用额度进行恢复，静待客户使用即可。造成这种现象的原因在于，当客户额度满的时候产生了退款。所以，客户额度会额外增加。'."\n" + .'例如，当前客户最大可用额度是1000，无任何使用。此时发生退款300。则已用额度，会变为-300。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '分销客户账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1133166938931507', + ], + ], + [ + 'name' => 'DeductAmount', + 'in' => 'query', + 'schema' => [ + 'description' => '要冲减的已抵扣额度', + 'type' => 'string', + 'required' => true, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码，候选值:'."\n" + .'200: OK'."\n" + .'1109: 系统错误', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后续 业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'This uid is not your EU.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '冲减已抵扣额度', + ], + 'EditEndUserStatus' => [ + 'summary' => '阿里云国际渠道总经销商伙伴以及阿里云国际渠道经销商伙伴管理代销下级客户后付费实例的停机状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => 'uid', + 'description' => '待处理客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1792155717328010', + ], + ], + [ + 'name' => 'CreditStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'creditStatus', + 'description' => '### 停机状态'."\n" + ."\n" + .'- postPayFreeze 后付费停机'."\n" + .'- postPayThaw 后付费复机', + 'type' => 'string', + 'required' => false, + 'example' => 'postPayFreeze', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'title' => 'msg', + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Data' => [ + 'title' => 'data', + 'description' => '是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'The current customer does not belong to this partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '设置客户实例的停机状态', + 'description' => '调用者必须是阿里云国际渠道总经销商伙伴以及阿里云国际渠道经销商伙伴'."\n" + ."\n" + .'**本内容只发布国际站**', + ], + 'EditNewBuyStatus' => [ + 'summary' => '阿里云代销模式的伙伴设置下级分销客户的新购状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => 'uid', + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1133166938931507', + ], + ], + [ + 'name' => 'NewBuyStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'newBuyStatus', + 'description' => '新购状态'."\n" + ."\n" + .'cancelBan:取消禁止新购'."\n" + ."\n" + .'ban:禁止新购', + 'type' => 'string', + 'required' => false, + 'example' => 'cancelBan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'title' => 'msg', + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Data' => [ + 'title' => 'data', + 'description' => '是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'The current customer does not belong to this partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '修改客户新购状态', + 'description' => '调用者身份必须是阿里云代销模式的伙伴'."\n" + ."\n" + .'**本内容只发布国际站**', + ], + 'EditZeroCreditShutdown' => [ + 'summary' => '阿里云总经销商伙伴和经销商伙伴修改下级客户的停机策略', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => 'uid', + 'description' => '待编辑停机策略的分销客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1263644979775567', + ], + ], + [ + 'name' => 'ShutdownPolicy', + 'in' => 'query', + 'schema' => [ + 'title' => 'shutdownPolicy', + 'description' => '### **停机策略**'."\n" + .'详细介绍请参考官网文档：https://www.alibabacloud.com/help/zh/channel-platform/latest/shutdowndelayprivilege'."\n" + ."\n" + .'- **immediatelyStop 立即停机**——当分销客户账号可用额度小于0，账号进入欠费状态，不可新购资源，后付费实例停机不再产生消费，预付费实例可以使用到有效期止。停机状态保持15天后，后付费实例将被释放。产品存在出账延迟，可能存在实例成功停机后，额度仍在扣减情况。'."\n" + .'- **delayStop 延迟停机**——延停策略中的透支额度，由阿里云根据账号历史消费金额统计得出，最低600 USD，预计在欠费后实例可继续使用15天。透支金额适用于按量付费产品，启用后当客户欠费时（可用额度< 0），欠费金额在透支额度范围内时，不触发实例停机。透支额度并非欠费金额上限，产品存在出账延迟，可能存在实例成功停机后，额度仍在扣减情况。停机状态保持15天后，后付费实例将被释放。在延停额度<=剩余额度<0的情况下，可手动立刻停机。'."\n" + .'- **noStop 不停机**——选择欠费不停机，当客户欠费（剩余额度< 0）后不会触发客户停机，客户欠费金额无上限，需要在ACPN人工操作“立即停机”修改实例状态，请慎重选择。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'immediatelyStop' => 'immediatelyStop', + 'noStop' => 'noStop', + 'delayStop' => 'delayStop', + ], + 'example' => 'noStop', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Msg' => [ + 'title' => 'msg', + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Data' => [ + 'title' => 'data', + 'description' => '是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'The current customer does not belong to this partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '修改客户停机策略', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。'."\n" + ."\n" + .'**本内容只发布国际站**', + ], + 'ExportCustomerQuotaRecord' => [ + 'summary' => 'ExportCustomerQuotaRecord 接口对应ACPN上客户总预算调整明细的导出功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserPk', + 'in' => 'query', + 'schema' => [ + 'title' => '客户uid', + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5113766248601929', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-11-10', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-12-24', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型'."\n" + .'枚举'."\n" + .'all 全部'."\n" + .'quota_create 创建'."\n" + .'quota_amount_adjust 额度调整', + 'description' => '操作类型'."\n" + .'枚举'."\n" + .'all 全部'."\n" + .'quota_create 创建'."\n" + .'quota_amount_adjust 额度调整', + 'type' => 'string', + 'required' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数，默认英文'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '210bc4b416874189683843905d9f9a', + ], + 'Msg' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'code', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '导出任务id', + 'description' => '导出任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231', + ], + 'Cost' => [ + 'title' => '预估耗时，单位分钟', + 'description' => '预估耗时，单位分钟', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 1231,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]', + 'title' => '导出分销客户quota流水', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。', + ], + 'ExportReversedDeductionHistory' => [ + 'summary' => 'ExportReversedDeductionHistory 接口对应ACPN上冲减明细的导出功能。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ExportUid', + 'in' => 'query', + 'schema' => [ + 'title' => '被导出的uid', + 'description' => '被导出的uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-01', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'default' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'asfasd123', + ], + 'Message' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '数据', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '导出任务id', + 'description' => '导出任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2131', + ], + 'Cost' => [ + 'title' => '预估耗时，单位分钟', + 'description' => '预估耗时，单位分钟', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asfasd123\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 2131,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]', + 'title' => '导出冲减明细列表', + ], + 'GetAccountInfo' => [ + 'summary' => '返回分销客户账号信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '分销客户账号UID，此参数和UserType参数必须有一个。如果此参数为空，则查询UserType类型的所有分销客户账号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1215848086704806', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '分销客户账号类型，取值范围:'."\n" + .'- 1 End User'."\n" + .'- 2 企业客户 '."\n" + .'- 3 T2伙伴', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页，当前页', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页，每页数量，最大20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果码'."\n" + .'Error Code. Value Range: '."\n" + .'- 200: OK '."\n" + .'- 1109: System Error '."\n" + .'- 3029: Invalid UID '."\n" + .'- 3062: Uid and UserType are both empty '."\n" + .'- 3063: UserType value out of range.', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PageInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页，每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '分页，总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Page' => [ + 'description' => '分页，当前页', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'AccountInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccountInfo' => [ + 'description' => '账号信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息', + 'type' => 'object', + 'properties' => [ + 'SubAccountType' => [ + 'description' => '账户类型:'."\n" + .'- 1 Agency的终端客户'."\n" + .'- 2 Reseller的终端客户'."\n" + .'- 3 企业客户'."\n" + .'- 4 Agency类型2级伙伴'."\n" + .'- 5 Reseller类型2级伙伴'."\n" + .'- 6 Agency+Reseller类型2级伙伴', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AssociationSuccessTime' => [ + 'description' => '分销客户账户与伙伴账户建立分销主子关系的关联时间', + 'type' => 'string', + 'example' => '2021-01-01', + ], + 'AccountNickname' => [ + 'description' => '分销客户账户昵称。 对于企业客户，是公司名称。 对于T2伙伴，则是伙伴名称。', + 'type' => 'string', + 'example' => 'XXX技术有限公司', + ], + 'Email' => [ + 'description' => '分销客户账户电子邮件地址', + 'type' => 'string', + 'example' => '[email protected]'."\n", + ], + 'Remark' => [ + 'description' => '分销客户账号说明', + 'type' => 'string', + 'example' => '子账号', + ], + 'Mobile' => [ + 'description' => '分销客户账号手机号', + 'type' => 'string', + 'example' => '13641588680', + ], + 'AliyunId' => [ + 'description' => '分销客户账户阿里云登录名', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Uid' => [ + 'description' => '分销客户账户UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1415740779475837', + ], + 'Cid' => [ + 'description' => '分销客户对应CID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '61479572', + ], + 'DelayStatus' => [ + 'title' => '延停策略。取值三个如下'."\n" + .'1、immediatelyStop，立即停机'."\n" + .'2、delayStop，延迟停机。延迟停机额度见delayAmount字段'."\n" + .'3、noStop，不停机', + 'description' => '延停策略。取值三个如下'."\n" + .'1、immediatelyStop，立即停机'."\n" + .'2、delayStop，延迟停机。延迟停机额度见delayAmount字段'."\n" + .'3、noStop，不停机', + 'type' => 'string', + 'example' => 'immediatelyStop', + ], + 'DelayAmount' => [ + 'title' => '当延停策略为delayStop（延迟停机）时，透支的额度', + 'description' => '当延停策略为delayStop（延迟停机）时，透支的额度', + 'type' => 'string', + 'example' => '600', + ], + 'CustomerBd' => [ + 'title' => '客户商务经理', + 'description' => '客户商务经理', + 'type' => 'string', + 'example' => '张三', + ], + 'NewBuyStatus' => [ + 'title' => '下单状态', + 'description' => '下单状态，取值如下'."\n" + .'Purchase Forbidden（禁止下单）'."\n" + .'Normal（正常）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CustomerAccountType' => [ + 'title' => '客户的账号类型，0个人，1企业', + 'description' => '客户的账号类型，0个人，1企业', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CustomerEnterpriseCertified' => [ + 'title' => '客户是否企业实名，0 否，1是', + 'description' => '客户是否企业实名，0否，1是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegisterCountryCode' => [ + 'title' => '客户的注册国家code', + 'description' => '客户的注册国家code', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"AccountInfoList\\": {\\n \\"AccountInfo\\": [\\n {\\n \\"SubAccountType\\": 1,\\n \\"AssociationSuccessTime\\": \\"2021-01-01\\",\\n \\"AccountNickname\\": \\"XXX技术有限公司\\",\\n \\"Email\\": \\"[email protected]\\\\n\\",\\n \\"Remark\\": \\"子账号\\",\\n \\"Mobile\\": \\"13641588680\\",\\n \\"AliyunId\\": \\"[email protected]\\",\\n \\"Uid\\": 1415740779475837,\\n \\"Cid\\": 61479572,\\n \\"DelayStatus\\": \\"immediatelyStop\\",\\n \\"DelayAmount\\": \\"600\\",\\n \\"CustomerBd\\": \\"张三\\",\\n \\"NewBuyStatus\\": \\"Normal\\",\\n \\"CustomerAccountType\\": 1,\\n \\"CustomerEnterpriseCertified\\": 1,\\n \\"RegisterCountryCode\\": \\"CN\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '查询分销客户信息', + ], + 'GetCreditInfo' => [ + 'summary' => '查询分销客户信控信息。如果分销客户是Agency类型的，那么返回参数中的PopCreditInfoJson为空。此功能仅供针对Reseller和Distributor。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '子账户UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1792155717328010', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后续 业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'OutstandingBalance' => [ + 'description' => '子账号消费的信用额度，并且这些额度还没有偿付', + 'type' => 'string', + 'example' => '200', + ], + 'CreditLine' => [ + 'description' => '子账号信控额度', + 'type' => 'string', + 'example' => '1000', + ], + 'AccountStatus' => [ + 'description' => '子账号信控状态，取值范围:'."\n" + .' 1. normal 正常'."\n" + .'2. arrearsNotShutdown 欠费未停机'."\n" + .' 3. shutdown 停机', + 'type' => 'string', + 'example' => 'normal', + ], + 'AvailableCredit' => [ + 'description' => '可用额度', + 'type' => 'string', + 'example' => '800', + ], + 'AlarmThreshold' => [ + 'description' => '百分比值，当可用额度降到信控额度的这个百分比'."\n" + .'之下的时候，就会触发给主账号邮件提醒。', + 'type' => 'string', + 'example' => '20', + ], + 'ZeroCreditShutdownPolicy' => [ + 'description' => '用来管理可用额度在0以及更少的时候，系统对资 源管控的策略。取值范围:'."\n" + ."\n" + .'1: delayStop 延迟停机, 阿里巴巴接管资源，延停 额度耗尽实例停机，再15天还未付费，则会释放 存储资源。'."\n" + ."\n" + .'2: noStop欠费不停机, 系统不会管理子账号的资 源生命周期。伙伴需要手工完成。'."\n" + ."\n" + .' 3.immediatelyStop 立即停机，账号进入欠费状态 触发实例停机。', + 'type' => 'string', + 'example' => 'delayStop', + ], + 'newBuyStatus' => [ + 'description' => '用来管理客户的下单动作。'."\n" + ."\n" + .'ban 禁止新购 '."\n" + ."\n" + .'cancelBan 正常状态', + 'type' => 'string', + 'example' => 'ban', + ], + 'ConsumedUndeductedValue' => [ + 'title' => '获取模拟抵扣前虚账单未结清总额', + 'description' => '获取模拟抵扣前虚账单未结清总额', + 'type' => 'string', + 'example' => '0.000000', + ], + 'PAYGFreezeStatus' => [ + 'description' => '后付费冻结状态'."\n" + .'freeze：冻结'."\n" + .'normal：正常', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OutstandingBalance\\": \\"200\\",\\n \\"CreditLine\\": \\"1000\\",\\n \\"AccountStatus\\": \\"normal\\",\\n \\"AvailableCredit\\": \\"800\\",\\n \\"AlarmThreshold\\": \\"20\\",\\n \\"ZeroCreditShutdownPolicy\\": \\"delayStop\\",\\n \\"newBuyStatus\\": \\"ban\\",\\n \\"ConsumedUndeductedValue\\": \\"0.000000\\",\\n \\"PAYGFreezeStatus\\": \\"normal\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '查询分销客户预算状态信息', + ], + 'GetPurchaseControlRecord' => [ + 'summary' => '下单控制记录查询', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OperationTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间'."\n" + .'为空则取半年内的数据'."\n" + .'时间格式为 yyyy-MM-dd HH:mm:ss', + 'description' => '起始时间'."\n" + .'为空则取半年内的数据'."\n" + .'时间格式为 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2023-12-15 10:34:36', + ], + ], + [ + 'name' => 'CustomerUID', + 'in' => 'query', + 'schema' => [ + 'title' => '客户id', + 'description' => '客户Uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '292828565558721922', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'RequestId', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'ChangedType' => [ + 'title' => '变更类型'."\n" + .'ban 禁止新购'."\n" + .'cancelBan 取消禁止', + 'description' => '变更类型'."\n" + .'ban 禁止新购'."\n" + .'cancelBan 取消禁止', + 'type' => 'string', + 'enumValueTitles' => [ + 'cancelBan ' => ' 取消禁止', + 'ban ' => '禁止新购', + ], + 'example' => 'ban ', + ], + 'OperationTime' => [ + 'title' => '操作时间（UTC+8）', + 'description' => '操作时间（UTC+8）', + 'type' => 'string', + 'example' => '2023-12-15 10:34:36', + ], + 'OperationPath' => [ + 'title' => '操作发起方式', + 'description' => '操作发起方式', + 'type' => 'string', + 'example' => 'ACPN', + ], + 'Operator' => [ + 'title' => '操作人', + 'description' => '操作人', + 'type' => 'string', + 'example' => '292828565558721922', + ], + ], + ], + ], + 'Code' => [ + 'description' => '结果码'."\n" + .'Error Code. Value Range: '."\n" + .'- 200: OK '."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Total' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": [\\n {\\n \\"ChangedType\\": \\"ban \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"292828565558721922\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '下单控制修改记录查询', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。', + ], + 'GetShutdownPolicyRecord' => [ + 'summary' => '查询延停策略修改记录', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OperationTime', + 'in' => 'query', + 'schema' => [ + 'title' => '起始时间'."\n" + .'为空则取半年内的数据'."\n" + .'时间格式为 yyyy-MM-dd HH:mm:ss', + 'description' => '起始时间'."\n" + .'为空则取半年内的数据'."\n" + .'时间格式为 yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2025-12-15 10:34:36', + ], + ], + [ + 'name' => 'CustomerUID', + 'in' => 'query', + 'schema' => [ + 'title' => '客户id', + 'description' => '客户Uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '292828565558721922', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '5', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + 'Data' => [ + 'description' => '告知是否成功创建客户，如果为true，则Message中为CID', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'CurrentPolicy' => [ + 'title' => '当前策略'."\n" + .'immediatelyStop 欠费立即停机'."\n" + .'delayStop 享受延停额度'."\n" + .'noStop 欠费不停机', + 'description' => '当前策略'."\n" + .'immediatelyStop 欠费立即停机'."\n" + .'delayStop 享受延停额度'."\n" + .'noStop 欠费不停机', + 'type' => 'string', + 'enumValueTitles' => [ + 'immediatelyStop ' => '欠费立即停机', + 'noStop ' => '欠费不停机', + 'delayStop ' => '享受延停额度', + ], + 'example' => 'noStop ', + ], + 'PreviousPolicy' => [ + 'title' => '变更前策略'."\n" + .'immediatelyStop 欠费立即停机'."\n" + .'delayStop 享受延停额度'."\n" + .'noStop 欠费不停机', + 'description' => '变更前策略'."\n" + .'immediatelyStop 欠费立即停机'."\n" + .'delayStop 享受延停额度'."\n" + .'noStop 欠费不停机', + 'type' => 'string', + 'enumValueTitles' => [ + 'immediatelyStop ' => '欠费立即停机', + 'noStop ' => '欠费不停机', + 'delayStop ' => '享受延停额度 ', + ], + 'example' => 'immediatelyStop ', + ], + 'OperationTime' => [ + 'title' => '操作时间（UTC+8）', + 'description' => '操作时间（UTC+8）', + 'type' => 'string', + 'example' => '2023-12-15 10:34:36', + ], + 'OperationPath' => [ + 'title' => '操作发起方式', + 'description' => '操作发起方式 API API/ ACPN ACPN /ALIYUN_BIZ 阿里云内部', + 'type' => 'string', + 'enumValueTitles' => [ + 'ALIYUN_BIZ' => '阿里云内部', + 'API' => 'API', + 'ACPN' => 'ACPN', + ], + 'example' => 'ACPN', + ], + 'Operator' => [ + 'title' => '操作人', + 'description' => '操作人', + 'type' => 'string', + 'example' => '11111111111', + ], + ], + ], + ], + 'Code' => [ + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Total' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '页码', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '每页大小', + 'description' => '每页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": [\\n {\\n \\"CurrentPolicy\\": \\"noStop \\",\\n \\"PreviousPolicy\\": \\"immediatelyStop \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"11111111111\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '延停策略修改记录查询', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。'."\n" + ."\n" + .'**本内容只发布国际站**', + ], + 'QueryReversedDeductionHistory' => [ + 'summary' => '查询对应客户的额度冲减明细列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => '客户uid', + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '开始日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-07-31', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'description' => '结束日期'."\n" + .'格式：yyyy-MM-dd', + 'type' => 'string', + 'required' => true, + 'example' => '2023-12-31', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页每页记录数，最大值100', + 'description' => '分页每页记录数，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页，当前页码，从 1 开始', + 'description' => '分页，当前页码，从 1 开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'default' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageNo' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '当前每页条数', + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Data' => [ + 'title' => '列表数据', + 'description' => '列表数据', + 'type' => 'array', + 'items' => [ + 'title' => '列表数据', + 'description' => '列表数据', + 'type' => 'object', + 'properties' => [ + 'OperationSubmitType' => [ + 'title' => '操作发起方式'."\n" + .'API/ACPN', + 'description' => '操作发起方式'."\n" + .'API/ACPN', + 'type' => 'string', + 'example' => 'ACPN', + ], + 'OperationTime' => [ + 'title' => '操作时间', + 'description' => '操作时间', + 'type' => 'string', + 'example' => '2024-11-01 10:22:11 UTC+8', + ], + 'OperationUid' => [ + 'title' => '操作人uid', + 'description' => '操作人uid', + 'type' => 'string', + 'example' => '132', + ], + 'OffsetAmount' => [ + 'title' => '冲减金额', + 'description' => '冲减金额', + 'type' => 'string', + 'example' => '1.00', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'asda1231as', + ], + 'Message' => [ + 'title' => '返回结果描述', + 'description' => '返回结果描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2024-11-01 10:22:11 UTC+8\\",\\n \\"OperationUid\\": \\"132\\",\\n \\"OffsetAmount\\": \\"1.00\\"\\n }\\n ],\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '查询冲减明细列表', + ], + 'SetAccountInfo' => [ + 'summary' => '用来更新子账户信息，包括昵称和注释。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AccountNickname', + 'in' => 'query', + 'schema' => [ + 'description' => '子账户昵称。 对于企业客户，是公司名称。 对于T2伙伴，则是伙伴名称。', + 'type' => 'string', + 'required' => false, + 'example' => '我的账号', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '子账户说明', + 'type' => 'string', + 'required' => false, + 'example' => '测试的账号', + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '子账户UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1133166938931507', + ], + ], + [ + 'name' => 'CustomerBd', + 'in' => 'query', + 'schema' => [ + 'title' => '客户商务经理', + 'description' => '客户商务经理（限50字符）', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果码'."\n" + .'错误代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误'."\n" + .'- 3030 账户昵称超过最大长度，最大长度150 bytes'."\n" + .'- 3031 Remark超过最大长度，最大长度是3000 Bytes', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'request ID，阿里云会根据这个进行错误跟踪', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'Error3030', + 'errorMessage' => 'The maximum length of CustomNick is 150.', + ], + [ + 'errorCode' => 'Error3031', + 'errorMessage' => 'The maximum length of FxDescription is 3000.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '更新子账号信息', + ], + 'SetCreditLine' => [ + 'summary' => '设置分销客户信控额度。此功能仅供针对Reseller和Distributor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '子账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1263644979775567', + ], + ], + [ + 'name' => 'CreditLine', + 'in' => 'query', + 'schema' => [ + 'description' => '新的信控额度', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误'."\n" + .'- 3040 子账号冻结，无法完成操作 - 3041 信控并非数字', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后 续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'Error3040', + 'errorMessage' => 'The account is in a frozen state and cannot be operated.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'This uid is not your EU.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '设置分销客户信控额度', + ], + 'SetWarningThreshold' => [ + 'summary' => '通过此API设置信控使用阈值。'."\n" + .'当客户信控到达阈值以下，会通过邮件通知分销商。'."\n" + .'此功能仅供针对Reseller和Distributor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'description' => '分销客户账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1792155717328010', + ], + ], + [ + 'name' => 'WarningValue', + 'in' => 'query', + 'schema' => [ + 'description' => '百分比，填写范围1到100，当可用信控额度低于信控额度百分比时，触发提示邮件给分销伙伴账号。', + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误'."\n" + .'- 3040 子账号冻结，无法完成操作 - 3044 告警比例值非数字'."\n" + .'- 3045 告警比例值应为1到100', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后续 业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + [ + 'errorCode' => 'Error3040', + 'errorMessage' => 'The account is in a frozen state and cannot be operated.', + ], + [ + 'errorCode' => 'Error3044', + 'errorMessage' => 'The Value is not a number.', + ], + [ + 'errorCode' => 'Error3045', + 'errorMessage' => 'The value must be between 1-100.', + ], + [ + 'errorCode' => 'InvalidParam.Uid.NotYourEu', + 'errorMessage' => 'This uid is not your EU.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '设置分销客户可用额度使用阈值', + ], + 'CancelSubscriptionBill' => [ + 'summary' => '国际渠道生态伙伴多级账单取消订阅功能', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'title' => 'subscribeType', + 'description' => '订阅类型 '."\n" + ."\n" + .'- PartnerBillingItemDetailForBillingPeriod 计费项账单明细'."\n" + .'- PartnerBillingItemDetailMonthly 计费项月账单'."\n" + .'- PartnerInstanceDetailForBillingPeriod 实例账单明细'."\n" + .'- PartnerInstanceDetailMonthly 实例月账单', + 'type' => 'string', + 'required' => true, + 'example' => 'PartnerBillingItemDetailForBillingPeriod', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求id', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '状态码', + 'type' => 'string', + 'enumValueTitles' => [ + 1008 => '取消订阅失败', + '不存在订阅记录', + ], + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '取消订阅多级分销账单', + 'description' => '请确保调用者是国际阿里云总经销商伙伴。'."\n" + ."\n" + .'用户一次可取消订阅一个类型的账单文件'."\n" + ."\n" + .'对应账单类型被取消后,不再推送文件到指定oss空间'."\n" + ."\n" + .'**本内容只发布国际站**', + ], + 'GetCommissionableProducts' => [ + 'summary' => '向T1层级的国际分销伙伴提供所有“生效中“、”已下架“的返佣商品列表。只针对国际用户，国内站无法调用', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页，当前页码，从 1 开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页每页记录数，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ListShowStatusList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '返佣商品的展示状态列表', + 'type' => 'array', + 'items' => [ + 'description' => '返佣商品展示状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PRE_ONLINE' => '待生效', + 'OFF_ONLINE' => '已失效', + 'ONLINE' => '生效中', + 'OFFLINE' => '已下架', + ], + 'example' => '["ONLINE","OFFLINE"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CommodityCodeList', + 'in' => 'query', + 'schema' => [ + 'description' => '商品code,多个code使用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '"oceanbase_obpre_public_intl,savingplan_common_public_intl"', + ], + ], + [ + 'name' => 'PipCodeList', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code,多个code使用英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '"oceanbase"', + ], + ], + [ + 'name' => 'RealStartMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '实际开始月份，格式为“yyyymm”', + 'type' => 'string', + 'required' => false, + 'example' => '“202502”', + ], + ], + [ + 'name' => 'RealEndMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '实际结束月份，格式为“yyyymm”', + 'type' => 'string', + 'required' => false, + 'example' => '“202509”', + ], + ], + [ + 'name' => 'FiscalYear', + 'in' => 'query', + 'schema' => [ + 'description' => '财年，输入为空时默认当前财年', + 'type' => 'string', + 'required' => false, + 'example' => '“FY26”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'description' => '返回结果列表数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品Code', + 'type' => 'string', + 'example' => '“oceanbase_obpre_public_intl”', + ], + 'CommodityName' => [ + 'description' => '商品名称', + 'type' => 'string', + 'example' => '“ApsaraDB for OceanBase Pre”', + ], + 'ProductCode' => [ + 'description' => '产品code', + 'type' => 'string', + 'example' => '“oceanbase”', + ], + 'ProductName' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => '“ApsaraDB for OceanBase”', + ], + 'Status' => [ + 'description' => '产品展示状态', + 'type' => 'string', + 'example' => '“ONLINE”', + ], + 'ActualStartMonth' => [ + 'description' => '实际开始月份，格式为“yyyymm”', + 'type' => 'string', + 'example' => '“202502”', + ], + 'EndMonth' => [ + 'description' => '实际结束月份，格式为“yyyymm”', + 'type' => 'string', + 'example' => '“202509”', + ], + 'EligibleForCommission' => [ + 'description' => '是否可返佣', + 'type' => 'string', + 'example' => 'Yes', + ], + 'EligibleForDiscount' => [ + 'description' => '是否可打折', + 'type' => 'string', + 'example' => 'Yes', + ], + 'SevenCoreProducts' => [ + 'description' => '是否为核心产品', + 'type' => 'string', + 'example' => 'Yes', + ], + 'ProductCampaign' => [ + 'description' => '是否为产品线激励商品', + 'type' => 'string', + 'example' => 'Yes', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '2103a30617045934095083027d88c5', + ], + 'Code' => [ + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表当前API调用是否成功的，不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"CommodityCode\\": \\"“oceanbase_obpre_public_intl”\\",\\n \\"CommodityName\\": \\"“ApsaraDB for OceanBase Pre”\\",\\n \\"ProductCode\\": \\"“oceanbase”\\",\\n \\"ProductName\\": \\"“ApsaraDB for OceanBase”\\",\\n \\"Status\\": \\"“ONLINE”\\",\\n \\"ActualStartMonth\\": \\"“202502”\\",\\n \\"EndMonth\\": \\"“202509”\\",\\n \\"EligibleForCommission\\": \\"Yes\\",\\n \\"EligibleForDiscount\\": \\"Yes\\",\\n \\"SevenCoreProducts\\": \\"Yes\\",\\n \\"ProductCampaign\\": \\"Yes\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询返佣商品列表', + 'description' => '确保当前调用账号身份为分销伙伴 '."\n" + .'<notice>仅国际提供></notice>', + ], + 'GetCustomerOrders' => [ + 'summary' => '国际站客户订单查询，只允许国际站调用。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号（可选）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '209335720330622', + ], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => [ + 'title' => '客户账号', + 'description' => '客户账号', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => [ + 'title' => '客户UID', + 'description' => '客户UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'title' => '订单类型：BUY、REFUND、UPGRADE、DOWNGRADE、REFUND、OTHERS', + 'description' => '订单类型:'."\n" + .'- BUY: 新购'."\n" + .'- UPGRADE: 升级'."\n" + .'- DOWNGRADE: 降级'."\n" + .'- RENEW: 续费'."\n" + .'- REFUND: 退款'."\n" + .'- OTHERS: 其他', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'RENEW', + ], + ], + [ + 'name' => 'OrderStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '订单状态：1 未支付；2 已废弃；3 已支付', + 'description' => '订单状态：'."\n" + .'- 1 未支付'."\n" + .'- 2 已废弃'."\n" + .'- 3 已支付', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '3', + ], + ], + [ + 'name' => 'TimeType', + 'in' => 'query', + 'schema' => [ + 'title' => '时间类型：1 支付时间；2 下单时间', + 'description' => '时间类型：'."\n" + .'- 1 支付时间'."\n" + .'- 2 下单时间', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '2', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间，与timeType结合使用。格式：yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => true, + 'example' => '2024-08-13 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间，与timeType结合使用。格式：yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => true, + 'example' => '2024-08-23 00:00:00', + 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', + ], + ], + [ + 'name' => 'CustomerManager', + 'in' => 'query', + 'schema' => [ + 'title' => '客户经理', + 'description' => '客户经理', + 'type' => 'string', + 'required' => false, + 'example' => 'myBd', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'title' => '产品明细code', + 'description' => '产品明细code', + 'type' => 'string', + 'required' => false, + 'example' => 'vm_intl', + ], + ], + [ + 'name' => 'OrderSource', + 'in' => 'query', + 'schema' => [ + 'title' => '订单来源：0 普通客户；1 企业客户；2 二级经销商', + 'description' => '订单来源：'."\n" + .'- 0 普通客户'."\n" + .'- 1 企业客户'."\n" + .'- 2 二级经销商', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '成功', + ], + 'Code' => [ + 'description' => '结果代码', + 'type' => 'string', + 'example' => '200', + ], + 'Msg' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => 'success:'."\n" + .'- 200 OK'."\n" + .'- 201 参数异常', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '告知是否成功创建客户，如果为true，则Message中为CID', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单号（可选）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '236414227150922', + ], + 'CustomerAccount' => [ + 'title' => '客户账户', + 'description' => '客户账户', + 'type' => 'string', + 'example' => 'test_123', + ], + 'CustomerNo' => [ + 'title' => '客户UID', + 'description' => '客户UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'ProductDetail' => [ + 'title' => '产品明细', + 'description' => '产品明细', + 'type' => 'string', + 'example' => 'oss', + ], + 'ProductType' => [ + 'title' => '产品明细code', + 'description' => '产品明细code', + 'type' => 'string', + 'example' => 'snapshot', + ], + 'OrderType' => [ + 'title' => '订单类型', + 'description' => '订单类型:'."\n" + .'- BUY: 新购'."\n" + .'- UPGRADE: 升级'."\n" + .'- DOWNGRADE: 降级'."\n" + .'- RENEW: 续费'."\n" + .'- REFUND: 退款'."\n" + .'- OTHERS: 其他', + 'type' => 'string', + 'example' => 'BUY', + ], + 'OriginalCost' => [ + 'title' => '订单原价', + 'description' => '订单原价', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.92', + ], + 'PretaxCost' => [ + 'title' => '应付金额', + 'description' => '应付金额', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.92', + ], + 'OrderStatus' => [ + 'title' => '订单状态', + 'description' => '订单状态：'."\n" + .'- 1 未支付'."\n" + .'- 2 已废弃'."\n" + .'- 3 已支付', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TimeToOrder' => [ + 'title' => '下单时间', + 'description' => '下单时间', + 'type' => 'string', + 'example' => '2024-08-13 13:02:02', + ], + 'PaymentTime' => [ + 'title' => '支付时间', + 'description' => '支付时间', + 'type' => 'string', + 'example' => '2024-08-13 13:02:02', + ], + 'PaymentMethod' => [ + 'title' => '付款方式', + 'description' => '付款方式', + 'type' => 'string', + 'example' => '3:32', + ], + 'CustomerManager' => [ + 'title' => '客户经理', + 'description' => '客户经理', + 'type' => 'string', + 'example' => 'myBd', + ], + 'OrderSource' => [ + 'title' => '订单来源', + 'description' => '订单来源：'."\n" + .'- 0 普通客户'."\n" + .'- 1 企业客户'."\n" + .'- 2 二级经销商', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions', + 'errorMessage' => 'No permissions for the operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"200\\",\\n \\"Msg\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"CustomerNo\\": 123456,\\n \\"ProductDetail\\": \\"oss\\",\\n \\"ProductType\\": \\"snapshot\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"OriginalCost\\": 3.92,\\n \\"PretaxCost\\": 3.92,\\n \\"OrderStatus\\": 3,\\n \\"TimeToOrder\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentTime\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentMethod\\": \\"3:32\\",\\n \\"CustomerManager\\": \\"myBd\\",\\n \\"OrderSource\\": \\"0\\"\\n }\\n ],\\n \\"PageSize\\": 1,\\n \\"PageNo\\": 1,\\n \\"Total\\": 100\\n}","type":"json"}]', + 'title' => '客户订单查询', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。', + ], + 'GetDailyBill' => [ + 'summary' => '获取分销商日账单。'."\n" + .'此功能仅供针对Reseller和Distributor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => 'Billing date. Format YYYY-MM-DD', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-24', + ], + ], + [ + 'name' => 'BillOwner', + 'in' => 'query', + 'schema' => [ + 'description' => '账单所属类型 取值范围:'."\n" + ."\n" + .'1: 分销伙伴账号 '."\n" + ."\n" + .'2: 分销客户账号', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'BillType', + 'in' => 'query', + 'schema' => [ + 'description' => '账单类型，取值范围:'."\n" + ."\n" + .'- DailyOrder(Deprecated)'."\n" + ."\n" + .'- DailyBill (Deprecated)'."\n" + ."\n" + .'- DailyInstanceBill (Deprecated) '."\n" + .'- DailyInstanceBillV2', + 'type' => 'string', + 'required' => true, + 'example' => 'DailyInstanceBillV2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误'."\n" + .'- 3050: 账单类型只能是DailyOrder, DailyBill, DailyInstanceBill '."\n" + .'- 3049: 消费时间格式错误'."\n" + .'- 3048: 账单所属只能是1 or 2', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功的。不代表后续 业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'BillLinkCSV' => [ + 'description' => '下载CSV文件地址，请使用HTTP协议', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', + ], + 'SpendingTime' => [ + 'description' => '消费时间，对应具体的消费日期', + 'type' => 'string', + 'example' => '20221201', + ], + 'BillType' => [ + 'description' => '同输入参数BillType', + 'type' => 'string', + 'example' => 'DailyInstanceBillV2', + ], + 'BillOwner' => [ + 'description' => '同输入参数BillOwner.', + 'type' => 'string', + 'example' => '1', + ], + 'BillLinkXLSX' => [ + 'description' => '下载XLSX文件地址，请使用HTTP协议', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillType\\": \\"DailyInstanceBillV2\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]', + 'title' => '分销商日账单', + ], + 'GetMonthlyBill' => [ + 'summary' => '返回分销商月账单。'."\n" + .'此功能仅供针对Reseller和Distributor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Month', + 'in' => 'query', + 'schema' => [ + 'description' => 'Billing Month, Format is YYYY-MM', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11', + ], + ], + [ + 'name' => 'BillOwner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bill Owner type.'."\n" + ."\n" + .' Value range:'."\n" + ."\n" + .'1: Master account '."\n" + ."\n" + .'2: Sub account', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'BillType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Value Range:'."\n" + ."\n" + .'MonthlyInvoice'."\n" + ."\n" + .'MonthRefundInvoice'."\n" + ."\n" + .'MonthlySummary (Deprecated)'."\n" + ."\n" + .'MonthlyInstanceAddAdjustBill '."\n" + ."\n" + .'MonthlyInstanceRefundBill'."\n" + ."\n" + .'MonthlyAddAdjustInvoce'."\n" + ."\n" + .'MonthlyRefundAdjustInvoce '."\n" + ."\n" + .'MonthlyInstanceConsumeV2 '."\n" + ."\n" + .'MarginReportV2', + 'type' => 'string', + 'required' => true, + 'example' => 'MonthlyInvoice', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码:'."\n" + .'- 200 OK'."\n" + .'- 1109 系统错误'."\n" + .'- 3030 账户昵称超过最大长度，最大长度150 bytes'."\n" + .'- 3031 Remark超过最大长度，最大长度是3000 Bytes', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '同Code参数值', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '候选值:True/False，代表了是否当前API调用本身是成功 的。不代表后续业务操作的成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'RefundInvoiceLink' => [ + 'description' => '下载退款发票的URL', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', + ], + 'BillType' => [ + 'description' => '同输入参数BillType', + 'type' => 'string', + 'example' => 'MonthlyInvoice', + ], + 'InvoiceLink' => [ + 'description' => 'Invoice下载URL', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', + ], + 'BillLinkCSV' => [ + 'description' => '下载CSV文件地址，请使用HTTP协议', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', + ], + 'RefundInvoiceFlag' => [ + 'description' => '告知是否存在退款发票，可选值:True，False', + 'type' => 'boolean', + 'example' => 'True', + ], + 'SpendingTime' => [ + 'description' => '消费时间，对应具体的消费时间', + 'type' => 'string', + 'example' => '20221201', + ], + 'BillOwner' => [ + 'description' => '同输入参数BillOwner.', + 'type' => 'string', + 'example' => '1', + ], + 'BillLinkXLSX' => [ + 'description' => '下载XLSX文件地址，请使用HTTP协议', + 'type' => 'string', + 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", + ], + ], + ], + 'RequestId' => [ + 'description' => '请求id，阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error1109', + 'errorMessage' => 'system error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RefundInvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillType\\": \\"MonthlyInvoice\\",\\n \\"InvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"RefundInvoiceFlag\\": true,\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\"\\n}","type":"json"}]', + 'title' => '分销商月账单', + ], + 'SubscriptionBill' => [ + 'summary' => '阿里云生态伙伴多级账单订阅oss生成', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubscribeBucket', + 'in' => 'query', + 'schema' => [ + 'title' => 'subscribeType', + 'description' => '账单存储oss bucket名称', + 'type' => 'string', + 'required' => true, + 'example' => 'bill-bucket', + ], + ], + [ + 'name' => 'BucketOwnerId', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerMainUid', + 'description' => '存储文件Oss归属的UID。'."\n" + ."\n" + .'如果是伙伴订阅，并需要推送到下级伙伴账号的OSS上时，需要此账号为伙伴账号的下级伙伴账号，并对下级伙伴账号授予[AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D)权限 '."\n" + ."\n" + .'如果是伙伴订阅,且推送到伙伴账号的OSS时,需要伙伴账号进行授予[AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D)权限。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5569414254138836', + ], + ], + [ + 'name' => 'SubscribeType', + 'in' => 'query', + 'schema' => [ + 'title' => 'popClientIP', + 'description' => '订阅类型 '."\n" + .'PartnerBillingItemDetailForBillingPeriod 计费项账单明细'."\n" + .'PartnerBillingItemDetailMonthly 计费项月账单'."\n" + .'PartnerInstanceDetailForBillingPeriod 实例账单明细'."\n" + .'PartnerInstanceDetailMonthly 实例月账单', + 'type' => 'string', + 'required' => true, + 'example' => 'PartnerBillingItemDetailForBillingPeriod', + ], + ], + [ + 'name' => 'BeginBillingCycle', + 'in' => 'query', + 'schema' => [ + 'title' => 'subscribeBucket', + 'description' => '起始推送账单月份'."\n" + .'格式yyyy-MM'."\n" + ."\n" + .'订阅成功后，系统会自动推送起始账期到当前时间的数据。最多可推送最近六个月内数据(包含当前月)。超出则订阅无效', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10', + ], + ], + [ + 'name' => 'BillFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '账单文件格式'."\n" + .'可选'."\n" + .'csv'."\n" + .'parquet'."\n" + ."\n" + .'如果订阅多个文件类型,建议区分bucket订阅.避免文件覆盖', + 'type' => 'string', + 'required' => true, + 'example' => 'csv', + ], + ], + [ + 'name' => 'SubscribeSegmentSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单个文件账单数据行数阈值，超过此阈值会自动拆分成多个文件，拆分后文件的命名规则为`uid_billType_billCycle_SquenceNo_fileNo`'."\n" + ."\n" + .'文件名称除fileNo信息不一致外其他信息全部一致,可视为同一账期,同一类型文件.因拆分导致的多个文件.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '状态码', + 'type' => 'string', + 'enumValueTitles' => [ + 1001 => '订阅账单类型无效', + '订阅文件类型无效', + '开始推送日期无效', + '订阅失败', + '没有订阅权限', + '已存在订阅记录', + '无效的bucket', + ], + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '订阅三级账单', + 'description' => '- 请确保调用者是国际阿里云总经销商伙伴。'."\n" + .'- 用户一次订阅一个类型的账单文件。'."\n" + .'- 订阅后次日开始每日推送上一日生成的账单文件，每月5号推送上月整账期的全量账单文件。'."\n" + .'- 按天生成的账单文件可能存在时延，延迟生成的账单会在生成次日推送，也可能会包含上一日之前延迟到上一日生成的账单。建议每个月初拉取上个月全量文件。'."\n" + .'- 需要给订阅用户授予[AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D)权限。'."\n" + .'- 文件名'."\n" + ."\n" + .'```'."\n" + ."\n" + .'BillingItemDetailForBillingPeriod (计费项账单明细)'."\n" + .' '."\n" + .'每日推送文件名格式：UID_PartnerBillingItemDetail_YYYYMMDD_SquenceNo_fileNo，例如：169**_BillingItemDetail_20190310_0001_01。'."\n" + .' '."\n" + .'下月初完整文件名格式：UID_PartnerBillingItemDetail_YYYYMM_SquenceNo_fileNo，例如：169**_BillingItemDetail_201903_0001_01。'."\n" + ."\n" + .'InstanceDetailForBillingPeriod (实例账单明细)'."\n" + .' '."\n" + .' 每日推送文件名格式：UID_PartnerInstanceDetail_YYYYMMDD_SquenceNo_fileNo，例如：169**_InstanceDetail_20190310_0001_01。'."\n" + .' '."\n" + .'下月初完整文件名格式：UID_PartnerInstanceDetail_YYYYMM_SquenceNo_fileNo，例如：169**_InstanceDetail_201903_1999-0001_01。'."\n" + ."\n" + .'BillingItemDetailMonthly (计费项月账单)'."\n" + .' '."\n" + .'每日推送文件名格式：UID_PartnerBillingItemDetailMonthly_YYYYMM_SquenceNo_fileNo，例如：169**_BillingItemDetailMonthly_201903_0001_01。此文件每日更新月初至当日的全量数据，直至次月5号。'."\n" + ."\n" + .'InstanceDetailMonthly (实例月账单)'."\n" + .' '."\n" + .'每日推送文件名格式：UID_PartnerInstanceDetailMonthly_YYYYMM_SquenceNo_fileNo，例如：169**_InstanceDetailMonthly_201903_0001_01。此文件每日更新月初至当日的全量数据，直至次月5号。'."\n" + ."\n" + .'fileNo只有在进行账单行数达到拆分阈值时,进行了文件的拆分.才会存在'."\n" + ."\n" + .'```'."\n" + .'**本内容只发布国际站**', + ], + 'GetTier2CouponApprovalDetail' => [ + 'summary' => '该接口只适用distributor，查看二级分销商发起的优惠券申请详情', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单ID', + 'type' => 'string', + 'required' => false, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '0b9a079e17691387754512757e6a1b', + ], + 'Code' => [ + 'description' => '接口返回码：200：表示成功。 其它：表示错误码。错误码详情，请参见错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'ApplicationSheetId' => [ + 'description' => '申请单 ID', + 'type' => 'string', + 'example' => '0b9a079e17691387754512757e6a1b', + ], + 'ApprovalStatus' => [ + 'description' => '审批状态'."\n" + .'- 1：已撤销'."\n" + .'- 2：审批中'."\n" + .'- 3：已驳回'."\n" + .'- 4：审批通过'."\n" + .'- 5：审批通过但发放失败'."\n" + .'- 8：待处理', + 'type' => 'string', + 'example' => '2', + ], + 'TotalAmount' => [ + 'description' => '申请金额', + 'type' => 'string', + 'example' => '100.00', + ], + 'RemainingQuota' => [ + 'description' => '发完优惠券预计剩余伙伴新客户PoC优惠券权益额度', + 'type' => 'string', + 'example' => '20.00', + ], + 'ApplicationReason' => [ + 'description' => '申请原因', + 'type' => 'string', + 'example' => '申请原因', + ], + 'ApplicantInfo' => [ + 'description' => '申请基本信息', + 'type' => 'object', + 'properties' => [ + 'T2PartnerName' => [ + 'description' => '二级分销商名称', + 'type' => 'string', + 'example' => 'test account', + ], + 'T2PartnerUid' => [ + 'description' => '二级分销商UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5248516846402795', + ], + 'ApplicableProducts' => [ + 'description' => '适用产品'."\n" + ."\n" + .'- UNIVERSAL：全部产品'."\n" + ."\n" + .'- 具体商品code', + 'type' => 'string', + 'example' => 'UNIVERSAL', + ], + 'ApplicationTime' => [ + 'description' => '申请时间', + 'type' => 'string', + 'example' => '2026-01-21 11:24', + ], + 'ValidUntil' => [ + 'description' => '有效期，为有效天数或有效时间段', + 'type' => 'string', + 'example' => '2026-01-21 ~ 2199-12-31', + ], + 'OrderType' => [ + 'description' => '订单类型，为优惠券使用的订单类型。'."\n" + .'- ALL：阿里云预付费'."\n" + .'- BILLING：阿里云按量付费账单'."\n" + .'- ALL,BILLING：阿里云预付费；阿里云按量付费账单', + 'type' => 'string', + 'example' => 'ALL,BILLING', + ], + ], + ], + 'CouponReceiptUidList' => [ + 'description' => '收券客户UID列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uid' => [ + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703016242044705', + ], + 'NominalValue' => [ + 'description' => '面额', + 'type' => 'string', + 'example' => '100.00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ApplicationSheetId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"ApprovalStatus\\": \\"2\\",\\n \\"TotalAmount\\": \\"100.00\\",\\n \\"RemainingQuota\\": \\"20.00\\",\\n \\"ApplicationReason\\": \\"申请原因\\",\\n \\"ApplicantInfo\\": {\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516846402795,\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ValidUntil\\": \\"2026-01-21 ~ 2199-12-31\\",\\n \\"OrderType\\": \\"ALL,BILLING\\"\\n },\\n \\"CouponReceiptUidList\\": [\\n {\\n \\"Uid\\": 1703016242044705,\\n \\"NominalValue\\": \\"100.00\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '二级分销商优惠券申请单详情', + ], + 'ListTier2CouponApproval' => [ + 'summary' => '该接口只适用distributor，用于distributor 一级伙伴查看其下面二级分销商为其eu申请的优惠券申请', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'T2PartnerName', + 'in' => 'query', + 'schema' => [ + 'description' => '二级分销商名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test account', + ], + ], + [ + 'name' => 'T2PartnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '二级分销商UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5248516956402795', + ], + ], + [ + 'name' => 'ApprovalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '审批状态'."\n" + .'- 1：已撤销'."\n" + .'- 2：审批中'."\n" + .'- 3：已驳回'."\n" + .'- 4：审批通过'."\n" + .'- 5：审批通过但发放失败'."\n" + .'- 8：待处理', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，从1开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单ID', + 'type' => 'string', + 'required' => false, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Total' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Code' => [ + 'description' => '状态code', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => '返回数据对象', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'ApplicationSheetId' => [ + 'description' => '申请单ID', + 'type' => 'string', + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + 'T2PartnerName' => [ + 'description' => '二级分销商名称', + 'type' => 'string', + 'example' => 'test account', + ], + 'T2PartnerUid' => [ + 'description' => '二级分销商UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5248516956402795', + ], + 'ApplicationTime' => [ + 'description' => '申请时间', + 'type' => 'string', + 'example' => '2026-01-21 11:24', + ], + 'ApprovalStatus' => [ + 'description' => '审批状态'."\n" + ."\n" + .'- 1：已撤销'."\n" + .'- 2：审批中'."\n" + .'- 3：已驳回'."\n" + .'- 4：审批通过'."\n" + .'- 5：审批通过但发放失败'."\n" + .'- 8：待处理', + 'type' => 'string', + 'example' => '1', + ], + 'TotalAmount' => [ + 'description' => '申请金额', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationSheetId\\": \\"d54ca949-9b88-4514-add3-c6029c4027f4\\",\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516956402795,\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ApprovalStatus\\": \\"1\\",\\n \\"TotalAmount\\": \\"200\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '二级分销商优惠券审批列表', + ], + 'CancelCoupon' => [ + 'summary' => '作废优惠券', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '优惠券编号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '501001340370350', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '操作结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_201', + 'errorMessage' => 'Parameters are illegal and required fields are empty.', + ], + [ + 'errorCode' => 'ERROR_2311', + 'errorMessage' => 'Coupon template does not exist.', + ], + [ + 'errorCode' => 'ERROR_1003', + 'errorMessage' => 'No permission to operate the object.', + ], + [ + 'errorCode' => 'ERROR_2307', + 'errorMessage' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '作废优惠券', + ], + 'CreateCouponTemplate' => [ + 'summary' => '创建优惠券模板', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '【模板名称】'."\n" + .'字段长度限制 30', + 'description' => '【模板名称】'."\n" + .'字段长度限制 30', + 'type' => 'string', + 'required' => true, + 'example' => '模板名称', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'ReasonForApplication', + 'in' => 'query', + 'schema' => [ + 'title' => '【模板申请原因】'."\n" + .'字段长度限制100', + 'description' => '【模板申请原因】'."\n" + .'字段长度限制100', + 'type' => 'string', + 'required' => true, + 'example' => '模板申请原因', + 'maxLength' => 100, + ], + ], + [ + 'name' => 'CostBearer', + 'in' => 'query', + 'schema' => [ + 'title' => '【优惠券成本承担方】'."\n" + .'● Partner自行承担'."\n" + .'● Alibaba Cloud阿里云承担成本', + 'description' => '【优惠券成本承担方】'."\n" + .'● Partner自行承担'."\n" + .'● Alibaba Cloud阿里云承担成本', + 'type' => 'string', + 'required' => true, + 'example' => 'Partner', + 'enum' => [ + 'Partner', + 'Alibaba Cloud', + ], + ], + ], + [ + 'name' => 'ApplicableProducts', + 'in' => 'query', + 'schema' => [ + 'title' => '【适用产品】'."\n" + .'● All Products全部产品'."\n" + .'● Custom自定义', + 'description' => '【适用产品】'."\n" + .'● All Products全部产品'."\n" + .'● Custom自定义', + 'type' => 'string', + 'required' => true, + 'example' => 'All Products', + 'enum' => [ + 'All Products', + 'Custom', + ], + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '【产品code列表】', + 'description' => '【产品code列表】', + 'type' => 'array', + 'items' => [ + 'description' => '【产品code】国际渠道分销优惠券可抵扣产品接口返回值', + 'type' => 'string', + 'required' => false, + 'example' => 'code1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'LimitPerPerson', + 'in' => 'query', + 'schema' => [ + 'title' => '【每人限领张数】'."\n" + .'● Limited to 1限领一张：'."\n" + .'● Unlimited不限制', + 'description' => '【每人限领张数】'."\n" + .'● Limited to 1限领一张：'."\n" + .'● Unlimited不限制', + 'type' => 'string', + 'required' => true, + 'example' => 'Unlimited', + 'enum' => [ + 'Limited to 1', + 'Unlimited', + ], + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'title' => '【面额】'."\n" + .'必须为整数', + 'description' => '【面额】'."\n" + .'必须为整数', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ValidUntil', + 'in' => 'query', + 'schema' => [ + 'title' => '【有效期】'."\n" + .'● Validity Duration:自发券之日起'."\n" + .'● Custom Timeframe:自定义时间段', + 'description' => '【有效期】'."\n" + .'● Validity Duration:自发券之日起'."\n" + .'● Custom Timeframe:自定义时间段', + 'type' => 'string', + 'required' => true, + 'example' => 'Validity Duration', + 'enum' => [ + 'Validity Duration', + 'Custom Timeframe', + ], + ], + ], + [ + 'name' => 'Vailddate', + 'in' => 'query', + 'schema' => [ + 'title' => '【生效时间的开始时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'description' => '【生效时间的开始时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-26', + ], + ], + [ + 'name' => 'Expireddate', + 'in' => 'query', + 'schema' => [ + 'title' => '【生效时间的结束时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'description' => '【生效时间的结束时间】'."\n" + .'yyyy-MM-dd 格式'."\n" + .'如 2024-08-26 '."\n" + .'有效期选择 自定义时间段 必填', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-26', + ], + ], + [ + 'name' => 'Vaildperioddays', + 'in' => 'query', + 'schema' => [ + 'title' => '【相对时间的持续多少天‘】'."\n" + .'限制为正整数'."\n" + .'有效期选择 自发券之日起 必填', + 'description' => '【相对时间的持续多少天】'."\n" + .'限制为正整数'."\n" + .'有效期选择 自发券之日起 必填', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PurchaseType', + 'in' => 'query', + 'schema' => [ + 'title' => '【订单类型】', + 'description' => '【订单类型】', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + 'enum' => [ + 'ALL', + 'Subscription', + 'Pay-As-You-Go', + ], + ], + ], + [ + 'name' => 'CouponDescription', + 'in' => 'query', + 'schema' => [ + 'title' => '券备注信息'."\n" + .'长度限制100', + 'description' => '券备注信息'."\n" + .'长度限制100', + 'type' => 'string', + 'required' => false, + 'example' => '券备注信息', + 'maxLength' => 100, + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => ' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US'."\n" + .' 日文：ja', + 'description' => ' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US'."\n" + .' 日文：ja', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2103a30617045934095083027d88c5', + ], + 'Code' => [ + 'title' => '状态码 200 成功', + 'description' => '状态码 200 成功', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '错误信息', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'TemplateName' => [ + 'title' => '优惠券模版名字', + 'description' => '优惠券模版名字', + 'type' => 'string', + 'example' => '模板名称', + ], + 'ApplicableProducts' => [ + 'title' => '【适用产品】'."\n" + .'● All Products全部产品'."\n" + .'● Custom自定义', + 'description' => '【适用产品】'."\n" + .'● All Products全部产品'."\n" + .'● Custom自定义', + 'type' => 'string', + 'example' => 'Custom', + 'enum' => [ + 'Custom', + 'All Products', + ], + ], + 'ProductType' => [ + 'title' => '【产品code列表】', + 'description' => '【产品code列表】', + 'type' => 'array', + 'items' => [ + 'description' => '【产品code】', + 'type' => 'string', + 'example' => 'code1', + ], + ], + 'Value' => [ + 'description' => '面额', + 'type' => 'string', + 'example' => '1', + ], + 'ValidUntil' => [ + 'title' => '【有效期】'."\n" + .'● Validity Duration:自发券之日起'."\n" + .'● Custom Timeframe:自定义时间段', + 'description' => '【有效期】'."\n" + .'● Validity Duration:自发券之日起'."\n" + .'● Custom Timeframe:自定义时间段', + 'type' => 'string', + 'example' => 'Validity Duration', + 'enum' => [ + 'Validity Duration', + 'Custom Timeframe', + ], + ], + 'Vailddate' => [ + 'title' => '【生效时间的开始时间】'."\n" + .'yyyy-MM-dd 格式', + 'description' => '【生效时间的开始时间】'."\n" + .'yyyy-MM-dd 格式', + 'type' => 'string', + 'example' => '2024-01-01', + ], + 'Expireddate' => [ + 'title' => '【生效时间的结束时间】'."\n" + .'yyyy-MM-dd 格式', + 'description' => '【生效时间的结束时间】'."\n" + .'yyyy-MM-dd 格式', + 'type' => 'string', + 'example' => '2024-01-01', + ], + 'Vaildperioddays' => [ + 'description' => '【相对时间的持续多少天】', + 'type' => 'string', + 'example' => '1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-04-02 16:15:31', + ], + 'CostBearer' => [ + 'title' => '【优惠券成本承担方】'."\n" + .'● Partner自行承担'."\n" + .'● Alibaba Cloud阿里云承担成本', + 'description' => '【优惠券成本承担方】'."\n" + .'● Partner自行承担'."\n" + .'● Alibaba Cloud阿里云承担成本', + 'type' => 'string', + 'example' => 'Partner', + 'enum' => [ + 'Partner', + 'Alibaba Cloud', + ], + ], + 'Status' => [ + 'title' => '状态'."\n" + ."\n" + .'CREATED 已创建 '."\n" + .'APPROVING 审核中'."\n" + .'APPROVED已批准'."\n" + .'UNAPPROVED 未批准'."\n" + .'ABANDONED 已作废'."\n" + .'EXPIRED 已过期'."\n" + .'EXHAUSTED 已用完'."\n" + .' ', + 'description' => '状态'."\n" + ."\n" + .'CREATED 已创建 '."\n" + .'APPROVING 审核中'."\n" + .'APPROVED已批准'."\n" + .'UNAPPROVED 未批准'."\n" + .'ABANDONED 已作废'."\n" + .'EXPIRED 已过期'."\n" + .'EXHAUSTED 已用完'."\n" + .' ', + 'type' => 'string', + 'example' => 'APPROVED', + ], + 'CouponTemplateID' => [ + 'title' => '优惠券模版ID', + 'description' => '优惠券模版ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111111', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_3070', + 'errorMessage' => 'CouponTemplateName must be entered.', + ], + [ + 'errorCode' => 'ERROR_3100', + 'errorMessage' => 'System exceptions, please submit a work order.', + ], + [ + 'errorCode' => 'ERROR_3091', + 'errorMessage' => 'Coupon template name length over limit.', + ], + [ + 'errorCode' => 'ERROR_3071', + 'errorMessage' => 'ApplicableProducts empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3094', + 'errorMessage' => 'Applicable product type parameters are not legal.', + ], + [ + 'errorCode' => 'ERROR_3080', + 'errorMessage' => 'Account empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3090', + 'errorMessage' => 'You have no authority.', + ], + [ + 'errorCode' => 'ERROR_3085', + 'errorMessage' => 'Product code is not in international channel partner coupons deductable product list.', + ], + [ + 'errorCode' => 'ERROR_3072', + 'errorMessage' => 'itemCodes empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3101', + 'errorMessage' => 'PurchaseType empty, please check .', + ], + [ + 'errorCode' => 'ERROR_3073', + 'errorMessage' => 'amout empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3096', + 'errorMessage' => 'Coupon value is illegal.', + ], + [ + 'errorCode' => 'ERROR_3074', + 'errorMessage' => 'personLimit empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3095', + 'errorMessage' => 'The per-person limit is illegal.', + ], + [ + 'errorCode' => 'ERROR_3075', + 'errorMessage' => 'applyReason empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3092', + 'errorMessage' => 'Reason for template request length over limit.', + ], + [ + 'errorCode' => 'ERROR_3098', + 'errorMessage' => 'Coupon Remarks Information length over limit.', + ], + [ + 'errorCode' => 'ERROR_3093', + 'errorMessage' => 'Coupon cost-bearer parameters are not legal.', + ], + [ + 'errorCode' => 'ERROR_3076', + 'errorMessage' => 'effDateType empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3078', + 'errorMessage' => 'effDateFrom empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3079', + 'errorMessage' => 'effDateTo empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3099', + 'errorMessage' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', + ], + [ + 'errorCode' => 'ERROR_3103', + 'errorMessage' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', + ], + [ + 'errorCode' => 'ERROR_3084', + 'errorMessage' => 'Coupon cannot be valid for more than 180 days.', + ], + [ + 'errorCode' => 'ERROR_3077', + 'errorMessage' => 'effDateDay empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3097', + 'errorMessage' => 'Time type is illegal.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"ApplicableProducts\\": \\"Custom\\",\\n \\"ProductType\\": [\\n \\"code1\\"\\n ],\\n \\"Value\\": \\"1\\",\\n \\"ValidUntil\\": \\"Validity Duration\\",\\n \\"Vailddate\\": \\"2024-01-01\\",\\n \\"Expireddate\\": \\"2024-01-01\\",\\n \\"Vaildperioddays\\": \\"1\\",\\n \\"CreateTime\\": \\"2024-04-02 16:15:31\\",\\n \\"CostBearer\\": \\"Partner\\",\\n \\"Status\\": \\"APPROVED\\",\\n \\"CouponTemplateID\\": 111111\\n }\\n}","type":"json"}]', + 'title' => '创建优惠券模板', + ], + 'CouponApprovalStatusList' => [ + 'summary' => '查询优惠券审批状态列表', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模板ID', + 'type' => 'string', + 'required' => false, + 'example' => '5093156', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => false, + 'example' => '测试优惠券模板', + ], + ], + [ + 'name' => 'TemplateStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模板状态。取值：'."\n" + .'- **1**：已撤销申请。'."\n" + .'- **2**：审核中。'."\n" + .'- **3**：审核驳回。'."\n" + .'- **4**：审核通过。'."\n" + .'- **5**：审核通过但发放失败。'."\n" + .'- **6**：自动通过。'."\n" + .'- **7**：自动通过但发放失败。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'PageNo' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'S00000101-100040', + ], + 'TemplateName' => [ + 'description' => '优惠券模版名字', + 'type' => 'string', + 'example' => '模板名称', + ], + 'TemplateStatus' => [ + 'description' => '优惠券模板状态。取值：'."\n" + .'- **1**：已撤销申请。'."\n" + .'- **2**：审核中。'."\n" + .'- **3**：审核驳回。'."\n" + .'- **4**：审核通过。'."\n" + .'- **5**：审核通过但发放失败。'."\n" + .'- **6**：自动通过。'."\n" + .'- **7**：自动通过但发放失败。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TimeOfRequest' => [ + 'description' => '申请时间', + 'type' => 'string', + 'example' => '2024-02-02 09:46:59', + ], + 'IssuerAccount' => [ + 'description' => '发放账号', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Note' => [ + 'description' => '审批意见', + 'type' => 'string', + 'example' => '通过', + ], + 'IssuerUid' => [ + 'description' => '发放账号uid', + 'type' => 'string', + 'example' => '5432738203821334', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"S00000101-100040\\",\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"TemplateStatus\\": 2,\\n \\"TimeOfRequest\\": \\"2024-02-02 09:46:59\\",\\n \\"IssuerAccount\\": \\"[email protected]\\",\\n \\"Note\\": \\"通过\\",\\n \\"IssuerUid\\": \\"5432738203821334\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '优惠券审批状态列表查询', + 'description' => '确保当前调用账号身份为分销伙伴 '."\n" + .'<notice>仅国际提供></notice>', + ], + 'DeleteCouponTemplate' => [ + 'summary' => '作废优惠券模板', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模板ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '6558410265670417297', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4', + ], + 'Code' => [ + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '结果message', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '操作结果', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_1003', + 'errorMessage' => 'No permission to operate the object.', + ], + [ + 'errorCode' => 'ERROR_2311', + 'errorMessage' => 'Coupon template does not exist.', + ], + [ + 'errorCode' => 'ERROR_201', + 'errorMessage' => 'Parameters are illegal and required fields are empty.', + ], + [ + 'errorCode' => 'ERROR_2310', + 'errorMessage' => 'The template has a coupon that is being approved so the template cannot be canceled.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '作废优惠券模板', + 'description' => '确保当前调用账号身份为分销伙伴 '."\n" + .'<notice>仅国际提供></notice>', + ], + 'GetCouponTemplateDetail' => [ + 'summary' => '查询优惠券模板详情', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模板ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5093156', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => '结果码', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '操作结果', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1576', + ], + 'TemplateName' => [ + 'description' => '优惠券模版名字', + 'type' => 'string', + 'example' => '模板名称', + ], + 'CreatedTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-11-21 18:18:22', + ], + 'ReasonForApplication' => [ + 'description' => '模板申请原因', + 'type' => 'string', + 'example' => '测试的', + ], + 'CostBearer' => [ + 'description' => '优惠券成本承担方'."\n" + .'● cost_by_self 自行承担'."\n" + .'● aliyun_poc阿里云承担成本', + 'type' => 'string', + 'example' => 'aliyun_poc', + ], + 'ApplicableProducts' => [ + 'description' => '适用产品'."\n" + ."\n" + .'- UNIVERSAL：全部产品'."\n" + ."\n" + .'- 具体商品code', + 'type' => 'string', + 'example' => 'UNIVERSAL', + ], + 'LimitPerPerson' => [ + 'description' => '每人限领张数'."\n" + ."\n" + .'- 1 限领一张'."\n" + ."\n" + .'- 0 不限制', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Denomination' => [ + 'description' => '面额', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'ValidUntilType' => [ + 'description' => '有效期类型'."\n" + ."\n" + .'- 0：相对时间'."\n" + .'- 1：决定时间', + 'type' => 'string', + 'example' => '0', + ], + 'ValidUntil' => [ + 'description' => '有效期，跟有效类型配合使用'."\n" + ."\n" + .'- 有效期类型为相对时间，有效期为有效天数'."\n" + ."\n" + .'- 有效期类型为绝对时间，有效期为时间段', + 'type' => 'string', + 'example' => '100', + ], + 'PurchaseType' => [ + 'description' => '订单类型'."\n" + .'- ALL 阿里云预付费'."\n" + .'- BILLING 阿里云按量付费账单', + 'type' => 'string', + 'example' => 'ALL,BILLING', + ], + 'CouponDescription' => [ + 'description' => '券备注信息', + 'type' => 'string', + 'example' => '测试的', + ], + 'Status' => [ + 'description' => '状态'."\n" + ."\n" + .'- APPROVED 已批准'."\n" + .'- ABANDONED已作废', + 'type' => 'string', + 'example' => 'APPROVED', + ], + ], + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_201', + 'errorMessage' => 'Parameters are illegal and required fields are empty.', + ], + [ + 'errorCode' => 'ERROR_1002', + 'errorMessage' => 'No query permission.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TemplateId\\": 1576,\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"CreatedTime\\": \\"2024-11-21 18:18:22\\",\\n \\"ReasonForApplication\\": \\"测试的\\",\\n \\"CostBearer\\": \\"aliyun_poc\\",\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"LimitPerPerson\\": 1,\\n \\"Denomination\\": 100,\\n \\"ValidUntilType\\": \\"0\\",\\n \\"ValidUntil\\": \\"100\\",\\n \\"PurchaseType\\": \\"ALL,BILLING\\",\\n \\"CouponDescription\\": \\"测试的\\",\\n \\"Status\\": \\"APPROVED\\"\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询优惠券模板详情', + 'description' => '确保当前调用账号身份为分销伙伴 '."\n" + .'<notice>仅国际提供></notice>', + ], + 'GetCoupondeductProductCode' => [ + 'summary' => '国际渠道分销优惠券可抵扣产品', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数 '."\n" + .'默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'description' => '多语言参数 '."\n" + .'默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，候选值:'."\n" + .'200: OK', + 'type' => 'string', + 'example' => 'code', + ], + 'Data' => [ + 'description' => '数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'ProductType' => [ + 'description' => '【产品code】', + 'type' => 'any', + 'example' => 'code1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_3100', + 'errorMessage' => 'System exceptions, please submit a work order.', + ], + [ + 'errorCode' => 'ERROR_3210', + 'errorMessage' => 'The current calling UID is not an international channel partner.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"code\\",\\n \\"Data\\": [\\n {\\n \\"ProductType\\": \\"code1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '国际渠道分销优惠券可抵扣产品', + ], + 'IssueCouponForCustomer' => [ + 'summary' => '发放优惠券', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CouponTemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券模版ID', + 'description' => '优惠券模版ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5075915', + ], + ], + [ + 'name' => 'Uidlist', + 'in' => 'query', + 'schema' => [ + 'title' => 'uid列表'."\n" + .'用,分割 如 111,2222', + 'description' => 'uid列表'."\n" + .'用,分割 如 111,2222', + 'type' => 'string', + 'required' => true, + 'example' => '111,2222', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'description' => '多语言参数'."\n" + .' 默认值:无'."\n" + .' 中文：zh-CN'."\n" + .' 英文：en-US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'IsUseBenefit', + 'in' => 'query', + 'schema' => [ + 'title' => '是否使用权益（已作废）'."\n" + .'如：true/false', + 'description' => '是否使用POC优惠券额度'."\n" + .'ture：使用POC优惠券额度，如果所有提交的账号都标记为免审批，则当前的优惠券申请将跳过审批流程，您的伙伴权益包中的POC优惠券配额将被扣除；'."\n" + .'false：不使用POC优惠券额度，无论提交账号的免审批状态如何，您的POC优惠券权益配额将保持不变，在这种情况下，申请将遵循标准的优惠券申请审批流程', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplicationReason', + 'in' => 'query', + 'schema' => [ + 'title' => '申请原因'."\n" + .'如：为客户XXX申请优惠券', + 'description' => '申请原因'."\n" + .'如：为客户XXX申请优惠券', + 'type' => 'string', + 'required' => false, + 'example' => '为客户XXX审批优惠券，该客户是XXXX', + 'maxLength' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => '错误代码', + 'type' => 'string', + 'example' => 'code', + ], + 'Message' => [ + 'description' => 'message信息', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'data' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'CouponTemplateId' => [ + 'title' => '优惠券模版ID', + 'description' => '优惠券模版ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5075915', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-05 18:24:07', + ], + 'Uidlist' => [ + 'description' => '发放UID', + 'type' => 'string', + 'example' => '111,2222'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ERROR_3100', + 'errorMessage' => 'System exceptions, please submit a work order.', + ], + [ + 'errorCode' => 'ERROR_3081', + 'errorMessage' => 'couponTemplateId empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3082', + 'errorMessage' => 'Uidlist empty, please check .', + ], + [ + 'errorCode' => 'ERROR_3080', + 'errorMessage' => 'Account empty, please check.', + ], + [ + 'errorCode' => 'ERROR_3090', + 'errorMessage' => 'You have no authority.', + ], + [ + 'errorCode' => 'ERROR_3088', + 'errorMessage' => 'Coupon template expired, unable to issue coupon.', + ], + [ + 'errorCode' => 'ERROR_3102', + 'errorMessage' => 'This coupon template ID was not created by this account.', + ], + [ + 'errorCode' => 'ERROR_3089', + 'errorMessage' => 'Coupon template issuance limit exceeded, unable to issue coupon.', + ], + [ + 'errorCode' => 'ERROR_3086', + 'errorMessage' => 'The current uid does not have a distribution relationship and cannot issue a coupon.', + ], + [ + 'errorCode' => 'ERROR_3087', + 'errorMessage' => 'The current uid is not the end user identity, can not issue coupons.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"code\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"data\\": {\\n \\"CouponTemplateId\\": 5075915,\\n \\"CreateTime\\": \\"2024-03-05 18:24:07\\",\\n \\"Uidlist\\": \\"111,2222\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '发放优惠券', + ], + 'ListCouponUsage' => [ + 'summary' => '分销伙伴查询自己优惠券发放后的优惠券使用量。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'title' => '收券账号，如：[email protected]', + 'description' => '阿里云客户账号', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券状态', + 'description' => '优惠券状态 </br>'."\n" + .'AVAILABLE 正常 </br>'."\n" + .'EXHAUSTED 已用完 </br>'."\n" + .'EXPIRED 已过期 </br>'."\n" + .'ABANDONED 已作废 </br>', + 'type' => 'string', + 'required' => false, + 'example' => 'AVAILABLE', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页号，如：1', + 'description' => '页码</br> '."\n" + .' 默认值为1 最小值1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，如：20', + 'description' => '分页行数 </br>'."\n" + .' 默认值20 最大值50 最小值1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'title' => '收券账号uid', + 'description' => '阿里云账号uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1133166938931507', + ], + ], + [ + 'name' => 'CouponTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券模版id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5075915', + ], + ], + [ + 'name' => 'T2PartnerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'T2伙伴uid'."\n" + .'如：123456789', + 'description' => 'T2伙伴uid'."\n" + .'如：123456789', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456768', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => 'Id of the request', + 'description' => '接口返回提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'RequestId' => [ + 'description' => '接口请求id返回问题提供查询使用', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'PageInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'Page' => [ + 'description' => '分页，当前页', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页，每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '分页，总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + ], + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'CouponTemplateId' => [ + 'description' => '优惠券模版id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '503802', + ], + 'CouponId' => [ + 'description' => '优惠券id', + 'type' => 'string', + 'example' => '59226280', + ], + 'Amount' => [ + 'description' => '优惠券面额', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'Balance' => [ + 'description' => '余额', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'EffDate' => [ + 'description' => '优惠券有效期', + 'type' => 'string', + 'example' => '2023-04-06 00:00:00 ~ 2023-04-07 00:00:00', + ], + 'Status' => [ + 'description' => '优惠券状态 </br>'."\n" + .'AVAILABLE 正常 </br>'."\n" + .'EXHAUSTED 已用完 </br>'."\n" + .'EXPIRED 已过期 </br>'."\n" + .'ABANDONED 已作废 </br>', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'Account' => [ + 'description' => '阿里云账号', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'PublishDate' => [ + 'description' => '优惠券发放时间', + 'type' => 'string', + 'example' => '2023-04-06 19:32:10'."\n", + ], + 'Uid' => [ + 'description' => '阿里云uid', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647668856741998', + ], + 'T2PartnerUid' => [ + 'description' => '二级分销商UID', + 'type' => 'string', + 'example' => '5248516956402795', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageInfo\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 300\\n },\\n \\"Data\\": [\\n {\\n \\"CouponTemplateId\\": 503802,\\n \\"CouponId\\": \\"59226280\\",\\n \\"Amount\\": 200,\\n \\"Balance\\": 0.01,\\n \\"EffDate\\": \\"2023-04-06 00:00:00 ~ 2023-04-07 00:00:00\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Account\\": \\"[email protected]\\",\\n \\"PublishDate\\": \\"2023-04-06 19:32:10\\\\n\\",\\n \\"Uid\\": 1647668856741998,\\n \\"T2PartnerUid\\": \\"5248516956402795\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '优惠券使用量列表查询', + 'description' => '确保当前调用账号身份为分销伙伴 '."\n" + .'<notice>仅国际提供></notice>', + ], + 'QuotaListExportPaged' => [ + 'summary' => '国际分销用户查看quota流水导出结果，只允许国际站调用。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，从1开始', + 'description' => '分页页码，从1开始', + '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', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数，默认英文'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '210e876f16704666020714468dab35', + ], + 'Total' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '当前每页条数', + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Msg' => [ + 'title' => '返回结果描述', + 'description' => '返回结果描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果列表数据。', + 'type' => 'array', + 'items' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名称', + 'description' => '文件名称', + 'type' => 'string', + 'example' => '5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-12-21 21:31:57 UTC+8', + ], + 'Status' => [ + 'title' => '任务状态展示', + 'description' => '任务状态展示', + 'type' => 'string', + 'example' => '3', + ], + 'StatusCode' => [ + 'title' => '任务状态code枚举'."\n" + .'2：导出中'."\n" + .'3：导出成功'."\n" + .'-1：导出失败', + 'description' => '任务状态code枚举'."\n" + .'2：导出中'."\n" + .'3：导出成功'."\n" + .'-1：导出失败', + 'type' => 'string', + 'example' => 'Export Success', + ], + 'Url' => [ + 'title' => '文件下载链接', + 'description' => '文件下载链接', + 'type' => 'string', + 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057', + ], + 'Message' => [ + 'title' => '提示信息', + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2023-12-21 21:31:57 UTC+8\\",\\n \\"Status\\": \\"3\\",\\n \\"StatusCode\\": \\"Export Success\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看quota流水导出结果', + 'description' => '调用者必须是阿里云国际站渠道总经销商伙伴或阿里云国际站渠道经销商伙伴。', + ], + 'ProcessApproval' => [ + 'summary' => '该功能只适用于distributor，对需要伙伴审批的流程进行审批', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ApplicationSheetId', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单id', + 'type' => 'string', + 'required' => true, + 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', + ], + ], + [ + 'name' => 'ApprovalAction', + 'in' => 'query', + 'schema' => [ + 'description' => '审批动作：'."\n" + .'- Approve：同意'."\n" + .'- Reject：拒绝', + 'type' => 'string', + 'required' => true, + 'example' => 'Approve', + ], + ], + [ + 'name' => 'ApprovalComments', + 'in' => 'query', + 'schema' => [ + 'description' => '审批意见', + 'type' => 'string', + 'required' => true, + 'example' => '同意', + 'maxLength' => 500, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'id of request', + 'type' => 'string', + 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => '审批结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '通用的审批流程审批', + ], + 'ListExportTasks' => [ + 'summary' => '查询导出后的文件列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，从1开始', + 'description' => '分页，当前页码，从 1 开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小，最大100', + 'description' => '分页每页记录数，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'description' => '多语言参数'."\n" + .'en：英文'."\n" + .'zh：中文'."\n" + .'ja：日文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'default' => 'en', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'title' => '导出场景code'."\n" + .'intlCustomerQuotaRecord：客户管理，quota流水导出'."\n" + .'intlExportUsageDeductHistory：客户管理，冲减明细导出', + 'description' => '导出场景code'."\n" + .'intlCustomerQuotaRecord：客户管理，quota流水导出'."\n" + .'intlExportUsageDeductHistory：客户管理，冲减明细导出', + 'type' => 'string', + 'required' => true, + 'example' => 'intlExportUsageDeductHistory', + 'enum' => [ + 'intlExportUsageDeductHistory', + 'intlCustomerQuotaRecord', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '导出任务id', + 'description' => '导出任务id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12343', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'asda1231as', + ], + 'Total' => [ + 'title' => '总条数', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageNo' => [ + 'title' => '当前页码', + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '当前每页条数', + 'description' => '当前每页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Message' => [ + 'title' => '返回结果描述', + 'description' => '返回结果描述', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '返回结果状态码，200是成功', + 'description' => '返回结果状态码，200是成功', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名称', + 'description' => '文件名称', + 'type' => 'string', + 'example' => '511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-11-01 10:22:11'."\n", + ], + 'Status' => [ + 'title' => '任务状态展示', + 'description' => '任务状态展示', + 'type' => 'string', + 'example' => 'Export Success', + ], + 'StatusCode' => [ + 'title' => '任务状态code枚举'."\n" + .'2：导出中'."\n" + .'3：导出成功'."\n" + .'-1：导出失败', + 'description' => '任务状态code枚举'."\n" + .'2：导出中'."\n" + .'3：导出成功'."\n" + .'-1：导出失败', + 'type' => 'string', + 'example' => '3', + ], + 'Url' => [ + 'title' => '文件下载链接', + 'description' => '文件下载链接', + 'type' => 'string', + 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057', + ], + 'Message' => [ + 'title' => '提示信息', + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'null', + ], + 'Id' => [ + 'title' => '导出任务id，唯一标识', + 'description' => '导出任务id，唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12355', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.ExportTask.SceneCodeError', + 'errorMessage' => 'The exporting scenario is incorrect.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2024-11-01 10:22:11\\\\n\\",\\n \\"Status\\": \\"Export Success\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"null\\",\\n \\"Id\\": 12355\\n }\\n ]\\n}","type":"json"}]', + 'title' => '通用的查询导出文件列表', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'agency.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/agency/2025-02-27/api-docs.php b/data/zh_cn/agency/2025-02-27/api-docs.php new file mode 100644 index 0000000..b44e988 --- /dev/null +++ b/data/zh_cn/agency/2025-02-27/api-docs.php @@ -0,0 +1,1763 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Agency', + 'version' => '2025-02-27', + ], + 'directories' => [ + 'GetBillDetailFileList', + 'GetSubPartnerOrderList', + 'GetSubPartnerList', + 'GetRenewalRateList', + 'GetCustomerOrderList', + 'GetCommissionDetailFileList', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetBillDetailFileList' => [ + 'summary' => '查询账单导出文件。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '月份', + 'type' => 'string', + 'required' => true, + 'example' => '202502', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'OssAccessKeyId', + 'in' => 'query', + 'schema' => [ + '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' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '210bc4b416874189683843905d9f9a', + ], + 'Code' => [ + 'description' => '状态code', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'BillMonth' => [ + 'description' => '月份', + 'type' => 'string', + 'example' => '202502', + ], + 'FileName' => [ + 'description' => '文件名称', + 'type' => 'string', + 'example' => '账单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' => '成功', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileName\\": \\"账单202502021112\\",\\n \\"Type\\": \\"拓渠\\",\\n \\"FileUrl\\": \\"aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"Status\\": \\"3\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Msg\\": \\"成功\\"\\n}","type":"json"}]', + 'title' => '查询账单导出文件', + ], + 'GetSubPartnerOrderList' => [ + 'summary' => '查询拓渠订单。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubPartnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '二级伙伴UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123432311', + ], + ], + [ + 'name' => 'SubPartnerName', + 'in' => 'query', + 'schema' => [ + 'description' => '二级伙伴名称', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX有限公司', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '商机ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '202501101023', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '209335720330622', + ], + ], + [ + 'name' => 'OrderTypeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '订单类型列表。'."\n" + .'订单类型包括：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', + 'type' => 'array', + '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' => 'int64', + 'required' => false, + 'maximum' => '3', + 'minimum' => '1', + 'example' => '3', + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称', + 'type' => 'string', + 'required' => false, + 'example' => '弹性计算', + ], + ], + [ + 'name' => 'OrderCreateAfter', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'OrderPayAfter', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PayAmountAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '实付起始金额', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayAmountBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '实付截至金额', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '10', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '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' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + '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类', + ], + ], + ], + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 3750,\\n \\"DiscountedPrice\\": 3750,\\n \\"AmountDue\\": 3750,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 0.9,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"弹性计算\\",\\n \\"CreatedAt\\": \\"2024-07-07 07:52:22\\",\\n \\"PaidAt\\": \\"2024-07-07 07:52:22\\",\\n \\"SubPartnerUid\\": 1123132,\\n \\"SubPartnerName\\": \\"xxx有限公司\\",\\n \\"ProjectId\\": 202502233443,\\n \\"CustomerClassification\\": \\"C类\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询拓渠订单', + ], + 'GetSubPartnerList' => [ + 'summary' => '查询二级分销商列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SubPartnerPid', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '二级伙伴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' => [ + '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' => [ + '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' => '张三', + ], + ], + ], + ], + '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.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"PageSize\\": \\"100\\",\\n \\"SubPartnerList\\": [\\n {\\n \\"CompanyName\\": \\"xxx有限公司\\",\\n \\"Pid\\": \\"P123456\\",\\n \\"MasterAccount\\": \\"xxxxxx有限公司主账号\\\\n\\",\\n \\"MasterUid\\": \\"123456\\",\\n \\"Province\\": \\"浙江省\\",\\n \\"City\\": \\"杭州市\\",\\n \\"District\\": \\"西湖区\\",\\n \\"Address\\": \\"xxx街道xxx号\\",\\n \\"AgreementStatus\\": \\"ACTIVE_PERIOD\\",\\n \\"AgreementStatusDesc\\": \\"生效期\\",\\n \\"JoinTime\\": \\"2000-01-01\\",\\n \\"Contact\\": \\"张三\\"\\n }\\n ],\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + 'title' => '查询二级分销商列表', + ], + 'GetRenewalRateList' => [ + 'summary' => '查询伙伴续费率。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'FiscalYearAndQuarter', + 'in' => 'query', + 'schema' => [ + 'description' => '财年季度', + 'type' => 'string', + 'required' => true, + 'example' => '2025Q4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'FiscalYearAndQuarter' => [ + 'description' => '财年季度', + 'type' => 'string', + 'example' => '2025Q4', + ], + 'MasterPid' => [ + 'description' => '伙伴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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"FiscalYearAndQuarter\\": \\"2025Q4\\",\\n \\"MasterPid\\": \\"P123423453\\",\\n \\"MasterPidName\\": \\"XX有限公司\\",\\n \\"FinalRenewalRate\\": 0.9,\\n \\"FinalRenewalAmountDue\\": 100,\\n \\"FinalRenewedAmount\\": 100,\\n \\"FinalOtherBillAmount\\": 100,\\n \\"FinalCustomerRenewalRate\\": 0.9,\\n \\"FinalCustomerRenewalAmountDue\\": 100,\\n \\"FinalCustomerRenewedAmount\\": 100,\\n \\"CustomerAdjustedRenewalAmountDue\\": 100,\\n \\"CustomerOtherBillAmount\\": 100,\\n \\"FinalSubPartnerRenewalRate\\": 0.85,\\n \\"FinalSubPartnerRenewalAmountDue\\": 100,\\n \\"FinalSubPartnerRenewedAmount\\": 100,\\n \\"SubPartnerAdjustedRenewalAmountDue\\": 100,\\n \\"SubPartnerOtherBillAmount\\": 100,\\n \\"SpecialFinalRenewRatio\\": 0.7,\\n \\"SpecialFinalRenewalAmountDue\\": 100,\\n \\"SpecialFinalRenewedAmount\\": 100,\\n \\"SpecialCustomerRenewRatio\\": 0.7,\\n \\"SpecialCustomerRenewalAmountDue\\": 100,\\n \\"SpecialCustomerRenewedAmount\\": 100,\\n \\"SpecialSubPartnerRenewRatio\\": 0.8,\\n \\"SpecialSubPartnerRenewalAmountDue\\": 100,\\n \\"SpecialSubPartnerRenewedAmount\\": 100\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询伙伴续费率', + ], + 'GetCustomerOrderList' => [ + 'summary' => '查询伙伴拓客订单。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '500', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'CustomerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '客户UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'CustomerAccount', + 'in' => 'query', + 'schema' => [ + 'description' => '客户账号', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'RamAccountForCustomerManager', + 'in' => 'query', + 'schema' => [ + 'description' => '客户跟进员工', + 'type' => 'string', + 'required' => false, + 'example' => '1234532', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '商机ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '202502002231', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '订单号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13595216', + ], + ], + [ + 'name' => 'OrderTypeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '订单类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '订单类型：BUY、UPGRADE、DOWNGRADE、'."\n" + .'RENEW、REFUND、OTHERS', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'DOWNGRADE', + 'RENEW', + 'REFUND', + 'OTHERS', + ], + ], + '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', + ], + ], + ], + [ + 'name' => 'PayType', + 'in' => 'query', + 'schema' => [ + 'description' => '支付类型：'."\n" + .'1：非代付；'."\n" + .'2：代付', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'required' => false, + 'example' => '弹性计算', + ], + ], + [ + 'name' => 'OrderCreateAfter', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'OrderPayAfter', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PayAmountAfter', + 'in' => 'query', + 'schema' => [ + 'description' => '实付起始金额', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PayAmountBefore', + 'in' => 'query', + 'schema' => [ + 'description' => '实付截至金额', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNo' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '236414227150922', + ], + 'OrderType' => [ + 'description' => '订单类型包括：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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRequest.NoPermissions.NotPartner', + 'errorMessage' => 'The current caller is not a partner.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"OrderType\\": \\"BUY\\",\\n \\"OrderStatus\\": 3,\\n \\"PayType\\": 1,\\n \\"Price\\": 29137,\\n \\"DiscountedPrice\\": 29137,\\n \\"AmountDue\\": 29137,\\n \\"DeductedAmountByCoupons\\": 0,\\n \\"AmountDiscount\\": 1,\\n \\"ProductCode\\": \\"slb\\",\\n \\"ProductName\\": \\"slb\\",\\n \\"CreatedAt\\": \\"2019-01-24 14:20:40\\",\\n \\"PaidAt\\": \\"2019-01-24 14:20:40\\",\\n \\"CustomerUid\\": 123456,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"RamAccountForCustomerManagers\\": [\\n \\"12345678\\"\\n ],\\n \\"CustomerClassification\\": \\"C类\\",\\n \\"ProjectId\\": 202502230421\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 400,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询伙伴拓客订单', + ], + 'GetCommissionDetailFileList' => [ + 'summary' => '查询伙伴佣金明细。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BillMonth', + 'in' => 'query', + 'schema' => [ + 'description' => '账单月份', + 'type' => 'string', + 'required' => false, + 'example' => '202501', + ], + ], + [ + 'name' => 'OssAccessKeyId', + 'in' => 'query', + 'schema' => [ + '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' => [ + '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.', + ], + [ + 'errorCode' => 'InvalidRequest.NoPermissions.RamNoPermission', + 'errorMessage' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"PartnerUid\\": \\"1112332432\\",\\n \\"BillMonth\\": \\"202502\\",\\n \\"FileList\\": [\\n {\\n \\"CommissionPolicyName\\": \\"参考【APS佣金查询下载功能】的政策名称\\",\\n \\"FileType\\": \\"总代政策为拓渠、普通政策为拓客\\",\\n \\"FileUrl\\": \\" aps.ailyun.com/file/download?resourceId=1234&type=1\\",\\n \\"FileName\\": \\"佣金202502021112\\",\\n \\"BucketSyncStatus\\": \\"处理中\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询伙伴佣金明细', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'agency.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', + ], + ], +]; |