调用 DescribeProduct 用于查询指定商品的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeProduct |
系统规定参数。取值:DescribeProduct。 |
AliUid | String | 否 | 190********569 |
AliUid |
Code | String | 是 | cmjj01**45 |
商品对应商品码 |
QueryDraft | Boolean | 否 | false |
是否查询商品草稿,通常不需要查询商品草稿,商品草稿适用于在商品正式上架售卖之前查询。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
FrontCategoryId | Long | 523617212 |
商品类目 ID |
Status | String | 1 |
已废弃 |
Type | String | MIRROR |
商品类型。取值:
|
PicUrl | String | https://oss.aliyuncs.com/photogallery/photo/1930532890589852/6245/495d5f19-03e4-4c2e-9c4e-bef9ab6af1e1.png |
商品图片 URL |
Score | Float | 5.0 |
商品评分 |
UseCount | Long | 10 |
使用计数 |
GmtModified | Long | 1578931200000 |
更改时间 |
SupplierPk | Long | 1526111111**** |
服务商 UID |
GmtCreated | Long | 1578931200000 |
创建时间 |
RequestId | String | 6EF60BEC-0242-43AF-BB20-270359FB54A7 |
请求 ID |
ShortDescription | String | 该镜像为LNMP(Ubuntu16.04 64位+Nginx+MySQL5.6+PHP5.3) |
商品简介 |
Description | String | <div>基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!</div> |
商品详情描述,支持 HTML。 |
Code | String | cmjj01**45 |
商品对应商品码 |
AuditFailMsg | String | 功能验收不通过 |
审核失败原因,QueryDraft = true 时返回。 |
Name | String | LNMP环境(Ubuntu16.04 Nginx PHP5.3) |
商品名称 |
AuditTime | Long | 1581609600000 |
审核时间,QueryDraft = true 时返回。 |
AuditStatus | String | function_fail |
审核状态,QueryDraft = true 时返回。
|
ShopInfo | Object |
店铺信息 |
|
Name | String | **科学公司 |
店铺名称 |
Emails | String | 46**41@example.com |
邮箱 |
Id | Long | 123 |
店铺 ID |
WangWangs | Array of WangWang |
旺旺 |
|
WangWang | |||
Remark | String | 123 |
备注 |
UserName | String | ABC |
旺旺用户名 |
Telephones | Array of String | {1386658****, 1386658****} |
电话 |
ProductSkus | Array of ProductSku |
商品规格信息 |
|
ProductSku | |||
Hidden | Boolean | true |
是否隐藏 |
Code | String | cmjj01****-Package |
规格码 |
Constraints | String | {\"img_id\":{\"img_version|img_region\":{\"V1.7|cn-shenzhen-st3-a01\":[\"m-wz9ho4hmos0lpxcldqoq\"]}} |
规格模块约束,支持 JSON 格式。 |
Name | String | 21 |
规格名称 |
ChargeType | String | PREPAY |
付费方式:
|
OrderPeriods | Array of OrderPeriod |
可订购周期 |
|
OrderPeriod | |||
Name | String | 小时 |
订购周期名称 |
PeriodType | String | HOUR |
预付费时间单位 |
Modules | Array of Module |
规格模块信息 |
|
Module | |||
Code | String | img_id |
规格模块 Code |
Name | String | 镜像ID |
模块名称 |
Id | String | 248220 |
模块 ID |
Properties | Array of Property |
模块可选值 |
|
Property | |||
Key | String | img_id |
英文名称 |
ShowType | String | number |
展示样式类型。取值:
|
Name | String | 镜像ID |
中文名称 |
DisplayUnit | String | 1 |
显示单位 |
PropertyValues | Array of PropertyValue |
属性值 |
|
PropertyValue | |||
DisplayName | String | 华北 1_V1.1 |
展示名称 |
Type | String | single_string |
属性值类型 |
Step | String | 1 |
步进 |
Value | String | m-28e213e7t |
属性值 |
Max | String | 123 |
最大 |
Remark | String | abc |
备注 |
Min | String | 11 |
最小 |
ProductExtras | Array of ProductExtra |
商品附加信息:
|
|
ProductExtra | |||
Type | String | HTML |
扩展项类型:
|
Key | String | product_advantage |
扩展项英文标识 |
Label | String | 产品亮点 |
扩展项中文标识 |
Order | Integer | 0 |
排序 |
Values | String | \"1. 基于阿里云(Ubuntu16.04 64位)系统源码安装,安全、稳定、高效!\" |
扩展项数据值 |
示例
请求示例
https://market.aliyuncs.com/?Action=DescribeProduct
&Code=cmjj01****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeProductResponse>
<Description><p>aaa</p></Description>
<Type>APP</Type>
<PicUrl>https://photogallery.oss.aliyuncs.com/photo/1666562244190862/17909/ce4e8f40-1d3e-465d-b884-f78a432cde81.jpg</PicUrl>
<Code>cmgj02****</Code>
<ProductExtras>
<ProductExtra>
<Values>"aaa"</Values>
<Key>product_advantage</Key>
<Type>HTML</Type>
<Order>0</Order>
<Label>产品亮点</Label>
</ProductExtra>
<ProductExtra>
<Values>
<Value>["Windows"]</Value>
<Label>适用系统版本</Label>
</Values>
<Values>
<Value>aa</Value>
<Label>版本号</Label>
</Values>
<Values>
<Value>应用软件类</Value>
<Label>交付方式</Label>
</Values>
<Key>product_param</Key>
<Type>LIST</Type>
<Order>15</Order>
<Label>产品参数</Label>
</ProductExtra>
</ProductExtras>
<Name>V3【回归】服务类-按周期</Name>
<ShortDescription>aaa</ShortDescription>
<ShopInfo>
<Telephones>
<Telephone>1581016*****</Telephone>
</Telephones>
<Name>****有限公司测试</Name>
<Emails>***.dxz@***.com</Emails>
<WangWangs>
<WangWang>
<UserName>凌鲲</UserName>
<Remark>凌鲲</Remark>
</WangWang>
</WangWangs>
<Id>1597411</Id>
</ShopInfo>
<ProductSkus>
<ProductSku>
<ChargeType>PREPAY</ChargeType>
<Name>预付费</Name>
<OrderPeriods>
<OrderPeriod>
<Name>一年</Name>
<PeriodType>YEAR</PeriodType>
</OrderPeriod>
</OrderPeriods>
<Modules>
<Module>
<Name>几号数</Name>
<Id>1018040000484633</Id>
<Code>AC</Code>
<Properties>
<Property>
<Name>几号数</Name>
<Key>AC</Key>
<DisplayUnit>个</DisplayUnit>
<PropertyValues>
<PropertyValue>
<Step>1</Step>
<Type>range_float</Type>
<Max>999</Max>
<Min>1</Min>
</PropertyValue>
<PropertyValue>
<Step>1</Step>
<Type>range_float</Type>
<Max>999999999999999</Max>
<Min>999</Min>
</PropertyValue>
</PropertyValues>
<ShowType>number</ShowType>
</Property>
</Properties>
</Module>
<Module>
<Name>购买个数</Name>
<Id>1018040000484634</Id>
<Code>order_num</Code>
<Properties>
<Property>
<Name>购买个数</Name>
<Key>order_num</Key>
<DisplayUnit/>
<PropertyValues>
<PropertyValue>
<Step>1</Step>
<Type>range_float</Type>
<Max>100</Max>
<Min>1</Min>
</PropertyValue>
</PropertyValues>
<ShowType>number</ShowType>
</Property>
</Properties>
</Module>
<Module>
<Name>购买时长</Name>
<Id>1018040000484740</Id>
<Code>ord_time</Code>
<Properties>
<Property>
<Name>购买时长</Name>
<Key>ord_time</Key>
<DisplayUnit/>
<PropertyValues>
<PropertyValue>
<Value>1:Month</Value>
<Type>single_string</Type>
<DisplayName>1个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>2:Month</Value>
<Type>single_string</Type>
<DisplayName>2个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>3:Month</Value>
<Type>single_string</Type>
<DisplayName>3个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>4:Month</Value>
<Type>single_string</Type>
<DisplayName>4个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>5:Month</Value>
<Type>single_string</Type>
<DisplayName>5个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>6:Month</Value>
<Type>single_string</Type>
<DisplayName>6个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>7:Month</Value>
<Type>single_string</Type>
<DisplayName>7个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>8:Month</Value>
<Type>single_string</Type>
<DisplayName>8个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>9:Month</Value>
<Type>single_string</Type>
<DisplayName>9个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>10:Month</Value>
<Type>single_string</Type>
<DisplayName>10个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>11:Month</Value>
<Type>single_string</Type>
<DisplayName>11个月</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>1:Year</Value>
<Type>single_string</Type>
<DisplayName>1年</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>2:Year</Value>
<Type>single_string</Type>
<DisplayName>2年</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>3:Year</Value>
<Type>single_string</Type>
<DisplayName>3年</DisplayName>
</PropertyValue>
</PropertyValues>
<ShowType>radio</ShowType>
</Property>
</Properties>
</Module>
<Module>
<Name>套餐配置</Name>
<Id>1018040000484632</Id>
<Code>package_config</Code>
<Properties>
<Property>
<Name>套餐配置</Name>
<Key>package_config</Key>
<DisplayUnit/>
<PropertyValues>
<PropertyValue>
<Value>yuncode2138100001</Value>
<Type>single_string</Type>
<DisplayName>{"frontShow":true}</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>yuncode2138100002</Value>
<Type>single_string</Type>
<DisplayName>{"frontShow":true}</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>yuncode2138100003</Value>
<Type>single_string</Type>
<DisplayName>{"frontShow":true}</DisplayName>
</PropertyValue>
</PropertyValues>
<ShowType>string</ShowType>
</Property>
</Properties>
</Module>
<Module>
<Name>套餐版本</Name>
<Id>1018040000484631</Id>
<Code>package_version</Code>
<Properties>
<Property>
<Name>套餐版本</Name>
<Key>package_version</Key>
<DisplayUnit/>
<PropertyValues>
<PropertyValue>
<Value>yuncode2138100001</Value>
<Type>single_string</Type>
<DisplayName>月版</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>yuncode2138100002</Value>
<Type>single_string</Type>
<DisplayName>年版</DisplayName>
</PropertyValue>
<PropertyValue>
<Value>yuncode2138100003</Value>
<Type>single_string</Type>
<DisplayName>年月版</DisplayName>
</PropertyValue>
</PropertyValues>
<ShowType>radio</ShowType>
</Property>
</Properties>
</Module>
</Modules>
<Constraints>{"AC":{"package_version":{"yuncode2138100003":[{"min":1,"max":999999999999999,"step":1}]}},"ord_time":{"package_version":{"yuncode2138100001":["1:Month","2:Month","3:Month","4:Month","5:Month","6:Month","7:Month","8:Month","9:Month","10:Month","11:Month"],"yuncode2138100002":["1:Year","2:Year","3:Year"],"yuncode2138100003":["1:Month","2:Month","3:Month","4:Month","5:Month","6:Month","7:Month","8:Month","9:Month","10:Month","11:Month","1:Year","2:Year","3:Year"]}}}</Constraints>
<Hidden>false</Hidden>
<Code>cmgj02****-prepay</Code>
</ProductSku>
</ProductSkus>
<Score>0</Score>
<SupplierPk>152611111****</SupplierPk>
<FrontCategoryId>523617212</FrontCategoryId>
</DescribeProductResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Description" : "<p>aaa</p>",
"Type" : "APP",
"PicUrl" : "https://photogallery.oss.aliyuncs.com/photo/1666562244190862/17909/ce4e8f40-1d3e-465d-b884-f78a432cde81.jpg",
"Code" : "cmgj02****",
"ProductExtras" : {
"ProductExtra" : [ {
"Values" : "\"aaa\"",
"Key" : "product_advantage",
"Type" : "HTML",
"Order" : 0,
"Label" : "产品亮点"
}, {
"Values" : [ {
"Value" : "[\"Windows\"]",
"Label" : "适用系统版本"
}, {
"Value" : "aa",
"Label" : "版本号"
}, {
"Value" : "应用软件类",
"Label" : "交付方式"
} ],
"Key" : "product_param",
"Type" : "LIST",
"Order" : 15,
"Label" : "产品参数"
} ]
},
"Name" : "V3【回归】服务类-按周期",
"ShortDescription" : "aaa",
"ShopInfo" : {
"Telephones" : {
"Telephone" : "1581016*****"
},
"Name" : "****有限公司测试",
"Emails" : "***.dxz@***.com",
"WangWangs" : {
"WangWang" : {
"UserName" : "凌鲲",
"Remark" : "凌鲲"
}
},
"Id" : 1597411
},
"ProductSkus" : {
"ProductSku" : {
"ChargeType" : "PREPAY",
"Name" : "预付费",
"OrderPeriods" : {
"OrderPeriod" : {
"Name" : "一年",
"PeriodType" : "YEAR"
}
},
"Modules" : {
"Module" : [ {
"Name" : "几号数",
"Id" : 1018040000484633,
"Code" : "AC",
"Properties" : {
"Property" : {
"Name" : "几号数",
"Key" : "AC",
"DisplayUnit" : "个",
"PropertyValues" : {
"PropertyValue" : [ {
"Step" : 1,
"Type" : "range_float",
"Max" : 999,
"Min" : 1
}, {
"Step" : 1,
"Type" : "range_float",
"Max" : 999999999999999,
"Min" : 999
} ]
},
"ShowType" : "number"
}
}
}, {
"Name" : "购买个数",
"Id" : 1018040000484634,
"Code" : "order_num",
"Properties" : {
"Property" : {
"Name" : "购买个数",
"Key" : "order_num",
"DisplayUnit" : "",
"PropertyValues" : {
"PropertyValue" : {
"Step" : 1,
"Type" : "range_float",
"Max" : 100,
"Min" : 1
}
},
"ShowType" : "number"
}
}
}, {
"Name" : "购买时长",
"Id" : 1018040000484740,
"Code" : "ord_time",
"Properties" : {
"Property" : {
"Name" : "购买时长",
"Key" : "ord_time",
"DisplayUnit" : "",
"PropertyValues" : {
"PropertyValue" : [ {
"Value" : "1:Month",
"Type" : "single_string",
"DisplayName" : "1个月"
}, {
"Value" : "2:Month",
"Type" : "single_string",
"DisplayName" : "2个月"
}, {
"Value" : "3:Month",
"Type" : "single_string",
"DisplayName" : "3个月"
}, {
"Value" : "4:Month",
"Type" : "single_string",
"DisplayName" : "4个月"
}, {
"Value" : "5:Month",
"Type" : "single_string",
"DisplayName" : "5个月"
}, {
"Value" : "6:Month",
"Type" : "single_string",
"DisplayName" : "6个月"
}, {
"Value" : "7:Month",
"Type" : "single_string",
"DisplayName" : "7个月"
}, {
"Value" : "8:Month",
"Type" : "single_string",
"DisplayName" : "8个月"
}, {
"Value" : "9:Month",
"Type" : "single_string",
"DisplayName" : "9个月"
}, {
"Value" : "10:Month",
"Type" : "single_string",
"DisplayName" : "10个月"
}, {
"Value" : "11:Month",
"Type" : "single_string",
"DisplayName" : "11个月"
}, {
"Value" : "1:Year",
"Type" : "single_string",
"DisplayName" : "1年"
}, {
"Value" : "2:Year",
"Type" : "single_string",
"DisplayName" : "2年"
}, {
"Value" : "3:Year",
"Type" : "single_string",
"DisplayName" : "3年"
} ]
},
"ShowType" : "radio"
}
}
}, {
"Name" : "套餐配置",
"Id" : 1018040000484632,
"Code" : "package_config",
"Properties" : {
"Property" : {
"Name" : "套餐配置",
"Key" : "package_config",
"DisplayUnit" : "",
"PropertyValues" : {
"PropertyValue" : [ {
"Value" : "yuncode2138100001",
"Type" : "single_string",
"DisplayName" : "{\"frontShow\":true}"
}, {
"Value" : "yuncode2138100002",
"Type" : "single_string",
"DisplayName" : "{\"frontShow\":true}"
}, {
"Value" : "yuncode2138100003",
"Type" : "single_string",
"DisplayName" : "{\"frontShow\":true}"
} ]
},
"ShowType" : "string"
}
}
}, {
"Name" : "套餐版本",
"Id" : 1018040000484631,
"Code" : "package_version",
"Properties" : {
"Property" : {
"Name" : "套餐版本",
"Key" : "package_version",
"DisplayUnit" : "",
"PropertyValues" : {
"PropertyValue" : [ {
"Value" : "yuncode2138100001",
"Type" : "single_string",
"DisplayName" : "月版"
}, {
"Value" : "yuncode2138100002",
"Type" : "single_string",
"DisplayName" : "年版"
}, {
"Value" : "yuncode2138100003",
"Type" : "single_string",
"DisplayName" : "年月版"
} ]
},
"ShowType" : "radio"
}
}
} ]
},
"Constraints" : "{\"AC\":{\"package_version\":{\"yuncode2138100003\":[{\"min\":1,\"max\":999999999999999,\"step\":1}]}},\"ord_time\":{\"package_version\":{\"yuncode2138100001\":[\"1:Month\",\"2:Month\",\"3:Month\",\"4:Month\",\"5:Month\",\"6:Month\",\"7:Month\",\"8:Month\",\"9:Month\",\"10:Month\",\"11:Month\"],\"yuncode2138100002\":[\"1:Year\",\"2:Year\",\"3:Year\"],\"yuncode2138100003\":[\"1:Month\",\"2:Month\",\"3:Month\",\"4:Month\",\"5:Month\",\"6:Month\",\"7:Month\",\"8:Month\",\"9:Month\",\"10:Month\",\"11:Month\",\"1:Year\",\"2:Year\",\"3:Year\"]}}}",
"Hidden" : false,
"Code" : "cmgj02****-prepay"
}
},
"Score" : 0,
"SupplierPk" : "152611111****",
"FrontCategoryId" : 523617212
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | DeniedModify | You are not authorized to call the specified API operation. | 没有调用权限 |
500 | UnknownError | An error occurred while processing your request. | 未知错误 |
访问错误中心查看更多错误码。
访问错误中心查看更多错误码。