diff options
Diffstat (limited to 'data/zh_cn/market/2015-11-01')
| -rw-r--r-- | data/zh_cn/market/2015-11-01/api-docs.php | 8437 |
1 files changed, 3229 insertions, 5208 deletions
diff --git a/data/zh_cn/market/2015-11-01/api-docs.php b/data/zh_cn/market/2015-11-01/api-docs.php index 7d61a6b..b01e734 100644 --- a/data/zh_cn/market/2015-11-01/api-docs.php +++ b/data/zh_cn/market/2015-11-01/api-docs.php @@ -1,257 +1,221 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Market', - 'version' => '2015-11-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'Market', 'version' => '2015-11-01'], 'directories' => [ [ - 'id' => 250866, - 'title' => '消息通知', + 'children' => ['DescribeFailedNotifications', 'ConfirmNotification'], 'type' => 'directory', - 'children' => [ - 'DescribeFailedNotifications', - 'ConfirmNotification', - ], + 'title' => '消息通知', + 'id' => 329765, ], [ - 'id' => 250867, - 'title' => '发票', + 'children' => ['ModifyInvoiceForIsv', 'DescribeInvoiceForIsv'], 'type' => 'directory', - 'children' => [ - 'ModifyInvoiceForIsv', - 'DescribeInvoiceForIsv', - ], + 'title' => '发票', + 'id' => 329768, ], [ - 'id' => 65815, - 'title' => '商品', + 'children' => ['DescribePrice', 'DescribeProduct', 'DescribeProducts'], 'type' => 'directory', - 'children' => [ - 'DescribePrice', - 'DescribeProduct', - 'DescribeProducts', - ], + 'title' => '商品', + 'id' => 329730, ], [ - 'id' => 65819, - 'title' => '订单', + 'children' => ['DescribeOrderForIsv', 'CreateOrder', 'DescribeOrder'], 'type' => 'directory', - 'children' => [ - 'DescribeOrderForIsv', - 'CreateOrder', - 'DescribeOrder', - ], + 'title' => '订单', + 'id' => 329734, ], [ - 'id' => 65822, - 'title' => '流程', + 'children' => ['DescribeProjectMessages', 'DescribeProjectNodes', 'DescribeProjectOperateLogs', 'DescribeCurrentNodeInfo', 'FinishCurrentProjectNode', 'RollbackCurrentProjectNode'], 'type' => 'directory', - 'children' => [ - 'DescribeProjectMessages', - 'DescribeProjectNodes', - 'DescribeProjectOperateLogs', - 'DescribeCurrentNodeInfo', - 'FinishCurrentProjectNode', - 'RollbackCurrentProjectNode', - ], + 'title' => '流程', + 'id' => 329738, ], [ - 'id' => 65829, - 'title' => '实例', + 'children' => ['DescribeInstance', 'DescribeInstanceForIsv', 'DescribeInstances', 'AutoRenewInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeInstance', - 'DescribeInstanceForIsv', - 'DescribeInstances', - 'AutoRenewInstance', - ], + 'title' => '实例', + 'id' => 329745, ], [ - 'id' => 65832, - 'title' => '项目', + 'children' => ['PauseProject', 'DescribeProjectAttachments', 'DescribeProjectInfo', 'ResumeProject'], 'type' => 'directory', - 'children' => [ - 'PauseProject', - 'DescribeProjectAttachments', - 'DescribeProjectInfo', - 'ResumeProject', - ], + 'title' => '项目', + 'id' => 329750, ], [ - 'id' => 65837, - 'title' => '授权', + 'children' => ['DescribeLicense', 'ActivateLicense'], 'type' => 'directory', - 'children' => [ - 'DescribeLicense', - 'ActivateLicense', - ], + 'title' => '授权', + 'id' => 329755, ], [ - 'id' => 65840, - 'title' => '计量', + 'children' => ['PushMeteringData'], 'type' => 'directory', - 'children' => [ - 'PushMeteringData', - ], + 'title' => '计量', + 'id' => 329758, ], [ - 'id' => 182754, - 'title' => '其他', + 'children' => ['CrossAccountVerifyToken', 'DescribeDistributionProductsLink', 'DescribeDistributionProducts', 'DescribeApiMetering', 'PushTimesUsage'], 'type' => 'directory', - 'children' => [ - 'CrossAccountVerifyToken', - 'DescribeDistributionProductsLink', - 'DescribeDistributionProducts', - 'DescribeApiMetering', - ], + 'title' => '其他', + 'id' => 329760, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DescribeFailedNotifications' => [ - 'summary' => '查询订阅通知失败列表，云市场调用商家消息SPI失败后，商家可以通过此接口主动查询出失败的信息。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ActivateLicense' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'LicenseCode', 'in' => 'query', - 'schema' => [ - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '授权码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA'], ], [ - 'name' => 'PageSize', + 'name' => 'Identification', 'in' => 'query', - 'schema' => [ - 'description' => '每页的实例个数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '激活的身份信息，用户的 aliyunUid。', 'type' => 'string', 'required' => false, 'example' => '129****1111'], ], ], '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' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'TotalCount' => [ - 'description' => '实例总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '55', - ], - 'PageNumber' => [ - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页的实例个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NotificationList' => [ - 'description' => '通知列表', - 'type' => 'array', - 'items' => [ - 'description' => '通知对象', - 'type' => 'object', - 'properties' => [ - 'NotificationRequestId' => [ - 'description' => '通知请求ID（UUID生成），用于幂等', - 'type' => 'string', - 'example' => 'deab3673236843a3b378c7d8d25c5f01', - ], - 'Message' => [ - 'description' => '通知消息体，json结构', - 'type' => 'string', - 'example' => '{"productCode":"cmgj00001","orderId":"123456","orderBizId":"111222","action":"orderPay","aliUid":"12211222211","skuId":"cmgj00001-prepay"}', - ], - 'Action' => [ - 'description' => '操作事件', - 'type' => 'string', - 'example' => 'orderPay', - ], - 'CreateTime' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1665988512000', - ], - ], - ], - ], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', + ['errorCode' => 'Auth.CallerType', 'errorMessage' => 'RAM users or STS tokens are not supported.', 'description' => '不支持子账号或STS账号调用。'], + ['errorCode' => 'License.Invalid', 'errorMessage' => 'The specified license is invalid.', 'description' => '无效的授权码。'], + ['errorCode' => 'License.Expired', 'errorMessage' => 'The specified license has expired.', 'description' => '授权码已过期。'], + ['errorCode' => 'License.Discard', 'errorMessage' => 'The specified license has been discarded.', 'description' => '授权码已废弃。'], + ['errorCode' => 'License.NotFound', 'errorMessage' => 'The specified license does not exist.', 'description' => '授权码不存在。'], + ['errorCode' => 'Auth.ISV', 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', 'description' => '非服务商账号，仅供服务商账号调用。'], + ['errorCode' => 'Auth.Match', 'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.', 'description' => '授权码对应的商品不属于该服务商。'], + ['errorCode' => 'Auth.Authorized', 'errorMessage' => 'The specified RAM user is not authorized.', 'description' => '子账号没有授权。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '激活授权码', + 'summary' => '调用 ActivateLicense 激活授权码。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ActivateLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<ActivateLicenseResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</ActivateLicenseResponse>","errorExample":""}]', + ], + 'AutoRenewInstance' => [ + 'summary' => '设置自动续费', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['title' => '开通open，关闭close，必传', 'type' => 'string', 'required' => true, 'description' => '开通open，关闭close，必传'], + ], + [ + 'name' => 'OrderBizId', + 'in' => 'formData', + 'schema' => ['title' => '云市场实例id，必传', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '云市场实例id，必传'], + ], + [ + 'name' => 'AutoRenewCycle', + 'in' => 'formData', + 'schema' => ['title' => '周期单位，开通时必传。Day（日），Month（月），Year（年）', 'type' => 'string', 'description' => '周期单位，开通时必传。Day（日），Month（月），Year（年）'], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'formData', + 'schema' => ['title' => '续费周期，开通时必传', 'type' => 'integer', 'format' => 'int32', 'description' => '续费周期，开通时必传'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResponseDTO<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => ['type' => 'boolean', 'description' => ''], + 'Data' => ['type' => 'boolean', 'description' => ''], + 'RequestId' => ['type' => 'string', 'description' => ''], + ], + 'description' => 'ResponseDTO<Boolean>', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'changeSet' => [ + ['createdAt' => '2022-11-23T01:54:11.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"TotalCount\\": 55,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"NotificationList\\": [\\n {\\n \\"NotificationRequestId\\": \\"deab3673236843a3b378c7d8d25c5f01\\",\\n \\"Message\\": \\"{\\\\\\"productCode\\\\\\":\\\\\\"cmgj00001\\\\\\",\\\\\\"orderId\\\\\\":\\\\\\"123456\\\\\\",\\\\\\"orderBizId\\\\\\":\\\\\\"111222\\\\\\",\\\\\\"action\\\\\\":\\\\\\"orderPay\\\\\\",\\\\\\"aliUid\\\\\\":\\\\\\"12211222211\\\\\\",\\\\\\"skuId\\\\\\":\\\\\\"cmgj00001-prepay\\\\\\"}\\",\\n \\"Action\\": \\"orderPay\\",\\n \\"CreateTime\\": 1665988512000\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询订阅通知失败列表', - 'description' => '查询商家订阅通知失败的信息'."\n" - ."\n" - .'- 如果当前不存在未确认的通知失败信息，TotalCount返回0', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:AutoRenewInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', ], 'ConfirmNotification' => [ 'summary' => '商家查收完毕通知信息之后调用此接口反馈给平台，后续该信息不会再被查询出来。', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -259,21 +223,12 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'NotificationRequestId', 'in' => 'query', - 'schema' => [ - 'description' => '通知请求ID', - 'type' => 'string', - 'required' => true, - 'example' => 'deab3673236843a3b378c7d8d25c5f01', - ], + 'schema' => ['description' => '通知请求ID', 'type' => 'string', 'required' => true, 'example' => 'deab3673236843a3b378c7d8d25c5f01'], ], ], 'responses' => [ @@ -283,131 +238,609 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '确认查收订阅通知', 'description' => '确认查收订阅通知失败信息'."\n" ."\n" .'- 调用成功之后该信息后续不会再被查询出来，平台认为商家已经把该信息正确处理完毕'."\n", - ], - 'ModifyInvoiceForIsv' => [ - 'summary' => '发票受理接口', - 'path' => '', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ConfirmNotification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A077D99E-0C4D-421E-A5D4-F533F6657817\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateOrder' => [ + 'summary' => '调用 CreateOrder 创建订单。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解云市场产品的收费方式和价格。'."\n" + ."\n" + .'商业镜像创建订单接口请参考 CreateInstance。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['description' => '订单类型。 取值： '."\n" + .'- INSTANCE_BUY：商品购买 '."\n" + .'- INSTANCE_RENEW：实例续费 '."\n" + .'- INSTANCE_UPGRADE：实例升级'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_BUY'], + ], + [ + 'name' => 'Commodity', + 'in' => 'query', + 'schema' => ['description' => '订单配件信息。 '."\n" + ."\n" + .'可根据指定的 OrderType，使用对应的配件再进行序列化。'."\n" + ."\n" + .'不同 OrderType 分别对应的 CommodityType 如下所示： '."\n" + .'* INSTANC_BUY：InstanceBuyCommodity'."\n" + .'* INSTANCE_RENEW：InstanceRenewCommodity'."\n" + .'* INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n" + ."\n" + .'示例中的 Commodity 参数说明如下：'."\n" + .'- 必传参数'."\n" + .' - productCode：商品码'."\n" + .' - skuCode：商品规格码。预付费固定为 prepay，后付费固定为 postpay。'."\n" + .' - duration：周期数量 1，2，3...。'."\n" + .' - pricingCycle：周期单位。Day（日），Month（月），Year（年）。'."\n" + .' - components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n" + ."\n" + .'- 可选参数'."\n" + .' - quantity：订购数量'."\n" + .' - queryPromotion：是否查询优惠'."\n" + .' - couponId：优惠卷 ID'."\n" + .' - properties：订单扩展属性字符串，JSON 的 dict 格式'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'InstanceBuyCommodity示例：{"components":{"package_version":"yuncode1394000000"},"duration":100,"pricingCycle":"Year","productCode":"cmfw019940","properties":{},"quantity":1,"skuCode":"cmfw019940-prepay"}；InstanceRenewCommodity示例：{“components”:{“package_version”:”yuncode1806900001”},”quantity”:1,”duration”:2,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”}；InstanceUpgradeCommodity示例：{“components”:{“package_version”:”yuncode1806900002”},”quantity”:1,”duration”:1,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”} '], + ], + [ + 'name' => 'OrderSouce', + 'in' => 'query', + 'schema' => ['description' => '订单来源（未启用）', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => ['description' => '付款方式：'."\n" + .'* AUTO：余额自动支付'."\n" + .'* HAND：手动支付'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HAND'], + ], + [ + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => '用于保证请求的幂等性。 '."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大不值过 64 个 ASCII 字符。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2709c68a-d569-4819-9c5d-1222ed2ee924'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3', - 'description' => '当前开票的发票类型：'."\n" - .'- 数字电子普通发票：2'."\n" - .'- 数字电子专用发票：3', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => '订单 ID', 'type' => 'string', 'example' => '202********0117'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed'], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'type' => 'array', + 'items' => ['description' => '实例 ID', 'type' => 'string', 'example' => '5604018'], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'title' => '创建订单', + 'description' => '请确保在使用该接口前，已充分了解云市场产品的收费方式和[价格](https://market.aliyun.com/)。'."\n" + ."\n" + .'商业镜像创建订单接口请参考 [CreateInstance](https://help.aliyun.com/document_detail/25499.html)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-03-28T06:49:05.000Z', 'description' => '错误码发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrder'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ElectronUrl', - 'in' => 'query', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'acm:CreateOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"202********0117\\",\\n \\"RequestId\\": \\"4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"5604018\\"\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"004CDE94-C51C-4EBD-8D4A-8874888ECBDB\\",\\"HostId\\":\\"market.aliyuncs.com\\",\\"Code\\":\\"UnknownError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}\\n"},{"type":"xml","example":"<CreateOrderResponse>\\n<RequestId>4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed</RequestId>\\n<InstanceIds>\\n <InstanceId>5604018</InstanceId>\\n</InstanceIds>\\n<OrderId>202********0117</OrderId>\\n</CreateOrderResponse>","errorExample":"<?xml version=\'1.0\' encoding=\'UTF-8\'?><Error><RequestId>904A07C3-D30A-4E2C-93B2-DDECAE4B66E8</RequestId><HostId>market.aliyuncs.com</HostId><Code>UnknownError</Code><Message>The request processing has failed due to some unknown error.</Message></Error>\\n"}]', + ], + 'CrossAccountVerifyToken' => [ + 'summary' => '查询跨账号角色授权信息，包含授权人阿里云账号UID、名称、授权时间、授权角色名称。', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => ['title' => '跨账号角色授权成功返回的token', 'description' => '跨账号角色授权成功返回的token', 'type' => 'string', 'required' => false, 'example' => 'C19D103FEA2D50A584410267CE9FBA56'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '电子发票地址', - 'description' => '电子发票地址，用于客户下载', - 'type' => 'string', - 'required' => false, - 'example' => 'https://oss.aliyuncs.com/xxxx.png', + 'title' => 'ResultDTO<ServiceRoleVerifyTokenDTO>', + 'description' => '返回结果对象', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '返回结果对象', + 'type' => 'object', + 'properties' => [ + 'Name' => ['title' => '用户展示名称', 'description' => '用户展示名称', 'type' => 'string', 'example' => 'marketplace_wangxiao_test'], + 'Uid' => ['title' => '用户阿里云uid', 'description' => '用户阿里云uid', 'type' => 'string', 'example' => '1744526877246715'], + 'AuthTime' => ['title' => '授权时间', 'description' => '授权时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1676974108866'], + 'AuthRoles' => [ + 'title' => '授权角色', + 'description' => '授权角色', + 'type' => 'array', + 'items' => ['description' => '授权角色名称', 'type' => 'string', 'example' => 'VendorCrossAccountXIAOYUNACCESSSMSRole'], + ], + ], + ], + 'Success' => ['description' => '接口返回成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '状态码，200表示成功', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => 'C19D103F-EA2D-50A5-8441-0267CE9FBA56'], + ], ], ], + ], + 'title' => '查询跨账号角色授权信息', + 'responseParamsDescription' => '返回值中授权人阿里云账号信息Name和Uid字段默认脱敏展示，如需明文展示，请联系云市场运营同学开通。', + 'changeSet' => [ + ['createdAt' => '2024-04-03T01:36:13.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'InvoiceId', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:CrossAccountVerifyToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Name\\": \\"marketplace_wangxiao_test\\",\\n \\"Uid\\": \\"1744526877246715\\",\\n \\"AuthTime\\": 1676974108866,\\n \\"AuthRoles\\": [\\n \\"VendorCrossAccountXIAOYUNACCESSSMSRole\\"\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C19D103F-EA2D-50A5-8441-0267CE9FBA56\\"\\n}","type":"json"}]', + ], + 'DescribeApiMetering' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'productCode', + 'in' => 'query', + 'schema' => ['description' => '商品code', 'type' => 'string', 'required' => false, 'example' => 'cmapi0004****'], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => ['description' => '类型，1表示套餐包，2表示资源包', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageNum', 'in' => 'query', + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '发票Id', - 'description' => '发票申请Id（对应DescribeInvoiceForIsv接口返回结果中的Result.Id）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4072040****', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '62FC432C55A1A63534A6CB34'], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'], + 'Result' => [ + 'description' => '返回值列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个对象', + 'type' => 'object', + 'properties' => [ + 'AliyunPk' => ['description' => '阿里云pk', 'type' => 'integer', 'format' => 'int64', 'example' => '102277855749****'], + 'ProductCode' => ['description' => '商品code', 'type' => 'string', 'example' => 'cmapi0004****'], + 'ProductName' => ['description' => '商品名称', 'type' => 'string', 'example' => '身份证实名认证-身份证实名'], + 'TotalQuota' => ['description' => '余量', 'type' => 'integer', 'format' => 'int64', 'example' => '98'], + 'TotalUsage' => ['description' => '使用量', 'type' => 'integer', 'format' => 'int64', 'example' => '220'], + 'TotalCapacity' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Unit' => ['description' => '单位', 'type' => 'string', 'example' => '次'], + ], + ], + ], + 'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Success' => ['description' => '结果标识', 'type' => 'boolean', 'example' => 'true'], + 'Count' => ['description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'PageSize' => ['description' => ' 每页个数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Message' => ['description' => '错误信息描述', 'type' => 'string', 'example' => '"成功"'], + 'Version' => ['description' => '版本', 'type' => 'string', 'example' => '1.0'], + 'Fatal' => ['description' => 'fatal', 'type' => 'boolean', 'example' => 'false'], + ], ], ], + ], + 'title' => 'API余量获取', + 'summary' => '获取用户的API余量、总量、使用量等数据。', + 'description' => '### **注意: 该接口支持主账号和Ram子账号获取API余量、总量、使用量信息**', + 'changeSet' => [ + ['createdAt' => '2024-07-29T06:21:08.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-25T03:49:10.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMetering'], + ], + ], + 'ramActions' => [ [ - 'name' => 'OperateType', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeApiMetering', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"62FC432C55A1A63534A6CB34\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": 0,\\n \\"ProductCode\\": \\"cmapi0004****\\",\\n \\"ProductName\\": \\"身份证实名认证-身份证实名\\",\\n \\"TotalQuota\\": 98,\\n \\"TotalUsage\\": 220,\\n \\"TotalCapacity\\": 0,\\n \\"Unit\\": \\"次\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"Success\\": true,\\n \\"Count\\": 100,\\n \\"PageSize\\": 20,\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Fatal\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeApiMeteringResponse>\\n <RequestId>62FC432C55A1A63534A6CB34</RequestId>\\n <Code>200</Code>\\n <Result>\\n <ProductCode>cmapi0004****</ProductCode>\\n <ProductName>身份证实名认证-身份证实名</ProductName>\\n <TotalQuota>98</TotalQuota>\\n <TotalUsage>220</TotalUsage>\\n <Unit>次</Unit>\\n </Result>\\n <PageNumber>1</PageNumber>\\n <Success>true</Success>\\n <Count>100</Count>\\n <PageSize>20</PageSize>\\n <Message>\\"成功\\"</Message>\\n <Version>1.0</Version>\\n <Fatal>false</Fatal>\\n</DescribeApiMeteringResponse>","errorExample":""}]', + ], + 'DescribeCurrentNodeInfo' => [ + 'summary' => '调用DescribeCurrentNodeInfo获取当前节点的流程信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '操作类型：开票：0 ；拒绝开票：1', - 'description' => '操作当前发票：'."\n" - .'- 开票：0'."\n" - .'- 拒绝开票：1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d'], + 'Result' => [ + 'description' => '成功流程节点信息', + 'type' => 'object', + 'properties' => [ + 'NextNodeId' => ['description' => '下一个流程节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '8473'], + 'StepNo' => ['description' => '所属流程节点的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'AutoFinishNode' => ['description' => '是否自动完成节点', 'type' => 'boolean', 'example' => 'false'], + 'FinalStepNo' => ['description' => '最后节点的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'PreviousNodeId' => ['description' => '上一个流程节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '8471'], + 'ParentNodeId' => ['description' => '父级流程节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GmtExpired' => ['description' => '流程节点超时时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588920725000'], + 'OperatorRole' => ['description' => '流程节点操作人角色，取值：-system：系统-custom：用户', 'type' => 'string', 'example' => 'Provider'], + 'GmtStart' => ['description' => '流程节点开始时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000'], + 'NodeStatus' => ['description' => '节点执行状态，取值：-NotStart：未开始-Starting：进行中-Cancel：已取消-Finish：已完成', 'type' => 'string', 'example' => 'Starting'], + 'NodeName' => ['description' => '节点名称', 'type' => 'string', 'example' => '等待服务开通'], + 'GmtFinished' => ['description' => '流程节点完成时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588920725000'], + 'AllowRollbackNode' => ['description' => '是否允许执行回滚到上一个流程节点', 'type' => 'boolean', 'example' => 'false'], + 'TemplateForm' => ['description' => '流程节点表单内容，格式为json。'."\n" + .'示例代码如下：'."\n" + .'`[ { "fieldKey": "TFD0", //表单 key "isRequired": true, //是否必填项 "maxLength": 50, //最大值长度 "placeHolder": "姓名", //表单值简介 "stepNum": 0, //排序值（升序） "title": "收货人姓名", //表单标题 "type": "text" //表单类型 }, { "fieldKey": "TFD1", "isRequired": true, "maxLength": 50, "placeHolder": "手机号码", "stepNum": 1, "title": "收货人电话", "type": "text" }, { "fieldKey": "TFD2", "isRequired": true, "maxLength": 50, "placeHolder": "省市区街道门牌号码", "stepNum": 2, "title": "详细收货地址", "type": "textarea" } ]`', 'type' => 'string', 'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]'], + 'NeedAttachment' => ['description' => '是否强制要求上传附件', 'type' => 'boolean', 'example' => 'false'], + 'NodeId' => ['description' => '流程节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '8472'], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => '获取当前节点的流程信息', + 'description' => '**'."\n" + .'**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'CheckNotice', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeCurrentNodeInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"00eb4de1-6cff-4f56-833e-7b1e070e398d\\",\\n \\"Result\\": {\\n \\"NextNodeId\\": 8473,\\n \\"StepNo\\": 3,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8471,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588920725000,\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Starting\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"GmtFinished\\": 1588920725000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8472\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCurrentNodeInfoResponse>\\n <Success>true</Success>\\n <RequestId>00eb4de1-6cff-4f56-833e-7b1e070e398d</RequestId>\\n <Result>\\n <NextNodeId>8473</NextNodeId>\\n <StepNo>3</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8471</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588920725000</GmtExpired>\\n <OperatorRole>Provider</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Starting</NodeStatus>\\n <NodeName>等待服务开通</NodeName>\\n <GmtFinished>1588920725000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\n <TemplateForm>[ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8472</NodeId>\\n </Result>\\n</DescribeCurrentNodeInfoResponse>","errorExample":""}]', + ], + 'DescribeDistributionProducts' => [ + 'summary' => '分页获取推广商品列表及详细信息。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页-当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页的推广商品数量', 'description' => '每页的推广商品数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'Filter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '服务商发票信息备注', - 'description' => '服务商发票信息备注', - 'type' => 'string', + 'description' => '过滤条件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '搜索标签类别，取值：'."\n" + ."\n" + .'- code：推广商品Code'."\n" + .'- name：推广商品名称'."\n" + .'- supplierName：推广服务商名称', 'type' => 'string', 'required' => true, 'example' => 'supplierName'], + 'Value' => ['description' => '搜索标签取值：'."\n" + ."\n" + .'- code: 测试商品code'."\n" + .'- name:测试商品名称'."\n" + .'- supplierName:测试供应商家名称', 'type' => 'string', 'required' => true, 'example' => 'cmj0000000'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => '******', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE'], + 'PageNumber' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页的推广商品数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '符合搜索条件的推广商品数', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'Results' => [ + 'description' => '推广商品信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FirstCategoryName' => ['title' => '商品类目，一级类目名称', 'description' => '商品类目，一级类目名称', 'type' => 'string', 'example' => 'API市场'], + 'SecondCategoryName' => ['title' => '商品类目，二级类目名称', 'description' => '商品类目，二级类目名称', 'type' => 'string', 'example' => '生活服务'], + 'Type' => ['title' => '商品类型'."\n" + .' APP 应用类'."\n" + .' SERVICE 服务类'."\n" + .' CHENGPIN_SITE 成品网站'."\n" + .' SITE_CUSTOM_SERVICE 定制网站'."\n" + .' SITE_PROMOTION_RUN 网站推广运营'."\n" + .' ENT_APP_SOFT 应用软件'."\n" + .' CLOUD_SERVICE 云服务'."\n" + .' EIF 企信宝'."\n" + .' BASIC_TOOLS 基础工具'."\n" + .' BASIC_SERVICES 基础服务'."\n" + .' JIANZHAN_XITONG 建站系统'."\n" + .' APP_COUPLES 应用伴侣'."\n" + .' MIRRORS_MARKET 镜像市场'."\n" + .' MIRRORS_MARKET_BASIC_ENVIRONMENT 基础环境'."\n" + .' MIRRORS_MARKET_APPLICATION_SOFTWARE 应用软件'."\n" + .' MIRROR 镜像类'."\n" + .' DINGDING 钉钉类'."\n" + .' DOWNLOAD 下载类'."\n" + .' EXTENDED 未知类'."\n" + .' API_SERVICE API类'."\n" + .' ROS 资源编排类'."\n" + .' DOCKER 容器类'."\n" + .' LICENSE 授权码类'."\n" + .' SAAS_WUYING 应用软件-无影应用', 'description' => '商品类型'."\n" + .' APP 应用类'."\n" + .' SERVICE 服务类'."\n" + .' CHENGPIN_SITE 成品网站'."\n" + .' SITE_CUSTOM_SERVICE 定制网站'."\n" + .' SITE_PROMOTION_RUN 网站推广运营'."\n" + .' ENT_APP_SOFT 应用软件'."\n" + .' CLOUD_SERVICE 云服务'."\n" + .' EIF 企信宝'."\n" + .' BASIC_TOOLS 基础工具'."\n" + .' BASIC_SERVICES 基础服务'."\n" + .' JIANZHAN_XITONG 建站系统'."\n" + .' APP_COUPLES 应用伴侣'."\n" + .' MIRRORS_MARKET 镜像市场'."\n" + .' MIRRORS_MARKET_BASIC_ENVIRONMENT 基础环境'."\n" + .' MIRRORS_MARKET_APPLICATION_SOFTWARE 应用软件'."\n" + .' MIRROR 镜像类'."\n" + .' DINGDING 钉钉类'."\n" + .' DOWNLOAD 下载类'."\n" + .' EXTENDED 未知类'."\n" + .' API_SERVICE API类'."\n" + .' ROS 资源编排类'."\n" + .' DOCKER 容器类'."\n" + .' LICENSE 授权码类'."\n" + .' SAAS_WUYING 应用软件-无影应用', 'type' => 'string', 'example' => 'API类'], + 'ImageUrl' => ['title' => '商品主图url', 'description' => '商品主图url', 'type' => 'string', 'example' => '//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg'], + 'Code' => ['title' => '商品code', 'description' => '商品code', 'type' => 'string', 'example' => 'cmap*****'], + 'Name' => ['title' => '商品名称', 'description' => '商品名称', 'type' => 'string', 'example' => '手机号码在网状态查询'], + 'ShortDescription' => ['title' => '商品简介', 'description' => '商品简介', 'type' => 'string', 'example' => '运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。'], + 'Price' => ['title' => '商品默认规格价格', 'description' => '商品默认规格价格，如100代表100,单位CNY', 'type' => 'string', 'example' => '100'], + 'Score' => ['title' => '商品用户评分', 'description' => '商品用户评分', 'type' => 'string', 'example' => '5'], + 'TradeCount' => ['title' => '商品近180天成交', 'description' => '商品近180天成交', 'type' => 'string', 'example' => '109'], + 'UserCommentCount' => ['title' => '商品买家评论数', 'description' => '商品买家评论数', 'type' => 'string', 'example' => '55'], + 'SubmissionRadio' => ['title' => '商品返佣比例', 'description' => '商品返佣比例,如30，代表30%', 'type' => 'string', 'example' => '30'], + 'SupplierName' => ['title' => '推广服务商名称', 'description' => '推广服务商名称', 'type' => 'string', 'example' => '深圳市****有限公司'], + 'SupplierUId' => ['title' => '推广服务商(商品供应商)阿里云UID', 'description' => '推广服务商(商品供应商)阿里云UID', 'type' => 'string', 'example' => '1911534921******'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'user is not distributor!', 'description' => ''], + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request. ', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '分页获取推广商品列表', + 'description' => '请使用推广服务商账号调用', + 'requestParamsDescription' => 'code为单个查询，name为商品名称，supplierName为商品供应商名称', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProducts'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Number', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeDistributionProducts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Results\\": [\\n {\\n \\"FirstCategoryName\\": \\"API市场\\",\\n \\"SecondCategoryName\\": \\"生活服务\\",\\n \\"Type\\": \\"API类\\",\\n \\"ImageUrl\\": \\"//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg\\",\\n \\"Code\\": \\"cmap*****\\",\\n \\"Name\\": \\"手机号码在网状态查询\\",\\n \\"ShortDescription\\": \\"运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。\\",\\n \\"Price\\": \\"100\\",\\n \\"Score\\": \\"5\\",\\n \\"TradeCount\\": \\"109\\",\\n \\"UserCommentCount\\": \\"55\\",\\n \\"SubmissionRadio\\": \\"30\\",\\n \\"SupplierName\\": \\"深圳市****有限公司\\",\\n \\"SupplierUId\\": \\"1911534921******\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsResponse>\\n <RequestId>5BD09171-MB74-18D8-890E-C70C067527BE</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>50</TotalCount>\\n <Results>\\n <FirstCategoryName>API市场</FirstCategoryName>\\n <SecondCategoryName>生活服务</SecondCategoryName>\\n <Type>API类</Type>\\n <ImageUrl>//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg</ImageUrl>\\n <Code>cmap*****</Code>\\n <Name>手机号码在网状态查询</Name>\\n <ShortDescription>运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。</ShortDescription>\\n <Price>100</Price>\\n <Score>5</Score>\\n <TradeCount>109</TradeCount>\\n <UserCommentCount>55</UserCommentCount>\\n <SubmissionRadio>30</SubmissionRadio>\\n <SupplierName>深圳市****有限公司</SupplierName>\\n <SupplierUId>1911534921******</SupplierUId>\\n </Results>\\n</DescribeDistributionProductsResponse>","errorExample":""}]', + ], + 'DescribeDistributionProductsLink' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Codes', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '发票号', - 'description' => '发票号', - 'type' => 'string', - 'required' => false, - 'example' => '1897702****', + 'title' => '商品code集合,不能为空集合，集合大小最多50条', + 'description' => '商品code集合,不能为空集合，集合大小最多50条', + 'type' => 'array', + 'items' => ['description' => 'cmapi*****', 'type' => 'string', 'required' => false, 'example' => 'cmapi******'], + 'required' => true, + 'docRequired' => true, + 'minItems' => 1, ], ], ], @@ -418,55 +851,150 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码，200表示成功', - 'type' => 'string', - 'example' => 'cmjj01**45', - ], - 'Message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => '"成功"', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5BD09171-BF4D-18D8-890E-C70C067527BE'], + 'TotalCount' => ['title' => '推广商品总数', 'description' => '推广商品总数', 'type' => 'integer', 'format' => 'int64', 'example' => '51'], + 'Success' => ['title' => '成功状态标识', 'description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ - 'description' => '是否返回成功', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '推广商品链接信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['title' => '商品推广链接', 'description' => '商品推广链接,注：示例链接为测试商品链接', 'type' => 'string', 'example' => 'https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D'], + 'Code' => ['title' => '推广商品code', 'description' => '推广商品code', 'type' => 'string', 'example' => 'cmapi000****'], + 'Name' => ['title' => '推广商品名称', 'description' => '推广商品名称', 'type' => 'string', 'example' => '测试商品'], + ], + 'description' => '', + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE', + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ['errorCode' => 'Forbidden!', 'errorMessage' => 'user is not distributor!', 'description' => ''], + ['errorCode' => 'ProductCodes', 'errorMessage' => 'productCodes is empty!', 'description' => ''], + ['errorCode' => 'codeSizeError', 'errorMessage' => 'productCodes size should less than 50!', 'description' => ''], + ['errorCode' => 'CodeError', 'errorMessage' => 'codes is not correct!', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取推广商品转化链接', + 'summary' => '获取推广商品的推广链接。', + 'description' => '请使用推广服务商账号调用，非推广服务商调用不成功。', + 'requestParamsDescription' => '推广商品的code数组不能为空，数组大小不能大于50', + 'changeSet' => [ + ['createdAt' => '2023-06-01T02:25:39.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProductsLink'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeDistributionProductsLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-BF4D-18D8-890E-C70C067527BE\\",\\n \\"TotalCount\\": 51,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"Url\\": \\"https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D\\",\\n \\"Code\\": \\"cmapi000****\\",\\n \\"Name\\": \\"测试商品\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsLinkResponse>\\n <RequestId>5BD09171-BF4D-18D8-890E-C70C067527BE</RequestId>\\n <TotalCount>51</TotalCount>\\n <Success>true</Success>\\n <Result>\\n <Url>https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D</Url>\\n <Code>cmapi000****</Code>\\n <Name>测试商品</Name>\\n </Result>\\n</DescribeDistributionProductsLinkResponse>","errorExample":""}]', + ], + 'DescribeFailedNotifications' => [ + 'summary' => '查询订阅通知失败列表，云市场调用商家消息SPI失败后，商家可以通过此接口主动查询出失败的信息。', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'PageNumber', + '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' => [ + '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' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'TotalCount' => ['description' => '实例总数', 'type' => 'integer', 'format' => 'int32', 'example' => '55'], + 'PageNumber' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页的实例个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NotificationList' => [ + 'description' => '通知列表', + 'type' => 'array', + 'items' => [ + 'description' => '通知对象', + 'type' => 'object', + 'properties' => [ + 'NotificationRequestId' => ['description' => '通知请求ID（UUID生成），用于幂等', 'type' => 'string', 'example' => 'deab3673236843a3b378c7d8d25c5f01'], + 'Message' => ['description' => '通知消息体，json结构', 'type' => 'string', 'example' => '{"productCode":"cmgj00001","orderId":"123456","orderBizId":"111222","action":"orderPay","aliUid":"12211222211","skuId":"cmgj00001-prepay"}'], + 'Action' => ['description' => '操作事件', 'type' => 'string', 'example' => 'orderPay'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1665988512000'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"cmjj01**45\\",\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\"\\n}","type":"json"}]', - 'title' => '云市场店铺发票受理', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询订阅通知失败列表', 'description' => '查询商家订阅通知失败的信息'."\n" ."\n" .'- 如果当前不存在未确认的通知失败信息，TotalCount返回0', - ], - 'DescribeInvoiceForIsv' => [ - 'summary' => '查询云市场供应商店铺的发票信息', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeFailedNotifications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"TotalCount\\": 55,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"NotificationList\\": [\\n {\\n \\"NotificationRequestId\\": \\"deab3673236843a3b378c7d8d25c5f01\\",\\n \\"Message\\": \\"{\\\\\\"productCode\\\\\\":\\\\\\"cmgj00001\\\\\\",\\\\\\"orderId\\\\\\":\\\\\\"123456\\\\\\",\\\\\\"orderBizId\\\\\\":\\\\\\"111222\\\\\\",\\\\\\"action\\\\\\":\\\\\\"orderPay\\\\\\",\\\\\\"aliUid\\\\\\":\\\\\\"12211222211\\\\\\",\\\\\\"skuId\\\\\\":\\\\\\"cmgj00001-prepay\\\\\\"}\\",\\n \\"Action\\": \\"orderPay\\",\\n \\"CreateTime\\": 1665988512000\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInstance' => [ + 'summary' => '调用 DescribeInstance 查询实例信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -474,128 +1002,609 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '发票状态：申请中：0；已完成：1', - 'description' => '当前发票状态'."\n" - .'- 申请中：0'."\n" - .'- 已完成：1', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '155****11'], ], [ - 'name' => 'Type', + 'name' => 'OrderType', 'in' => 'query', + 'schema' => ['description' => '订单类型，已废弃。', 'type' => 'string', 'required' => false, 'example' => 'NEW'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3', - 'description' => '发票类型，为空代表默认查询所有类型'."\n" - .'- 数字电子普通发票：2'."\n" - .'- 数字电子专用发票：3', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '业务状态，根据不同商品类型设置不同值：'."\n" + ."\n" + .'当ProductType = MIRROR 时'."\n" + .'- PRODUCE：生产中'."\n" + .'- USING：使用中'."\n" + .'- UNUSED：未使用'."\n" + .'- EXPIRED：已过期'."\n" + .'- CLOSED：已释放'."\n" + ."\n" + .'当 ProductType = SERVICE 时'."\n" + .'- READYING：未开始'."\n" + .'- STARTED：服务中'."\n" + .'- CONFIRM：已完成'."\n" + .'- EXPIRED：已过期'."\n" + .'- CLOSED：已释放'."\n" + ."\n" + .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" + .'- OPENING：开通中'."\n" + .'- OPENED：已开通'."\n" + .'- EXPIRED：已过期'."\n" + .'- CLOSED：已释放', 'type' => 'string', 'example' => 'OPENED'], + 'AppJson' => ['description' => '应用信息，示例中的参数说明如下：'."\n" + ."\n" + .'- username：用户名'."\n" + .'- passowrd：密码'."\n" + .'- frontEndUrl：前台地址'."\n" + .'- adminUrl：管理地址', 'type' => 'string', 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}'], + 'ProductName' => ['description' => '商品名称', 'type' => 'string', 'example' => '***协同办公'], + 'InstanceId' => ['description' => '实例ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111'], + 'ExtendJson' => ['description' => '扩展信息', 'type' => 'string', 'example' => '{"说明": "如有使用问题，请联系..."}'], + 'IsTrial' => ['description' => '是否试用', 'type' => 'boolean', 'example' => 'true'], + 'BeganOn' => ['description' => '实例开通时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000'], + 'ComponentJson' => ['description' => '业务模块'."\n" + ."\n" + .'示例中的参数说明如下：'."\n" + ."\n" + .'- package_version：版本', 'type' => 'string', 'example' => '{"package_version":"yuncode000111"}'], + 'Constraints' => ['description' => '已废弃', 'type' => 'string', 'example' => '{}'], + 'ProductType' => ['description' => '商品类型，取值：'."\n" + ."\n" + .'- APP：应用类'."\n" + .'- SERVIC：服务类'."\n" + .'- MIRROR：镜像类'."\n" + .'- DOWNLOAD：下载类'."\n" + .'- API_SERVICE：API类'."\n" + .'- DOCKER：DOCKER类', 'type' => 'string', 'example' => 'APP'], + 'HostJson' => ['description' => '主机信息，示例中的参数说明如下：'."\n" + ."\n" + .'- username：用户名'."\n" + .'- passowrd：密码'."\n" + .'- ip：主机 IP'."\n" + .'- innerIp：主机内网 IP', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}'], + 'ProductSkuCode' => ['description' => '规格Code', 'type' => 'string', 'example' => 'cmgj00**11-prepay'], + 'CreatedOn' => ['description' => '创建时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634018000'], + 'EndOn' => ['description' => '到期时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1602259200000'], + 'OrderId' => ['description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111'], + 'ProductCode' => ['description' => '商品Code', 'type' => 'string', 'example' => 'cmgj00**11'], + 'SupplierName' => ['description' => '服务商名称', 'type' => 'string', 'example' => '*****有限公司'], + 'RelationalData' => [ + 'description' => '关联信息', + 'type' => 'object', + 'properties' => [ + 'ServiceStatus' => ['description' => '服务状态'."\n" + ."\n" + .'- READYING：未开始'."\n" + .'- STARTED： 服务中'."\n" + .'- CONFIRM：已完成'."\n" + .'- EXPIRED： 已过期'."\n" + .'- CLOSED： 已释放', 'type' => 'string', 'example' => 'STARTED'], + ], + ], + 'Modules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Module' => [ + 'description' => '商品模块信息，已废弃。', + 'type' => 'array', + 'items' => [ + 'description' => '已废弃', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '已废弃', 'type' => 'string', 'example' => 'package_config'], + 'Name' => ['description' => '已废弃', 'type' => 'string', 'example' => '套餐配置'], + 'Id' => ['description' => '已废弃', 'type' => 'string', 'example' => '101*********026'], + 'Properties' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Property' => [ + 'description' => '已废弃', + 'type' => 'array', + 'items' => [ + 'description' => '已废弃', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'ShowType' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Name' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'DisplayUnit' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'PropertyValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PropertyValue' => [ + 'description' => '已废弃', + 'type' => 'array', + 'items' => [ + 'description' => '已废弃', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Type' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Step' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Value' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Max' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Remark' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + 'Min' => ['description' => '已废弃', 'type' => 'string', 'example' => '12'], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + 'AutoRenewal' => ['type' => 'string', 'description' => ''], + 'ActiveAddress' => ['type' => 'string', 'description' => ''], + 'LicenseCode' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ], + ], + 'title' => '查询实例信息', + 'changeSet' => [ + ['createdAt' => '2024-03-14T01:57:29.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstance'], + ], + ], + 'ramActions' => [ [ - 'name' => 'InvoiceId', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"Constraints\\": \\"{}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"Modules\\": {\\n \\"Module\\": [\\n {\\n \\"Code\\": \\"package_config\\",\\n \\"Name\\": \\"套餐配置\\",\\n \\"Id\\": \\"101*********026\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Key\\": \\"12\\",\\n \\"ShowType\\": \\"12\\",\\n \\"Name\\": \\"12\\",\\n \\"DisplayUnit\\": \\"12\\",\\n \\"PropertyValues\\": {\\n \\"PropertyValue\\": [\\n {\\n \\"DisplayName\\": \\"12\\",\\n \\"Type\\": \\"12\\",\\n \\"Step\\": \\"12\\",\\n \\"Value\\": \\"12\\",\\n \\"Max\\": \\"12\\",\\n \\"Remark\\": \\"12\\",\\n \\"Min\\": \\"12\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"AutoRenewal\\": \\"\\",\\n \\"ActiveAddress\\": \\"\\",\\n \\"LicenseCode\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceResponse>\\n <BeganOn>1570634021000</BeganOn>\\n <ProductCode>cmgj00**11</ProductCode>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <OrderId>204605827111111</OrderId>\\n <InstanceId>15581111</InstanceId>\\n <EndOn>1602259200000</EndOn>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductType>APP</ProductType>\\n <CreatedOn>1570634018000</CreatedOn>\\n <RelationalData>\\n <ServiceStatus>READYING</ServiceStatus>\\n </RelationalData>\\n <ProductName>***协同办公</ProductName>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <SupplierName>阿里巴巴技术有限公司</SupplierName>\\n</DescribeInstanceResponse>","errorExample":""}]', + ], + 'DescribeInstanceForIsv' => [ + 'summary' => '服务商侧查询实例信息', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '155****11'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '发票Id', - 'description' => '发票申请 Id（对应 DescribeInvoiceForIsv 接口返回结果中的 Result.Id）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4072040****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '业务状态，根据不同商品类型设置不同值：'."\n" + .'当ProductType = MIRROR 时'."\n" + .'● PRODUCE：生产中'."\n" + .'● USING：使用中'."\n" + .'● UNUSED：未使用'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放'."\n" + .'当 ProductType = SERVICE 时'."\n" + .'● READYING：未开始'."\n" + .'● STARTED：服务中'."\n" + .'● CONFIRM：已完成'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放'."\n" + .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" + .'● OPENING：开通中'."\n" + .'● OPENED：已开通'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放', 'description' => '业务状态，根据不同商品类型设置不同值：'."\n" + .'当ProductType = MIRROR 时'."\n" + .'● PRODUCE：生产中'."\n" + .'● USING：使用中'."\n" + .'● UNUSED：未使用'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放'."\n" + .'当 ProductType = SERVICE 时'."\n" + .'● READYING：未开始'."\n" + .'● STARTED：服务中'."\n" + .'● CONFIRM：已完成'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放'."\n" + .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" + .'● OPENING：开通中'."\n" + .'● OPENED：已开通'."\n" + .'● EXPIRED：已过期'."\n" + .'● CLOSED：已释放', 'type' => 'string', 'example' => 'OPENED'], + 'AppJson' => ['title' => '应用信息，示例中的参数说明如下：'."\n" + ."\n" + .'username：用户名'."\n" + .'passowrd：密码'."\n" + .'frontEndUrl：前台地址'."\n" + .'adminUrl：管理地址', 'description' => '应用信息，示例中的参数说明如下：'."\n" + ."\n" + .'username：用户名'."\n" + .'passowrd：密码'."\n" + .'frontEndUrl：前台地址'."\n" + .'adminUrl：管理地址', 'type' => 'string', 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}'], + 'ProductName' => ['title' => '商品名称', 'description' => '商品名称', 'type' => 'string', 'example' => '***协同办公'], + 'InstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111'], + 'ExtendJson' => ['title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => '{"说明": "如有使用问题，请联系..."}'], + 'IsTrial' => ['title' => '是否试用', 'description' => '是否试用', 'type' => 'boolean', 'example' => 'true'], + 'BeganOn' => ['title' => '实例开通时间（时间戳）', 'description' => '实例开通时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000'], + 'ComponentJson' => ['title' => '业务模块'."\n" + .'示例中的参数说明如下：'."\n" + .'● package_version：版本', 'description' => '业务模块'."\n" + .'示例中的参数说明如下：'."\n" + .'● package_version：版本', 'type' => 'string', 'example' => '{"package_version":"yuncode000111"}'], + 'ProductType' => ['title' => '商品类型，取值：'."\n" + .'● APP：应用类'."\n" + .'● SERVIC：服务类'."\n" + .'● MIRROR：镜像类'."\n" + .'● DOWNLOAD：下载类'."\n" + .'● API_SERVICE：API类'."\n" + .'● DOCKER：DOCKER类', 'description' => '商品类型，取值：'."\n" + .'● APP：应用类'."\n" + .'● SERVIC：服务类'."\n" + .'● MIRROR：镜像类'."\n" + .'● DOWNLOAD：下载类'."\n" + .'● API_SERVICE：API类'."\n" + .'● DOCKER：DOCKER类', 'type' => 'string', 'example' => 'APP'], + 'HostJson' => ['title' => '主机信息，示例中的参数说明如下：'."\n" + ."\n" + .'username：用户名'."\n" + .'passowrd：密码'."\n" + .'ip：主机 IP'."\n" + .'innerIp：主机内网 IP', 'description' => '主机信息，示例中的参数说明如下：'."\n" + ."\n" + .'username：用户名'."\n" + .'passowrd：密码'."\n" + .'ip：主机 IP'."\n" + .'innerIp：主机内网 IP', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}'], + 'ProductSkuCode' => ['title' => '规格Code', 'description' => '规格Code', 'type' => 'string', 'example' => 'cmgj00**11-prepay'], + 'CreatedOn' => ['title' => '创建时间（时间戳）', 'description' => '创建时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634018000'], + 'EndOn' => ['title' => '到期时间（时间戳）', 'description' => '到期时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1602259200000'], + 'OrderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111'], + 'ProductCode' => ['title' => '商品Code', 'description' => '商品Code', 'type' => 'string', 'example' => 'cmgj00**11'], + 'SupplierName' => ['title' => '服务商名称', 'description' => '服务商名称', 'type' => 'string', 'example' => '*****有限公司'], + 'RelationalData' => [ + 'title' => '关联信息', + 'description' => '关联信息', + 'type' => 'object', + 'properties' => [ + 'ServiceStatus' => ['title' => '服务状态'."\n" + .'● READYING：未开始'."\n" + .'● STARTED： 服务中'."\n" + .'● CONFIRM：已完成'."\n" + .'● EXPIRED： 已过期'."\n" + .'● CLOSED： 已释放', 'description' => '服务状态'."\n" + .'● READYING：未开始'."\n" + .'● STARTED： 服务中'."\n" + .'● CONFIRM：已完成'."\n" + .'● EXPIRED： 已过期'."\n" + .'● CLOSED： 已释放', 'type' => 'string', 'example' => 'STARTED'], + ], + ], + 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '6EF60BEC-****-****-****-270359FB54A7'], + 'AutoRenewal' => ['title' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n" + .'autoRenewCycle:Day（日），Month（月），Year（年）'."\n" + .'autoRenewDuration:续费周期', 'description' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n" + .'autoRenewCycle:Day（日），Month（月），Year（年）'."\n" + .'autoRenewDuration:续费周期', 'type' => 'string', 'example' => '{"autoRenewCycle":"Year","autoRenewDuration":1}'], + 'ActiveAddress' => ['title' => '激活地址', 'description' => '激活地址', 'type' => 'string', 'example' => 'https://*****.com'], + 'LicenseCode' => ['title' => '激活码', 'description' => '激活码', 'type' => 'string', 'example' => 'xxxxxx'], + 'ImageJson' => ['title' => '镜像实例信息'."\n" + .'imageId：镜像id'."\n" + .'instanceId: 实例id'."\n" + .'ecsInstanceId: ecs id', 'description' => '镜像实例信息'."\n" + .'imageId：镜像id'."\n" + .'instanceId: 实例id'."\n" + .'ecsInstanceId: ecs id', 'type' => 'string', 'example' => '{"imageId":"m-*******","instanceId":********}'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '服务商侧查询实例信息', + 'changeSet' => [ + ['createdAt' => '2024-12-17T09:25:32.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeInstanceForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"AutoRenewal\\": \\"{\\\\\\"autoRenewCycle\\\\\\":\\\\\\"Year\\\\\\",\\\\\\"autoRenewDuration\\\\\\":1}\\",\\n \\"ActiveAddress\\": \\"https://*****.com\\",\\n \\"LicenseCode\\": \\"xxxxxx\\",\\n \\"ImageJson\\": \\"{\\\\\\"imageId\\\\\\":\\\\\\"m-*******\\\\\\",\\\\\\"instanceId\\\\\\":********}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceForIsvResponse>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductName>***协同办公</ProductName>\\n <InstanceId>1551111111</InstanceId>\\n <ExtendJson>{\\"说明\\": \\"如有使用问题，请联系...\\"}</ExtendJson>\\n <IsTrial>true</IsTrial>\\n <BeganOn>1570634021000</BeganOn>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <ProductType>APP</ProductType>\\n <HostJson>{\\"password\\":\\"***\\",\\"ip\\":\\"118.31.***.41\\",\\"innerIp\\":\\"118.31.***.41\\",\\"region\\":\\"\\",\\"username\\":\\"***\\",\\"beianInfo\\":\\"\\"}</HostJson>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <CreatedOn>1570634018000</CreatedOn>\\n <EndOn>1602259200000</EndOn>\\n <OrderId>204211111111111</OrderId>\\n <ProductCode>cmgj00**11</ProductCode>\\n <SupplierName>*****有限公司</SupplierName>\\n <RelationalData>\\n <ServiceStatus>STARTED</ServiceStatus>\\n </RelationalData>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n <AutoRenewal>{\\"autoRenewCycle\\":\\"Year\\",\\"autoRenewDuration\\":1}</AutoRenewal>\\n <ActiveAddress>https://*****.com</ActiveAddress>\\n <LicenseCode>xxxxxx</LicenseCode>\\n <ImageJson>{\\"imageId\\":\\"m-*******\\",\\"instanceId\\":********}</ImageJson>\\n</DescribeInstanceForIsvResponse>","errorExample":""}]', + ], + 'DescribeInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => ['description' => '商品类型：'."\n" + .'APP-应用类'."\n" + .'SERVICE-服务类'."\n" + .'MIRROR-镜像类'."\n" + .'DOWNLOAD-下载类'."\n" + .'API_SERVICE-API类'."\n" + .'ROS-资源编排类'."\n" + .'DOCKER-容器类'."\n" + .'IOT-IOT类', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '分页参数，当前页码', 'description' => '分页参数，每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['title' => '分页参数，每页数量', 'description' => '分页参数，页数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'Codes', + 'in' => 'query', + 'schema' => ['description' => '指定商品code, 如有多个，用 , 分隔', 'type' => 'string', 'required' => false, 'example' => 'cmgj000112,cmgj000113'], + ], + [ + 'name' => 'ExceptCodes', + 'in' => 'query', + 'schema' => ['description' => '排除商品code，与指定商品code不能同时传， 如有多个，用 , 分隔', 'type' => 'string', 'required' => false, 'example' => 'cmgj000114,cmgj000115'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页的实例个数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54C22FB9-0CB1-5629-97A8-653FC7990F00'], + 'PageNumber' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页的实例个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '实例总数', 'type' => 'integer', 'format' => 'int32', 'example' => '55'], + 'InstanceItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceItem' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '业务状态'."\n" + .'- 当 ProductType = MIRROR 时'."\n" + .' - PRODUCE：生产中'."\n" + .' - USING：使用中'."\n" + .' - UNUSED：未使用'."\n" + .' - EXPIRED：已过期'."\n" + .' - CLOSED：已释放'."\n" + ."\n" + .'- 当 ProductType = SERVICE 时'."\n" + .' - READYING：未开始'."\n" + .' - STARTED：服务中'."\n" + .' - CONFIRM：已完成'."\n" + .' - EXPIRED：已过期'."\n" + .' - CLOSED：已释放'."\n" + ."\n" + .'- 当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" + .' - OPENING：开通中'."\n" + .' - OPENED：已开通'."\n" + .' - EXPIRED：已过期'."\n" + .' - CLOSED：已释放', 'type' => 'string', 'example' => 'OPENED'], + 'AppJson' => ['description' => '应用信息'."\n" + ."\n" + .'示例中的参数说明如下：'."\n" + .'- username：用户名'."\n" + .'- passowrd：密码'."\n" + .'- frontEndUrl：前台地址'."\n" + .'- adminUrl：管理地址'."\n" + .'- authUrl: 免登地址', 'type' => 'string', 'example' => '{"frontEndUrl":"https://***.aliyun.com","password":"Sjtv***","adminUrl":"https://***.aiiyun.com","username":"aliyun***"}'], + 'ApiJson' => ['type' => 'string', 'example' => '{}', 'description' => ''], + 'ProductName' => ['description' => '商品名称', 'type' => 'string', 'example' => '***协同办公'], + 'ImageJson' => ['description' => '镜像信息', 'type' => 'string', 'example' => '{}'], + 'InstanceId' => ['description' => '实例id', 'type' => 'integer', 'format' => 'int64', 'example' => '1551111111'], + 'ExtendJson' => ['description' => '扩展信息', 'type' => 'string', 'example' => '{"说明": "如有使用问题，请联系..."}'], + 'BeganOn' => ['description' => '开通时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000'], + 'ProductType' => ['description' => '商品类型，取值：'."\n" + .'- APP：应用类'."\n" + .'- SERVIC：服务类'."\n" + .'- MIRROR：镜像类'."\n" + .'- DOWNLOAD：下载类'."\n" + .'- API_SERVICE：API类'."\n" + .'- DOCKER：DOCKER类', 'type' => 'string', 'example' => 'APP'], + 'HostJson' => ['description' => '主机信息'."\n" + ."\n" + .'示例中的参数说明如下：'."\n" + .'- username：用户名'."\n" + .'- passowrd：密码'."\n" + .'- ip：主机 IP'."\n" + .'- innerIp：主机内网 IP', 'type' => 'string', 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}'], + 'ProductSkuCode' => ['description' => '规格code', 'type' => 'string', 'example' => 'cmgj00**11-prepay'], + 'CreatedOn' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570634021000'], + 'IdaasJson' => ['description' => 'idaas信息，已经废弃', 'type' => 'string', 'example' => '{}'], + 'EndOn' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570644021000'], + 'OrderId' => ['description' => '订单id', 'type' => 'integer', 'format' => 'int64', 'example' => '204211111111111'], + 'ProductCode' => ['description' => '商品code', 'type' => 'string', 'example' => 'cmgj00**11'], + 'SupplierName' => ['description' => '服务商名称', 'type' => 'string', 'example' => '阿里巴巴技术有限公司'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54C22FB9-0CB1-5629-97A8-653FC7990F00\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 55,\\n \\"InstanceItems\\": {\\n \\"InstanceItem\\": [\\n {\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://***.aliyun.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://***.aiiyun.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ApiJson\\": \\"{}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"ImageJson\\": \\"{}\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"BeganOn\\": 1570634021000,\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634021000,\\n \\"IdaasJson\\": \\"{}\\",\\n \\"EndOn\\": 1570644021000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"阿里巴巴技术有限公司\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询业务列表', + 'summary' => '查询用户已购买的服务列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-29T09:32:23.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstances'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeInvoiceForIsv' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '发票状态：申请中：0；已完成：1', 'description' => '当前发票状态'."\n" + .'- 申请中：0'."\n" + .'- 已完成：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3', 'description' => '发票类型，为空代表默认查询所有类型'."\n" + .'- 数字电子普通发票：2'."\n" + .'- 数字电子专用发票：3', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'InvoiceId', + 'in' => 'query', + 'schema' => ['title' => '发票Id', 'description' => '发票申请 Id（对应 DescribeInvoiceForIsv 接口返回结果中的 Result.Id）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4072040****'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页的实例个数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'title' => '客户的阿里云userId', - 'description' => '客户的阿里云userId', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '174452687724****', - ], + 'schema' => ['title' => '客户的阿里云userId', 'description' => '客户的阿里云userId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '174452687724****'], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '结束时间（日期后默认拼接23:59:59）', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-01 00:00:00', - ], + 'schema' => ['title' => '开始时间', 'description' => '结束时间（日期后默认拼接23:59:59）', 'type' => 'string', 'required' => false, 'example' => '2025-01-01 00:00:00'], ], [ 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => '开始时间（日期后默认拼接00:00:00）', - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-31 23:59:59', - ], + 'schema' => ['title' => '结束时间', 'description' => '开始时间（日期后默认拼接00:00:00）', 'type' => 'string', 'required' => false, 'example' => '2025-01-31 23:59:59'], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '查询页码,从1开始', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询页码,从1开始', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。(未启用此参数)', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。(未启用此参数)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '本次调用返回的查询凭证值。(未启用此参数)', - 'type' => 'string', - 'required' => false, - 'example' => '3v3mzZN1QdVsTPNiT0OkD9v+MeV8LSqSQDSuTTVFCUMMWShmnj/LXRMScqm242bB', - ], + 'schema' => ['description' => '本次调用返回的查询凭证值。(未启用此参数)', 'type' => 'string', 'required' => false, 'example' => '3v3mzZN1QdVsTPNiT0OkD9v+MeV8LSqSQDSuTTVFCUMMWShmnj/LXRMScqm242bB'], ], ], 'responses' => [ @@ -605,36 +1614,12 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'PageSize' => [ - 'description' => '每页的实例个数。', - 'type' => 'string', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页数', - 'type' => 'string', - 'example' => '1', - ], - 'Count' => [ - 'description' => '总数', - 'type' => 'string', - 'example' => '100', - ], - 'Code' => [ - 'description' => '商品对应商品码', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => '结果标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'PageSize' => ['description' => '每页的实例个数。', 'type' => 'string', 'example' => '10'], + 'PageNumber' => ['description' => '当前页数', 'type' => 'string', 'example' => '1'], + 'Count' => ['description' => '总数', 'type' => 'string', 'example' => '100'], + 'Code' => ['description' => '商品对应商品码', 'type' => 'string', 'example' => '200'], + 'Success' => ['description' => '结果标识', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'description' => '成功流程节点信息', 'type' => 'array', @@ -642,16 +1627,8 @@ 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'AliyunPk' => [ - 'description' => '客户的阿里云userId', - 'type' => 'string', - 'example' => '102277855749****', - ], - 'CreateTimeStr' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2025-01-01 00:00:00'."\n", - ], + 'AliyunPk' => ['description' => '客户的阿里云userId', 'type' => 'string', 'example' => '102277855749****'], + 'CreateTimeStr' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n"], 'EvaluateList' => [ 'description' => '订单/账单/合同编号', 'type' => 'array', @@ -659,82 +1636,28 @@ 'description' => '修改时间', 'type' => 'object', 'properties' => [ - 'Agent' => [ - 'title' => '是否代理开票', - 'description' => '是否代理开票', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Amount' => [ - 'title' => '金额（分）', - 'description' => '金额（单位：元）', - 'type' => 'string', - 'example' => '1', - ], - 'BizTimeStr' => [ - 'description' => '业务发生时间', - 'type' => 'string', - 'example' => '2025-01-01 00:00:00'."\n", - ], - 'Id' => [ - 'title' => '开票对象id', - 'description' => '开票对象id', - 'type' => 'string', - 'example' => '9540765', - ], - 'OrderType' => [ - 'title' => '订账单类型'."\n" - .'0：订单'."\n" - .'1：账单', - 'description' => '订账单类型'."\n" - ."\n" - .'- 0：订单'."\n" - ."\n" - .'- 1：账单', - 'type' => 'string', - 'example' => '0', - ], - 'OutBizId' => [ - 'title' => '订单Id', - 'description' => '订单Id', - 'type' => 'string', - 'example' => '2024091610072000****', - ], - 'RealAliyunPk' => [ - 'title' => '订单归属账号', - 'description' => '订单归属账号', - 'type' => 'string', - 'example' => '102277855749****'."\n", - ], - 'RealAliyunId' => [ - 'description' => '账号id', - 'type' => 'string', - 'example' => 'example@alibaba-inc.com', - ], - 'ProductCode' => [ - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmapi00067***', - ], - 'ProductName' => [ - 'description' => '商品名称（已废弃）', - 'type' => 'string', - 'example' => '图像识别OCR***', - ], + 'Agent' => ['title' => '是否代理开票', 'description' => '是否代理开票', 'type' => 'boolean', 'example' => 'false'], + 'Amount' => ['title' => '金额（分）', 'description' => '金额（单位：元）', 'type' => 'string', 'example' => '1'], + 'BizTimeStr' => ['description' => '业务发生时间', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n"], + 'Id' => ['title' => '开票对象id', 'description' => '开票对象id', 'type' => 'string', 'example' => '9540765'], + 'OrderType' => ['title' => '订账单类型'."\n" + .'0：订单'."\n" + .'1：账单', 'description' => '订账单类型'."\n" + ."\n" + .'- 0：订单'."\n" + ."\n" + .'- 1：账单', 'type' => 'string', 'example' => '0'], + 'OutBizId' => ['title' => '订单Id', 'description' => '订单Id', 'type' => 'string', 'example' => '2024091610072000****'], + 'RealAliyunPk' => ['title' => '订单归属账号', 'description' => '订单归属账号', 'type' => 'string', 'example' => '102277855749****'."\n"], + 'RealAliyunId' => ['description' => '账号id', 'type' => 'string', 'example' => 'example@alibaba-inc.com'], + 'ProductCode' => ['description' => '商品Code', 'type' => 'string', 'example' => 'cmapi00067***'], + 'ProductName' => ['description' => '商品名称（已废弃）', 'type' => 'string', 'example' => '图像识别OCR***'], ], ], ], - 'Id' => [ - 'description' => '发票申请Id（对应调用发票受理接口ModifyInvoiceForIsv'."\n" - .'时参数InvoiceId）', - 'type' => 'string', - 'example' => '4072040****'."\n", - ], - 'InvoiceId' => [ - 'description' => '发票对象id', - 'type' => 'string', - 'example' => '4072040****'."\n", - ], + 'Id' => ['description' => '发票申请Id（对应调用发票受理接口ModifyInvoiceForIsv'."\n" + .'时参数InvoiceId）', 'type' => 'string', 'example' => '4072040****'."\n"], + 'InvoiceId' => ['description' => '发票对象id', 'type' => 'string', 'example' => '4072040****'."\n"], 'InvoiceList' => [ 'description' => '发票子集合（废弃）', 'type' => 'array', @@ -742,142 +1665,50 @@ 'description' => '发票子集合（废弃）', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '发票对象id', - 'type' => 'string', - 'example' => '4072040****'."\n", - ], - 'InvoiceAmount' => [ - 'description' => '申请开票金额（单位：元）。', - 'type' => 'string', - 'example' => '99.99', - ], + 'Id' => ['description' => '发票对象id', 'type' => 'string', 'example' => '4072040****'."\n"], + 'InvoiceAmount' => ['description' => '申请开票金额（单位：元）。', 'type' => 'string', 'example' => '99.99'], ], ], ], - 'MaterialType' => [ - 'title' => '发票开具类型，0：纸质，1：电子', - 'description' => '发票开具类型'."\n" - .'- 0：纸质'."\n" - .'- 1：电子', - 'type' => 'string', - 'example' => '1', - ], - 'ModifiedTime' => [ - 'description' => '订单状态修改时间(GMT时间)', - 'type' => 'string', - 'example' => '2025-03-04T09:43:18+08:00', - ], - 'Price' => [ - 'title' => '电子发票下载地址', - 'description' => '发票总金额（单位：元）', - 'type' => 'string', - 'example' => '99.99', - ], - 'Status' => [ - 'title' => '发票状态 0：待开票；1：已开票', - 'description' => '发票状态 0：待开票；1：已开票', - 'type' => 'string', - 'example' => 'Success', - ], - 'Title' => [ - 'title' => '发票抬头', - 'description' => '发票抬头', - 'type' => 'string', - 'example' => '阿里云计算有限公司', - ], - 'Type' => [ - 'title' => '数字电子普通发票:2'."\n" - .'数字电子专用发票:3', - 'description' => '发票类型'."\n" - .'- 数字电子普通发票:2'."\n" - .'- 数字电子专用发票:3', - 'type' => 'string', - 'example' => '2', - ], + 'MaterialType' => ['title' => '发票开具类型，0：纸质，1：电子', 'description' => '发票开具类型'."\n" + .'- 0：纸质'."\n" + .'- 1：电子', 'type' => 'string', 'example' => '1'], + 'ModifiedTime' => ['description' => '订单状态修改时间(GMT时间)', 'type' => 'string', 'example' => '2025-03-04T09:43:18+08:00'], + 'Price' => ['title' => '电子发票下载地址', 'description' => '发票总金额（单位：元）', 'type' => 'string', 'example' => '99.99'], + 'Status' => ['title' => '发票状态 0：待开票；1：已开票', 'description' => '发票状态 0：待开票；1：已开票', 'type' => 'string', 'example' => 'Success'], + 'Title' => ['title' => '发票抬头', 'description' => '发票抬头', 'type' => 'string', 'example' => '阿里云计算有限公司'], + 'Type' => ['title' => '数字电子普通发票:2'."\n" + .'数字电子专用发票:3', 'description' => '发票类型'."\n" + .'- 数字电子普通发票:2'."\n" + .'- 数字电子专用发票:3', 'type' => 'string', 'example' => '2'], 'UserAddressDto' => [ 'description' => '地址信息', 'type' => 'object', 'properties' => [ - 'AliyunPk' => [ - 'description' => '客户的阿里云userId', - 'type' => 'string', - 'example' => '174452687724****'."\n", - ], - 'BizType' => [ - 'description' => '废弃', - 'type' => 'string', - 'example' => '******', - ], - 'Emails' => [ - 'description' => '邮箱', - 'type' => 'string', - 'example' => '******', - ], - 'Addressee' => [ - 'description' => '收件人', - 'type' => 'string', - 'example' => '***', - ], - 'DeliveryAddress' => [ - 'description' => '收货地址', - 'type' => 'string', - 'example' => '杭州市****'."\n", - ], - 'Phone' => [ - 'description' => '电话', - 'type' => 'string', - 'example' => '130********', - ], - 'PostalCode' => [ - 'description' => '邮政编码', - 'type' => 'string', - 'example' => '******', - ], + 'AliyunPk' => ['description' => '客户的阿里云userId', 'type' => 'string', 'example' => '174452687724****'."\n"], + 'BizType' => ['description' => '废弃', 'type' => 'string', 'example' => '******'], + 'Emails' => ['description' => '邮箱', 'type' => 'string', 'example' => '******'], + 'Addressee' => ['description' => '收件人', 'type' => 'string', 'example' => '***'], + 'DeliveryAddress' => ['description' => '收货地址', 'type' => 'string', 'example' => '杭州市****'."\n"], + 'Phone' => ['description' => '电话', 'type' => 'string', 'example' => '130********'], + 'PostalCode' => ['description' => '邮政编码', 'type' => 'string', 'example' => '******'], ], ], - 'ModifiedTimeStr' => [ - 'description' => '发票修改时间', - 'type' => 'string', - 'example' => '2025-01-01 00:00:00'."\n", - ], + 'ModifiedTimeStr' => ['description' => '发票修改时间', 'type' => 'string', 'example' => '2025-01-01 00:00:00'."\n"], 'ReceiptUserInfoDto' => [ 'description' => '发票申请人用户信息', 'type' => 'object', 'properties' => [ - 'TaxNumber' => [ - 'description' => '企业社会征信代码', - 'type' => 'string', - 'example' => '91420100MA49L5****', - ], + 'TaxNumber' => ['description' => '企业社会征信代码', 'type' => 'string', 'example' => '91420100MA49L5****'], ], ], - 'UserNotice' => [ - 'title' => '用户发票备注', - 'description' => '用户发票备注', - 'type' => 'string', - 'example' => '无', - ], - 'CheckNotice' => [ - 'title' => '服务商发票备注', - 'description' => '服务商发票备注', - 'type' => 'string', - 'example' => '无', - ], + 'UserNotice' => ['title' => '用户发票备注', 'description' => '用户发票备注', 'type' => 'string', 'example' => '无'], + 'CheckNotice' => ['title' => '服务商发票备注', 'description' => '服务商发票备注', 'type' => 'string', 'example' => '无'], ], ], ], - 'NextToken' => [ - 'description' => '本次调用返回的查询凭证值。', - 'type' => 'string', - 'example' => '3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+', - ], - 'MaxResults' => [ - 'description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'NextToken' => ['description' => '本次调用返回的查询凭证值。', 'type' => 'string', 'example' => '3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+'], + 'MaxResults' => ['description' => '分页查询时每页的最大条目数。最大值为50。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], @@ -885,66 +1716,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'PageSize' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'PageNumber' => [ - 'type' => 'string', - ], - 'Version' => [ - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Count' => [ - 'type' => 'string', - ], - 'Fatal' => [ - 'type' => 'boolean', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'AccessDeniedDetail' => ['type' => 'string', 'description' => ''], + 'RequestId' => ['type' => 'string', 'description' => ''], + 'PageSize' => ['type' => 'string', 'description' => ''], + 'Message' => ['type' => 'string', 'description' => ''], + 'PageNumber' => ['type' => 'string', 'description' => ''], + 'Version' => ['type' => 'string', 'description' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'Count' => ['type' => 'string', 'description' => ''], + 'Fatal' => ['type' => 'boolean', 'description' => ''], + 'Code' => ['type' => 'string', 'description' => ''], + 'Success' => ['type' => 'boolean', 'description' => ''], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Count\\": \\"100\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": \\"102277855749****\\",\\n \\"CreateTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"EvaluateList\\": [\\n {\\n \\"Agent\\": false,\\n \\"Amount\\": \\"1\\",\\n \\"BizTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"Id\\": \\"9540765\\",\\n \\"OrderType\\": \\"0\\",\\n \\"OutBizId\\": \\"2024091610072000****\\",\\n \\"RealAliyunPk\\": \\"102277855749****\\\\n\\",\\n \\"RealAliyunId\\": \\"example@alibaba-inc.com\\",\\n \\"ProductCode\\": \\"cmapi00067***\\",\\n \\"ProductName\\": \\"图像识别OCR***\\"\\n }\\n ],\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceId\\": \\"4072040****\\\\n\\",\\n \\"InvoiceList\\": [\\n {\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceAmount\\": \\"99.99\\"\\n }\\n ],\\n \\"MaterialType\\": \\"1\\",\\n \\"ModifiedTime\\": \\"2025-03-04T09:43:18+08:00\\",\\n \\"Price\\": \\"99.99\\",\\n \\"Status\\": \\"Success\\",\\n \\"Title\\": \\"阿里云计算有限公司\\",\\n \\"Type\\": \\"2\\",\\n \\"UserAddressDto\\": {\\n \\"AliyunPk\\": \\"174452687724****\\\\n\\",\\n \\"BizType\\": \\"******\\",\\n \\"Emails\\": \\"******\\",\\n \\"Addressee\\": \\"***\\",\\n \\"DeliveryAddress\\": \\"杭州市****\\\\n\\",\\n \\"Phone\\": \\"130********\\",\\n \\"PostalCode\\": \\"******\\"\\n },\\n \\"ModifiedTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"ReceiptUserInfoDto\\": {\\n \\"TaxNumber\\": \\"91420100MA49L5****\\"\\n },\\n \\"UserNotice\\": \\"无\\",\\n \\"CheckNotice\\": \\"无\\"\\n }\\n ],\\n \\"NextToken\\": \\"3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询云市场供应商店铺的发票信息', + 'summary' => '查询云市场供应商店铺的发票信息', 'description' => '根据授权码查询业务信息首先验证授权码是否有效。'."\n" ."\n" .'- 授权码无效，返回错误信息'."\n" ."\n" .'- 授权码有效，返回授权信息', - ], - 'DescribePrice' => [ - 'summary' => '调用 DescribePrice 查询对应商品的价格信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-08-14T14:39:17.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'acm:DescribeInvoiceForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Count\\": \\"100\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": \\"102277855749****\\",\\n \\"CreateTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"EvaluateList\\": [\\n {\\n \\"Agent\\": false,\\n \\"Amount\\": \\"1\\",\\n \\"BizTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"Id\\": \\"9540765\\",\\n \\"OrderType\\": \\"0\\",\\n \\"OutBizId\\": \\"2024091610072000****\\",\\n \\"RealAliyunPk\\": \\"102277855749****\\\\n\\",\\n \\"RealAliyunId\\": \\"example@alibaba-inc.com\\",\\n \\"ProductCode\\": \\"cmapi00067***\\",\\n \\"ProductName\\": \\"图像识别OCR***\\"\\n }\\n ],\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceId\\": \\"4072040****\\\\n\\",\\n \\"InvoiceList\\": [\\n {\\n \\"Id\\": \\"4072040****\\\\n\\",\\n \\"InvoiceAmount\\": \\"99.99\\"\\n }\\n ],\\n \\"MaterialType\\": \\"1\\",\\n \\"ModifiedTime\\": \\"2025-03-04T09:43:18+08:00\\",\\n \\"Price\\": \\"99.99\\",\\n \\"Status\\": \\"Success\\",\\n \\"Title\\": \\"阿里云计算有限公司\\",\\n \\"Type\\": \\"2\\",\\n \\"UserAddressDto\\": {\\n \\"AliyunPk\\": \\"174452687724****\\\\n\\",\\n \\"BizType\\": \\"******\\",\\n \\"Emails\\": \\"******\\",\\n \\"Addressee\\": \\"***\\",\\n \\"DeliveryAddress\\": \\"杭州市****\\\\n\\",\\n \\"Phone\\": \\"130********\\",\\n \\"PostalCode\\": \\"******\\"\\n },\\n \\"ModifiedTimeStr\\": \\"2025-01-01 00:00:00\\\\n\\",\\n \\"ReceiptUserInfoDto\\": {\\n \\"TaxNumber\\": \\"91420100MA49L5****\\"\\n },\\n \\"UserNotice\\": \\"无\\",\\n \\"CheckNotice\\": \\"无\\"\\n }\\n ],\\n \\"NextToken\\": \\"3v3mzZN1QdVsTPNiT0OkD36LC9I+AJHU9z2oXBmJJOyy4nQl7MIUZUYG6fdbYBk+\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + ], + 'DescribeLicense' => [ + 'summary' => '调用 DescribeLicense 查询授权信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -952,123 +1773,424 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'LicenseCode', + 'in' => 'query', + 'schema' => ['description' => '激活码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxxxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'License' => [ + 'description' => '激活码对象', + 'type' => 'object', + 'properties' => [ + 'ActivateTime' => ['description' => '激活时间', 'type' => 'string', 'example' => '2019-05-25 09:00:00'], + 'LicenseStatus' => ['description' => '激活码状态'."\n" + .'- ACTIVATED'."\n" + .'- INACTIVATED', 'type' => 'string', 'example' => 'ACTIVATED'], + 'ProductName' => ['description' => '商品名称', 'type' => 'string', 'example' => 'LNMP环境'], + 'ExpiredTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2019-06-25 09:00:00'], + 'ProductSkuId' => ['description' => '商品规格ID', 'type' => 'string', 'example' => 'cmgj02****-prepay'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2019-05-25 09:00:00'], + 'LicenseCode' => ['description' => '激活码', 'type' => 'string', 'example' => '-'], + 'InstanceId' => ['description' => '业务实例ID', 'type' => 'string', 'example' => '1551111111'], + 'SupplierName' => ['description' => '供应商名称', 'type' => 'string', 'example' => '**科技股份有限公司'], + 'ProductCode' => ['description' => '商品Code', 'type' => 'string', 'example' => 'cmgj02****'], + 'ExtendArray' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LicenseAttribute' => [ + 'description' => '扩展对象数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '对象code', 'type' => 'string', 'example' => 'package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;'], + 'Value' => ['description' => '对象值', 'type' => 'string', 'example' => '-'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + 'ExtendInfo' => [ + 'description' => '扩展属性', + 'type' => 'object', + 'properties' => [ + 'AliUid' => ['description' => '阿里云UID', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****'], + 'AccountQuantity' => ['description' => '账号信息', 'type' => 'integer', 'format' => 'int64', 'example' => '-'], + 'Email' => ['description' => '邮箱', 'type' => 'string', 'example' => 'id***@**.com'], + 'Mobile' => ['description' => '电话', 'type' => 'string', 'example' => '129****1111'], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Auth.SubAccount.Error', 'errorMessage' => 'The specified AccessKey information does not belong to the RAM user.', 'description' => '该AccessKey不是子账号的AccessKey。'], + ['errorCode' => 'License.Invalid', 'errorMessage' => 'The specified license is invalid.', 'description' => '无效的授权码。'], + ['errorCode' => 'License.Expired', 'errorMessage' => 'The specified license has expired.', 'description' => '授权码已过期。'], + ['errorCode' => 'License.Discard', 'errorMessage' => 'The specified license has been discarded.', 'description' => '授权码已废弃。'], + ['errorCode' => 'License.NotFound', 'errorMessage' => 'The specified license does not exist.', 'description' => '授权码不存在。'], + ['errorCode' => 'Auth.ISV.Error', 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', 'description' => '非服务商账号，仅供服务商账号调用。'], + ['errorCode' => 'Auth.Match', 'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.', 'description' => '授权码对应的商品不属于该服务商。'], + ['errorCode' => 'Auth.Authorized', 'errorMessage' => 'The specified RAM user is not authorized.', 'description' => '子账号没有授权。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询授权信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"License\\": {\\n \\"ActivateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseStatus\\": \\"ACTIVATED\\",\\n \\"ProductName\\": \\"LNMP环境\\",\\n \\"ExpiredTime\\": \\"2019-06-25 09:00:00\\",\\n \\"ProductSkuId\\": \\"cmgj02****-prepay\\",\\n \\"CreateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseCode\\": \\"-\\",\\n \\"InstanceId\\": \\"1551111111\\",\\n \\"SupplierName\\": \\"**科技股份有限公司\\",\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"ExtendArray\\": {\\n \\"LicenseAttribute\\": [\\n {\\n \\"Code\\": \\"package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;\\",\\n \\"Value\\": \\"-\\"\\n }\\n ]\\n },\\n \\"ExtendInfo\\": {\\n \\"AliUid\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"Email\\": \\"id***@**.com\\",\\n \\"Mobile\\": \\"129****1111\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLicenseResponse>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <License>\\n <ActivateTime>2019-05-25 09:00:00</ActivateTime>\\n <LicenseStatus>ACTIVATED</LicenseStatus>\\n <ProductName>LNMP环境</ProductName>\\n <ExpiredTime>2019-06-25 09:00:00</ExpiredTime>\\n <ProductSkuId>cmgj02****-prepay</ProductSkuId>\\n <CreateTime>2019-05-25 09:00:00</CreateTime>\\n <LicenseCode>-</LicenseCode>\\n <InstanceId>1551111111</InstanceId>\\n <SupplierName>**科技股份有限公司</SupplierName>\\n <ProductCode>cmgj02****</ProductCode>\\n <ExtendArray>\\n <Code>-</Code>\\n <Value>-</Value>\\n </ExtendArray>\\n <ExtendInfo>\\n <Email>id***@**.com</Email>\\n <Mobile>129****1111</Mobile>\\n </ExtendInfo>\\n </License>\\n</DescribeLicenseResponse>","errorExample":""}]', + ], + 'DescribeOrder' => [ + 'summary' => '调用 DescribeOrder 用于查询对应订单的详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrderType', + 'name' => 'OrderId', 'in' => 'query', + 'schema' => ['description' => '订单ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202*********415'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '订单类型。取值：'."\n" - ."\n" - .'INSTANCE_BUY：商品购买'."\n" - .'INSTANCE_RENEW：实例续费'."\n" - .'INSTANCE_UPGRADE：实例升级'."\n" - .'说明：对于续费类型的询价，需要在 Commodity 中传入 InstanceId。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_BUY', + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['description' => '订购商品名称', 'type' => 'string', 'example' => 'saas服务产品'], + 'SupplierCompanyName' => ['description' => '卖家公司名称', 'type' => 'string', 'example' => '**科技股份有限公司'], + 'OriginalPrice' => ['description' => '订单原价（元）', 'type' => 'number', 'format' => 'float', 'example' => '10.0'], + 'AliUid' => ['description' => '阿里云用户唯一标识（aliyunPK）', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****'], + 'CouponPrice' => ['description' => '已使用代金券金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'AccountQuantity' => ['description' => '账号数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'PeriodType' => ['description' => '预付费的时间单位。取值：'."\n" + ."\n" + .'- MONTH：单月'."\n" + .'- SEASON：季度'."\n" + .'- HALFYEAR：半年'."\n" + .'- YEAR：一年'."\n" + .'- TWOYEARS：两年'."\n" + .'- ONCE：单次', 'type' => 'string', 'example' => 'MONTH'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'PayStatus' => ['description' => '付款状态。取值：'."\n" + ."\n" + .'- PAID 已支付'."\n" + .'- UNPAID 未支付', 'type' => 'string', 'example' => 'PAID'], + 'PaymentPrice' => ['description' => '实际支付金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'OrderStatus' => ['description' => '订单状态。取值：'."\n" + ."\n" + .'- NORMAL 正常'."\n" + .'- REFUND 退款'."\n" + .'- DELETE 作废', 'type' => 'string', 'example' => 'NORMAL'], + 'ProductSkuCode' => ['description' => '订购商品规格 Code', 'type' => 'string', 'example' => 'cmgj02****-prepay'], + 'PaidOn' => ['description' => '付款时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191675000'], + 'Components' => ['description' => '订单模块信息。示例中的参数说明如下：'."\n" + ."\n" + .'- package_quantity： 使用次数（API 商品特有模块）'."\n" + .'- package_version：版本'."\n" + .'- ord_time： 时长'."\n" + .'- order_num： 数量'."\n" + .'- code：模块 Code'."\n" + .'- globarKey： 模块 key'."\n" + .'- name： 模块名称'."\n" + .'- value： 模块值', 'type' => 'object', 'example' => '{ "package_quantity": { "code": "package_quantity", "globarKey": "cmapi014302_package_quantity_package_quantity_10000", "name": "10000次", "value": "10000" }, "package_version": { "code": "package_version", "globarKey": "cmapi014302_package_version_package_version_yuncode830200000", "name": "0元／10000次", "value": "yuncode830200000" }, "ord_time": { "code": "ord_time", "globarKey": "cmapi014302_ord_time_ord_time_6:Month", "name": "6个月", "value": "6:Month" }, "order_num": { "code": "order_num", "globarKey": "cmapi014302_order_num_order_num_1", "name": "1", "value": "1" } }'], + 'CreatedOn' => ['description' => '下单时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191564000'], + 'OrderType' => ['description' => '订单类型。取值：'."\n" + ."\n" + .'- NEW 新购订单'."\n" + .'- RENEW 续费订单'."\n" + .'- TRIAL 试用订单', 'type' => 'string', 'example' => 'NEW'], + 'TotalPrice' => ['description' => '订单应收金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'Quantity' => ['description' => '订购数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'OrderId' => ['description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '202211111111111'], + 'ProductCode' => ['description' => '商品Code', 'type' => 'string', 'example' => 'cmgj02****'], + 'SupplierTelephones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Telephone' => [ + 'description' => '卖家客服热线', + 'type' => 'array', + 'items' => ['description' => '卖家客服热线', 'type' => 'string', 'example' => '{139*****950, 139*****831}'], + ], + ], + 'description' => '', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '订单关联业务实例', + 'type' => 'array', + 'items' => ['description' => '订单关联业务实例 ID', 'type' => 'string', 'example' => '{1597985, 1227195}'], + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ], + ], + 'title' => '用于查询对应订单的详细信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOrder'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"SupplierCompanyName\\": \\"**科技股份有限公司\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"Components\\": {\\n \\"package_quantity\\": {\\n \\"code\\": \\"package_quantity\\",\\n \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\",\\n \\"name\\": \\"10000次\\",\\n \\"value\\": \\"10000\\"\\n },\\n \\"package_version\\": {\\n \\"code\\": \\"package_version\\",\\n \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\",\\n \\"name\\": \\"0元／10000次\\",\\n \\"value\\": \\"yuncode830200000\\"\\n },\\n \\"ord_time\\": {\\n \\"code\\": \\"ord_time\\",\\n \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\",\\n \\"name\\": \\"6个月\\",\\n \\"value\\": \\"6:Month\\"\\n },\\n \\"order_num\\": {\\n \\"code\\": \\"order_num\\",\\n \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\",\\n \\"name\\": \\"1\\",\\n \\"value\\": \\"1\\"\\n }\\n },\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"SupplierTelephones\\": {\\n \\"Telephone\\": [\\n \\"{139*****950, 139*****831}\\"\\n ]\\n },\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"{1597985, 1227195}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeOrderResponse>\\n <PaidOn>1531191675000</PaidOn>\\n <PeriodType>MONTH</PeriodType>\\n <CouponPrice>0.0</CouponPrice>\\n <PayStatus>PAID</PayStatus>\\n <OriginalPrice>10.0</OriginalPrice>\\n <ProductName>saas服务产品</ProductName>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <ProductCode>cmgj02****</ProductCode>\\n <SupplierCompanyName>**科技股份有限公司</SupplierCompanyName>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <SupplierTelephones>\\n <Telephone>{139*****950, 139*****831}</Telephone>\\n </SupplierTelephones>\\n <Components>{ \\"package_quantity\\": { \\"code\\": \\"package_quantity\\", \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\", \\"name\\": \\"10000次\\", \\"value\\": \\"10000\\" }, \\"package_version\\": { \\"code\\": \\"package_version\\", \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\", \\"name\\": \\"0元／10000次\\", \\"value\\": \\"yuncode830200000\\" }, \\"ord_time\\": { \\"code\\": \\"ord_time\\", \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\", \\"name\\": \\"6个月\\", \\"value\\": \\"6:Month\\" }, \\"order_num\\": { \\"code\\": \\"order_num\\", \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\", \\"name\\": \\"1\\", \\"value\\": \\"1\\" } }</Components>\\n <OrderStatus>NORMAL</OrderStatus>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0.0</TotalPrice>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <CreatedOn>1531191564000</CreatedOn>\\n <PaymentPrice>0.0</PaymentPrice>\\n <InstanceIds>\\n <InstanceId>{1597985, 1227195}</InstanceId>\\n </InstanceIds>\\n <AccountQuantity>0</AccountQuantity>\\n <AliUid>190311111111****</AliUid>\\n</DescribeOrderResponse>","errorExample":""}]', + ], + 'DescribeOrderForIsv' => [ + 'summary' => '服务商侧查询订单详情', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Commodity', + 'name' => 'OrderId', 'in' => 'query', + 'schema' => ['description' => '订单id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202*********415'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '根据指定的 OrderType，使用对应的配件并序列化。 不同 OrderType 分别对应的 CommodityType 如下所示：'."\n" - ."\n" - .'INSTANCE_BUY：InstanceBuyCommodity'."\n" - .'INSTANCE_RENEW：InstanceRenewCommodity'."\n" - .'INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n" - .'示例中的参数说明如下：'."\n" - ."\n" - .'productCode：商品 Code。'."\n" - .'skuCode：商品规格 Code。非镜像商品：预付费固定为 prepay，后付费固定为 postpay；镜像商品：按量为ECS，包年包月为Package'."\n" - .'components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n" - .'duration：周期数量 1,2,3...。'."\n" - .'pricingCycle: 周期单位。Day（日），Month（月），Year（年）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"components":{"package_version":"yuncode12928000016"},"duration":1,"pricingCycle":"YEAR","productCode":"cmgj01**28","quantity":1,"skuCode":"prepay"}', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['title' => '订购商品名称', 'description' => '订购商品名称', 'type' => 'string', 'example' => 'saas服务产品'], + 'OriginalPrice' => ['title' => '订单原价（元）', 'description' => '订单原价（元）', 'type' => 'number', 'format' => 'float', 'example' => '10.0'], + 'AliUid' => ['title' => '阿里云用户唯一标识（aliyunPK）', 'description' => '阿里云用户唯一标识（aliyunPK）', 'type' => 'integer', 'format' => 'int64', 'example' => '190311111111****'], + 'CouponPrice' => ['title' => '已使用代金券金额（元）', 'description' => '已使用代金券金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'AccountQuantity' => ['title' => '账号数', 'description' => '账号数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'PeriodType' => ['title' => '预付费的时间单位。取值：'."\n" + .'● MONTH：单月'."\n" + .'● SEASON：季度'."\n" + .'● HALFYEAR：半年'."\n" + .'● YEAR：一年'."\n" + .'● TWOYEARS：两年'."\n" + .'● ONCE：单次', 'description' => '预付费的时间单位。取值：'."\n" + .'● MONTH：单月'."\n" + .'● SEASON：季度'."\n" + .'● HALFYEAR：半年'."\n" + .'● YEAR：一年'."\n" + .'● TWOYEARS：两年'."\n" + .'● ONCE：单次', 'type' => 'string', 'example' => 'MONTH'], + 'PayStatus' => ['title' => '付款状态。取值：'."\n" + .'● PAID 已支付'."\n" + .'● UNPAID 未支付', 'description' => '付款状态。取值：'."\n" + .'● PAID 已支付'."\n" + .'● UNPAID 未支付', 'type' => 'string', 'example' => 'PAID'], + 'PaymentPrice' => ['title' => '实际支付金额（元）', 'description' => '实际支付金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'OrderStatus' => ['title' => '订单状态。取值：'."\n" + .'● NORMAL 正常'."\n" + .'● REFUND 退款'."\n" + .'● DELETE 作废', 'description' => '订单状态。取值：'."\n" + .'● NORMAL 正常'."\n" + .'● REFUND 退款'."\n" + .'● DELETE 作废', 'type' => 'string', 'example' => 'NORMAL'], + 'ProductSkuCode' => ['title' => '订购商品规格 Code', 'description' => '订购商品规格 Code', 'type' => 'string', 'example' => 'cmgj02****-prepay'], + 'PaidOn' => ['title' => '付款时间', 'description' => '付款时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191675000'], + 'CreatedOn' => ['title' => '下单时间', 'description' => '下单时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1531191564000'], + 'OrderType' => ['title' => '订单类型。取值：'."\n" + .'● NEW 新购订单'."\n" + .'● RENEW 续费订单'."\n" + .'● TRIAL 试用订单', 'description' => '订单类型。取值：'."\n" + .'● NEW 新购订单'."\n" + .'● RENEW 续费订单'."\n" + .'● TRIAL 试用订单'."\n" + .'● UPGRADE 升级订单'."\n" + .'● DOWNGRADE 降配订单'."\n" + .'● PURCHASE 转正订单', 'type' => 'string', 'example' => 'NEW'], + 'TotalPrice' => ['title' => '订单应收金额（元）', 'description' => '订单应收金额（元）', 'type' => 'number', 'format' => 'float', 'example' => '0.0'], + 'Quantity' => ['title' => '订购数量', 'description' => '订购数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'OrderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '202211111111111'], + 'ProductCode' => ['title' => '商品Code', 'description' => '商品Code', 'type' => 'string', 'example' => 'cmgj02****'], + 'InstanceIds' => [ + 'title' => '订单关联业务实例 ID', + 'description' => 'List', + 'type' => 'array', + 'items' => ['description' => '实例id', 'type' => 'string', 'example' => '1597985'], + ], + 'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。'."\n", 'type' => 'string', 'example' => '6EF60BEC-****-****-****-270359FB54A7'], + 'Components' => ['description' => '订单模块信息。示例中的参数说明如下：'."\n" + .'● package_quantity： 使用次数（API 商品特有模块）'."\n" + .'● package_version：版本'."\n" + .'● ord_time： 时长'."\n" + .'● order_num： 数量'."\n" + .'● code：模块 Code'."\n" + .'● globarKey： 模块 key'."\n" + .'● name： 模块名称'."\n" + .'● value： 模块值', 'type' => 'any', 'example' => '{"package_version":{"code":"package_version","globarKey":"cmgj0******8_package_version_package_version_yuncode4176*****1","name":"0.01","value":"yuncode4176*****1"},"ord_time":{"code":"ord_time","globarKey":"cmgj0******8_ord_time_ord_time_1:Month","name":"1个月","value":"1:Month"},"order_num":{"code":"order_num","globarKey":"cmgj0******8_order_num_order_num_1","name":"1","value":"1"}}'], + ], ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"InstanceIds\\": [\\n \\"1597985\\"\\n ],\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"Components\\": \\"{\\\\\\"package_version\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"package_version\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_package_version_package_version_yuncode4176*****1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"0.01\\\\\\",\\\\\\"value\\\\\\":\\\\\\"yuncode4176*****1\\\\\\"},\\\\\\"ord_time\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"ord_time\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_ord_time_ord_time_1:Month\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1个月\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1:Month\\\\\\"},\\\\\\"order_num\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"order_num\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_order_num_order_num_1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeOrderForIsvResponse>\\n <ProductName>saas服务产品</ProductName>\\n <OriginalPrice>10</OriginalPrice>\\n <CouponPrice>0</CouponPrice>\\n <AccountQuantity>0</AccountQuantity>\\n <PeriodType>MONTH</PeriodType>\\n <PayStatus>PAID</PayStatus>\\n <PaymentPrice>0</PaymentPrice>\\n <OrderStatus>NORMAL</OrderStatus>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <PaidOn>1531191675000</PaidOn>\\n <CreatedOn>1531191564000</CreatedOn>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0</TotalPrice>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <ProductCode>cmgj02****</ProductCode>\\n <InstanceIds>1597985</InstanceIds>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n</DescribeOrderForIsvResponse>","errorExample":""}]', + 'title' => '服务商侧查询订单详情', + 'changeSet' => [ + ['createdAt' => '2024-12-13T01:38:22.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeOrderForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribePrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => ['description' => '订单类型。取值：'."\n" + ."\n" + .'INSTANCE_BUY：商品购买'."\n" + .'INSTANCE_RENEW：实例续费'."\n" + .'INSTANCE_UPGRADE：实例升级'."\n" + .'说明：对于续费类型的询价，需要在 Commodity 中传入 InstanceId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_BUY'], + ], + [ + 'name' => 'Commodity', + 'in' => 'query', + 'schema' => ['description' => '根据指定的 OrderType，使用对应的配件并序列化。 不同 OrderType 分别对应的 CommodityType 如下所示：'."\n" + ."\n" + .'INSTANCE_BUY：InstanceBuyCommodity'."\n" + .'INSTANCE_RENEW：InstanceRenewCommodity'."\n" + .'INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n" + .'示例中的参数说明如下：'."\n" + ."\n" + .'productCode：商品 Code。'."\n" + .'skuCode：商品规格 Code。非镜像商品：预付费固定为 prepay，后付费固定为 postpay；镜像商品：按量为ECS，包年包月为Package'."\n" + .'components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n" + .'duration：周期数量 1,2,3...。'."\n" + .'pricingCycle: 周期单位。Day（日），Month（月），Year（年）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"components":{"package_version":"yuncode12928000016"},"duration":1,"pricingCycle":"YEAR","productCode":"cmgj01**28","quantity":1,"skuCode":"prepay"}'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ExpressionCode' => [ - 'description' => '限购编码', - 'type' => 'string', - 'example' => 'ORDER.NO_REAL_NAME_AUTHENTICATION', - ], - 'Cuxiao' => [ - 'description' => '是否有促销', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DiscountPrice' => [ - 'description' => '优惠的价格（原价-实际价格），单位：元', - 'type' => 'number', - 'format' => 'float', - 'example' => '178.20', - ], - 'Cycle' => [ - 'description' => '周期单位'."\n" - ."\n" - .'DAY：日'."\n" - .'MONTH：月'."\n" - .'YEAR：年', - 'type' => 'string', - 'example' => 'MONTH', - ], - 'TradePrice' => [ - 'description' => '实际价格，单位：元', - 'type' => 'number', - 'format' => 'float', - 'example' => '19.80', - ], - 'OriginalPrice' => [ - 'description' => '原价，单位：元', - 'type' => 'number', - 'format' => 'float', - 'example' => '198.00', - ], - 'Duration' => [ - 'description' => '周期数， 1，2，3...', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Currency' => [ - 'description' => '币种'."\n" - ."\n" - .'CNY： 人民币'."\n" - .'USD： 美元'."\n" - .'JPY：日元', - 'type' => 'string', - 'example' => 'CNY', - ], - 'ExpressionMessage' => [ - 'description' => '限购描述', - 'type' => 'string', - 'example' => '企业用户才能购买', - ], - 'InfoTitle' => [ - 'description' => '活动名称', - 'type' => 'string', - 'example' => '新年特惠', - ], - 'ProductCode' => [ - 'description' => '商品 Code', - 'type' => 'string', - 'example' => 'cmgj01****', - ], + 'ExpressionCode' => ['description' => '限购编码', 'type' => 'string', 'example' => 'ORDER.NO_REAL_NAME_AUTHENTICATION'], + 'Cuxiao' => ['description' => '是否有促销', 'type' => 'boolean', 'example' => 'true'], + 'DiscountPrice' => ['description' => '优惠的价格（原价-实际价格），单位：元', 'type' => 'number', 'format' => 'float', 'example' => '178.20'], + 'Cycle' => ['description' => '周期单位'."\n" + ."\n" + .'DAY：日'."\n" + .'MONTH：月'."\n" + .'YEAR：年', 'type' => 'string', 'example' => 'MONTH'], + 'TradePrice' => ['description' => '实际价格，单位：元', 'type' => 'number', 'format' => 'float', 'example' => '19.80'], + 'OriginalPrice' => ['description' => '原价，单位：元', 'type' => 'number', 'format' => 'float', 'example' => '198.00'], + 'Duration' => ['description' => '周期数， 1，2，3...', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Currency' => ['description' => '币种'."\n" + ."\n" + .'CNY： 人民币'."\n" + .'USD： 美元'."\n" + .'JPY：日元', 'type' => 'string', 'example' => 'CNY'], + 'ExpressionMessage' => ['description' => '限购描述', 'type' => 'string', 'example' => '企业用户才能购买'], + 'InfoTitle' => ['description' => '活动名称', 'type' => 'string', 'example' => '新年特惠'], + 'ProductCode' => ['description' => '商品 Code', 'type' => 'string', 'example' => 'cmgj01****'], 'PromotionRules' => [ 'type' => 'object', 'itemNode' => true, @@ -1079,25 +2201,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Title' => [ - 'description' => '优惠标题', - 'type' => 'string', - 'example' => '展示型首年19.8元', - ], - 'Name' => [ - 'description' => '优惠内容', - 'type' => 'string', - 'example' => '展示型首年19.8元', - ], - 'RuleId' => [ - 'description' => '优惠ID', - 'type' => 'string', - 'example' => '102112', - ], + 'Title' => ['description' => '优惠标题', 'type' => 'string', 'example' => '展示型首年19.8元'], + 'Name' => ['description' => '优惠内容', 'type' => 'string', 'example' => '展示型首年19.8元'], + 'RuleId' => ['description' => '优惠ID', 'type' => 'string', 'example' => '102112'], ], + 'description' => '', ], ], ], + 'description' => '', ], 'Coupons' => [ 'type' => 'object', @@ -1109,84 +2221,64 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'CouponOptionCode' => [ - 'description' => '优惠券类型', - 'type' => 'string', - 'example' => 'ActiveCoupon', - ], - 'CouponOptionNo' => [ - 'description' => '优惠券编号', - 'type' => 'string', - 'example' => '3874923111', - ], - 'CouponName' => [ - 'description' => '优惠券名称', - 'type' => 'string', - 'example' => '促销', - ], - 'CouponDesc' => [ - 'description' => '优惠券描述', - 'type' => 'string', - 'example' => '促销', - ], - 'IsSelected' => [ - 'description' => '是否选中', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CanPromFee' => [ - 'description' => '可优惠价格', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.00', - ], + 'CouponOptionCode' => ['description' => '优惠券类型', 'type' => 'string', 'example' => 'ActiveCoupon'], + 'CouponOptionNo' => ['description' => '优惠券编号', 'type' => 'string', 'example' => '3874923111'], + 'CouponName' => ['description' => '优惠券名称', 'type' => 'string', 'example' => '促销'], + 'CouponDesc' => ['description' => '优惠券描述', 'type' => 'string', 'example' => '促销'], + 'IsSelected' => ['description' => '是否选中', 'type' => 'boolean', 'example' => 'false'], + 'CanPromFee' => ['description' => '可优惠价格', 'type' => 'number', 'format' => 'float', 'example' => '100.00'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], ], [ - [ - 'errorCode' => 'DownstreamError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'DownstreamError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '内部调用失败。'], ], [ - [ - 'errorCode' => 'ReturnNull', - 'errorMessage' => 'No results found.', - ], + ['errorCode' => 'ReturnNull', 'errorMessage' => 'No results found.', 'description' => '没有返回结果。'], ], 999999 => [ - [ - 'errorCode' => 'IgnoreError', - 'errorMessage' => 'The specified parameter is invalid.', + ['errorCode' => 'IgnoreError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], + ], + 'title' => '查询对应商品的价格信息', + 'summary' => '调用 DescribePrice 查询对应商品的价格信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpressionCode\\": \\"ORDER.NO_REAL_NAME_AUTHENTICATION\\",\\n \\"Cuxiao\\": true,\\n \\"DiscountPrice\\": 178.2,\\n \\"Cycle\\": \\"MONTH\\",\\n \\"TradePrice\\": 19.8,\\n \\"OriginalPrice\\": 198,\\n \\"Duration\\": 1,\\n \\"Currency\\": \\"CNY\\",\\n \\"ExpressionMessage\\": \\"企业用户才能购买\\",\\n \\"InfoTitle\\": \\"新年特惠\\",\\n \\"ProductCode\\": \\"cmgj01****\\",\\n \\"PromotionRules\\": {\\n \\"PromotionRule\\": [\\n {\\n \\"Title\\": \\"展示型首年19.8元\\",\\n \\"Name\\": \\"展示型首年19.8元\\",\\n \\"RuleId\\": \\"102112\\"\\n }\\n ]\\n },\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"CouponOptionCode\\": \\"ActiveCoupon\\",\\n \\"CouponOptionNo\\": \\"3874923111\\",\\n \\"CouponName\\": \\"促销\\",\\n \\"CouponDesc\\": \\"促销\\",\\n \\"IsSelected\\": false,\\n \\"CanPromFee\\": 100\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePriceResponse>\\n <Cuxiao>false</Cuxiao>\\n <Cycle>Month</Cycle>\\n <DiscountPrice>0</DiscountPrice>\\n <Duration>1</Duration>\\n <OriginalPrice>0</OriginalPrice>\\n <ProductCode>cmgj01****</ProductCode>\\n <TradePrice>0</TradePrice>\\n</DescribePriceResponse>","errorExample":""}]', - 'title' => '查询对应商品的价格信息', ], 'DescribeProduct' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1194,40 +2286,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AliUid', 'in' => 'query', - 'schema' => [ - 'description' => 'AliUid', - 'type' => 'string', - 'required' => false, - 'example' => '190********569', - ], + 'schema' => ['description' => 'AliUid', 'type' => 'string', 'required' => false, 'example' => '190********569'], ], [ 'name' => 'Code', 'in' => 'query', - 'schema' => [ - 'description' => '商品对应商品码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cmjj01**45', - ], + 'schema' => ['description' => '商品对应商品码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cmjj01**45'], ], [ 'name' => 'QueryDraft', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询商品草稿，通常不需要查询商品草稿，商品草稿适用于在商品正式上架售卖之前查询。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否查询商品草稿，通常不需要查询商品草稿，商品草稿适用于在商品正式上架售卖之前查询。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -1235,132 +2309,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'FrontCategoryId' => [ - 'description' => '商品类目 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '523617212', - ], - 'Status' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '1', - ], - 'Type' => [ - 'description' => '商品类型。取值：'."\n" - ."\n" - .'* APP：应用类'."\n" - .'* DOWNLOAD： 下载类'."\n" - .'* MIRROR： 镜像类'."\n" - .'* SERVICE： 服务类'."\n" - .'* API_SERVICE： api类', - 'type' => 'string', - 'example' => 'MIRROR', - ], - 'PicUrl' => [ - 'description' => '商品图片 URL', - 'type' => 'string', - 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png', - ], - 'Score' => [ - 'description' => '商品评分', - 'type' => 'number', - 'format' => 'float', - 'example' => '5.0', - ], - 'UseCount' => [ - 'description' => '使用计数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'GmtModified' => [ - 'description' => '更改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1578931200000', - ], - 'SupplierPk' => [ - 'description' => '服务商 UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1526111111****', - ], - 'GmtCreated' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1578931200000', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'ShortDescription' => [ - 'description' => '商品简介', - 'type' => 'string', - 'example' => '该镜像为LNMP（Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3）', - ], - 'Description' => [ - 'description' => '商品详情描述，支持 HTML。', - 'type' => 'string', - 'example' => '<div>基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！</div>', - ], - 'Code' => [ - 'description' => '商品对应商品码', - 'type' => 'string', - 'example' => 'cmjj01**45', - ], - 'AuditFailMsg' => [ - 'description' => '审核失败原因，QueryDraft = true 时返回。', - 'type' => 'string', - 'example' => '功能验收不通过', - ], - 'Name' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => 'LNMP环境（Ubuntu16.04 Nginx PHP5.3）', - ], - 'AuditTime' => [ - 'description' => '审核时间，QueryDraft = true 时返回。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1581609600000', - ], - 'AuditStatus' => [ - 'description' => '审核状态，QueryDraft = true 时返回。'."\n" - .'- draft：未提交'."\n" - .'- security_ing：安全审核中'."\n" - .'- security_fail：安全审核失败'."\n" - .'- function_ing：功能审核中'."\n" - .'- function_fail：功能审核失败'."\n" - .'- info_ing：商品信息审核中'."\n" - .'- info_fail：商品信息审核失败'."\n" - .'- success：成功'."\n", - 'type' => 'string', - 'example' => 'function_fail', - ], + 'FrontCategoryId' => ['description' => '商品类目 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '523617212'], + 'Status' => ['description' => '已废弃', 'type' => 'string', 'example' => '1'], + 'Type' => ['description' => '商品类型。取值：'."\n" + ."\n" + .'* APP：应用类'."\n" + .'* DOWNLOAD： 下载类'."\n" + .'* MIRROR： 镜像类'."\n" + .'* SERVICE： 服务类'."\n" + .'* API_SERVICE： api类', 'type' => 'string', 'example' => 'MIRROR'], + 'PicUrl' => ['description' => '商品图片 URL', 'type' => 'string', 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png'], + 'Score' => ['description' => '商品评分', 'type' => 'number', 'format' => 'float', 'example' => '5.0'], + 'UseCount' => ['description' => '使用计数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'GmtModified' => ['description' => '更改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1578931200000'], + 'SupplierPk' => ['description' => '服务商 UID', 'type' => 'integer', 'format' => 'int64', 'example' => '1526111111****'], + 'GmtCreated' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1578931200000'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'ShortDescription' => ['description' => '商品简介', 'type' => 'string', 'example' => '该镜像为LNMP（Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3）'], + 'Description' => ['description' => '商品详情描述，支持 HTML。', 'type' => 'string', 'example' => '<div>基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！</div>'], + 'Code' => ['description' => '商品对应商品码', 'type' => 'string', 'example' => 'cmjj01**45'], + 'AuditFailMsg' => ['description' => '审核失败原因，QueryDraft = true 时返回。', 'type' => 'string', 'example' => '功能验收不通过'], + 'Name' => ['description' => '商品名称', 'type' => 'string', 'example' => 'LNMP环境（Ubuntu16.04 Nginx PHP5.3）'], + 'AuditTime' => ['description' => '审核时间，QueryDraft = true 时返回。', 'type' => 'integer', 'format' => 'int64', 'example' => '1581609600000'], + 'AuditStatus' => ['description' => '审核状态，QueryDraft = true 时返回。'."\n" + .'- draft：未提交'."\n" + .'- security_ing：安全审核中'."\n" + .'- security_fail：安全审核失败'."\n" + .'- function_ing：功能审核中'."\n" + .'- function_fail：功能审核失败'."\n" + .'- info_ing：商品信息审核中'."\n" + .'- info_fail：商品信息审核失败'."\n" + .'- success：成功'."\n", 'type' => 'string', 'example' => 'function_fail'], 'ShopInfo' => [ 'description' => '店铺信息', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '店铺名称', - 'type' => 'string', - 'example' => '**科学公司', - ], - 'Emails' => [ - 'description' => '邮箱', - 'type' => 'string', - 'example' => '46**41@example.com', - ], - 'Id' => [ - 'description' => '店铺 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'Name' => ['description' => '店铺名称', 'type' => 'string', 'example' => '**科学公司'], + 'Emails' => ['description' => '邮箱', 'type' => 'string', 'example' => '46**41@example.com'], + 'Id' => ['description' => '店铺 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], 'WangWangs' => [ 'type' => 'object', 'itemNode' => true, @@ -1371,20 +2357,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Remark' => [ - 'description' => '备注', - 'type' => 'string', - 'example' => '123', - ], - 'UserName' => [ - 'description' => '旺旺用户名', - 'type' => 'string', - 'example' => 'ABC', - ], + 'Remark' => ['description' => '备注', 'type' => 'string', 'example' => '123'], + 'UserName' => ['description' => '旺旺用户名', 'type' => 'string', 'example' => 'ABC'], ], + 'description' => '', ], ], ], + 'description' => '', ], 'Telephones' => [ 'type' => 'object', @@ -1392,13 +2372,11 @@ 'properties' => [ 'Telephone' => [ 'type' => 'array', - 'items' => [ - 'description' => '电话', - 'type' => 'string', - 'example' => '{1386658****, 1386658****}', - ], + 'items' => ['description' => '电话', 'type' => 'string', 'example' => '{1386658****, 1386658****}'], + 'description' => '', ], ], + 'description' => '', ], ], ], @@ -1412,34 +2390,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Hidden' => [ - 'description' => '是否隐藏', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '规格码', - 'type' => 'string', - 'example' => 'cmjj01****-Package', - ], - 'Constraints' => [ - 'description' => '规格模块约束，支持 JSON 格式。', - 'type' => 'string', - 'example' => '{\\"img_id\\":{\\"img_version|img_region\\":{\\"V1.7|cn-shenzhen-st3-a01\\":[\\"m-wz9ho4hmos0lpxcldqoq\\"]}}', - ], - 'Name' => [ - 'description' => '规格名称', - 'type' => 'string', - 'example' => '21', - ], - 'ChargeType' => [ - 'description' => '付费方式：'."\n" - ."\n" - .'* POSTPAY：后付费'."\n" - .'* PREPAY：预付费'."\n", - 'type' => 'string', - 'example' => 'PREPAY', - ], + 'Hidden' => ['description' => '是否隐藏', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '规格码', 'type' => 'string', 'example' => 'cmjj01****-Package'], + 'Constraints' => ['description' => '规格模块约束，支持 JSON 格式。', 'type' => 'string', 'example' => '{\\"img_id\\":{\\"img_version|img_region\\":{\\"V1.7|cn-shenzhen-st3-a01\\":[\\"m-wz9ho4hmos0lpxcldqoq\\"]}}'], + 'Name' => ['description' => '规格名称', 'type' => 'string', 'example' => '21'], + 'ChargeType' => ['description' => '付费方式：'."\n" + ."\n" + .'* POSTPAY：后付费'."\n" + .'* PREPAY：预付费'."\n", 'type' => 'string', 'example' => 'PREPAY'], 'OrderPeriods' => [ 'type' => 'object', 'itemNode' => true, @@ -1450,20 +2408,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '订购周期名称', - 'type' => 'string', - 'example' => '小时', - ], - 'PeriodType' => [ - 'description' => '预付费时间单位', - 'type' => 'string', - 'example' => 'HOUR', - ], + 'Name' => ['description' => '订购周期名称', 'type' => 'string', 'example' => '小时'], + 'PeriodType' => ['description' => '预付费时间单位', 'type' => 'string', 'example' => 'HOUR'], ], + 'description' => '', ], ], ], + 'description' => '', ], 'Modules' => [ 'type' => 'object', @@ -1475,21 +2427,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '规格模块 Code', - 'type' => 'string', - 'example' => 'img_id', - ], - 'Name' => [ - 'description' => '模块名称', - 'type' => 'string', - 'example' => '镜像ID', - ], - 'Id' => [ - 'description' => '模块 ID', - 'type' => 'string', - 'example' => '248220', - ], + 'Code' => ['description' => '规格模块 Code', 'type' => 'string', 'example' => 'img_id'], + 'Name' => ['description' => '模块名称', 'type' => 'string', 'example' => '镜像ID'], + 'Id' => ['description' => '模块 ID', 'type' => 'string', 'example' => '248220'], 'Properties' => [ 'type' => 'object', 'itemNode' => true, @@ -1500,29 +2440,13 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '英文名称', - 'type' => 'string', - 'example' => 'img_id', - ], - 'ShowType' => [ - 'description' => '展示样式类型。取值：'."\n" - .'- number： 数字'."\n" - .'- string: 字符串'."\n" - .'- radio：单选', - 'type' => 'string', - 'example' => 'number', - ], - 'Name' => [ - 'description' => '中文名称', - 'type' => 'string', - 'example' => '镜像ID', - ], - 'DisplayUnit' => [ - 'description' => '显示单位', - 'type' => 'string', - 'example' => '1', - ], + 'Key' => ['description' => '英文名称', 'type' => 'string', 'example' => 'img_id'], + 'ShowType' => ['description' => '展示样式类型。取值：'."\n" + .'- number： 数字'."\n" + .'- string: 字符串'."\n" + .'- radio：单选', 'type' => 'string', 'example' => 'number'], + 'Name' => ['description' => '中文名称', 'type' => 'string', 'example' => '镜像ID'], + 'DisplayUnit' => ['description' => '显示单位', 'type' => 'string', 'example' => '1'], 'PropertyValues' => [ 'type' => 'object', 'itemNode' => true, @@ -1533,60 +2457,40 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '展示名称', - 'type' => 'string', - 'example' => '华北 1_V1.1', - ], - 'Type' => [ - 'description' => '属性值类型', - 'type' => 'string', - 'example' => 'single_string', - ], - 'Step' => [ - 'description' => '步进', - 'type' => 'string', - 'example' => '1', - ], - 'Value' => [ - 'description' => '属性值', - 'type' => 'string', - 'example' => 'm-28e213e7t', - ], - 'Max' => [ - 'description' => '最大', - 'type' => 'string', - 'example' => '123', - ], - 'Remark' => [ - 'description' => '备注', - 'type' => 'string', - 'example' => 'abc', - ], - 'Min' => [ - 'description' => '最小', - 'type' => 'string', - 'example' => '11', - ], + 'DisplayName' => ['description' => '展示名称', 'type' => 'string', 'example' => '华北 1_V1.1'], + 'Type' => ['description' => '属性值类型', 'type' => 'string', 'example' => 'single_string'], + 'Step' => ['description' => '步进', 'type' => 'string', 'example' => '1'], + 'Value' => ['description' => '属性值', 'type' => 'string', 'example' => 'm-28e213e7t'], + 'Max' => ['description' => '最大', 'type' => 'string', 'example' => '123'], + 'Remark' => ['description' => '备注', 'type' => 'string', 'example' => 'abc'], + 'Min' => ['description' => '最小', 'type' => 'string', 'example' => '11'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], 'ProductExtras' => [ 'type' => 'object', @@ -1606,60 +2510,36 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '扩展项类型：'."\n" - ."\n" - .'* HTML'."\n" - .'* LIST'."\n" - .'* JSON'."\n" - .'* SLIDER'."\n" - .'* LINK'."\n" - .'* IMG'."\n", - 'type' => 'string', - 'example' => 'HTML', - ], - 'Key' => [ - 'description' => '扩展项英文标识', - 'type' => 'string', - 'example' => 'product_advantage', - ], - 'Label' => [ - 'description' => '扩展项中文标识', - 'type' => 'string', - 'example' => '产品亮点', - ], - 'Order' => [ - 'description' => '排序', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Values' => [ - 'description' => '扩展项数据值', - 'type' => 'string', - 'example' => '\\"1. 基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！\\"', - ], + 'Type' => ['description' => '扩展项类型：'."\n" + ."\n" + .'* HTML'."\n" + .'* LIST'."\n" + .'* JSON'."\n" + .'* SLIDER'."\n" + .'* LINK'."\n" + .'* IMG'."\n", 'type' => 'string', 'example' => 'HTML'], + 'Key' => ['description' => '扩展项英文标识', 'type' => 'string', 'example' => 'product_advantage'], + 'Label' => ['description' => '扩展项中文标识', 'type' => 'string', 'example' => '产品亮点'], + 'Order' => ['description' => '排序', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Values' => ['description' => '扩展项数据值', 'type' => 'string', 'example' => '\\"1. 基于阿里云（Ubuntu16.04 64位）系统源码安装，安全、稳定、高效！\\"'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DeniedModify', - 'errorMessage' => 'You are not authorized to call the specified API operation.', - ], + ['errorCode' => 'DeniedModify', 'errorMessage' => 'You are not authorized to call the specified API operation.', 'description' => '没有调用权限。'], ], 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], ], ], 'eventInfo' => [ @@ -1672,16 +2552,17 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProduct'], + ], + ], + 'ramActions' => [], ], 'DescribeProducts' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1689,41 +2570,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'SearchTerm', 'in' => 'query', - 'schema' => [ - 'description' => '搜索词', - 'type' => 'string', - 'required' => false, - 'example' => '镜像', - ], + 'schema' => ['description' => '搜索词', 'type' => 'string', 'required' => false, 'example' => '镜像'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '当前页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页显示商品数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '每页显示商品数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Filter', @@ -1737,117 +2599,108 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '搜索标签类别，取值：'."\n" - ."\n" - .'* sort：排序方式'."\n" - .'* categoryId：类目 ID'."\n" - .'* productType：商品类型'."\n" - .'* aliyunUid：商品所属服务商的阿里云主账号Uid', - 'type' => 'string', - 'required' => false, - 'example' => 'categoryId', - ], - 'Value' => [ - 'description' => '搜索标签取值：'."\n" - ."\n\n" - .'- sort'."\n" - .' - user_count-desc：近180天成交数'."\n" - .' - created_on-desc：创建时间'."\n" - .' - price-desc：价格'."\n" - .' - score-desc：评分'."\n" - ."\n" - .'- categoryId '."\n" - .' - 软件市场 53366009'."\n" - .' + 运行环境 53448001'."\n" - .' - 管理与监控 53690006'."\n" - .' - 建站系统 53616009'."\n" - .' - 应用开发 55530001'."\n" - .' - 数据库 56024006'."\n" - .' - 服务器软件 56014009'."\n" - .' - 网络功能软件 56368007'."\n" - .' - 操作系统 57742013'."\n" - .' - 服务市场 52734001'."\n" - .' - 数据迁移 52738004'."\n" - .' - 环境配置 52746001'."\n" - .' - 故障排查 52740002'."\n" - .' - 安全代维 52732002'."\n" - .' - 定制开发 56082003'."\n" - .' - 培训与认证 57252001'."\n" - .' - 专线接入 57392001'."\n" - .' - 企业服务 56838014'."\n" - .' - 安全服务 57004003'."\n" - .' - 建站市场 52738001'."\n" - .' - 企业展示 52738005'."\n" - .' - 电子商务 52750001'."\n" - .' - 手机网站 52752001'."\n" - .' - 设计 52732003'."\n" - .' - 信息门户 52744002'."\n" - .' - 售后服务 52744003'."\n" - .' - 社区论坛 55586021'."\n" - .' - 移动营销 55514022'."\n" - .' - 模板网站 56598032'."\n" - .' - 网站空间 57342011'."\n" - .' - 云安全市场 56764045'."\n" - .' + 主机安全 56832023'."\n" - .' + 应用安全 56846020'."\n" - .' + 数据安全 56824015'."\n" - .' + 安全管理 56830014'."\n" - .' + 网络安全 56820014'."\n" - .' - 企业应用 56832009'."\n" - .' - 办公管理 56778013'."\n" - .' - 财务管理 56764034'."\n" - .' - 人事管理 56780006'."\n" - .' - 销售管理 56842010'."\n" - .' - 广告营销 56842011'."\n" - .' - 外贸业务 56790007'."\n" - .' - 云通信 57602001'."\n" - .' - 供应链管理 57604001'."\n" - .' - 数据服务 57606001'."\n" - .' - 解决方案 56848023'."\n" - .' - 电商 56848024'."\n" - .' - 金融 56820017'."\n" - .' - 物流 56776025'."\n" - .' - 政务 56842031'."\n" - .' - 多媒体 56784018'."\n" - .' - 物联网 56794026'."\n" - .' - 大数据 56792022'."\n" - .' - API市场 56956004'."\n" - .' - 电子商务 56928004'."\n" - .' - 金融理财 57000002'."\n" - .' - 交通地理 57002002'."\n" - .' - 企业管理 56928005'."\n" - .' - 公共事务 57002003'."\n" - .' - 气象水利 57096001'."\n" - .' - 人工智能 57124001'."\n" - .' - 生活服务 57126001'."\n" - .' - 物联网市场 201194001'."\n" - .' - 集成系统 201196001'."\n" - .' - 智能硬件 201198001'."\n" - .' - 模组 201200001'."\n" - .' - 传感器 201192002'."\n" - .' - 芯片 201202001'."\n" - .' - 物联网应用 201196002'."\n" - .' - 物联服务 201196003'."\n" - .' - 数据智能 201204005'."\n" - .' - 数据分析及展现 201190008'."\n" - .' - 舆情分析 201198004'."\n" - .' - 电商与营销 201202006'."\n" - .' - 人工智能 201204006'."\n" - .' - 气象交通 201214006'."\n" - .' - 金融财务 201208013'."\n" - .'- productType:'."\n" - .' - APP：应用类'."\n" - .' - SERVICE：服务类'."\n" - .' - MIRROR：镜像类'."\n" - .' - DOWNLOAD：下载类'."\n" - .' - API_SERVICE：API 类'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '53366009', - ], + 'Key' => ['description' => '搜索标签类别，取值：'."\n" + ."\n" + .'* sort：排序方式'."\n" + .'* categoryId：类目 ID'."\n" + .'* productType：商品类型'."\n" + .'* aliyunUid：商品所属服务商的阿里云主账号Uid', 'type' => 'string', 'required' => false, 'example' => 'categoryId'], + 'Value' => ['description' => '搜索标签取值：'."\n" + ."\n\n" + .'- sort'."\n" + .' - user_count-desc：近180天成交数'."\n" + .' - created_on-desc：创建时间'."\n" + .' - price-desc：价格'."\n" + .' - score-desc：评分'."\n" + ."\n" + .'- categoryId '."\n" + .' - 软件市场 53366009'."\n" + .' + 运行环境 53448001'."\n" + .' - 管理与监控 53690006'."\n" + .' - 建站系统 53616009'."\n" + .' - 应用开发 55530001'."\n" + .' - 数据库 56024006'."\n" + .' - 服务器软件 56014009'."\n" + .' - 网络功能软件 56368007'."\n" + .' - 操作系统 57742013'."\n" + .' - 服务市场 52734001'."\n" + .' - 数据迁移 52738004'."\n" + .' - 环境配置 52746001'."\n" + .' - 故障排查 52740002'."\n" + .' - 安全代维 52732002'."\n" + .' - 定制开发 56082003'."\n" + .' - 培训与认证 57252001'."\n" + .' - 专线接入 57392001'."\n" + .' - 企业服务 56838014'."\n" + .' - 安全服务 57004003'."\n" + .' - 建站市场 52738001'."\n" + .' - 企业展示 52738005'."\n" + .' - 电子商务 52750001'."\n" + .' - 手机网站 52752001'."\n" + .' - 设计 52732003'."\n" + .' - 信息门户 52744002'."\n" + .' - 售后服务 52744003'."\n" + .' - 社区论坛 55586021'."\n" + .' - 移动营销 55514022'."\n" + .' - 模板网站 56598032'."\n" + .' - 网站空间 57342011'."\n" + .' - 云安全市场 56764045'."\n" + .' + 主机安全 56832023'."\n" + .' + 应用安全 56846020'."\n" + .' + 数据安全 56824015'."\n" + .' + 安全管理 56830014'."\n" + .' + 网络安全 56820014'."\n" + .' - 企业应用 56832009'."\n" + .' - 办公管理 56778013'."\n" + .' - 财务管理 56764034'."\n" + .' - 人事管理 56780006'."\n" + .' - 销售管理 56842010'."\n" + .' - 广告营销 56842011'."\n" + .' - 外贸业务 56790007'."\n" + .' - 云通信 57602001'."\n" + .' - 供应链管理 57604001'."\n" + .' - 数据服务 57606001'."\n" + .' - 解决方案 56848023'."\n" + .' - 电商 56848024'."\n" + .' - 金融 56820017'."\n" + .' - 物流 56776025'."\n" + .' - 政务 56842031'."\n" + .' - 多媒体 56784018'."\n" + .' - 物联网 56794026'."\n" + .' - 大数据 56792022'."\n" + .' - API市场 56956004'."\n" + .' - 电子商务 56928004'."\n" + .' - 金融理财 57000002'."\n" + .' - 交通地理 57002002'."\n" + .' - 企业管理 56928005'."\n" + .' - 公共事务 57002003'."\n" + .' - 气象水利 57096001'."\n" + .' - 人工智能 57124001'."\n" + .' - 生活服务 57126001'."\n" + .' - 物联网市场 201194001'."\n" + .' - 集成系统 201196001'."\n" + .' - 智能硬件 201198001'."\n" + .' - 模组 201200001'."\n" + .' - 传感器 201192002'."\n" + .' - 芯片 201202001'."\n" + .' - 物联网应用 201196002'."\n" + .' - 物联服务 201196003'."\n" + .' - 数据智能 201204005'."\n" + .' - 数据分析及展现 201190008'."\n" + .' - 舆情分析 201198004'."\n" + .' - 电商与营销 201202006'."\n" + .' - 人工智能 201204006'."\n" + .' - 气象交通 201214006'."\n" + .' - 金融财务 201208013'."\n" + .'- productType:'."\n" + .' - APP：应用类'."\n" + .' - SERVICE：服务类'."\n" + .' - MIRROR：镜像类'."\n" + .' - DOWNLOAD：下载类'."\n" + .' - API_SERVICE：API 类'."\n", 'type' => 'string', 'required' => false, 'example' => '53366009'], ], 'required' => false, + 'description' => '', ], 'required' => false, 'maxItems' => 5, @@ -1859,29 +2712,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817', - ], - 'PageNumber' => [ - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示商品数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '符合搜索条件的商品数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '75', - ], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'A077D99E-0C4D-421E-A5D4-F533F6657817'], + 'PageNumber' => ['description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页显示商品数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '符合搜索条件的商品数', 'type' => 'integer', 'format' => 'int32', 'example' => '75'], 'ProductItems' => [ 'type' => 'object', 'itemNode' => true, @@ -1892,115 +2726,40 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'PriceInfo' => [ - 'description' => '价格信息。', - 'type' => 'string', - 'example' => '{\'DiscountPrice\': 0.0, \'TradePrice\': 15750.0, \'Currency\': \'CNY\', \'OriginalPrice\': 15750.0, \'RuleIds\': {\'RuleId\': []}, \'Coupons\': {\'Coupon\': []}}', - ], - 'DeliveryWay' => [ - 'description' => '交付方式', - 'type' => 'string', - 'example' => '镜像', - ], - 'ImageUrl' => [ - 'description' => '图片 URL', - 'type' => 'string', - 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png', - ], - 'WarrantyDate' => [ - 'description' => '质保时间', - 'type' => 'string', - 'example' => '1天', - ], - 'Tags' => [ - 'description' => '产品标签', - 'type' => 'string', - 'example' => '企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板', - ], - 'Score' => [ - 'description' => '评分', - 'type' => 'string', - 'example' => '5.0', - ], - 'SupplierId' => [ - 'description' => '供应商 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '228399', - ], - 'OperationSystem' => [ - 'description' => '交付时间', - 'type' => 'string', - 'example' => 'windows', - ], - 'ShortDescription' => [ - 'description' => '商品简介', - 'type' => 'string', - 'example' => '【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务，应用标准化全自动服务流程体系，帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买，<em>ECS</em>最低配置1核1G即可。购买须知：请在购买<em>ECS</em>配置安全组时选择HTTP：80端口 ...', - ], - 'DeliveryDate' => [ - 'description' => '交付时间', - 'type' => 'string', - 'example' => '1天', - ], - 'TargetUrl' => [ - 'description' => '详情页URL', - 'type' => 'string', - 'example' => '/products/53616009/cmjj02****.html', - ], - 'Code' => [ - 'description' => '商品码', - 'type' => 'string', - 'example' => 'cmjj02****', - ], - 'CategoryId' => [ - 'description' => '类目 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53398003', - ], - 'Name' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => 'PHP多版本环境（Windows2012 | phpStudy）', - ], - 'SuggestedPrice' => [ - 'description' => '建议价格', - 'type' => 'string', - 'example' => '10元/月', - ], - 'SupplierName' => [ - 'description' => '供应商名称', - 'type' => 'string', - 'example' => '长沙****有限公司', - ], + 'PriceInfo' => ['description' => '价格信息。', 'type' => 'string', 'example' => '{\'DiscountPrice\': 0.0, \'TradePrice\': 15750.0, \'Currency\': \'CNY\', \'OriginalPrice\': 15750.0, \'RuleIds\': {\'RuleId\': []}, \'Coupons\': {\'Coupon\': []}}'], + 'DeliveryWay' => ['description' => '交付方式', 'type' => 'string', 'example' => '镜像'], + 'ImageUrl' => ['description' => '图片 URL', 'type' => 'string', 'example' => 'https://oss.aliyuncs.com/photogallery/photo/1904996544835414/7549/767d6d07-8366-4822-b84e-61f6ea10d146.png'], + 'WarrantyDate' => ['description' => '质保时间', 'type' => 'string', 'example' => '1天'], + 'Tags' => ['description' => '产品标签', 'type' => 'string', 'example' => '企业,上云,Windows,Windows server 2012,Apache,Nginx,Windows面板'], + 'Score' => ['description' => '评分', 'type' => 'string', 'example' => '5.0'], + 'SupplierId' => ['description' => '供应商 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '228399'], + 'OperationSystem' => ['description' => '交付时间', 'type' => 'string', 'example' => 'windows'], + 'ShortDescription' => ['description' => '商品简介', 'type' => 'string', 'example' => '【定制建站一条龙服务+阿里云独享服务器】由客户经理与设计师提供一对一服务，应用标准化全自动服务流程体系，帮助企业轻松拥有官方网站。该建站产品与<em>ECS</em>下单时同时购买，<em>ECS</em>最低配置1核1G即可。购买须知：请在购买<em>ECS</em>配置安全组时选择HTTP：80端口 ...'], + 'DeliveryDate' => ['description' => '交付时间', 'type' => 'string', 'example' => '1天'], + 'TargetUrl' => ['description' => '详情页URL', 'type' => 'string', 'example' => '/products/53616009/cmjj02****.html'], + 'Code' => ['description' => '商品码', 'type' => 'string', 'example' => 'cmjj02****'], + 'CategoryId' => ['description' => '类目 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '53398003'], + 'Name' => ['description' => '商品名称', 'type' => 'string', 'example' => 'PHP多版本环境（Windows2012 | phpStudy）'], + 'SuggestedPrice' => ['description' => '建议价格', 'type' => 'string', 'example' => '10元/月'], + 'SupplierName' => ['description' => '供应商名称', 'type' => 'string', 'example' => '长沙****有限公司'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.CategoryId', - 'errorMessage' => 'The specified CategoryId is invalid.', - ], - [ - 'errorCode' => 'Invalid.Sort', - 'errorMessage' => 'The specified Sort is invalid.', - ], - [ - 'errorCode' => 'Invalid.Param', - 'errorMessage' => 'The specified Filter key is invalid.', - ], + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ['errorCode' => 'Invalid.CategoryId', 'errorMessage' => 'The specified CategoryId is invalid.', 'description' => 'CategoryId参数错误。'], + ['errorCode' => 'Invalid.Sort', 'errorMessage' => 'The specified Sort is invalid.', 'description' => 'Sort参数错误。'], + ['errorCode' => 'Invalid.Param', 'errorMessage' => 'The specified Filter key is invalid.', 'description' => '不支持的Filter key参数。'], ], ], 'eventInfo' => [ @@ -2013,17 +2772,16 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeOrderForIsv' => [ - 'summary' => '服务商侧查询订单详情', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DescribeProjectAttachments' => [ + 'summary' => '调用DescribeProjectAttachments获取项目附件列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2031,387 +2789,86 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrderId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '订单id', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '202*********415', - ], + 'schema' => ['description' => '云市场业务实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ProductName' => [ - 'title' => '订购商品名称', - 'description' => '订购商品名称', - 'type' => 'string', - 'example' => 'saas服务产品', - ], - 'OriginalPrice' => [ - 'title' => '订单原价（元）', - 'description' => '订单原价（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '10.0', - ], - 'AliUid' => [ - 'title' => '阿里云用户唯一标识（aliyunPK）', - 'description' => '阿里云用户唯一标识（aliyunPK）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190311111111****', - ], - 'CouponPrice' => [ - 'title' => '已使用代金券金额（元）', - 'description' => '已使用代金券金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'AccountQuantity' => [ - 'title' => '账号数', - 'description' => '账号数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'PeriodType' => [ - 'title' => '预付费的时间单位。取值：'."\n" - .'● MONTH：单月'."\n" - .'● SEASON：季度'."\n" - .'● HALFYEAR：半年'."\n" - .'● YEAR：一年'."\n" - .'● TWOYEARS：两年'."\n" - .'● ONCE：单次', - 'description' => '预付费的时间单位。取值：'."\n" - .'● MONTH：单月'."\n" - .'● SEASON：季度'."\n" - .'● HALFYEAR：半年'."\n" - .'● YEAR：一年'."\n" - .'● TWOYEARS：两年'."\n" - .'● ONCE：单次', - 'type' => 'string', - 'example' => 'MONTH', - ], - 'PayStatus' => [ - 'title' => '付款状态。取值：'."\n" - .'● PAID 已支付'."\n" - .'● UNPAID 未支付', - 'description' => '付款状态。取值：'."\n" - .'● PAID 已支付'."\n" - .'● UNPAID 未支付', - 'type' => 'string', - 'example' => 'PAID', - ], - 'PaymentPrice' => [ - 'title' => '实际支付金额（元）', - 'description' => '实际支付金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'OrderStatus' => [ - 'title' => '订单状态。取值：'."\n" - .'● NORMAL 正常'."\n" - .'● REFUND 退款'."\n" - .'● DELETE 作废', - 'description' => '订单状态。取值：'."\n" - .'● NORMAL 正常'."\n" - .'● REFUND 退款'."\n" - .'● DELETE 作废', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ProductSkuCode' => [ - 'title' => '订购商品规格 Code', - 'description' => '订购商品规格 Code', - 'type' => 'string', - 'example' => 'cmgj02****-prepay', - ], - 'PaidOn' => [ - 'title' => '付款时间', - 'description' => '付款时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531191675000', - ], - 'CreatedOn' => [ - 'title' => '下单时间', - 'description' => '下单时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531191564000', - ], - 'OrderType' => [ - 'title' => '订单类型。取值：'."\n" - .'● NEW 新购订单'."\n" - .'● RENEW 续费订单'."\n" - .'● TRIAL 试用订单', - 'description' => '订单类型。取值：'."\n" - .'● NEW 新购订单'."\n" - .'● RENEW 续费订单'."\n" - .'● TRIAL 试用订单'."\n" - .'● UPGRADE 升级订单'."\n" - .'● DOWNGRADE 降配订单'."\n" - .'● PURCHASE 转正订单', - 'type' => 'string', - 'example' => 'NEW', - ], - 'TotalPrice' => [ - 'title' => '订单应收金额（元）', - 'description' => '订单应收金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'Quantity' => [ - 'title' => '订购数量', - 'description' => '订购数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OrderId' => [ - 'title' => '订单ID', - 'description' => '订单ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202211111111111', - ], - 'ProductCode' => [ - 'title' => '商品Code', - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj02****', - ], - 'InstanceIds' => [ - 'title' => '订单关联业务实例 ID', - 'description' => 'List', + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求标识', 'type' => 'string', 'example' => 'e03a9f78-7b40-4fb3-a015-350913e37e3f'], + 'Result' => [ 'type' => 'array', 'items' => [ - 'description' => '实例id', - 'type' => 'string', - 'example' => '1597985', + 'type' => 'object', + 'properties' => [ + 'FileLinkGmtExpired' => ['description' => '文件地址生效截止时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1589334682404'], + 'StepNo' => ['description' => '流程节点序号', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'AttachmentToken' => ['description' => '附件MD5', 'type' => 'string', 'example' => 'Mzc4NDAtODQ3MjY4MzI='], + 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => 'f8-test-perview.jpeg'], + 'OperatorRole' => ['description' => ' 操作人角色', 'type' => 'string', 'example' => 'Provider'], + 'NodeName' => ['description' => '节点名称', 'type' => 'string', 'example' => '等待服务开通'], + 'OperatorName' => ['description' => '操作人名称', 'type' => 'string', 'example' => '**科技技术有限公司'], + 'FileLink' => ['description' => '文件访问地址', 'type' => 'string', 'example' => 'http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D'], + 'GmtCreate' => ['description' => '附件上传时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1587968858000'], + 'FileSuffix' => ['description' => '文件后缀', 'type' => 'string', 'example' => 'jpg'], + 'Operator' => ['description' => '操作人阿里云UID', 'type' => 'integer', 'format' => 'int64', 'example' => '45261111****'], + 'Content' => ['description' => '内容文本', 'type' => 'string', 'example' => '无'], + 'NodeId' => ['description' => '附件上传的流程节点ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8472'], + 'AttachmentType' => ['description' => '附件类型', 'type' => 'string', 'example' => 'File'], + 'FileSize' => ['description' => '文件大小（byte）', 'type' => 'integer', 'format' => 'int64', 'example' => '109124'], + ], + 'description' => '', ], - ], - 'RequestId' => [ - 'description' => '请求ID。用于出现错误后排查问题。'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-****-****-****-270359FB54A7', - ], - 'Components' => [ - 'description' => '订单模块信息。示例中的参数说明如下：'."\n" - .'● package_quantity： 使用次数（API 商品特有模块）'."\n" - .'● package_version：版本'."\n" - .'● ord_time： 时长'."\n" - .'● order_num： 数量'."\n" - .'● code：模块 Code'."\n" - .'● globarKey： 模块 key'."\n" - .'● name： 模块名称'."\n" - .'● value： 模块值', - 'type' => 'any', - 'example' => '{"package_version":{"code":"package_version","globarKey":"cmgj0******8_package_version_package_version_yuncode4176*****1","name":"0.01","value":"yuncode4176*****1"},"ord_time":{"code":"ord_time","globarKey":"cmgj0******8_ord_time_ord_time_1:Month","name":"1个月","value":"1:Month"},"order_num":{"code":"order_num","globarKey":"cmgj0******8_order_num_order_num_1","name":"1","value":"1"}}', + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"InstanceIds\\": [\\n \\"1597985\\"\\n ],\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"Components\\": \\"{\\\\\\"package_version\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"package_version\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_package_version_package_version_yuncode4176*****1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"0.01\\\\\\",\\\\\\"value\\\\\\":\\\\\\"yuncode4176*****1\\\\\\"},\\\\\\"ord_time\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"ord_time\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_ord_time_ord_time_1:Month\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1个月\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1:Month\\\\\\"},\\\\\\"order_num\\\\\\":{\\\\\\"code\\\\\\":\\\\\\"order_num\\\\\\",\\\\\\"globarKey\\\\\\":\\\\\\"cmgj0******8_order_num_order_num_1\\\\\\",\\\\\\"name\\\\\\":\\\\\\"1\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"}}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeOrderForIsvResponse>\\n <ProductName>saas服务产品</ProductName>\\n <OriginalPrice>10</OriginalPrice>\\n <CouponPrice>0</CouponPrice>\\n <AccountQuantity>0</AccountQuantity>\\n <PeriodType>MONTH</PeriodType>\\n <PayStatus>PAID</PayStatus>\\n <PaymentPrice>0</PaymentPrice>\\n <OrderStatus>NORMAL</OrderStatus>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <PaidOn>1531191675000</PaidOn>\\n <CreatedOn>1531191564000</CreatedOn>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0</TotalPrice>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <ProductCode>cmgj02****</ProductCode>\\n <InstanceIds>1597985</InstanceIds>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n</DescribeOrderForIsvResponse>","errorExample":""}]', - 'title' => '服务商侧查询订单详情', - ], - 'CreateOrder' => [ - 'summary' => '调用 CreateOrder 创建订单。'."\n" - ."\n" - .'请确保在使用该接口前，已充分了解云市场产品的收费方式和价格。'."\n" - ."\n" - .'商业镜像创建订单接口请参考 CreateInstance。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', + 'title' => '获取项目附件列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'OrderType', - 'in' => 'query', - 'schema' => [ - 'description' => '订单类型。 取值： '."\n" - .'- INSTANCE_BUY：商品购买 '."\n" - .'- INSTANCE_RENEW：实例续费 '."\n" - .'- INSTANCE_UPGRADE：实例升级'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_BUY', - ], - ], - [ - 'name' => 'Commodity', - 'in' => 'query', - 'schema' => [ - 'description' => '订单配件信息。 '."\n" - ."\n" - .'可根据指定的 OrderType，使用对应的配件再进行序列化。'."\n" - ."\n" - .'不同 OrderType 分别对应的 CommodityType 如下所示： '."\n" - .'* INSTANC_BUY：InstanceBuyCommodity'."\n" - .'* INSTANCE_RENEW：InstanceRenewCommodity'."\n" - .'* INSTANCE_UPGRADE：InstanceUpgradeCommodity'."\n" - ."\n" - .'示例中的 Commodity 参数说明如下：'."\n" - .'- 必传参数'."\n" - .' - productCode：商品码'."\n" - .' - skuCode：商品规格码。预付费固定为 prepay，后付费固定为 postpay。'."\n" - .' - duration：周期数量 1，2，3...。'."\n" - .' - pricingCycle：周期单位。Day（日），Month（月），Year（年）。'."\n" - .' - components：规格模块。其中版本 package_version 必传，其他模块根据商品的设置来传。'."\n" - ."\n" - .'- 可选参数'."\n" - .' - quantity：订购数量'."\n" - .' - queryPromotion：是否查询优惠'."\n" - .' - couponId：优惠卷 ID'."\n" - .' - properties：订单扩展属性字符串，JSON 的 dict 格式'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'InstanceBuyCommodity示例：{"components":{"package_version":"yuncode1394000000"},"duration":100,"pricingCycle":"Year","productCode":"cmfw019940","properties":{},"quantity":1,"skuCode":"cmfw019940-prepay"}；InstanceRenewCommodity示例：{“components”:{“package_version”:”yuncode1806900001”},”quantity”:1,”duration”:2,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”}；InstanceUpgradeCommodity示例：{“components”:{“package_version”:”yuncode1806900002”},”quantity”:1,”duration”:1,”instanceId”:”6227091”,”productCode”:”cmgj024069”,”pricingCycle”:”Month”,”properties”:{},”skuCode”:”cmgj024069-prepay”} ', - ], - ], + 'ramActions' => [ [ - 'name' => 'OrderSouce', - 'in' => 'query', - 'schema' => [ - 'description' => '订单来源（未启用）', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - [ - 'name' => 'PaymentType', - 'in' => 'query', - 'schema' => [ - 'description' => '付款方式：'."\n" - .'* AUTO：余额自动支付'."\n" - .'* HAND：手动支付'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HAND', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。 '."\n" - .'由客户端生成该参数值，要保证在不同请求间唯一，最大不值过 64 个 ASCII 字符。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2709c68a-d569-4819-9c5d-1222ed2ee924', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => '订单 ID', - 'type' => 'string', - 'example' => '202********0117', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed', - ], - 'InstanceIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'InstanceId' => [ - 'type' => 'array', - 'items' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => '5604018', - ], - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectAttachments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"202********0117\\",\\n \\"RequestId\\": \\"4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"5604018\\"\\n ]\\n }\\n}","errorExample":"{\\"RequestId\\":\\"004CDE94-C51C-4EBD-8D4A-8874888ECBDB\\",\\"HostId\\":\\"market.aliyuncs.com\\",\\"Code\\":\\"UnknownError\\",\\"Message\\":\\"The request processing has failed due to some unknown error.\\"}\\n"},{"type":"xml","example":"<CreateOrderResponse>\\n<RequestId>4ca591b5-bc30-4fa7-aeaa-c4d0ec5d24ed</RequestId>\\n<InstanceIds>\\n <InstanceId>5604018</InstanceId>\\n</InstanceIds>\\n<OrderId>202********0117</OrderId>\\n</CreateOrderResponse>","errorExample":"<?xml version=\'1.0\' encoding=\'UTF-8\'?><Error><RequestId>904A07C3-D30A-4E2C-93B2-DDECAE4B66E8</RequestId><HostId>market.aliyuncs.com</HostId><Code>UnknownError</Code><Message>The request processing has failed due to some unknown error.</Message></Error>\\n"}]', - 'title' => '创建订单', - 'description' => '请确保在使用该接口前，已充分了解云市场产品的收费方式和[价格](https://market.aliyun.com/)。'."\n" - ."\n" - .'商业镜像创建订单接口请参考 [CreateInstance](https://help.aliyun.com/document_detail/25499.html)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e03a9f78-7b40-4fb3-a015-350913e37e3f\\",\\n \\"Result\\": [\\n {\\n \\"FileLinkGmtExpired\\": 1589334682404,\\n \\"StepNo\\": 3,\\n \\"AttachmentToken\\": \\"Mzc4NDAtODQ3MjY4MzI=\\",\\n \\"FileName\\": \\"f8-test-perview.jpeg\\",\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"OperatorName\\": \\"**科技技术有限公司\\",\\n \\"FileLink\\": \\"http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D\\",\\n \\"GmtCreate\\": 1587968858000,\\n \\"FileSuffix\\": \\"jpg\\",\\n \\"Operator\\": 0,\\n \\"Content\\": \\"无\\",\\n \\"NodeId\\": 8472,\\n \\"AttachmentType\\": \\"File\\",\\n \\"FileSize\\": 109124\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeProjectAttachmentsResponse>\\n <requestId>e03a9f78-7b40-4fb3-a015-350913e37e3f</requestId>\\n <result>\\n <attachmentToken>Mzc4NDAtODQ3MjY4MzI=</attachmentToken>\\n <attachmentType>File</attachmentType>\\n <content />\\n <fileLink>http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D</fileLink>\\n <fileLinkGmtExpired>1589334682404</fileLinkGmtExpired>\\n <fileName>f8-test-perview.jpeg</fileName>\\n <fileSize>109124</fileSize>\\n <fileSuffix>jpg</fileSuffix>\\n <gmtCreate>1587968858000</gmtCreate>\\n <nodeId>8472</nodeId>\\n <nodeName>等待服务开通</nodeName>\\n <operator>45261111****</operator>\\n <operatorName>**科技技术有限公司</operatorName>\\n <operatorRole>Provider</operatorRole>\\n <stepNo>3</stepNo>\\n </result>\\n <success>true</success>\\n</DescribeProjectAttachmentsResponse>","errorExample":""}]', ], - 'DescribeOrder' => [ - 'summary' => '调用 DescribeOrder 用于查询对应订单的详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeProjectInfo' => [ + 'summary' => '调用DescribeProjectInfo获取项目信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2419,22 +2876,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrderId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '订单ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '202*********415', - ], + 'schema' => ['description' => '云市场业务实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], ], 'responses' => [ @@ -2442,198 +2889,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ProductName' => [ - 'description' => '订购商品名称', - 'type' => 'string', - 'example' => 'saas服务产品', - ], - 'SupplierCompanyName' => [ - 'description' => '卖家公司名称', - 'type' => 'string', - 'example' => '**科技股份有限公司', - ], - 'OriginalPrice' => [ - 'description' => '订单原价（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '10.0', - ], - 'AliUid' => [ - 'description' => '阿里云用户唯一标识（aliyunPK）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190311111111****', - ], - 'CouponPrice' => [ - 'description' => '已使用代金券金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'AccountQuantity' => [ - 'description' => '账号数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'PeriodType' => [ - 'description' => '预付费的时间单位。取值：'."\n" - ."\n" - .'- MONTH：单月'."\n" - .'- SEASON：季度'."\n" - .'- HALFYEAR：半年'."\n" - .'- YEAR：一年'."\n" - .'- TWOYEARS：两年'."\n" - .'- ONCE：单次', - 'type' => 'string', - 'example' => 'MONTH', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'PayStatus' => [ - 'description' => '付款状态。取值：'."\n" - ."\n" - .'- PAID 已支付'."\n" - .'- UNPAID 未支付', - 'type' => 'string', - 'example' => 'PAID', - ], - 'PaymentPrice' => [ - 'description' => '实际支付金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'OrderStatus' => [ - 'description' => '订单状态。取值：'."\n" - ."\n" - .'- NORMAL 正常'."\n" - .'- REFUND 退款'."\n" - .'- DELETE 作废', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ProductSkuCode' => [ - 'description' => '订购商品规格 Code', - 'type' => 'string', - 'example' => 'cmgj02****-prepay', - ], - 'PaidOn' => [ - 'description' => '付款时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531191675000', - ], - 'Components' => [ - 'description' => '订单模块信息。示例中的参数说明如下：'."\n" - ."\n" - .'- package_quantity： 使用次数（API 商品特有模块）'."\n" - .'- package_version：版本'."\n" - .'- ord_time： 时长'."\n" - .'- order_num： 数量'."\n" - .'- code：模块 Code'."\n" - .'- globarKey： 模块 key'."\n" - .'- name： 模块名称'."\n" - .'- value： 模块值', - 'type' => 'object', - 'example' => '{ "package_quantity": { "code": "package_quantity", "globarKey": "cmapi014302_package_quantity_package_quantity_10000", "name": "10000次", "value": "10000" }, "package_version": { "code": "package_version", "globarKey": "cmapi014302_package_version_package_version_yuncode830200000", "name": "0元／10000次", "value": "yuncode830200000" }, "ord_time": { "code": "ord_time", "globarKey": "cmapi014302_ord_time_ord_time_6:Month", "name": "6个月", "value": "6:Month" }, "order_num": { "code": "order_num", "globarKey": "cmapi014302_order_num_order_num_1", "name": "1", "value": "1" } }', - ], - 'CreatedOn' => [ - 'description' => '下单时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531191564000', - ], - 'OrderType' => [ - 'description' => '订单类型。取值：'."\n" - ."\n" - .'- NEW 新购订单'."\n" - .'- RENEW 续费订单'."\n" - .'- TRIAL 试用订单', - 'type' => 'string', - 'example' => 'NEW', - ], - 'TotalPrice' => [ - 'description' => '订单应收金额（元）', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - ], - 'Quantity' => [ - 'description' => '订购数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OrderId' => [ - 'description' => '订单ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '202211111111111', - ], - 'ProductCode' => [ - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj02****', - ], - 'SupplierTelephones' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Telephone' => [ - 'description' => '卖家客服热线', - 'type' => 'array', - 'items' => [ - 'description' => '卖家客服热线', - 'type' => 'string', - 'example' => '{139*****950, 139*****831}', - ], - ], - ], - ], - 'InstanceIds' => [ + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ee3e1b3b-6c38-4bcf-be40-5a946cfda761'], + 'Result' => [ + 'description' => '返回结果', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'InstanceId' => [ - 'description' => '订单关联业务实例', - 'type' => 'array', - 'items' => [ - 'description' => '订单关联业务实例 ID', - 'type' => 'string', - 'example' => '{1597985, 1227195}', - ], - ], + 'ProductName' => ['description' => '云市场商品名称', 'type' => 'string', 'example' => '公司宝****记账'], + 'ProjectStatus' => ['description' => '项目执行状态，取值：'."\n" + ."\n" + .'- Starting：进行中'."\n" + .'- Cancel：已取消'."\n" + .'- Pause：已暂停'."\n" + .'- Finish：已完成', 'type' => 'string', 'example' => 'Starting'], + 'CustomerAliUid' => ['description' => '用户阿里云UID', 'type' => 'integer', 'format' => 'int64', 'example' => '27291111****'], + 'TemplateType' => ['description' => '项目所属模板类型，取值：'."\n" + ."\n" + .'- Public：公共模板'."\n" + .'- Private：私有模板', 'type' => 'string', 'example' => 'Public'], + 'InstanceId' => ['description' => '云市场业务实例ID', 'type' => 'string', 'example' => '4****89'], + 'ProductSkuName' => ['description' => '云市场商品规格名称', 'type' => 'string', 'example' => '小***纳税人'], + 'FinalStepNo' => ['description' => '最后节点的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'CurrentStepNo' => ['description' => '当前流程节点', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'GmtExpired' => ['description' => '项目超时时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1620403200000'], + 'GmtFinished' => ['description' => '项目完成时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1620403200000'], + 'ProductSkuCode' => ['description' => '云市场商品规格Code', 'type' => 'string', 'example' => 'yuncode****500001'], + 'GmtCreate' => ['description' => '项目创建时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834324000'], + 'SupplierAliUid' => ['description' => '项目所属厂商UID', 'type' => 'integer', 'format' => 'int64', 'example' => '45121111****'], + 'FinishType' => ['description' => '项目完成方式，取值：'."\n" + ."\n" + .'- null：未完成项目默认值'."\n" + .'- CustomerConfirm：客户手动确认'."\n" + .'- SystemAutoConfirm：因超时系统自动确认', 'type' => 'string', 'example' => 'null'], + 'TemplateId' => ['description' => '项目所属流程模板ID', 'type' => 'integer', 'format' => 'int64', 'example' => '410'], + 'OrderId' => ['description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2059111111111'], + 'ProductCode' => ['description' => '商品Code', 'type' => 'string', 'example' => 'cmgj***055'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => '获取项目信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProductName\\": \\"saas服务产品\\",\\n \\"SupplierCompanyName\\": \\"**科技股份有限公司\\",\\n \\"OriginalPrice\\": 10,\\n \\"AliUid\\": 0,\\n \\"CouponPrice\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"PeriodType\\": \\"MONTH\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"PayStatus\\": \\"PAID\\",\\n \\"PaymentPrice\\": 0,\\n \\"OrderStatus\\": \\"NORMAL\\",\\n \\"ProductSkuCode\\": \\"cmgj02****-prepay\\",\\n \\"PaidOn\\": 1531191675000,\\n \\"Components\\": {\\n \\"package_quantity\\": {\\n \\"code\\": \\"package_quantity\\",\\n \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\",\\n \\"name\\": \\"10000次\\",\\n \\"value\\": \\"10000\\"\\n },\\n \\"package_version\\": {\\n \\"code\\": \\"package_version\\",\\n \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\",\\n \\"name\\": \\"0元／10000次\\",\\n \\"value\\": \\"yuncode830200000\\"\\n },\\n \\"ord_time\\": {\\n \\"code\\": \\"ord_time\\",\\n \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\",\\n \\"name\\": \\"6个月\\",\\n \\"value\\": \\"6:Month\\"\\n },\\n \\"order_num\\": {\\n \\"code\\": \\"order_num\\",\\n \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\",\\n \\"name\\": \\"1\\",\\n \\"value\\": \\"1\\"\\n }\\n },\\n \\"CreatedOn\\": 1531191564000,\\n \\"OrderType\\": \\"NEW\\",\\n \\"TotalPrice\\": 0,\\n \\"Quantity\\": 1,\\n \\"OrderId\\": 202211111111111,\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"SupplierTelephones\\": {\\n \\"Telephone\\": [\\n \\"{139*****950, 139*****831}\\"\\n ]\\n },\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"{1597985, 1227195}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeOrderResponse>\\n <PaidOn>1531191675000</PaidOn>\\n <PeriodType>MONTH</PeriodType>\\n <CouponPrice>0.0</CouponPrice>\\n <PayStatus>PAID</PayStatus>\\n <OriginalPrice>10.0</OriginalPrice>\\n <ProductName>saas服务产品</ProductName>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <ProductCode>cmgj02****</ProductCode>\\n <SupplierCompanyName>**科技股份有限公司</SupplierCompanyName>\\n <Quantity>1</Quantity>\\n <OrderId>202211111111111</OrderId>\\n <SupplierTelephones>\\n <Telephone>{139*****950, 139*****831}</Telephone>\\n </SupplierTelephones>\\n <Components>{ \\"package_quantity\\": { \\"code\\": \\"package_quantity\\", \\"globarKey\\": \\"cmapi014302_package_quantity_package_quantity_10000\\", \\"name\\": \\"10000次\\", \\"value\\": \\"10000\\" }, \\"package_version\\": { \\"code\\": \\"package_version\\", \\"globarKey\\": \\"cmapi014302_package_version_package_version_yuncode830200000\\", \\"name\\": \\"0元／10000次\\", \\"value\\": \\"yuncode830200000\\" }, \\"ord_time\\": { \\"code\\": \\"ord_time\\", \\"globarKey\\": \\"cmapi014302_ord_time_ord_time_6:Month\\", \\"name\\": \\"6个月\\", \\"value\\": \\"6:Month\\" }, \\"order_num\\": { \\"code\\": \\"order_num\\", \\"globarKey\\": \\"cmapi014302_order_num_order_num_1\\", \\"name\\": \\"1\\", \\"value\\": \\"1\\" } }</Components>\\n <OrderStatus>NORMAL</OrderStatus>\\n <OrderType>NEW</OrderType>\\n <TotalPrice>0.0</TotalPrice>\\n <ProductSkuCode>cmgj02****-prepay</ProductSkuCode>\\n <CreatedOn>1531191564000</CreatedOn>\\n <PaymentPrice>0.0</PaymentPrice>\\n <InstanceIds>\\n <InstanceId>{1597985, 1227195}</InstanceId>\\n </InstanceIds>\\n <AccountQuantity>0</AccountQuantity>\\n <AliUid>190311111111****</AliUid>\\n</DescribeOrderResponse>","errorExample":""}]', - 'title' => '用于查询对应订单的详细信息', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ee3e1b3b-6c38-4bcf-be40-5a946cfda761\\",\\n \\"Result\\": {\\n \\"ProductName\\": \\"公司宝****记账\\",\\n \\"ProjectStatus\\": \\"Starting\\",\\n \\"CustomerAliUid\\": 0,\\n \\"TemplateType\\": \\"Public\\",\\n \\"InstanceId\\": \\"4****89\\",\\n \\"ProductSkuName\\": \\"小***纳税人\\",\\n \\"FinalStepNo\\": 4,\\n \\"CurrentStepNo\\": 3,\\n \\"GmtExpired\\": 1620403200000,\\n \\"GmtFinished\\": 1620403200000,\\n \\"ProductSkuCode\\": \\"yuncode****500001\\",\\n \\"GmtCreate\\": 1588834324000,\\n \\"SupplierAliUid\\": 0,\\n \\"FinishType\\": \\"null\\",\\n \\"TemplateId\\": 410,\\n \\"OrderId\\": 2059111111111,\\n \\"ProductCode\\": \\"cmgj***055\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectInfoResponse>\\n <requestId>ee3e1b3b-6c38-4bcf-be40-5a946cfda761</requestId>\\n <result>\\n <currentStepNo>3</currentStepNo>\\n <customerAliUid>27291111****</customerAliUid>\\n <finalStepNo>4</finalStepNo>\\n <finishType/>\\n <gmtCreate>1588834324000</gmtCreate>\\n <gmtExpired>1620403200000</gmtExpired>\\n <gmtFinished/>\\n <instanceId>4****89</instanceId>\\n <orderId>2059111111111</orderId>\\n <productCode>cmgj***055</productCode>\\n <productName>公司宝****记账</productName>\\n <productSkuCode>yuncode****500001</productSkuCode>\\n <productSkuName>小***纳税人</productSkuName>\\n <projectStatus>Starting</projectStatus>\\n <supplierAliUid>45121111****</supplierAliUid>\\n <templateId>410</templateId>\\n <templateType>Public</templateType>\\n </result>\\n <success>true</success>\\n</DescribeProjectInfoResponse>","errorExample":""}]', ], 'DescribeProjectMessages' => [ 'summary' => '调用DescribeProjectMessages获取项目流程留言信息列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2641,33 +2973,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场业务实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '云市场业务实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '查询页码，每页查询20条。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询页码，每页查询20条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -2675,104 +2991,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d', - ], - 'TotalCount' => [ - 'description' => '留言总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d'], + 'TotalCount' => ['description' => '留言总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], 'Result' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => '留言时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589015560000', - ], - 'Operator' => [ - 'description' => '留言人的阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '452611111****', - ], - 'OperatorRole' => [ - 'description' => '操作人角色，取值：'."\n" - ."\n" - .'- System：系统'."\n" - .'- Custom：客户'."\n" - .'- Provider：服务提供商', - 'type' => 'string', - 'example' => 'Provider', - ], - 'Content' => [ - 'description' => '留言内容', - 'type' => 'string', - 'example' => '尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。', - ], - 'OperatorName' => [ - 'description' => '留言人名称', - 'type' => 'string', - 'example' => '***科技技术有限公司', - ], + 'GmtCreate' => ['description' => '留言时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1589015560000'], + 'Operator' => ['description' => '留言人的阿里云UID', 'type' => 'integer', 'format' => 'int64', 'example' => '452611111****'], + 'OperatorRole' => ['description' => '操作人角色，取值：'."\n" + ."\n" + .'- System：系统'."\n" + .'- Custom：客户'."\n" + .'- Provider：服务提供商', 'type' => 'string', 'example' => 'Provider'], + 'Content' => ['description' => '留言内容', 'type' => 'string', 'example' => '尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。'], + 'OperatorName' => ['description' => '留言人名称', 'type' => 'string', 'example' => '***科技技术有限公司'], ], + 'description' => '', ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => '获取项目流程留言信息列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"00eb4de1-6cff-4f56-833e-7b1e070e398d\\",\\n \\"TotalCount\\": 28,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": 1589015560000,\\n \\"Operator\\": 0,\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"Content\\": \\"尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。\\",\\n \\"OperatorName\\": \\"***科技技术有限公司\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectMessagesResponse>\\n <TotalCount>21</TotalCount>\\n <RequestId>00eb4de1-6cff-4f56-833e-7b1e070e398d</RequestId>\\n <Success>true</Success>\\n <Result>\\n <Operator>452611111****</Operator>\\n <OperatorName>***科技技术有限公司</OperatorName>\\n <GmtCreate>1589015560000</GmtCreate>\\n <OperatorRole>Provider</OperatorRole>\\n <Content>尊敬的客户您好，我们已经为您上传了方案，请您查阅，然后尽快将您的意见反馈给我们。</Content>\\n </Result>\\n</DescribeProjectMessagesResponse>","errorExample":""}]', - 'title' => '获取项目流程留言信息列表', ], 'DescribeProjectNodes' => [ - 'summary' => '调用DescribeProjectNodes获取项目流程节点列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2780,22 +3059,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '云市场订单实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], ], 'responses' => [ @@ -2803,16 +3072,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '937fee1f-26bb-4b6e-8def-977a6bdaa1e5', - ], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '937fee1f-26bb-4b6e-8def-977a6bdaa1e5'], 'Result' => [ 'description' => '无', 'type' => 'array', @@ -2820,151 +3081,76 @@ 'description' => '节点执行结果', 'type' => 'object', 'properties' => [ - 'NextNodeId' => [ - 'description' => '下一个流程节点 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8472', - ], - 'StepNo' => [ - 'description' => '所属流程节点的序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AutoFinishNode' => [ - 'description' => '节点超时是否自动完成', - 'type' => 'boolean', - 'example' => 'false', - ], - 'FinalStepNo' => [ - 'description' => '最终流程节点的序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PreviousNodeId' => [ - 'description' => '上一个流程节点 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8470', - ], - 'ParentNodeId' => [ - 'description' => '父级流程节点 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GmtExpired' => [ - 'description' => '流程节点超时时间（Unix 时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588834325000', - ], - 'OperatorRole' => [ - 'description' => '操作人角色，取值：'."\n" - ."\n" - .'- System：系统'."\n" - .'- Custom：客户'."\n" - .'- Provider：服务提供商', - 'type' => 'string', - 'example' => 'System', - ], - 'GmtStart' => [ - 'description' => '流程节点开始时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588834325000', - ], - 'NodeStatus' => [ - 'description' => '节点执行状态，取值：'."\n" - .'- NotStart：未开始'."\n" - .'- Starting：进行中'."\n" - .'- Cancel：已取消'."\n" - .'- Finish：已完成', - 'type' => 'string', - 'example' => 'Finish', - ], - 'NodeName' => [ - 'description' => '节点名称', - 'type' => 'string', - 'example' => '分配服务商节点', - ], - 'GmtFinished' => [ - 'description' => '流程节点完成时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588834325000', - ], - 'AllowRollbackNode' => [ - 'description' => '是否允许执行回滚到上一个流程节点', - 'type' => 'boolean', - 'example' => 'false', - ], - 'TemplateForm' => [ - 'description' => '流程节点表单内容', - 'type' => 'string', - 'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]', - ], - 'NeedAttachment' => [ - 'description' => '是否强制要求上传附件', - 'type' => 'boolean', - 'example' => 'false', - ], - 'NodeId' => [ - 'description' => '流程节点id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8471', - ], + 'NextNodeId' => ['description' => '下一个流程节点 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8472'], + 'StepNo' => ['description' => '所属流程节点的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'AutoFinishNode' => ['description' => '节点超时是否自动完成', 'type' => 'boolean', 'example' => 'false'], + 'FinalStepNo' => ['description' => '最终流程节点的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'PreviousNodeId' => ['description' => '上一个流程节点 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '8470'], + 'ParentNodeId' => ['description' => '父级流程节点 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GmtExpired' => ['description' => '流程节点超时时间（Unix 时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000'], + 'OperatorRole' => ['description' => '操作人角色，取值：'."\n" + ."\n" + .'- System：系统'."\n" + .'- Custom：客户'."\n" + .'- Provider：服务提供商', 'type' => 'string', 'example' => 'System'], + 'GmtStart' => ['description' => '流程节点开始时间（Unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000'], + 'NodeStatus' => ['description' => '节点执行状态，取值：'."\n" + .'- NotStart：未开始'."\n" + .'- Starting：进行中'."\n" + .'- Cancel：已取消'."\n" + .'- Finish：已完成', 'type' => 'string', 'example' => 'Finish'], + 'NodeName' => ['description' => '节点名称', 'type' => 'string', 'example' => '分配服务商节点'], + 'GmtFinished' => ['description' => '流程节点完成时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1588834325000'], + 'AllowRollbackNode' => ['description' => '是否允许执行回滚到上一个流程节点', 'type' => 'boolean', 'example' => 'false'], + 'TemplateForm' => ['description' => '流程节点表单内容', 'type' => 'string', 'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]'], + 'NeedAttachment' => ['description' => '是否强制要求上传附件', 'type' => 'boolean', 'example' => 'false'], + 'NodeId' => ['description' => '流程节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '8471'], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"937fee1f-26bb-4b6e-8def-977a6bdaa1e5\\",\\n \\"Result\\": [\\n {\\n \\"NextNodeId\\": 8472,\\n \\"StepNo\\": 2,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8470,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588834325000,\\n \\"OperatorRole\\": \\"System\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Finish\\",\\n \\"NodeName\\": \\"分配服务商节点\\",\\n \\"GmtFinished\\": 1588834325000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8471\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectNodesResponse>\\n <Success>true</Success>\\n <RequestId>937fee1f-26bb-4b6e-8def-977a6bdaa1e5</RequestId>\\n <Result>\\n <NextNodeId>8472</NextNodeId>\\n <StepNo>2</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8470</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588834325000</GmtExpired>\\n <OperatorRole>System</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Finish</NodeStatus>\\n <NodeName>分配服务商节点</NodeName>\\n <GmtFinished>1588834325000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\n <TemplateForm>[ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8471</NodeId>\\n </Result>\\n</DescribeProjectNodesResponse>","errorExample":""}]', 'title' => '获取项目流程节点列表', + 'summary' => '调用DescribeProjectNodes获取项目流程节点列表。', 'description' => '**'."\n" .'**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"937fee1f-26bb-4b6e-8def-977a6bdaa1e5\\",\\n \\"Result\\": [\\n {\\n \\"NextNodeId\\": 8472,\\n \\"StepNo\\": 2,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8470,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588834325000,\\n \\"OperatorRole\\": \\"System\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Finish\\",\\n \\"NodeName\\": \\"分配服务商节点\\",\\n \\"GmtFinished\\": 1588834325000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8471\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectNodesResponse>\\n <Success>true</Success>\\n <RequestId>937fee1f-26bb-4b6e-8def-977a6bdaa1e5</RequestId>\\n <Result>\\n <NextNodeId>8472</NextNodeId>\\n <StepNo>2</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8470</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588834325000</GmtExpired>\\n <OperatorRole>System</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Finish</NodeStatus>\\n <NodeName>分配服务商节点</NodeName>\\n <GmtFinished>1588834325000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\n <TemplateForm>[ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8471</NodeId>\\n </Result>\\n</DescribeProjectNodesResponse>","errorExample":""}]', ], 'DescribeProjectOperateLogs' => [ 'summary' => '调用DescribeProjectOperateLogs获取项目流程操作日志。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2972,22 +3158,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], ], 'responses' => [ @@ -2995,16 +3171,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'e6037e86-657f-4194-bb6a-7b26973aec8d', - ], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'e6037e86-657f-4194-bb6a-7b26973aec8d'], 'Result' => [ 'description' => '返回结果', 'type' => 'array', @@ -3012,262 +3180,56 @@ 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => '操作时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1587624497000', - ], - 'Operator' => [ - 'description' => '操作人阿里云uid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OperatorRole' => [ - 'description' => '操作人角色-System：系统-Custom：客户-Provider：服务提供商', - 'type' => 'string', - 'example' => 'System', - ], - 'Description' => [ - 'description' => '操作内容描述', - 'type' => 'string', - 'example' => '进入分配服务商操作人', - ], - 'OperatorName' => [ - 'description' => '操作人名称', - 'type' => 'string', - 'example' => '系统', - ], + 'GmtCreate' => ['description' => '操作时间（unix时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1587624497000'], + 'Operator' => ['description' => '操作人阿里云uid', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OperatorRole' => ['description' => '操作人角色-System：系统-Custom：客户-Provider：服务提供商', 'type' => 'string', 'example' => 'System'], + 'Description' => ['description' => '操作内容描述', 'type' => 'string', 'example' => '进入分配服务商操作人'], + 'OperatorName' => ['description' => '操作人名称', 'type' => 'string', 'example' => '系统'], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e6037e86-657f-4194-bb6a-7b26973aec8d\\",\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": 1587624497000,\\n \\"Operator\\": 0,\\n \\"OperatorRole\\": \\"System\\",\\n \\"Description\\": \\"进入分配服务商操作人\\",\\n \\"OperatorName\\": \\"系统\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectOperateLogsResponse>\\n <Success>true</Success>\\n <RequestId>e6037e86-657f-4194-bb6a-7b26973aec8d</RequestId>\\n <Result>\\n <GmtCreate>1587624497000</GmtCreate>\\n <Operator>0</Operator>\\n <OperatorRole>System</OperatorRole>\\n <Description>进入分配服务商操作人</Description>\\n <OperatorName>系统</OperatorName>\\n </Result>\\n</DescribeProjectOperateLogsResponse>","errorExample":""}]', 'title' => '获取项目流程操作日志', 'description' => '**'."\n" .'**', - ], - 'DescribeCurrentNodeInfo' => [ - 'summary' => '调用DescribeCurrentNodeInfo获取当前节点的流程信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => '00eb4de1-6cff-4f56-833e-7b1e070e398d', - ], - 'Result' => [ - 'description' => '成功流程节点信息', - 'type' => 'object', - 'properties' => [ - 'NextNodeId' => [ - 'description' => '下一个流程节点id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8473', - ], - 'StepNo' => [ - 'description' => '所属流程节点的序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'AutoFinishNode' => [ - 'description' => '是否自动完成节点', - 'type' => 'boolean', - 'example' => 'false', - ], - 'FinalStepNo' => [ - 'description' => '最后节点的序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PreviousNodeId' => [ - 'description' => '上一个流程节点id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8471', - ], - 'ParentNodeId' => [ - 'description' => '父级流程节点id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GmtExpired' => [ - 'description' => '流程节点超时时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588920725000', - ], - 'OperatorRole' => [ - 'description' => '流程节点操作人角色，取值：-system：系统-custom：用户', - 'type' => 'string', - 'example' => 'Provider', - ], - 'GmtStart' => [ - 'description' => '流程节点开始时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588834325000', - ], - 'NodeStatus' => [ - 'description' => '节点执行状态，取值：-NotStart：未开始-Starting：进行中-Cancel：已取消-Finish：已完成', - 'type' => 'string', - 'example' => 'Starting', - ], - 'NodeName' => [ - 'description' => '节点名称', - 'type' => 'string', - 'example' => '等待服务开通', - ], - 'GmtFinished' => [ - 'description' => '流程节点完成时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588920725000', - ], - 'AllowRollbackNode' => [ - 'description' => '是否允许执行回滚到上一个流程节点', - 'type' => 'boolean', - 'example' => 'false', - ], - 'TemplateForm' => [ - 'description' => '流程节点表单内容，格式为json。'."\n" - .'示例代码如下：'."\n" - .'`[ { "fieldKey": "TFD0", //表单 key "isRequired": true, //是否必填项 "maxLength": 50, //最大值长度 "placeHolder": "姓名", //表单值简介 "stepNum": 0, //排序值（升序） "title": "收货人姓名", //表单标题 "type": "text" //表单类型 }, { "fieldKey": "TFD1", "isRequired": true, "maxLength": 50, "placeHolder": "手机号码", "stepNum": 1, "title": "收货人电话", "type": "text" }, { "fieldKey": "TFD2", "isRequired": true, "maxLength": 50, "placeHolder": "省市区街道门牌号码", "stepNum": 2, "title": "详细收货地址", "type": "textarea" } ]`', - 'type' => 'string', - 'example' => '[ {"fieldKey": "TFD0","isRequired": true,"maxLength": 50, "placeHolder": "姓名","stepNum": 0,"title": "收货人姓名","type": "text" },{ "fieldKey": "TFD1","isRequired": true,"maxLength": 50,"placeHolder": "手机号码","stepNum": 1,"title": "收货人电话","type": "text"},{"fieldKey": "TFD2","isRequired": true,"maxLength": 50,"placeHolder": "省市区街道门牌号码","stepNum": 2,"title": "详细收货地址","type": "textarea"}]', - ], - 'NeedAttachment' => [ - 'description' => '是否强制要求上传附件', - 'type' => 'boolean', - 'example' => 'false', - ], - 'NodeId' => [ - 'description' => '流程节点id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8472', - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectOperateLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"00eb4de1-6cff-4f56-833e-7b1e070e398d\\",\\n \\"Result\\": {\\n \\"NextNodeId\\": 8473,\\n \\"StepNo\\": 3,\\n \\"AutoFinishNode\\": false,\\n \\"FinalStepNo\\": 4,\\n \\"PreviousNodeId\\": 8471,\\n \\"ParentNodeId\\": 0,\\n \\"GmtExpired\\": 1588920725000,\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"GmtStart\\": 1588834325000,\\n \\"NodeStatus\\": \\"Starting\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"GmtFinished\\": 1588920725000,\\n \\"AllowRollbackNode\\": false,\\n \\"TemplateForm\\": \\"[ {\\\\\\"fieldKey\\\\\\": \\\\\\"TFD0\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50, \\\\\\"placeHolder\\\\\\": \\\\\\"姓名\\\\\\",\\\\\\"stepNum\\\\\\": 0,\\\\\\"title\\\\\\": \\\\\\"收货人姓名\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\" },{ \\\\\\"fieldKey\\\\\\": \\\\\\"TFD1\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"手机号码\\\\\\",\\\\\\"stepNum\\\\\\": 1,\\\\\\"title\\\\\\": \\\\\\"收货人电话\\\\\\",\\\\\\"type\\\\\\": \\\\\\"text\\\\\\"},{\\\\\\"fieldKey\\\\\\": \\\\\\"TFD2\\\\\\",\\\\\\"isRequired\\\\\\": true,\\\\\\"maxLength\\\\\\": 50,\\\\\\"placeHolder\\\\\\": \\\\\\"省市区街道门牌号码\\\\\\",\\\\\\"stepNum\\\\\\": 2,\\\\\\"title\\\\\\": \\\\\\"详细收货地址\\\\\\",\\\\\\"type\\\\\\": \\\\\\"textarea\\\\\\"}]\\",\\n \\"NeedAttachment\\": false,\\n \\"NodeId\\": 8472\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCurrentNodeInfoResponse>\\n <Success>true</Success>\\n <RequestId>00eb4de1-6cff-4f56-833e-7b1e070e398d</RequestId>\\n <Result>\\n <NextNodeId>8473</NextNodeId>\\n <StepNo>3</StepNo>\\n <AutoFinishNode>false</AutoFinishNode>\\n <FinalStepNo>4</FinalStepNo>\\n <PreviousNodeId>8471</PreviousNodeId>\\n <ParentNodeId>0</ParentNodeId>\\n <GmtExpired>1588920725000</GmtExpired>\\n <OperatorRole>Provider</OperatorRole>\\n <GmtStart>1588834325000</GmtStart>\\n <NodeStatus>Starting</NodeStatus>\\n <NodeName>等待服务开通</NodeName>\\n <GmtFinished>1588920725000</GmtFinished>\\n <AllowRollbackNode>false</AllowRollbackNode>\\n <TemplateForm>[ {\\"fieldKey\\": \\"TFD0\\",\\"isRequired\\": true,\\"maxLength\\": 50, \\"placeHolder\\": \\"姓名\\",\\"stepNum\\": 0,\\"title\\": \\"收货人姓名\\",\\"type\\": \\"text\\" },{ \\"fieldKey\\": \\"TFD1\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"手机号码\\",\\"stepNum\\": 1,\\"title\\": \\"收货人电话\\",\\"type\\": \\"text\\"},{\\"fieldKey\\": \\"TFD2\\",\\"isRequired\\": true,\\"maxLength\\": 50,\\"placeHolder\\": \\"省市区街道门牌号码\\",\\"stepNum\\": 2,\\"title\\": \\"详细收货地址\\",\\"type\\": \\"textarea\\"}]</TemplateForm>\\n <NeedAttachment>false</NeedAttachment>\\n <NodeId>8472</NodeId>\\n </Result>\\n</DescribeCurrentNodeInfoResponse>","errorExample":""}]', - 'title' => '获取当前节点的流程信息', - 'description' => '**'."\n" - .'**', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e6037e86-657f-4194-bb6a-7b26973aec8d\\",\\n \\"Result\\": [\\n {\\n \\"GmtCreate\\": 1587624497000,\\n \\"Operator\\": 0,\\n \\"OperatorRole\\": \\"System\\",\\n \\"Description\\": \\"进入分配服务商操作人\\",\\n \\"OperatorName\\": \\"系统\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectOperateLogsResponse>\\n <Success>true</Success>\\n <RequestId>e6037e86-657f-4194-bb6a-7b26973aec8d</RequestId>\\n <Result>\\n <GmtCreate>1587624497000</GmtCreate>\\n <Operator>0</Operator>\\n <OperatorRole>System</OperatorRole>\\n <Description>进入分配服务商操作人</Description>\\n <OperatorName>系统</OperatorName>\\n </Result>\\n</DescribeProjectOperateLogsResponse>","errorExample":""}]', ], 'FinishCurrentProjectNode' => [ 'summary' => '调用FinishCurrentProjectNode完成当前流程。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3275,54 +3237,27 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], [ 'name' => 'NodeId', 'in' => 'query', - 'schema' => [ - 'description' => '流程节点ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1924', - ], + 'schema' => ['description' => '流程节点ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1924'], ], [ 'name' => 'TemplateForm', 'in' => 'query', - 'schema' => [ - 'description' => '提交表单内容，格式为json。示例代码如下：{"TFD0":"mr.go","TFD1":"1330010xxxx","TFD2":"北京市朝阳区望京街道x区y号"}', - 'type' => 'string', - 'required' => false, - 'example' => '{"TFD0": "Mr.Go","TFD1": "1330010xxxx","TFD2": "北京市朝阳区望京街道X区Y号" }', - ], + 'schema' => ['description' => '提交表单内容，格式为json。示例代码如下：{"TFD0":"mr.go","TFD1":"1330010xxxx","TFD2":"北京市朝阳区望京街道x区y号"}', 'type' => 'string', 'required' => false, 'example' => '{"TFD0": "Mr.Go","TFD1": "1330010xxxx","TFD2": "北京市朝阳区望京街道X区Y号" }'], ], [ 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '备注信息', - 'type' => 'string', - 'required' => false, - 'example' => '收货地址已提交，请尽快安排发货。', - ], + 'schema' => ['description' => '备注信息', 'type' => 'string', 'required' => false, 'example' => '收货地址已提交，请尽快安排发货。'], ], ], 'responses' => [ @@ -3330,73 +3265,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', - ], - 'Result' => [ - 'description' => '返回结果', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f'], + 'Result' => ['description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], - [ - 'errorCode' => 'IllegalOperatorRole', - 'errorMessage' => 'Illegal operator role.', - ], - [ - 'errorCode' => 'IllegalCurrentNode', - 'errorMessage' => 'Illegal current node.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''], + ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<FinishCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</FinishCurrentProjectNodeResponse>","errorExample":""}]', 'title' => '完成当前流程', 'description' => '**'."\n" .'**', - ], - 'RollbackCurrentProjectNode' => [ - 'summary' => '调用RollbackCurrentProjectNode触发当前流程驳回。', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:FinishCurrentProjectNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<FinishCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</FinishCurrentProjectNodeResponse>","errorExample":""}]', + ], + 'ModifyInvoiceForIsv' => [ + 'summary' => '发票受理接口', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3404,839 +3320,210 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['title' => '发票类型：数字电子普通发票：2；数字电子专用发票：3', 'description' => '当前开票的发票类型：'."\n" + .'- 数字电子普通发票：2'."\n" + .'- 数字电子专用发票：3', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], [ - 'name' => 'NodeId', + 'name' => 'ElectronUrl', 'in' => 'query', - 'schema' => [ - 'description' => '当前流程节点ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1925', - ], + 'schema' => ['title' => '电子发票地址', 'description' => '电子发票地址，用于客户下载', 'type' => 'string', 'required' => false, 'example' => 'https://oss.aliyuncs.com/xxxx.png'], ], [ - 'name' => 'Remark', + 'name' => 'InvoiceId', 'in' => 'query', - 'schema' => [ - 'description' => '打回原因备注', - 'type' => 'string', - 'required' => false, - 'example' => '尊敬的顾客您好，您提交的收货地址存在多个匹配结果，请您核对后再重新提交。', - ], + 'schema' => ['title' => '发票Id', 'description' => '发票申请Id（对应DescribeInvoiceForIsv接口返回结果中的Result.Id）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4072040****'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', - ], - 'Result' => [ - 'description' => '是否返回成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], - [ - 'errorCode' => 'IllegalOperatorRole', - 'errorMessage' => 'Illegal operator role.', - ], - [ - 'errorCode' => 'IllegalCurrentNode', - 'errorMessage' => 'Illegal current node.', - ], - [ - 'errorCode' => 'IllegalProjectStatus', - 'errorMessage' => 'Illegal project status.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RollbackCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</RollbackCurrentProjectNodeResponse>","errorExample":""}]', - 'title' => '触发当前流程驳回', - 'description' => '**'."\n" - .'**', - ], - 'DescribeInstance' => [ - 'summary' => '调用 DescribeInstance 查询实例信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => ['title' => '操作类型：开票：0 ；拒绝开票：1', 'description' => '操作当前发票：'."\n" + .'- 开票：0'."\n" + .'- 拒绝开票：1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CheckNotice', 'in' => 'query', - 'schema' => [ - 'description' => '实例 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '155****11', - ], + 'schema' => ['title' => '服务商发票信息备注', 'description' => '服务商发票信息备注', 'type' => 'string', 'required' => false, 'example' => '******'], ], [ - 'name' => 'OrderType', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '订单类型，已废弃。', - 'type' => 'string', - 'required' => false, - 'example' => 'NEW', - ], + 'schema' => ['title' => '发票号', 'description' => '发票号', 'type' => 'string', 'required' => false, 'example' => '1897702****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '业务状态，根据不同商品类型设置不同值：'."\n" - ."\n" - .'当ProductType = MIRROR 时'."\n" - .'- PRODUCE：生产中'."\n" - .'- USING：使用中'."\n" - .'- UNUSED：未使用'."\n" - .'- EXPIRED：已过期'."\n" - .'- CLOSED：已释放'."\n" - ."\n" - .'当 ProductType = SERVICE 时'."\n" - .'- READYING：未开始'."\n" - .'- STARTED：服务中'."\n" - .'- CONFIRM：已完成'."\n" - .'- EXPIRED：已过期'."\n" - .'- CLOSED：已释放'."\n" - ."\n" - .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" - .'- OPENING：开通中'."\n" - .'- OPENED：已开通'."\n" - .'- EXPIRED：已过期'."\n" - .'- CLOSED：已释放', - 'type' => 'string', - 'example' => 'OPENED', - ], - 'AppJson' => [ - 'description' => '应用信息，示例中的参数说明如下：'."\n" - ."\n" - .'- username：用户名'."\n" - .'- passowrd：密码'."\n" - .'- frontEndUrl：前台地址'."\n" - .'- adminUrl：管理地址', - 'type' => 'string', - 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}', - ], - 'ProductName' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => '***协同办公', - ], - 'InstanceId' => [ - 'description' => '实例ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551111111', - ], - 'ExtendJson' => [ - 'description' => '扩展信息', - 'type' => 'string', - 'example' => '{"说明": "如有使用问题，请联系..."}', - ], - 'IsTrial' => [ - 'description' => '是否试用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BeganOn' => [ - 'description' => '实例开通时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634021000', - ], - 'ComponentJson' => [ - 'description' => '业务模块'."\n" - ."\n" - .'示例中的参数说明如下：'."\n" - ."\n" - .'- package_version：版本', - 'type' => 'string', - 'example' => '{"package_version":"yuncode000111"}', - ], - 'Constraints' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '{}', - ], - 'ProductType' => [ - 'description' => '商品类型，取值：'."\n" - ."\n" - .'- APP：应用类'."\n" - .'- SERVIC：服务类'."\n" - .'- MIRROR：镜像类'."\n" - .'- DOWNLOAD：下载类'."\n" - .'- API_SERVICE：API类'."\n" - .'- DOCKER：DOCKER类', - 'type' => 'string', - 'example' => 'APP', - ], - 'HostJson' => [ - 'description' => '主机信息，示例中的参数说明如下：'."\n" - ."\n" - .'- username：用户名'."\n" - .'- passowrd：密码'."\n" - .'- ip：主机 IP'."\n" - .'- innerIp：主机内网 IP', - 'type' => 'string', - 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}', - ], - 'ProductSkuCode' => [ - 'description' => '规格Code', - 'type' => 'string', - 'example' => 'cmgj00**11-prepay', - ], - 'CreatedOn' => [ - 'description' => '创建时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634018000', - ], - 'EndOn' => [ - 'description' => '到期时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1602259200000', - ], - 'OrderId' => [ - 'description' => '订单ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204211111111111', - ], - 'ProductCode' => [ - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj00**11', - ], - 'SupplierName' => [ - 'description' => '服务商名称', - 'type' => 'string', - 'example' => '*****有限公司', - ], - 'RelationalData' => [ - 'description' => '关联信息', - 'type' => 'object', - 'properties' => [ - 'ServiceStatus' => [ - 'description' => '服务状态'."\n" - ."\n" - .'- READYING：未开始'."\n" - .'- STARTED： 服务中'."\n" - .'- CONFIRM：已完成'."\n" - .'- EXPIRED： 已过期'."\n" - .'- CLOSED： 已释放', - 'type' => 'string', - 'example' => 'STARTED', - ], - ], - ], - 'Modules' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Module' => [ - 'description' => '商品模块信息，已废弃。', - 'type' => 'array', - 'items' => [ - 'description' => '已废弃', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => 'package_config', - ], - 'Name' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '套餐配置', - ], - 'Id' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '101*********026', - ], - 'Properties' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Property' => [ - 'description' => '已废弃', - 'type' => 'array', - 'items' => [ - 'description' => '已废弃', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'ShowType' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Name' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'DisplayUnit' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'PropertyValues' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PropertyValue' => [ - 'description' => '已废弃', - 'type' => 'array', - 'items' => [ - 'description' => '已废弃', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Type' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Step' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Value' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Max' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Remark' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - 'Min' => [ - 'description' => '已废弃', - 'type' => 'string', - 'example' => '12', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'AutoRenewal' => [ - 'type' => 'string', - ], - 'ActiveAddress' => [ - 'type' => 'string', - ], - 'LicenseCode' => [ - 'type' => 'string', - ], + 'Code' => ['description' => '状态码，200表示成功', 'type' => 'string', 'example' => 'cmjj01**45'], + 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '"成功"'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Result' => ['description' => '是否返回成功', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE'], ], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '云市场店铺发票受理', + 'description' => '查询商家订阅通知失败的信息'."\n" + ."\n" + .'- 如果当前不存在未确认的通知失败信息，TotalCount返回0', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"Constraints\\": \\"{}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"Modules\\": {\\n \\"Module\\": [\\n {\\n \\"Code\\": \\"package_config\\",\\n \\"Name\\": \\"套餐配置\\",\\n \\"Id\\": \\"101*********026\\",\\n \\"Properties\\": {\\n \\"Property\\": [\\n {\\n \\"Key\\": \\"12\\",\\n \\"ShowType\\": \\"12\\",\\n \\"Name\\": \\"12\\",\\n \\"DisplayUnit\\": \\"12\\",\\n \\"PropertyValues\\": {\\n \\"PropertyValue\\": [\\n {\\n \\"DisplayName\\": \\"12\\",\\n \\"Type\\": \\"12\\",\\n \\"Step\\": \\"12\\",\\n \\"Value\\": \\"12\\",\\n \\"Max\\": \\"12\\",\\n \\"Remark\\": \\"12\\",\\n \\"Min\\": \\"12\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"AutoRenewal\\": \\"\\",\\n \\"ActiveAddress\\": \\"\\",\\n \\"LicenseCode\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceResponse>\\n <BeganOn>1570634021000</BeganOn>\\n <ProductCode>cmgj00**11</ProductCode>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <OrderId>204605827111111</OrderId>\\n <InstanceId>15581111</InstanceId>\\n <EndOn>1602259200000</EndOn>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductType>APP</ProductType>\\n <CreatedOn>1570634018000</CreatedOn>\\n <RelationalData>\\n <ServiceStatus>READYING</ServiceStatus>\\n </RelationalData>\\n <ProductName>***协同办公</ProductName>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <SupplierName>阿里巴巴技术有限公司</SupplierName>\\n</DescribeInstanceResponse>","errorExample":""}]', - 'title' => '查询实例信息', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"cmjj01**45\\",\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\"\\n}","type":"json"}]', ], - 'DescribeInstanceForIsv' => [ - 'summary' => '服务商侧查询实例信息', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PauseProject' => [ + 'summary' => '调用PauseProject暂停项目。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '155****11', - ], + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => ['description' => '当前操作流程节点ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1922'], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => ['description' => '备注原因', 'type' => 'string', 'required' => false, 'example' => '等待与仓库确认库存，目前库存显示异常。'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '业务状态，根据不同商品类型设置不同值：'."\n" - .'当ProductType = MIRROR 时'."\n" - .'● PRODUCE：生产中'."\n" - .'● USING：使用中'."\n" - .'● UNUSED：未使用'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放'."\n" - .'当 ProductType = SERVICE 时'."\n" - .'● READYING：未开始'."\n" - .'● STARTED：服务中'."\n" - .'● CONFIRM：已完成'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放'."\n" - .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" - .'● OPENING：开通中'."\n" - .'● OPENED：已开通'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放', - 'description' => '业务状态，根据不同商品类型设置不同值：'."\n" - .'当ProductType = MIRROR 时'."\n" - .'● PRODUCE：生产中'."\n" - .'● USING：使用中'."\n" - .'● UNUSED：未使用'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放'."\n" - .'当 ProductType = SERVICE 时'."\n" - .'● READYING：未开始'."\n" - .'● STARTED：服务中'."\n" - .'● CONFIRM：已完成'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放'."\n" - .'当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" - .'● OPENING：开通中'."\n" - .'● OPENED：已开通'."\n" - .'● EXPIRED：已过期'."\n" - .'● CLOSED：已释放', - 'type' => 'string', - 'example' => 'OPENED', - ], - 'AppJson' => [ - 'title' => '应用信息，示例中的参数说明如下：'."\n" - ."\n" - .'username：用户名'."\n" - .'passowrd：密码'."\n" - .'frontEndUrl：前台地址'."\n" - .'adminUrl：管理地址', - 'description' => '应用信息，示例中的参数说明如下：'."\n" - ."\n" - .'username：用户名'."\n" - .'passowrd：密码'."\n" - .'frontEndUrl：前台地址'."\n" - .'adminUrl：管理地址', - 'type' => 'string', - 'example' => '{"frontEndUrl":"https://****.aliyundoc.com","password":"Sjtv***","adminUrl":"https://****.aliyundoc.com","username":"aliyun***"}', - ], - 'ProductName' => [ - 'title' => '商品名称', - 'description' => '商品名称', - 'type' => 'string', - 'example' => '***协同办公', - ], - 'InstanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551111111', - ], - 'ExtendJson' => [ - 'title' => '扩展信息', - 'description' => '扩展信息', - 'type' => 'string', - 'example' => '{"说明": "如有使用问题，请联系..."}', - ], - 'IsTrial' => [ - 'title' => '是否试用', - 'description' => '是否试用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'BeganOn' => [ - 'title' => '实例开通时间（时间戳）', - 'description' => '实例开通时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634021000', - ], - 'ComponentJson' => [ - 'title' => '业务模块'."\n" - .'示例中的参数说明如下：'."\n" - .'● package_version：版本', - 'description' => '业务模块'."\n" - .'示例中的参数说明如下：'."\n" - .'● package_version：版本', - 'type' => 'string', - 'example' => '{"package_version":"yuncode000111"}', - ], - 'ProductType' => [ - 'title' => '商品类型，取值：'."\n" - .'● APP：应用类'."\n" - .'● SERVIC：服务类'."\n" - .'● MIRROR：镜像类'."\n" - .'● DOWNLOAD：下载类'."\n" - .'● API_SERVICE：API类'."\n" - .'● DOCKER：DOCKER类', - 'description' => '商品类型，取值：'."\n" - .'● APP：应用类'."\n" - .'● SERVIC：服务类'."\n" - .'● MIRROR：镜像类'."\n" - .'● DOWNLOAD：下载类'."\n" - .'● API_SERVICE：API类'."\n" - .'● DOCKER：DOCKER类', - 'type' => 'string', - 'example' => 'APP', - ], - 'HostJson' => [ - 'title' => '主机信息，示例中的参数说明如下：'."\n" - ."\n" - .'username：用户名'."\n" - .'passowrd：密码'."\n" - .'ip：主机 IP'."\n" - .'innerIp：主机内网 IP', - 'description' => '主机信息，示例中的参数说明如下：'."\n" - ."\n" - .'username：用户名'."\n" - .'passowrd：密码'."\n" - .'ip：主机 IP'."\n" - .'innerIp：主机内网 IP', - 'type' => 'string', - 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}', - ], - 'ProductSkuCode' => [ - 'title' => '规格Code', - 'description' => '规格Code', - 'type' => 'string', - 'example' => 'cmgj00**11-prepay', - ], - 'CreatedOn' => [ - 'title' => '创建时间（时间戳）', - 'description' => '创建时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634018000', - ], - 'EndOn' => [ - 'title' => '到期时间（时间戳）', - 'description' => '到期时间（时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1602259200000', - ], - 'OrderId' => [ - 'title' => '订单ID', - 'description' => '订单ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204211111111111', - ], - 'ProductCode' => [ - 'title' => '商品Code', - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj00**11', - ], - 'SupplierName' => [ - 'title' => '服务商名称', - 'description' => '服务商名称', - 'type' => 'string', - 'example' => '*****有限公司', - ], - 'RelationalData' => [ - 'title' => '关联信息', - 'description' => '关联信息', - 'type' => 'object', - 'properties' => [ - 'ServiceStatus' => [ - 'title' => '服务状态'."\n" - .'● READYING：未开始'."\n" - .'● STARTED： 服务中'."\n" - .'● CONFIRM：已完成'."\n" - .'● EXPIRED： 已过期'."\n" - .'● CLOSED： 已释放', - 'description' => '服务状态'."\n" - .'● READYING：未开始'."\n" - .'● STARTED： 服务中'."\n" - .'● CONFIRM：已完成'."\n" - .'● EXPIRED： 已过期'."\n" - .'● CLOSED： 已释放', - 'type' => 'string', - 'example' => 'STARTED', - ], - ], - ], - 'RequestId' => [ - 'title' => 'requestId', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6EF60BEC-****-****-****-270359FB54A7', - ], - 'AutoRenewal' => [ - 'title' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n" - .'autoRenewCycle:Day（日），Month（月），Year（年）'."\n" - .'autoRenewDuration:续费周期', - 'description' => '周期类商品自动付费，不为空时表示已开通自动续费'."\n" - .'autoRenewCycle:Day（日），Month（月），Year（年）'."\n" - .'autoRenewDuration:续费周期', - 'type' => 'string', - 'example' => '{"autoRenewCycle":"Year","autoRenewDuration":1}', - ], - 'ActiveAddress' => [ - 'title' => '激活地址', - 'description' => '激活地址', - 'type' => 'string', - 'example' => 'https://*****.com', - ], - 'LicenseCode' => [ - 'title' => '激活码', - 'description' => '激活码', - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'ImageJson' => [ - 'title' => '镜像实例信息'."\n" - .'imageId：镜像id'."\n" - .'instanceId: 实例id'."\n" - .'ecsInstanceId: ecs id', - 'description' => '镜像实例信息'."\n" - .'imageId：镜像id'."\n" - .'instanceId: 实例id'."\n" - .'ecsInstanceId: ecs id', - 'type' => 'string', - 'example' => '{"imageId":"m-*******","instanceId":********}', - ], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f'], + 'Result' => ['description' => '是否返回成功', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''], + ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''], + ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://****.aliyundoc.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"IsTrial\\": true,\\n \\"BeganOn\\": 1570634021000,\\n \\"ComponentJson\\": \\"{\\\\\\"package_version\\\\\\":\\\\\\"yuncode000111\\\\\\"}\\",\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634018000,\\n \\"EndOn\\": 1602259200000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"*****有限公司\\",\\n \\"RelationalData\\": {\\n \\"ServiceStatus\\": \\"STARTED\\"\\n },\\n \\"RequestId\\": \\"6EF60BEC-****-****-****-270359FB54A7\\",\\n \\"AutoRenewal\\": \\"{\\\\\\"autoRenewCycle\\\\\\":\\\\\\"Year\\\\\\",\\\\\\"autoRenewDuration\\\\\\":1}\\",\\n \\"ActiveAddress\\": \\"https://*****.com\\",\\n \\"LicenseCode\\": \\"xxxxxx\\",\\n \\"ImageJson\\": \\"{\\\\\\"imageId\\\\\\":\\\\\\"m-*******\\\\\\",\\\\\\"instanceId\\\\\\":********}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceForIsvResponse>\\n <Status>OPENED</Status>\\n <AppJson>{\\"frontEndUrl\\":\\"https://****.aliyundoc.com\\",\\"password\\":\\"Sjtv***\\",\\"adminUrl\\":\\"https://****.aliyundoc.com\\",\\"username\\":\\"aliyun***\\"}</AppJson>\\n <ProductName>***协同办公</ProductName>\\n <InstanceId>1551111111</InstanceId>\\n <ExtendJson>{\\"说明\\": \\"如有使用问题，请联系...\\"}</ExtendJson>\\n <IsTrial>true</IsTrial>\\n <BeganOn>1570634021000</BeganOn>\\n <ComponentJson>{\\"package_version\\":\\"yuncode000111\\"}</ComponentJson>\\n <ProductType>APP</ProductType>\\n <HostJson>{\\"password\\":\\"***\\",\\"ip\\":\\"118.31.***.41\\",\\"innerIp\\":\\"118.31.***.41\\",\\"region\\":\\"\\",\\"username\\":\\"***\\",\\"beianInfo\\":\\"\\"}</HostJson>\\n <ProductSkuCode>cmgj00**11-prepay</ProductSkuCode>\\n <CreatedOn>1570634018000</CreatedOn>\\n <EndOn>1602259200000</EndOn>\\n <OrderId>204211111111111</OrderId>\\n <ProductCode>cmgj00**11</ProductCode>\\n <SupplierName>*****有限公司</SupplierName>\\n <RelationalData>\\n <ServiceStatus>STARTED</ServiceStatus>\\n </RelationalData>\\n <RequestId>6EF60BEC-****-****-****-270359FB54A7</RequestId>\\n <AutoRenewal>{\\"autoRenewCycle\\":\\"Year\\",\\"autoRenewDuration\\":1}</AutoRenewal>\\n <ActiveAddress>https://*****.com</ActiveAddress>\\n <LicenseCode>xxxxxx</LicenseCode>\\n <ImageJson>{\\"imageId\\":\\"m-*******\\",\\"instanceId\\":********}</ImageJson>\\n</DescribeInstanceForIsvResponse>","errorExample":""}]', - 'title' => '服务商侧查询实例信息', - ], - 'DescribeInstances' => [ - 'summary' => '查询用户已购买的服务列表。', - 'methods' => [ - 'post', - 'get', + 'title' => '暂停项目', + 'description' => '**'."\n" + .'**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:PauseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PauseProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</PauseProjectResponse>","errorExample":""}]', + ], + 'PushMeteringData' => [ + 'summary' => '调用PushMeteringData推送计量数据。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => '商品类型：'."\n" - .'APP-应用类'."\n" - .'SERVICE-服务类'."\n" - .'MIRROR-镜像类'."\n" - .'DOWNLOAD-下载类'."\n" - .'API_SERVICE-API类'."\n" - .'ROS-资源编排类'."\n" - .'DOCKER-容器类'."\n" - .'IOT-IOT类', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，当前页码', - 'description' => '分页参数，每页数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，每页数量', - 'description' => '分页参数，页数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Codes', - 'in' => 'query', - 'schema' => [ - 'description' => '指定商品code, 如有多个，用 , 分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'cmgj000112,cmgj000113', - ], - ], - [ - 'name' => 'ExceptCodes', + 'name' => 'Metering', 'in' => 'query', - 'schema' => [ - 'description' => '排除商品code，与指定商品code不能同时传， 如有多个，用 , 分隔', - 'type' => 'string', - 'required' => false, - 'example' => 'cmgj000114,cmgj000115', - ], + 'schema' => ['description' => '示例中的参数说明如下：'."\n" + ."\n" + .'- InstanceId：云市场实例ID 。参数类型为String。'."\n" + .'- StartTime：计量开始时间。单位秒（格式为Unix时间戳, 如1723771200）。参数类型为Long。'."\n" + .'- EndTime：计量结束时间。单位秒（格式为Unix时间戳，如1723771800）。参数类型为Long。'."\n" + .'- Entities：计量实体对象。参数类型为List<Map>。'."\n" + .' - Key：计量项属性名称。参数类型为String。'."\n" + .' - Frequency：使用次数（次）。'."\n" + .' - Period：使用小时时长（秒）。'."\n" + .' 注意：请求参数中的时长单位为秒，而计费单位为小时，因此计费时会转换为小时，如推送19:00-20:00的用量1800，计费价格为1元/小时，按小时出账该时段费用为1800 / 3600 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" + ."\n" + .' - Storage：使用存储空间（Byte）。'."\n" + ."\n" + .' 注意：请求参数中的单位为Byte，而计费单位为MB，因此计费时会转换为MB，如推送19:00-20:00的用量524288，计费价格为1元/MB，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" + ."\n" + .' - NetworkOut：上行使用流量（Bit）。'."\n" + ."\n" + .' 注意：请求参数中的单位为Bit，而计费单位为Mb，因此计费时会转换为Mb，如推送19:00-20:00的用量524288，计费价格为1元/Mb，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" + ."\n" + .' - NetworkIn：下行使用流量（Bit）。'."\n" + ."\n" + .' 注意：请求参数中的单位为Bit，而计费单位为Mb，因此计费时会转换为Mb，如推送19:00-20:00的用量524288，计费价格为1元/Mb，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" + ."\n" + .' - Character：字符数（个）。'."\n" + .' - DailyActiveUser：日活跃用户数（DAU）。'."\n" + .' - PeriodMin：使用分钟时长（分钟）。'."\n" + .' - VirtualCpu：虚拟CPU核数。'."\n" + .' - Unit: Unit(个)。'."\n" + .' - Memory: Memory(GB)。'."\n" + .' - KTokens: 使用tokens数(token)。'."\n" + .' 注意：请求参数中的KTokens单位为token, 不需要转化为千tokens，而计费单位为千tokens，因此计费时会将推送计量参数中token值转化为千tokens，如推送19:00-20:00的用量1500 token，示例: {"Key":"KTokens","Value":"1500","meteringAssit":"cmapi00071246-KTokens-1"}，计费价格为1元/千tokens，按小时出账该时段费用为1500 / 1000 x 1 = 1.5元, 费用如为小数，保留两位小数，超过两位舍弃。'."\n" + .' - Suit:Suit(套)，注意参数中传递的值是套。'."\n" + .' - StorageGigaByte: StorageGigaByte(存储空间GB)，注意参数中直接传递的参数单位是GB，不需要转化为Byte等。'."\n" + .' - Value：计量数值（取值 >= 0）。参数类型为Integer。'."\n" + .' - meteringAssit: 多维度计量项Id。参数类型为String, 在商品发布的后台可以看到这个计费项id。Frequency等计费项有1个或多个都会有这个值，新发布的品推送计量时需要将这个参数传递过来。'."\n" + .' - SerialNo：大模型调用场景特有，当是http调用的时候请设置为requestId，websocket的时候请设置为单次任务的uid，只有在商品是分钟出账的情况下，需要传递这个参数，其他情况下不需要传递这个参数。'."\n" + ."\n" + .'**说明**：'."\n" + .'- 多维度的计量能力，即对于上述的Frequency(次)、Period(使用时长)、PeriodMin等这些计费项在发布商品的时候可以支持多个，比如一个商品中可以有多个PeriodMin计费项，每个PeriodMin计费项会生成一个唯一的ID，用户标识计费项，这个计费项是在发布商品的时候生成的，格式如(cmapi00060317-PeriodMin-3， cmapi00060317-PeriodMin-4)。在推送计量的时候需要将上面的ID传递过来，以便进行相应的计费扣减。新发布品推送的计量数据格式如下所示:'."\n" + .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]。'."\n" + .'- 推送的计量参数请参考示例，示例中的参数都是必要的，数据缺失会推送计量失败。', 'type' => 'string', 'required' => false, 'example' => '按小时/按天推量时：'."\n" + .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]'."\n" + ."\n\n" + .'大模型场景实时推量时：'."\n" + .'[{"InstanceId":"1000001","SerialNo":"210f470417561055092582279ea052","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]'], ], ], 'responses' => [ @@ -4244,278 +3531,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '54C22FB9-0CB1-5629-97A8-653FC7990F00', - ], - 'PageNumber' => [ - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页的实例个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '实例总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '55', - ], - 'InstanceItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'InstanceItem' => [ - 'description' => '实例列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '业务状态'."\n" - .'- 当 ProductType = MIRROR 时'."\n" - .' - PRODUCE：生产中'."\n" - .' - USING：使用中'."\n" - .' - UNUSED：未使用'."\n" - .' - EXPIRED：已过期'."\n" - .' - CLOSED：已释放'."\n" - ."\n" - .'- 当 ProductType = SERVICE 时'."\n" - .' - READYING：未开始'."\n" - .' - STARTED：服务中'."\n" - .' - CONFIRM：已完成'."\n" - .' - EXPIRED：已过期'."\n" - .' - CLOSED：已释放'."\n" - ."\n" - .'- 当 ProductType = APP, DOWNLOAD, API_SERVICE, DOCKER 时'."\n" - .' - OPENING：开通中'."\n" - .' - OPENED：已开通'."\n" - .' - EXPIRED：已过期'."\n" - .' - CLOSED：已释放', - 'type' => 'string', - 'example' => 'OPENED', - ], - 'AppJson' => [ - 'description' => '应用信息'."\n" - ."\n" - .'示例中的参数说明如下：'."\n" - .'- username：用户名'."\n" - .'- passowrd：密码'."\n" - .'- frontEndUrl：前台地址'."\n" - .'- adminUrl：管理地址'."\n" - .'- authUrl: 免登地址', - 'type' => 'string', - 'example' => '{"frontEndUrl":"https://***.aliyun.com","password":"Sjtv***","adminUrl":"https://***.aiiyun.com","username":"aliyun***"}', - ], - 'ApiJson' => [ - 'type' => 'string', - 'example' => '{}', - ], - 'ProductName' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => '***协同办公', - ], - 'ImageJson' => [ - 'description' => '镜像信息', - 'type' => 'string', - 'example' => '{}', - ], - 'InstanceId' => [ - 'description' => '实例id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551111111', - ], - 'ExtendJson' => [ - 'description' => '扩展信息', - 'type' => 'string', - 'example' => '{"说明": "如有使用问题，请联系..."}', - ], - 'BeganOn' => [ - 'description' => '开通时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634021000', - ], - 'ProductType' => [ - 'description' => '商品类型，取值：'."\n" - .'- APP：应用类'."\n" - .'- SERVIC：服务类'."\n" - .'- MIRROR：镜像类'."\n" - .'- DOWNLOAD：下载类'."\n" - .'- API_SERVICE：API类'."\n" - .'- DOCKER：DOCKER类', - 'type' => 'string', - 'example' => 'APP', - ], - 'HostJson' => [ - 'description' => '主机信息'."\n" - ."\n" - .'示例中的参数说明如下：'."\n" - .'- username：用户名'."\n" - .'- passowrd：密码'."\n" - .'- ip：主机 IP'."\n" - .'- innerIp：主机内网 IP', - 'type' => 'string', - 'example' => '{"password":"***","ip":"118.31.***.41","innerIp":"118.31.***.41","region":"","username":"***","beianInfo":""}', - ], - 'ProductSkuCode' => [ - 'description' => '规格code', - 'type' => 'string', - 'example' => 'cmgj00**11-prepay', - ], - 'CreatedOn' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570634021000', - ], - 'IdaasJson' => [ - 'description' => 'idaas信息，已经废弃', - 'type' => 'string', - 'example' => '{}', - ], - 'EndOn' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570644021000', - ], - 'OrderId' => [ - 'description' => '订单id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204211111111111', - ], - 'ProductCode' => [ - 'description' => '商品code', - 'type' => 'string', - 'example' => 'cmgj00**11', - ], - 'SupplierName' => [ - 'description' => '服务商名称', - 'type' => 'string', - 'example' => '阿里巴巴技术有限公司', - ], - ], - ], - ], - ], - ], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => ' 请求ID', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Parameter.Metering', 'errorMessage' => 'meteringAssit is empty', 'description' => 'meteringAssit 为空'], + ['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => '请求参数错误。'], + ], 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'UnknownError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '未知错误。'], + ['errorCode' => 'Service.Flow.Control', 'errorMessage' => 'The rate throttling threshold has been exceeded.', 'description' => '请求超过流控限制。'], + ['errorCode' => 'Invalid.Parameter.Instance', 'errorMessage' => 'The specified Instance parameter is invalid.', 'description' => 'Instance参数请求错误。'], + ['errorCode' => 'Invalid.Parameter.Metering', 'errorMessage' => 'The specified Metering parameter is invalid.', 'description' => 'Metering参数请求错误。'], + ['errorCode' => 'Metering.Data.Exceeded', 'errorMessage' => 'The number of metering entities must not exceed 100.', 'description' => 'Metering entities不能超过100个。'], + ['errorCode' => 'Permission.Denied', 'errorMessage' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.', 'description' => '没有调用权限，请联系接口负责人添加白名单。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54C22FB9-0CB1-5629-97A8-653FC7990F00\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 55,\\n \\"InstanceItems\\": {\\n \\"InstanceItem\\": [\\n {\\n \\"Status\\": \\"OPENED\\",\\n \\"AppJson\\": \\"{\\\\\\"frontEndUrl\\\\\\":\\\\\\"https://***.aliyun.com\\\\\\",\\\\\\"password\\\\\\":\\\\\\"Sjtv***\\\\\\",\\\\\\"adminUrl\\\\\\":\\\\\\"https://***.aiiyun.com\\\\\\",\\\\\\"username\\\\\\":\\\\\\"aliyun***\\\\\\"}\\",\\n \\"ApiJson\\": \\"{}\\",\\n \\"ProductName\\": \\"***协同办公\\",\\n \\"ImageJson\\": \\"{}\\",\\n \\"InstanceId\\": 1551111111,\\n \\"ExtendJson\\": \\"{\\\\\\"说明\\\\\\": \\\\\\"如有使用问题，请联系...\\\\\\"}\\",\\n \\"BeganOn\\": 1570634021000,\\n \\"ProductType\\": \\"APP\\",\\n \\"HostJson\\": \\"{\\\\\\"password\\\\\\":\\\\\\"***\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"innerIp\\\\\\":\\\\\\"118.31.***.41\\\\\\",\\\\\\"region\\\\\\":\\\\\\"\\\\\\",\\\\\\"username\\\\\\":\\\\\\"***\\\\\\",\\\\\\"beianInfo\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ProductSkuCode\\": \\"cmgj00**11-prepay\\",\\n \\"CreatedOn\\": 1570634021000,\\n \\"IdaasJson\\": \\"{}\\",\\n \\"EndOn\\": 1570644021000,\\n \\"OrderId\\": 204211111111111,\\n \\"ProductCode\\": \\"cmgj00**11\\",\\n \\"SupplierName\\": \\"阿里巴巴技术有限公司\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询业务列表', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<PushMeteringDataResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</PushMeteringDataResponse>","errorExample":""}]', + 'title' => '推送计量数据', + 'description' => '### 编码和格式要求'."\n" + .'- 请求参数全部需要URLEncode编码。'."\n" + .'- 注意参数中Metering字段要严格按照文档中的示例来提交，以往发现很多提交过来的不是一个JSON字段，提交之前可以先用JSON格式化工具检查一下，否则接口调用会失败。'."\n" + .'### 请求频率与单次写入量限制'."\n" + .'- 按小时/天计量时：云市场对每个InstanceId的请求限制为60秒一次，每次请求支持写入的计量数据为100条。'."\n" + .'- 实时计量时（针对大模型使用场景）：云市场对每个InstanceId的请求无频率限制，每次请求支持写入的计量数据限制为10条。'."\n" + .'### 计量数据批量推送限制'."\n" + .'- 不支持跨商品的InstanceId批量推送，批量推送时请确保所有InstanceId来自同一个商品。'."\n" + .'- 批量推送计量数据时，“InstanceId”属性必须为同一个商品所产生的实例，目前不支持多个商品的实例同时推送。'."\n" + .'### 计量数据推送时间要求'."\n" + .'- 按小时出账的商品，截止出账时间是下一个小时，计量数据必须按时推送过来。比如推送的计量数据是8:10-08:20，则必须在9.59之前将计量数据推送过来，否则将不会出账。按天出账规则类似，即第二天1:59之前必须要把前一天的数据推送过来，否则推送计量会报错，不会出账。'."\n" + .'- 分钟级出账的商品，会将实时推量的数据按分钟进行聚合，并按分钟出账。'."\n" + .'- 如果商品设置为实时出账，StartTime和EndTime为任意时间宽度均可以，但是EndTime一定要大于StartTime 。'."\n" + .'- 如果商品设置为非实时出账（即选择按小时、按天等），StartTime和EndTime'."\n" + .' 的间隔必须大于5分钟。'."\n" + .'### 推量和出账的时效性'."\n" + .'- 如果实例状态已经过期，则在实例过期之后推送的计量数据不会出账，比如实例是2025-07-09 12:20:00过期，则推送过来的 2025-07-09 13:00:00-2025-07-09 14:00:00这一小时的计量数据是不会出账的。2025-07-09 12:00:00-2025-07-09 13:00:00 这一小时的计量数据仍然可以正常出账。'."\n" + .'- 推送完计量数据后，不会立即出账，按小时计费的会在下一个时间区间出账，比如按小时计费8:00-9:00的账单，会在10点之后出账，按天计费的会在下一天出账。出账后，客户可以在[阿里云账单详情](https://billing-cost.console.aliyun.com/finance/expense-report/expense-detail-by-instance)中查看。'."\n" + .'### 金额抹零'."\n" + .'- 账单如果金额过少，单次账单金额不足0.01元时，买家侧的账单金额为0。比如商品单价是0.001元/次，按分钟出账，每分钟都消耗9次，则每分钟的账单金额为0。如果按小时出账，单个小时的账单金额不足0.01，则买家侧的账单金额为0。分钟级出账金额抹零的概率可能会高于按小时出账的概率。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AutoRenewInstance' => [ - 'summary' => '设置自动续费', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-15T03:16:22.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-07-10T00:48:28.000Z', 'description' => '错误码发生变更'], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '开通open，关闭close，必传', - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'OrderBizId', - 'in' => 'formData', - 'schema' => [ - 'title' => '云市场实例id，必传', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - ], - [ - 'name' => 'AutoRenewCycle', - 'in' => 'formData', - 'schema' => [ - 'title' => '周期单位，开通时必传。Day（日），Month（月），Year（年）', - 'type' => 'string', - ], - ], - [ - 'name' => 'AutoRenewDuration', - 'in' => 'formData', - 'schema' => [ - 'title' => '续费周期，开通时必传', - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResponseDTO<Boolean>', - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - ], - 'Data' => [ - 'type' => 'boolean', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'acm:PushMeteringData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '', ], - 'PauseProject' => [ - 'summary' => '调用PauseProject暂停项目。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PushTimesUsage' => [ + 'summary' => '用于服务商向云市场推送用户预付费按次计费商品的使用次数扣减。', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4523,318 +3610,99 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['title' => '实例id，必填', 'description' => '云市场实例ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '1000001'], ], [ - 'name' => 'NodeId', + 'name' => 'Times', 'in' => 'query', - 'schema' => [ - 'description' => '当前操作流程节点ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1922', - ], + 'schema' => ['title' => '使用次数，必填', 'description' => '本次扣减的使用次数。取值必须大于0。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Remark', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '备注原因', - 'type' => 'string', - 'required' => false, - 'example' => '等待与仓库确认库存，目前库存显示异常。', - ], + 'schema' => ['title' => '客户端令牌，防止重复提交', 'description' => '保证请求幂等性的客户端令牌。建议使用UUID。同一个 `ClientToken` 在24小时内仅允许提交一次。重试同一笔操作时必须使用相同的 `ClientToken`，新的业务操作请使用新的 `ClientToken`。'."\n", 'type' => 'string', 'required' => false, 'example' => '6dff6c70-3484-4a39-b725-164e3ad9b20d'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ResultDTO<Boolean>', + 'description' => 'ResultDTO<Boolean>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', - ], - 'Result' => [ - 'description' => '是否返回成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Result' => ['description' => '返回结果', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '请求是否成功。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '状态码。'."\n", 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '返回信息。'."\n", 'type' => 'string', 'example' => 'success'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'], + 'HttpStateCode' => ['description' => '请求HttpStateCode', 'type' => 'string', 'example' => '200'], + 'ForceFatal' => ['description' => '致命错误', 'type' => 'boolean'], + 'AccessDeniedDetail' => ['description' => '鉴权报错信息', 'type' => 'string', 'example' => '{}'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], - [ - 'errorCode' => 'IllegalOperatorRole', - 'errorMessage' => 'Illegal operator role.', - ], - [ - 'errorCode' => 'IllegalCurrentNode', - 'errorMessage' => 'Illegal current node.', - ], - [ - 'errorCode' => 'IllegalProjectStatus', - 'errorMessage' => 'Illegal project status.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PauseProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</PauseProjectResponse>","errorExample":""}]', - 'title' => '暂停项目', - 'description' => '**'."\n" - .'**', + ['errorCode' => 'DuplicateClientToken', 'errorMessage' => 'clientToken Duplicate Submission (PROCESSING Status).', 'description' => 'clientToken 重复提交（PROCESSING 状态）'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instance does not exist.', 'description' => '实例不存在'], + ['errorCode' => 'SupplierNotFound', 'errorMessage' => 'Service provider does not exist.', 'description' => '服务商不存在'], + ['errorCode' => 'Forbidden', 'errorMessage' => 'Permission verification failed.', 'description' => '权限校验失败'], + ['errorCode' => 'Throttling', 'errorMessage' => 'Distributed lock acquisition failure (concurrency limit).', 'description' => '分布式锁获取失败（并发限制）'], + ['errorCode' => 'UnknownResult', 'errorMessage' => 'Update result unknown, please contact cloud market.', 'description' => '更新结果未知，请联系云市场确认'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '推送预付费商品使用量扣减', + 'description' => '## 请求说明'."\n" + .'- 该接口适用于预付费按次计费的商品，通过此接口服务商可以将用户的使用次数推送给云市场进行扣减。'."\n" + .'- 接口采用强制更新模式，直接扣减指定次数，调用方需自行判断用户使用量是否超出。'."\n" + .'- 所有请求参数必须进行URLEncode编码。'."\n" + .'- 使用`ClientToken`参数实现幂等性控制，在24小时内相同的`ClientToken`不允许重复提交。'."\n" + .'- 同一笔扣减操作的重试必须使用相同的`ClientToken`；新的业务操作应使用新的`ClientToken`。'."\n" + .'- 如果上一次请求已成功（即使因网关超时未收到响应），使用相同`ClientToken`重试会幂等返回成功，不会重复扣减。'."\n" + .'- 如果上一次请求结果未确定（处于PROCESSING状态），使用相同`ClientToken`重试会返回`DuplicateClientToken`错误，请稍后重试或联系云市场确认推送状态。'."\n" + .'- 同一个`InstanceId`同一时刻只允许一个操作执行，并发请求会返回`Throttling`错误，请稍后重试。'."\n" + .'- 可以在[OpenAPI Explorer](https://api.aliyun.com/#product=Market&api=PushTimesUsage&type=RPC&version=2015-11-01)中直接运行该接口，免去计算签名的困扰。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"HttpStateCode\\": \\"200\\",\\n \\"ForceFatal\\": true,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', ], - 'DescribeProjectAttachments' => [ - 'summary' => '调用DescribeProjectAttachments获取项目附件列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResumeProject' => [ + 'summary' => '调用ResumeProject恢复暂停项目。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场业务实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求标识', - 'type' => 'string', - 'example' => 'e03a9f78-7b40-4fb3-a015-350913e37e3f', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileLinkGmtExpired' => [ - 'description' => '文件地址生效截止时间（unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589334682404', - ], - 'StepNo' => [ - 'description' => '流程节点序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'AttachmentToken' => [ - 'description' => '附件MD5', - 'type' => 'string', - 'example' => 'Mzc4NDAtODQ3MjY4MzI=', - ], - 'FileName' => [ - 'description' => '文件名称', - 'type' => 'string', - 'example' => 'f8-test-perview.jpeg', - ], - 'OperatorRole' => [ - 'description' => ' 操作人角色', - 'type' => 'string', - 'example' => 'Provider', - ], - 'NodeName' => [ - 'description' => '节点名称', - 'type' => 'string', - 'example' => '等待服务开通', - ], - 'OperatorName' => [ - 'description' => '操作人名称', - 'type' => 'string', - 'example' => '**科技技术有限公司', - ], - 'FileLink' => [ - 'description' => '文件访问地址', - 'type' => 'string', - 'example' => 'http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D', - ], - 'GmtCreate' => [ - 'description' => '附件上传时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1587968858000', - ], - 'FileSuffix' => [ - 'description' => '文件后缀', - 'type' => 'string', - 'example' => 'jpg', - ], - 'Operator' => [ - 'description' => '操作人阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45261111****', - ], - 'Content' => [ - 'description' => '内容文本', - 'type' => 'string', - 'example' => '无', - ], - 'NodeId' => [ - 'description' => '附件上传的流程节点ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8472', - ], - 'AttachmentType' => [ - 'description' => '附件类型', - 'type' => 'string', - 'example' => 'File', - ], - 'FileSize' => [ - 'description' => '文件大小（byte）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '109124', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"e03a9f78-7b40-4fb3-a015-350913e37e3f\\",\\n \\"Result\\": [\\n {\\n \\"FileLinkGmtExpired\\": 1589334682404,\\n \\"StepNo\\": 3,\\n \\"AttachmentToken\\": \\"Mzc4NDAtODQ3MjY4MzI=\\",\\n \\"FileName\\": \\"f8-test-perview.jpeg\\",\\n \\"OperatorRole\\": \\"Provider\\",\\n \\"NodeName\\": \\"等待服务开通\\",\\n \\"OperatorName\\": \\"**科技技术有限公司\\",\\n \\"FileLink\\": \\"http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r*********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D\\",\\n \\"GmtCreate\\": 1587968858000,\\n \\"FileSuffix\\": \\"jpg\\",\\n \\"Operator\\": 0,\\n \\"Content\\": \\"无\\",\\n \\"NodeId\\": 8472,\\n \\"AttachmentType\\": \\"File\\",\\n \\"FileSize\\": 109124\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeProjectAttachmentsResponse>\\n <requestId>e03a9f78-7b40-4fb3-a015-350913e37e3f</requestId>\\n <result>\\n <attachmentToken>Mzc4NDAtODQ3MjY4MzI=</attachmentToken>\\n <attachmentType>File</attachmentType>\\n <content />\\n <fileLink>http://delivery-center.oss-cn-shanghai.aliyuncs.com/6a8****0e2/e0a***f3.jpg?Expires=1589334682&OSSAccessKeyId=wI2r********&Signature=JWB39pUxs7RCqrcw58qXPEGu6M0%3D</fileLink>\\n <fileLinkGmtExpired>1589334682404</fileLinkGmtExpired>\\n <fileName>f8-test-perview.jpeg</fileName>\\n <fileSize>109124</fileSize>\\n <fileSuffix>jpg</fileSuffix>\\n <gmtCreate>1587968858000</gmtCreate>\\n <nodeId>8472</nodeId>\\n <nodeName>等待服务开通</nodeName>\\n <operator>45261111****</operator>\\n <operatorName>**科技技术有限公司</operatorName>\\n <operatorRole>Provider</operatorRole>\\n <stepNo>3</stepNo>\\n </result>\\n <success>true</success>\\n</DescribeProjectAttachmentsResponse>","errorExample":""}]', - 'title' => '获取项目附件列表', - ], - 'DescribeProjectInfo' => [ - 'summary' => '调用DescribeProjectInfo获取项目信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => ['description' => '操作流程节点ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1922'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '云市场业务实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '备注原因', 'type' => 'string', 'required' => false, 'example' => '仓库库存已补充，可安排发货。'], ], ], 'responses' => [ @@ -4842,215 +3710,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ee3e1b3b-6c38-4bcf-be40-5a946cfda761', - ], - 'Result' => [ - 'description' => '返回结果', - 'type' => 'object', - 'properties' => [ - 'ProductName' => [ - 'description' => '云市场商品名称', - 'type' => 'string', - 'example' => '公司宝****记账', - ], - 'ProjectStatus' => [ - 'description' => '项目执行状态，取值：'."\n" - ."\n" - .'- Starting：进行中'."\n" - .'- Cancel：已取消'."\n" - .'- Pause：已暂停'."\n" - .'- Finish：已完成', - 'type' => 'string', - 'example' => 'Starting', - ], - 'CustomerAliUid' => [ - 'description' => '用户阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27291111****', - ], - 'TemplateType' => [ - 'description' => '项目所属模板类型，取值：'."\n" - ."\n" - .'- Public：公共模板'."\n" - .'- Private：私有模板', - 'type' => 'string', - 'example' => 'Public', - ], - 'InstanceId' => [ - 'description' => '云市场业务实例ID', - 'type' => 'string', - 'example' => '4****89', - ], - 'ProductSkuName' => [ - 'description' => '云市场商品规格名称', - 'type' => 'string', - 'example' => '小***纳税人', - ], - 'FinalStepNo' => [ - 'description' => '最后节点的序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'CurrentStepNo' => [ - 'description' => '当前流程节点', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'GmtExpired' => [ - 'description' => '项目超时时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620403200000', - ], - 'GmtFinished' => [ - 'description' => '项目完成时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620403200000', - ], - 'ProductSkuCode' => [ - 'description' => '云市场商品规格Code', - 'type' => 'string', - 'example' => 'yuncode****500001', - ], - 'GmtCreate' => [ - 'description' => '项目创建时间（Unix时间戳）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588834324000', - ], - 'SupplierAliUid' => [ - 'description' => '项目所属厂商UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45121111****', - ], - 'FinishType' => [ - 'description' => '项目完成方式，取值：'."\n" - ."\n" - .'- null：未完成项目默认值'."\n" - .'- CustomerConfirm：客户手动确认'."\n" - .'- SystemAutoConfirm：因超时系统自动确认', - 'type' => 'string', - 'example' => 'null', - ], - 'TemplateId' => [ - 'description' => '项目所属流程模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '410', - ], - 'OrderId' => [ - 'description' => '订单ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2059111111111', - ], - 'ProductCode' => [ - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj***055', - ], - ], - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f'], + 'Result' => ['description' => '是否返回成功', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''], + ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''], + ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"ee3e1b3b-6c38-4bcf-be40-5a946cfda761\\",\\n \\"Result\\": {\\n \\"ProductName\\": \\"公司宝****记账\\",\\n \\"ProjectStatus\\": \\"Starting\\",\\n \\"CustomerAliUid\\": 0,\\n \\"TemplateType\\": \\"Public\\",\\n \\"InstanceId\\": \\"4****89\\",\\n \\"ProductSkuName\\": \\"小***纳税人\\",\\n \\"FinalStepNo\\": 4,\\n \\"CurrentStepNo\\": 3,\\n \\"GmtExpired\\": 1620403200000,\\n \\"GmtFinished\\": 1620403200000,\\n \\"ProductSkuCode\\": \\"yuncode****500001\\",\\n \\"GmtCreate\\": 1588834324000,\\n \\"SupplierAliUid\\": 0,\\n \\"FinishType\\": \\"null\\",\\n \\"TemplateId\\": 410,\\n \\"OrderId\\": 2059111111111,\\n \\"ProductCode\\": \\"cmgj***055\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectInfoResponse>\\n <requestId>ee3e1b3b-6c38-4bcf-be40-5a946cfda761</requestId>\\n <result>\\n <currentStepNo>3</currentStepNo>\\n <customerAliUid>27291111****</customerAliUid>\\n <finalStepNo>4</finalStepNo>\\n <finishType/>\\n <gmtCreate>1588834324000</gmtCreate>\\n <gmtExpired>1620403200000</gmtExpired>\\n <gmtFinished/>\\n <instanceId>4****89</instanceId>\\n <orderId>2059111111111</orderId>\\n <productCode>cmgj***055</productCode>\\n <productName>公司宝****记账</productName>\\n <productSkuCode>yuncode****500001</productSkuCode>\\n <productSkuName>小***纳税人</productSkuName>\\n <projectStatus>Starting</projectStatus>\\n <supplierAliUid>45121111****</supplierAliUid>\\n <templateId>410</templateId>\\n <templateType>Public</templateType>\\n </result>\\n <success>true</success>\\n</DescribeProjectInfoResponse>","errorExample":""}]', - 'title' => '获取项目信息', - ], - 'ResumeProject' => [ - 'summary' => '调用ResumeProject恢复暂停项目。', - 'methods' => [ - 'post', + 'title' => '恢复暂停项目', + 'description' => '**'."\n" + .'**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ResumeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ResumeProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</ResumeProjectResponse>","errorExample":""}]', + ], + 'RollbackCurrentProjectNode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云市场订单实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4****89', - ], + 'schema' => ['description' => '云市场订单实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4****89'], ], [ 'name' => 'NodeId', 'in' => 'query', - 'schema' => [ - 'description' => '操作流程节点ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1922', - ], + 'schema' => ['description' => '当前流程节点ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1925'], ], [ 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '备注原因', - 'type' => 'string', - 'required' => false, - 'example' => '仓库库存已补充，可安排发货。', - ], + 'schema' => ['description' => '打回原因备注', 'type' => 'string', 'required' => false, 'example' => '尊敬的顾客您好，您提交的收货地址存在多个匹配结果，请您核对后再重新提交。'], ], ], 'responses' => [ @@ -5058,1313 +3787,605 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f', - ], - 'Result' => [ - 'description' => '是否返回成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'ee69a00f-189b-400f-9fd2-af89749fb50f'], + 'Result' => ['description' => '是否返回成功', 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => '成功状态标识', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'Illegal request.', - ], - [ - 'errorCode' => 'IllegalParameter', - 'errorMessage' => 'Illegal parameter %s.', - ], - [ - 'errorCode' => 'IllegalResult', - 'errorMessage' => 'Illegal result.', - ], - [ - 'errorCode' => 'IllegalPermission', - 'errorMessage' => 'Permission Denied.', - ], - [ - 'errorCode' => 'IllegalOperatorRole', - 'errorMessage' => 'Illegal operator role.', - ], - [ - 'errorCode' => 'IllegalCurrentNode', - 'errorMessage' => 'Illegal current node.', - ], - [ - 'errorCode' => 'IllegalProjectStatus', - 'errorMessage' => 'Illegal project status.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'Illegal request.', 'description' => ''], + ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter %s.', 'description' => ''], + ['errorCode' => 'IllegalResult', 'errorMessage' => 'Illegal result.', 'description' => '数据结果异常'], + ['errorCode' => 'IllegalPermission', 'errorMessage' => 'Permission Denied.', 'description' => ''], + ['errorCode' => 'IllegalOperatorRole', 'errorMessage' => 'Illegal operator role.', 'description' => ''], + ['errorCode' => 'IllegalCurrentNode', 'errorMessage' => 'Illegal current node.', 'description' => ''], + ['errorCode' => 'IllegalProjectStatus', 'errorMessage' => 'Illegal project status.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ResumeProjectResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</ResumeProjectResponse>","errorExample":""}]', - 'title' => '恢复暂停项目', + 'title' => '触发当前流程驳回', + 'summary' => '调用RollbackCurrentProjectNode触发当前流程驳回。', 'description' => '**'."\n" .'**', - ], - 'DescribeLicense' => [ - 'summary' => '调用 DescribeLicense 查询授权信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:RollbackCurrentProjectNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ee69a00f-189b-400f-9fd2-af89749fb50f\\",\\n \\"Result\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RollbackCurrentProjectNodeResponse>\\n <RequestId>ee69a00f-189b-400f-9fd2-af89749fb50f</RequestId>\\n <Result>true</Result>\\n <Success>true</Success>\\n</RollbackCurrentProjectNodeResponse>","errorExample":""}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => 'market.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'market.ap-southeast-1.aliyuncs.com', 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'market.aliyuncs.com', 'endpoint' => 'market.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Auth.Authorized', 'message' => 'The specified RAM user is not authorized.', 'http_code' => 400, 'description' => '子账号没有授权。'], + ['code' => 'Auth.CallerType', 'message' => 'RAM users or STS tokens are not supported.', 'http_code' => 400, 'description' => '不支持子账号或STS账号调用。'], + ['code' => 'Auth.ISV', 'message' => 'Only ISV accounts are allowed to call the specified API operation.', 'http_code' => 400, 'description' => '非服务商账号，仅供服务商账号调用。'], + ['code' => 'Auth.ISV.Error', 'message' => 'Only ISV accounts are allowed to call the specified API operation.', 'http_code' => 400, 'description' => '非服务商账号，仅供服务商账号调用。'], + ['code' => 'Auth.Match', 'message' => 'The product to be enabled by the specified license does not belong to the ISV.', 'http_code' => 400, 'description' => '授权码对应的商品不属于该服务商。'], + ['code' => 'Auth.SubAccount.Error', 'message' => 'The specified AccessKey information does not belong to the RAM user.', 'http_code' => 400, 'description' => '该AccessKey不是子账号的AccessKey。'], + ['code' => 'DeniedModify', 'message' => 'You are not authorized to call the specified API operation.', 'http_code' => 400, 'description' => '没有调用权限。'], + ['code' => 'DownstreamError', 'message' => 'An error occurred while processing your request.', 'http_code' => 501, 'description' => '内部调用失败。'], + ['code' => 'IgnoreError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '参数错误。'], + ['code' => 'IllegalResult', 'message' => 'Illegal result.', 'http_code' => 400, 'description' => '数据结果异常'], + ['code' => 'INAVLIDPARAM.CALLERTYPE', 'message' => 'The specified callerType is invalid.', 'http_code' => 400, 'description' => '不支持的callerType类型。'], + ['code' => 'INAVLIDPARAM.OWNERID', 'message' => 'The partner ownerId parameter must be specified.', 'http_code' => 400, 'description' => '虚商必须传递ownerId参数。'], + ['code' => 'Invalid.CategoryId', 'message' => 'The specified CategoryId is invalid.', 'http_code' => 500, 'description' => 'CategoryId参数错误。'], + ['code' => 'Invalid.Param', 'message' => 'The specified Filter key is invalid.', 'http_code' => 500, 'description' => '不支持的Filter key参数。'], + ['code' => 'Invalid.Parameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '请求参数错误。'], + ['code' => 'Invalid.Parameter.Instance', 'message' => 'The specified Instance parameter is invalid.', 'http_code' => 500, 'description' => 'Instance参数请求错误。'], + ['code' => 'Invalid.Parameter.Metering', 'message' => 'The specified Metering parameter is invalid.', 'http_code' => 500, 'description' => 'Metering参数请求错误。'], + ['code' => 'Invalid.Parameter.Metering', 'message' => 'meteringAssit is empty', 'http_code' => 400, 'description' => 'meteringAssit 为空'], + ['code' => 'Invalid.Parameter.OrderId', 'message' => 'orderId is not correct.', 'http_code' => 400, 'description' => '参数不正确'], + ['code' => 'Invalid.Sort', 'message' => 'The specified Sort is invalid.', 'http_code' => 500, 'description' => 'Sort参数错误。'], + ['code' => 'INVALIDPARAM.BIDOWNERBID', 'message' => 'The owner does not belong to the partner specified by the BID.', 'http_code' => 400, 'description' => '请求账号的BID不匹配。'], + ['code' => 'INVALIDPARAM.BIDTYPE', 'message' => 'You must specify both callerBid and callerType.', 'http_code' => 400, 'description' => 'callerBid或者callerType为空。'], + ['code' => 'INVALIDPARAM.CALLERBID', 'message' => 'The specified callerBid is invalid.', 'http_code' => 400, 'description' => '不支持此BID的账号调用。'], + ['code' => 'INVALIDPARAM.PARTNERBID', 'message' => 'The specified partner BID is invalid.', 'http_code' => 400, 'description' => '服务化虚商账号不能调用。'], + ['code' => 'License.Discard', 'message' => 'The specified license has been discarded.', 'http_code' => 400, 'description' => '授权码已废弃。'], + ['code' => 'License.Expired', 'message' => 'The specified license has expired.', 'http_code' => 400, 'description' => '授权码已过期。'], + ['code' => 'License.Invalid', 'message' => 'The specified license is invalid.', 'http_code' => 400, 'description' => '无效的授权码。'], + ['code' => 'License.NotFound', 'message' => 'The specified license does not exist.', 'http_code' => 400, 'description' => '授权码不存在。'], + ['code' => 'Metering.Data.Exceeded', 'message' => 'The number of metering entities must not exceed 100.', 'http_code' => 500, 'description' => 'Metering entities不能超过100个。'], + ['code' => 'PAY.ACCOUNT_BOOK_NOT_EXIST', 'message' => 'The specified subscription does not exist.', 'http_code' => 400, 'description' => '账户的预购不存在。'], + ['code' => 'Permission.Denied', 'message' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.', 'http_code' => 500, 'description' => '没有调用权限，请联系接口负责人添加白名单。'], + ['code' => 'ReturnNull', 'message' => 'No results found.', 'http_code' => 502, 'description' => '没有返回结果。'], + ['code' => 'Service.Flow.Control', 'message' => 'The rate throttling threshold has been exceeded.', 'http_code' => 500, 'description' => '请求超过流控限制。'], + ['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => '未知错误。'], + ['code' => 'UnknownError', 'message' => 'execute oms post error', 'http_code' => 500, 'description' => '执行oms post相关接口出错'], + ['code' => 'InstanceNotFound', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => '实例不存在'], + ['code' => 'DuplicateClientToken', 'message' => 'clientToken Duplicate Submission (PROCESSING Status).', 'http_code' => 400, 'description' => 'clientToken 重复提交（PROCESSING 状态）'], + ['code' => 'SupplierNotFound', 'message' => 'Service provider does not exist.', 'http_code' => 400, 'description' => '服务商不存在'], + ['code' => 'Forbidden', 'message' => 'Permission verification failed.', 'http_code' => 400, 'description' => '权限校验失败'], + ['code' => 'Throttling', 'message' => 'Distributed lock acquisition failure (concurrency limit).', 'http_code' => 400, 'description' => '分布式锁获取失败（并发限制）'], + ['code' => 'UnknownResult', 'message' => 'Update result unknown, please contact cloud market.', 'http_code' => 400, 'description' => '更新结果未知，请联系云市场确认'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'PushMeteringData'], ], - 'parameters' => [ - [ - 'name' => 'LicenseCode', - 'in' => 'query', - 'schema' => [ - 'description' => '激活码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxxxxx', - ], - ], + 'createdAt' => '2025-12-15T03:16:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeInstances'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'License' => [ - 'description' => '激活码对象', - 'type' => 'object', - 'properties' => [ - 'ActivateTime' => [ - 'description' => '激活时间', - 'type' => 'string', - 'example' => '2019-05-25 09:00:00', - ], - 'LicenseStatus' => [ - 'description' => '激活码状态'."\n" - .'- ACTIVATED'."\n" - .'- INACTIVATED', - 'type' => 'string', - 'example' => 'ACTIVATED', - ], - 'ProductName' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => 'LNMP环境', - ], - 'ExpiredTime' => [ - 'description' => '过期时间', - 'type' => 'string', - 'example' => '2019-06-25 09:00:00', - ], - 'ProductSkuId' => [ - 'description' => '商品规格ID', - 'type' => 'string', - 'example' => 'cmgj02****-prepay', - ], - 'CreateTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2019-05-25 09:00:00', - ], - 'LicenseCode' => [ - 'description' => '激活码', - 'type' => 'string', - 'example' => '-', - ], - 'InstanceId' => [ - 'description' => '业务实例ID', - 'type' => 'string', - 'example' => '1551111111', - ], - 'SupplierName' => [ - 'description' => '供应商名称', - 'type' => 'string', - 'example' => '**科技股份有限公司', - ], - 'ProductCode' => [ - 'description' => '商品Code', - 'type' => 'string', - 'example' => 'cmgj02****', - ], - 'ExtendArray' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LicenseAttribute' => [ - 'description' => '扩展对象数组', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '对象code', - 'type' => 'string', - 'example' => 'package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;', - ], - 'Value' => [ - 'description' => '对象值', - 'type' => 'string', - 'example' => '-', - ], - ], - ], - ], - ], - ], - 'ExtendInfo' => [ - 'description' => '扩展属性', - 'type' => 'object', - 'properties' => [ - 'AliUid' => [ - 'description' => '阿里云UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190311111111****', - ], - 'AccountQuantity' => [ - 'description' => '账号信息', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-', - ], - 'Email' => [ - 'description' => '邮箱', - 'type' => 'string', - 'example' => 'id***@**.com', - ], - 'Mobile' => [ - 'description' => '电话', - 'type' => 'string', - 'example' => '129****1111', - ], - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2024-08-29T09:32:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeApiMetering'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Auth.SubAccount.Error', - 'errorMessage' => 'The specified AccessKey information does not belong to the RAM user.', - ], - [ - 'errorCode' => 'License.Invalid', - 'errorMessage' => 'The specified license is invalid.', - ], - [ - 'errorCode' => 'License.Expired', - 'errorMessage' => 'The specified license has expired.', - ], - [ - 'errorCode' => 'License.Discard', - 'errorMessage' => 'The specified license has been discarded.', - ], - [ - 'errorCode' => 'License.NotFound', - 'errorMessage' => 'The specified license does not exist.', - ], - [ - 'errorCode' => 'Auth.ISV.Error', - 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', - ], - [ - 'errorCode' => 'Auth.Match', - 'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.', - ], - [ - 'errorCode' => 'Auth.Authorized', - 'errorMessage' => 'The specified RAM user is not authorized.', - ], - ], + 'createdAt' => '2024-07-29T06:21:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CrossAccountVerifyToken'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'createdAt' => '2024-04-03T01:36:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateOrder'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"License\\": {\\n \\"ActivateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseStatus\\": \\"ACTIVATED\\",\\n \\"ProductName\\": \\"LNMP环境\\",\\n \\"ExpiredTime\\": \\"2019-06-25 09:00:00\\",\\n \\"ProductSkuId\\": \\"cmgj02****-prepay\\",\\n \\"CreateTime\\": \\"2019-05-25 09:00:00\\",\\n \\"LicenseCode\\": \\"-\\",\\n \\"InstanceId\\": \\"1551111111\\",\\n \\"SupplierName\\": \\"**科技股份有限公司\\",\\n \\"ProductCode\\": \\"cmgj02****\\",\\n \\"ExtendArray\\": {\\n \\"LicenseAttribute\\": [\\n {\\n \\"Code\\": \\"package_version:对应商品规格code;orderBizId:云市场实例ID;activeAddress:激活地址;orderId:包含新购和续费订单ID，逗号分割;aliUid:用户阿里云Uid;expiresTime:授权码过期时间;\\",\\n \\"Value\\": \\"-\\"\\n }\\n ]\\n },\\n \\"ExtendInfo\\": {\\n \\"AliUid\\": 0,\\n \\"AccountQuantity\\": 0,\\n \\"Email\\": \\"id***@**.com\\",\\n \\"Mobile\\": \\"129****1111\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLicenseResponse>\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n <License>\\n <ActivateTime>2019-05-25 09:00:00</ActivateTime>\\n <LicenseStatus>ACTIVATED</LicenseStatus>\\n <ProductName>LNMP环境</ProductName>\\n <ExpiredTime>2019-06-25 09:00:00</ExpiredTime>\\n <ProductSkuId>cmgj02****-prepay</ProductSkuId>\\n <CreateTime>2019-05-25 09:00:00</CreateTime>\\n <LicenseCode>-</LicenseCode>\\n <InstanceId>1551111111</InstanceId>\\n <SupplierName>**科技股份有限公司</SupplierName>\\n <ProductCode>cmgj02****</ProductCode>\\n <ExtendArray>\\n <Code>-</Code>\\n <Value>-</Value>\\n </ExtendArray>\\n <ExtendInfo>\\n <Email>id***@**.com</Email>\\n <Mobile>129****1111</Mobile>\\n </ExtendInfo>\\n </License>\\n</DescribeLicenseResponse>","errorExample":""}]', - 'title' => '查询授权信息', + 'createdAt' => '2024-03-28T06:49:13.000Z', + 'description' => '', ], - 'ActivateLicense' => [ - 'summary' => '调用 ActivateLicense 激活授权码。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeInstance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-03-14T01:57:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeApiMetering'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-12-25T03:49:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'PushMeteringData'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2023-07-10T00:48:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDistributionProductsLink'], ], - 'parameters' => [ - [ - 'name' => 'LicenseCode', - 'in' => 'query', - 'schema' => [ - 'description' => '授权码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA', + 'createdAt' => '2023-06-01T02:25:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AutoRenewInstance'], + ], + 'createdAt' => '2022-11-23T01:55:38.000Z', + 'description' => '增加对周期类商品自动续费的支持', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProducts'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOrder'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateOrder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistributionProductsLink'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeProduct'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMetering'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstances'], + ], + ], + 'ram' => [ + 'productCode' => 'Market', + 'productName' => '云市场', + 'ramCodes' => ['acm'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DescribeOrderForIsv', + 'description' => '服务商侧查询订单详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeOrderForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Identification', - 'in' => 'query', - 'schema' => [ - 'description' => '激活的身份信息，用户的 aliyunUid。', - 'type' => 'string', - 'required' => false, - 'example' => '129****1111', + ], + [ + 'apiName' => 'ConfirmNotification', + 'description' => '确认查收订阅通知', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ConfirmNotification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - ], + [ + 'apiName' => 'DescribeProjectMessages', + 'description' => 'DescribeProjectMessages', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Auth.CallerType', - 'errorMessage' => 'RAM users or STS tokens are not supported.', - ], - [ - 'errorCode' => 'License.Invalid', - 'errorMessage' => 'The specified license is invalid.', - ], - [ - 'errorCode' => 'License.Expired', - 'errorMessage' => 'The specified license has expired.', - ], - [ - 'errorCode' => 'License.Discard', - 'errorMessage' => 'The specified license has been discarded.', - ], - [ - 'errorCode' => 'License.NotFound', - 'errorMessage' => 'The specified license does not exist.', - ], - [ - 'errorCode' => 'Auth.ISV', - 'errorMessage' => 'Only ISV accounts are allowed to call the specified API operation.', - ], - [ - 'errorCode' => 'Auth.Match', - 'errorMessage' => 'The product to be enabled by the specified license does not belong to the ISV.', - ], - [ - 'errorCode' => 'Auth.Authorized', - 'errorMessage' => 'The specified RAM user is not authorized.', + [ + 'apiName' => 'DescribeApiMetering', + 'description' => 'API余量获取', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeApiMetering', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<ActivateLicenseResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</ActivateLicenseResponse>","errorExample":""}]', - 'title' => '激活授权码', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PushMeteringData' => [ - 'summary' => '调用PushMeteringData推送计量数据。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDistributionProductsLink', + 'description' => '获取推广商品转化链接', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeDistributionProductsLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Metering', - 'in' => 'query', - 'schema' => [ - 'description' => '示例中的参数说明如下：'."\n" - ."\n" - .'- InstanceId：云市场实例ID 。参数类型为String。'."\n" - .'- StartTime：计量开始时间。单位秒（格式为Unix时间戳, 如1723771200）。参数类型为Long。'."\n" - .'- EndTime：计量结束时间。单位秒（格式为Unix时间戳，如1723771800）。参数类型为Long。'."\n" - .'- Entities：计量实体对象。参数类型为List<Map>。'."\n" - .' - Key：计量项属性名称。参数类型为String。'."\n" - .' - Frequency：使用次数（次）。'."\n" - .' - Period：使用小时时长（秒）。'."\n" - .' 注意：请求参数中的时长单位为秒，而计费单位为小时，因此计费时会转换为小时，如推送19:00-20:00的用量1800，计费价格为1元/小时，按小时出账该时段费用为1800 / 3600 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" - ."\n" - .' - Storage：使用存储空间（Byte）。'."\n" - ."\n" - .' 注意：请求参数中的单位为Byte，而计费单位为MB，因此计费时会转换为MB，如推送19:00-20:00的用量524288，计费价格为1元/MB，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" - ."\n" - .' - NetworkOut：上行使用流量（Bit）。'."\n" - ."\n" - .' 注意：请求参数中的单位为Bit，而计费单位为Mb，因此计费时会转换为Mb，如推送19:00-20:00的用量524288，计费价格为1元/Mb，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" - ."\n" - .' - NetworkIn：下行使用流量（Bit）。'."\n" - ."\n" - .' 注意：请求参数中的单位为Bit，而计费单位为Mb，因此计费时会转换为Mb，如推送19:00-20:00的用量524288，计费价格为1元/Mb，按小时出账该时段费用为524288 / 1024 / 1024 x 1 = 0.5元，费用如为小数，保留两位小数，超过两位舍弃。'."\n" - ."\n" - .' - Character：字符数（个）。'."\n" - .' - DailyActiveUser：日活跃用户数（DAU）。'."\n" - .' - PeriodMin：使用分钟时长（分钟）。'."\n" - .' - VirtualCpu：虚拟CPU核数。'."\n" - .' - Unit: Unit(个)。'."\n" - .' - Memory: Memory(GB)。'."\n" - .' - KTokens: 使用tokens数(token)。'."\n" - .' 注意：请求参数中的KTokens单位为token, 不需要转化为千tokens，而计费单位为千tokens，因此计费时会将推送计量参数中token值转化为千tokens，如推送19:00-20:00的用量1500 token，示例: {"Key":"KTokens","Value":"1500","meteringAssit":"cmapi00071246-KTokens-1"}，计费价格为1元/千tokens，按小时出账该时段费用为1500 / 1000 x 1 = 1.5元, 费用如为小数，保留两位小数，超过两位舍弃。'."\n" - .' - Suit:Suit(套)，注意参数中传递的值是套。'."\n" - .' - StorageGigaByte: StorageGigaByte(存储空间GB)，注意参数中直接传递的参数单位是GB，不需要转化为Byte等。'."\n" - .' - Value：计量数值（取值 >= 0）。参数类型为Integer。'."\n" - .' - meteringAssit: 多维度计量项Id。参数类型为String, 在商品发布的后台可以看到这个计费项id。Frequency等计费项有1个或多个都会有这个值，新发布的品推送计量时需要将这个参数传递过来。'."\n" - .' - SerialNo：大模型调用场景特有，当是http调用的时候请设置为requestId，websocket的时候请设置为单次任务的uid，只有在商品是分钟出账的情况下，需要传递这个参数，其他情况下不需要传递这个参数。'."\n" - ."\n" - .'**说明**：'."\n" - .'- 多维度的计量能力，即对于上述的Frequency(次)、Period(使用时长)、PeriodMin等这些计费项在发布商品的时候可以支持多个，比如一个商品中可以有多个PeriodMin计费项，每个PeriodMin计费项会生成一个唯一的ID，用户标识计费项，这个计费项是在发布商品的时候生成的，格式如(cmapi00060317-PeriodMin-3， cmapi00060317-PeriodMin-4)。在推送计量的时候需要将上面的ID传递过来，以便进行相应的计费扣减。新发布品推送的计量数据格式如下所示:'."\n" - .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]。'."\n" - .'- 推送的计量参数请参考示例，示例中的参数都是必要的，数据缺失会推送计量失败。', - 'type' => 'string', - 'required' => false, - 'example' => '按小时/按天推量时：'."\n" - .'[{"InstanceId":"1000001","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]'."\n" - ."\n\n" - .'大模型场景实时推量时：'."\n" - .'[{"InstanceId":"1000001","SerialNo":"210f470417561055092582279ea052","StartTime":"100000000","EndTime":"100000010","Entities":[{"Key":"PeriodMin","Value":"96","meteringAssit":"cmapi00060317-PeriodMin-4"}]}]', + [ + 'apiName' => 'ResumeProject', + 'description' => 'ResumeProject', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ResumeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => ' 请求ID', - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - ], + [ + 'apiName' => 'DescribePrice', + 'description' => '查询对应商品的价格信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Parameter.Metering', - 'errorMessage' => 'meteringAssit is empty', - ], - [ - 'errorCode' => 'Invalid.Parameter', - 'errorMessage' => 'The specified parameter is invalid.', + [ + 'apiName' => 'DescribeFailedNotifications', + 'description' => '查询订阅通知失败列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeFailedNotifications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - [ - 'errorCode' => 'Service.Flow.Control', - 'errorMessage' => 'The rate throttling threshold has been exceeded.', - ], - [ - 'errorCode' => 'Invalid.Parameter.Instance', - 'errorMessage' => 'The specified Instance parameter is invalid.', - ], - [ - 'errorCode' => 'Invalid.Parameter.Metering', - 'errorMessage' => 'The specified Metering parameter is invalid.', - ], - [ - 'errorCode' => 'Metering.Data.Exceeded', - 'errorMessage' => 'The number of metering entities must not exceed 100.', - ], - [ - 'errorCode' => 'Permission.Denied', - 'errorMessage' => 'You are not authorized to call the API operation. Contact the API developer to add your account to the API user whitelist.', + ], + [ + 'apiName' => 'DescribeProjectNodes', + 'description' => 'DescribeProjectNodes', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectNodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<PushMeteringDataResponse>\\n<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n<Success>true</Success>\\n</PushMeteringDataResponse>","errorExample":""}]', - 'title' => '推送计量数据', - 'description' => '### 编码和格式要求'."\n" - .'- 请求参数全部需要URLEncode编码。'."\n" - .'- 注意参数中Metering字段要严格按照文档中的示例来提交，以往发现很多提交过来的不是一个JSON字段，提交之前可以先用JSON格式化工具检查一下，否则接口调用会失败。'."\n" - .'### 请求频率与单次写入量限制'."\n" - .'- 按小时/天计量时：云市场对每个InstanceId的请求限制为60秒一次，每次请求支持写入的计量数据为100条。'."\n" - .'- 实时计量时（针对大模型使用场景）：云市场对每个InstanceId的请求无频率限制，每次请求支持写入的计量数据限制为10条。'."\n" - .'### 计量数据批量推送限制'."\n" - .'- 不支持跨商品的InstanceId批量推送，批量推送时请确保所有InstanceId来自同一个商品。'."\n" - .'- 批量推送计量数据时，“InstanceId”属性必须为同一个商品所产生的实例，目前不支持多个商品的实例同时推送。'."\n" - .'### 计量数据推送时间要求'."\n" - .'- 按小时出账的商品，截止出账时间是下一个小时，计量数据必须按时推送过来。比如推送的计量数据是8:10-08:20，则必须在9.59之前将计量数据推送过来，否则将不会出账。按天出账规则类似，即第二天1:59之前必须要把前一天的数据推送过来，否则推送计量会报错，不会出账。'."\n" - .'- 分钟级出账的商品，会将实时推量的数据按分钟进行聚合，并按分钟出账。'."\n" - .'- 如果商品设置为实时出账，StartTime和EndTime为任意时间宽度均可以，但是EndTime一定要大于StartTime 。'."\n" - .'- 如果商品设置为非实时出账（即选择按小时、按天等），StartTime和EndTime'."\n" - .' 的间隔必须大于5分钟。'."\n" - .'### 推量和出账的时效性'."\n" - .'- 如果实例状态已经过期，则在实例过期之后推送的计量数据不会出账，比如实例是2025-07-09 12:20:00过期，则推送过来的 2025-07-09 13:00:00-2025-07-09 14:00:00这一小时的计量数据是不会出账的。2025-07-09 12:00:00-2025-07-09 13:00:00 这一小时的计量数据仍然可以正常出账。'."\n" - .'- 推送完计量数据后，不会立即出账，按小时计费的会在下一个时间区间出账，比如按小时计费8:00-9:00的账单，会在10点之后出账，按天计费的会在下一天出账。出账后，客户可以在[阿里云账单详情](https://billing-cost.console.aliyun.com/finance/expense-report/expense-detail-by-instance)中查看。'."\n" - .'### 金额抹零'."\n" - .'- 账单如果金额过少，单次账单金额不足0.01元时，买家侧的账单金额为0。比如商品单价是0.001元/次，按分钟出账，每分钟都消耗9次，则每分钟的账单金额为0。如果按小时出账，单个小时的账单金额不足0.01，则买家侧的账单金额为0。分钟级出账金额抹零的概率可能会高于按小时出账的概率。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CrossAccountVerifyToken' => [ - 'summary' => '查询跨账号角色授权信息，包含授权人阿里云账号UID、名称、授权时间、授权角色名称。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'PauseProject', + 'description' => 'PauseProject', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:PauseProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CrossAccountVerifyToken', + 'description' => '查询跨账号角色授权信息', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Token', - 'in' => 'formData', - 'schema' => [ - 'title' => '跨账号角色授权成功返回的token', - 'description' => '跨账号角色授权成功返回的token', - 'type' => 'string', - 'required' => false, - 'example' => 'C19D103FEA2D50A584410267CE9FBA56', + 'ramAction' => [ + 'action' => 'acm:CrossAccountVerifyToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultDTO<ServiceRoleVerifyTokenDTO>', - 'description' => '返回结果对象', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '返回结果对象', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '用户展示名称', - 'description' => '用户展示名称', - 'type' => 'string', - 'example' => 'marketplace_wangxiao_test', - ], - 'Uid' => [ - 'title' => '用户阿里云uid', - 'description' => '用户阿里云uid', - 'type' => 'string', - 'example' => '1744526877246715', - ], - 'AuthTime' => [ - 'title' => '授权时间', - 'description' => '授权时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1676974108866', - ], - 'AuthRoles' => [ - 'title' => '授权角色', - 'description' => '授权角色', - 'type' => 'array', - 'items' => [ - 'description' => '授权角色名称', - 'type' => 'string', - 'example' => 'VendorCrossAccountXIAOYUNACCESSSMSRole', - ], - ], - ], - ], - 'Success' => [ - 'description' => '接口返回成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '状态码，200表示成功', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'RequestId', - 'type' => 'string', - 'example' => 'C19D103F-EA2D-50A5-8441-0267CE9FBA56', - ], - ], + [ + 'apiName' => 'DescribeDistributionProducts', + 'description' => '分页获取推广商品列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeDistributionProducts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Name\\": \\"marketplace_wangxiao_test\\",\\n \\"Uid\\": \\"1744526877246715\\",\\n \\"AuthTime\\": 1676974108866,\\n \\"AuthRoles\\": [\\n \\"VendorCrossAccountXIAOYUNACCESSSMSRole\\"\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C19D103F-EA2D-50A5-8441-0267CE9FBA56\\"\\n}","type":"json"}]', - 'title' => '查询跨账号角色授权信息', - 'responseParamsDescription' => '返回值中授权人阿里云账号信息Name和Uid字段默认脱敏展示，如需明文展示，请联系云市场运营同学开通。', - ], - 'DescribeDistributionProductsLink' => [ - 'summary' => '获取推广商品的推广链接。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeInstances', + 'description' => '查询业务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeLicense', + 'description' => 'DescribeLicense', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Codes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '商品code集合,不能为空集合，集合大小最多50条', - 'description' => '商品code集合,不能为空集合，集合大小最多50条', - 'type' => 'array', - 'items' => [ - 'description' => 'cmapi*****', - 'type' => 'string', - 'required' => false, - 'example' => 'cmapi******', - ], - 'required' => true, - 'docRequired' => true, - 'minItems' => 1, + 'ramAction' => [ + 'action' => 'acm:DescribeLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5BD09171-BF4D-18D8-890E-C70C067527BE', - ], - 'TotalCount' => [ - 'title' => '推广商品总数', - 'description' => '推广商品总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51', - ], - 'Success' => [ - 'title' => '成功状态标识', - 'description' => '成功状态标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => '推广商品链接信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'title' => '商品推广链接', - 'description' => '商品推广链接,注：示例链接为测试商品链接', - 'type' => 'string', - 'example' => 'https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D', - ], - 'Code' => [ - 'title' => '推广商品code', - 'description' => '推广商品code', - 'type' => 'string', - 'example' => 'cmapi000****', - ], - 'Name' => [ - 'title' => '推广商品名称', - 'description' => '推广商品名称', - 'type' => 'string', - 'example' => '测试商品', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeInvoiceForIsv', + 'description' => '查询云市场供应商店铺的发票信息', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'acm:DescribeInvoiceForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - [ - 'errorCode' => 'Forbidden!', - 'errorMessage' => 'user is not distributor!', - ], - [ - 'errorCode' => 'ProductCodes', - 'errorMessage' => 'productCodes is empty!', - ], - [ - 'errorCode' => 'codeSizeError', - 'errorMessage' => 'productCodes size should less than 50!', - ], - [ - 'errorCode' => 'CodeError', - 'errorMessage' => 'codes is not correct!', + [ + 'apiName' => 'PushTimesUsage', + 'description' => '推送预付费商品使用量扣减', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:PushTimesUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-BF4D-18D8-890E-C70C067527BE\\",\\n \\"TotalCount\\": 51,\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"Url\\": \\"https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D\\",\\n \\"Code\\": \\"cmapi000****\\",\\n \\"Name\\": \\"测试商品\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsLinkResponse>\\n <RequestId>5BD09171-BF4D-18D8-890E-C70C067527BE</RequestId>\\n <TotalCount>51</TotalCount>\\n <Success>true</Success>\\n <Result>\\n <Url>https://market.aliyun.com/ad/adClick?param=QN%2BgAHA8mY%2BV1vSDtkNqyWG9G5uUX2Q8%2BJrC8wTzBo5YK7tTmm4Zdiz6nmmyLHMC5REAsq2viyeJYjBjVHno1HydPvHrVarNXQTMEzEmR8TRZaG2FsnzpszXKK2cMA69CUmF9qQpHqU%3D</Url>\\n <Code>cmapi000****</Code>\\n <Name>测试商品</Name>\\n </Result>\\n</DescribeDistributionProductsLinkResponse>","errorExample":""}]', - 'title' => '获取推广商品转化链接', - 'description' => '请使用推广服务商账号调用，非推广服务商调用不成功。', - 'requestParamsDescription' => '推广商品的code数组不能为空，数组大小不能大于50', - ], - 'DescribeDistributionProducts' => [ - 'summary' => '分页获取推广商品列表及详细信息。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeCurrentNodeInfo', + 'description' => 'DescribeCurrentNodeInfo', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeCurrentNodeInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeInstance', + 'description' => '查询实例信息', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页-当前页数', - 'description' => '当前页数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'ramAction' => [ + 'action' => 'acm:DescribeInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页的推广商品数量', - 'description' => '每页的推广商品数量。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', + ], + [ + 'apiName' => 'DescribeProjectAttachments', + 'description' => 'DescribeProjectAttachments', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectAttachments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '过滤条件列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '搜索标签类别，取值：'."\n" - ."\n" - .'- code：推广商品Code'."\n" - .'- name：推广商品名称'."\n" - .'- supplierName：推广服务商名称', - 'type' => 'string', - 'required' => true, - 'example' => 'supplierName', - ], - 'Value' => [ - 'description' => '搜索标签取值：'."\n" - ."\n" - .'- code: 测试商品code'."\n" - .'- name:测试商品名称'."\n" - .'- supplierName:测试供应商家名称', - 'type' => 'string', - 'required' => true, - 'example' => 'cmj0000000', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DescribeProjectInfo', + 'description' => 'DescribeProjectInfo', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '5BD09171-MB74-18D8-890E-C70C067527BE', - ], - 'PageNumber' => [ - 'description' => '当前页数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页的推广商品数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '符合搜索条件的推广商品数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Results' => [ - 'description' => '推广商品信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FirstCategoryName' => [ - 'title' => '商品类目，一级类目名称', - 'description' => '商品类目，一级类目名称', - 'type' => 'string', - 'example' => 'API市场', - ], - 'SecondCategoryName' => [ - 'title' => '商品类目，二级类目名称', - 'description' => '商品类目，二级类目名称', - 'type' => 'string', - 'example' => '生活服务', - ], - 'Type' => [ - 'title' => '商品类型'."\n" - .' APP 应用类'."\n" - .' SERVICE 服务类'."\n" - .' CHENGPIN_SITE 成品网站'."\n" - .' SITE_CUSTOM_SERVICE 定制网站'."\n" - .' SITE_PROMOTION_RUN 网站推广运营'."\n" - .' ENT_APP_SOFT 应用软件'."\n" - .' CLOUD_SERVICE 云服务'."\n" - .' EIF 企信宝'."\n" - .' BASIC_TOOLS 基础工具'."\n" - .' BASIC_SERVICES 基础服务'."\n" - .' JIANZHAN_XITONG 建站系统'."\n" - .' APP_COUPLES 应用伴侣'."\n" - .' MIRRORS_MARKET 镜像市场'."\n" - .' MIRRORS_MARKET_BASIC_ENVIRONMENT 基础环境'."\n" - .' MIRRORS_MARKET_APPLICATION_SOFTWARE 应用软件'."\n" - .' MIRROR 镜像类'."\n" - .' DINGDING 钉钉类'."\n" - .' DOWNLOAD 下载类'."\n" - .' EXTENDED 未知类'."\n" - .' API_SERVICE API类'."\n" - .' ROS 资源编排类'."\n" - .' DOCKER 容器类'."\n" - .' LICENSE 授权码类'."\n" - .' SAAS_WUYING 应用软件-无影应用', - 'description' => '商品类型'."\n" - .' APP 应用类'."\n" - .' SERVICE 服务类'."\n" - .' CHENGPIN_SITE 成品网站'."\n" - .' SITE_CUSTOM_SERVICE 定制网站'."\n" - .' SITE_PROMOTION_RUN 网站推广运营'."\n" - .' ENT_APP_SOFT 应用软件'."\n" - .' CLOUD_SERVICE 云服务'."\n" - .' EIF 企信宝'."\n" - .' BASIC_TOOLS 基础工具'."\n" - .' BASIC_SERVICES 基础服务'."\n" - .' JIANZHAN_XITONG 建站系统'."\n" - .' APP_COUPLES 应用伴侣'."\n" - .' MIRRORS_MARKET 镜像市场'."\n" - .' MIRRORS_MARKET_BASIC_ENVIRONMENT 基础环境'."\n" - .' MIRRORS_MARKET_APPLICATION_SOFTWARE 应用软件'."\n" - .' MIRROR 镜像类'."\n" - .' DINGDING 钉钉类'."\n" - .' DOWNLOAD 下载类'."\n" - .' EXTENDED 未知类'."\n" - .' API_SERVICE API类'."\n" - .' ROS 资源编排类'."\n" - .' DOCKER 容器类'."\n" - .' LICENSE 授权码类'."\n" - .' SAAS_WUYING 应用软件-无影应用', - 'type' => 'string', - 'example' => 'API类', - ], - 'ImageUrl' => [ - 'title' => '商品主图url', - 'description' => '商品主图url', - 'type' => 'string', - 'example' => '//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg', - ], - 'Code' => [ - 'title' => '商品code', - 'description' => '商品code', - 'type' => 'string', - 'example' => 'cmap*****', - ], - 'Name' => [ - 'title' => '商品名称', - 'description' => '商品名称', - 'type' => 'string', - 'example' => '手机号码在网状态查询', - ], - 'ShortDescription' => [ - 'title' => '商品简介', - 'description' => '商品简介', - 'type' => 'string', - 'example' => '运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。', - ], - 'Price' => [ - 'title' => '商品默认规格价格', - 'description' => '商品默认规格价格，如100代表100,单位CNY', - 'type' => 'string', - 'example' => '100', - ], - 'Score' => [ - 'title' => '商品用户评分', - 'description' => '商品用户评分', - 'type' => 'string', - 'example' => '5', - ], - 'TradeCount' => [ - 'title' => '商品近180天成交', - 'description' => '商品近180天成交', - 'type' => 'string', - 'example' => '109', - ], - 'UserCommentCount' => [ - 'title' => '商品买家评论数', - 'description' => '商品买家评论数', - 'type' => 'string', - 'example' => '55', - ], - 'SubmissionRadio' => [ - 'title' => '商品返佣比例', - 'description' => '商品返佣比例,如30，代表30%', - 'type' => 'string', - 'example' => '30', - ], - 'SupplierName' => [ - 'title' => '推广服务商名称', - 'description' => '推广服务商名称', - 'type' => 'string', - 'example' => '深圳市****有限公司', - ], - 'SupplierUId' => [ - 'title' => '推广服务商(商品供应商)阿里云UID', - 'description' => '推广服务商(商品供应商)阿里云UID', - 'type' => 'string', - 'example' => '1911534921******', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeInstanceForIsv', + 'description' => '服务商侧查询实例信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeInstanceForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'user is not distributor!', - ], - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => 'An error occurred while processing your request. ', + [ + 'apiName' => 'DescribeOrder', + 'description' => '用于查询对应订单的详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD09171-MB74-18D8-890E-C70C067527BE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"Results\\": [\\n {\\n \\"FirstCategoryName\\": \\"API市场\\",\\n \\"SecondCategoryName\\": \\"生活服务\\",\\n \\"Type\\": \\"API类\\",\\n \\"ImageUrl\\": \\"//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg\\",\\n \\"Code\\": \\"cmap*****\\",\\n \\"Name\\": \\"手机号码在网状态查询\\",\\n \\"ShortDescription\\": \\"运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。\\",\\n \\"Price\\": \\"100\\",\\n \\"Score\\": \\"5\\",\\n \\"TradeCount\\": \\"109\\",\\n \\"UserCommentCount\\": \\"55\\",\\n \\"SubmissionRadio\\": \\"30\\",\\n \\"SupplierName\\": \\"深圳市****有限公司\\",\\n \\"SupplierUId\\": \\"1911534921******\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeDistributionProductsResponse>\\n <RequestId>5BD09171-MB74-18D8-890E-C70C067527BE</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>50</TotalCount>\\n <Results>\\n <FirstCategoryName>API市场</FirstCategoryName>\\n <SecondCategoryName>生活服务</SecondCategoryName>\\n <Type>API类</Type>\\n <ImageUrl>//photogallery.oss-cn-hangzhou.aliyuncs.com/photo/1744526877246715/09605255-87fd-44d1-8143-96ebc8019d46.jpeg</ImageUrl>\\n <Code>cmap*****</Code>\\n <Name>手机号码在网状态查询</Name>\\n <ShortDescription>运营商号码状态查询】精准实时空号检测，手机号在网状态查询，返回正常、空号、通话中、在网但不可用、关机、呼叫转移、疑似关机、携号转网、号码错误、停机等多种状态。</ShortDescription>\\n <Price>100</Price>\\n <Score>5</Score>\\n <TradeCount>109</TradeCount>\\n <UserCommentCount>55</UserCommentCount>\\n <SubmissionRadio>30</SubmissionRadio>\\n <SupplierName>深圳市****有限公司</SupplierName>\\n <SupplierUId>1911534921******</SupplierUId>\\n </Results>\\n</DescribeDistributionProductsResponse>","errorExample":""}]', - 'title' => '分页获取推广商品列表', - 'description' => '请使用推广服务商账号调用', - 'requestParamsDescription' => 'code为单个查询，name为商品名称，supplierName为商品供应商名称', - ], - 'DescribeApiMetering' => [ - 'summary' => '获取用户的API余量、总量、使用量等数据。', - 'methods' => [ - 'get', + [ + 'apiName' => 'RollbackCurrentProjectNode', + 'description' => ' RollbackCurrentProjectNode', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:RollbackCurrentProjectNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'AutoRenewInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:AutoRenewInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'FinishCurrentProjectNode', + 'description' => 'FinishCurrentProjectNode', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:FinishCurrentProjectNode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'ModifyInvoiceForIsv', + 'description' => '云市场店铺发票受理', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ModifyInvoiceForIsv', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'productCode', - 'in' => 'query', - 'schema' => [ - 'description' => '商品code', - 'type' => 'string', - 'required' => false, - 'example' => 'cmapi0004****', + [ + 'apiName' => 'ActivateLicense', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'acm:ActivateLicense', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '类型，1表示套餐包，2表示资源包', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'PushMeteringData', + 'description' => '推送计量数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'acm:PushMeteringData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'pageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'CreateOrder', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'acm:CreateOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回值', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => '62FC432C55A1A63534A6CB34', - ], - 'Code' => [ - 'description' => '状态码', - 'type' => 'string', - 'example' => '200', - ], - 'Result' => [ - 'description' => '返回值列表', - 'type' => 'array', - 'items' => [ - 'description' => '单个对象', - 'type' => 'object', - 'properties' => [ - 'AliyunPk' => [ - 'description' => '阿里云pk', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102277855749****', - ], - 'ProductCode' => [ - 'description' => '商品code', - 'type' => 'string', - 'example' => 'cmapi0004****', - ], - 'ProductName' => [ - 'description' => '商品名称', - 'type' => 'string', - 'example' => '身份证实名认证-身份证实名', - ], - 'TotalQuota' => [ - 'description' => '余量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'TotalUsage' => [ - 'description' => '使用量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '220', - ], - 'TotalCapacity' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Unit' => [ - 'description' => '单位', - 'type' => 'string', - 'example' => '次', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Success' => [ - 'description' => '结果标识', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageSize' => [ - 'description' => ' 每页个数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Message' => [ - 'description' => '错误信息描述', - 'type' => 'string', - 'example' => '"成功"', - ], - 'Version' => [ - 'description' => '版本', - 'type' => 'string', - 'example' => '1.0', - ], - 'Fatal' => [ - 'description' => 'fatal', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'DescribeProjectOperateLogs', + 'description' => 'DescribeProjectOperateLogs', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'acm:DescribeProjectOperateLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Market', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"62FC432C55A1A63534A6CB34\\",\\n \\"Code\\": \\"200\\",\\n \\"Result\\": [\\n {\\n \\"AliyunPk\\": 0,\\n \\"ProductCode\\": \\"cmapi0004****\\",\\n \\"ProductName\\": \\"身份证实名认证-身份证实名\\",\\n \\"TotalQuota\\": 98,\\n \\"TotalUsage\\": 220,\\n \\"TotalCapacity\\": 0,\\n \\"Unit\\": \\"次\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"Success\\": true,\\n \\"Count\\": 100,\\n \\"PageSize\\": 20,\\n \\"Message\\": \\"\\\\\\"成功\\\\\\"\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Fatal\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeApiMeteringResponse>\\n <RequestId>62FC432C55A1A63534A6CB34</RequestId>\\n <Code>200</Code>\\n <Result>\\n <ProductCode>cmapi0004****</ProductCode>\\n <ProductName>身份证实名认证-身份证实名</ProductName>\\n <TotalQuota>98</TotalQuota>\\n <TotalUsage>220</TotalUsage>\\n <Unit>次</Unit>\\n </Result>\\n <PageNumber>1</PageNumber>\\n <Success>true</Success>\\n <Count>100</Count>\\n <PageSize>20</PageSize>\\n <Message>\\"成功\\"</Message>\\n <Version>1.0</Version>\\n <Fatal>false</Fatal>\\n</DescribeApiMeteringResponse>","errorExample":""}]', - 'title' => 'API余量获取', - 'description' => '### **注意: 该接口支持主账号和Ram子账号获取API余量、总量、使用量信息**', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'market.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'market.ap-southeast-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |