查詢用戶代金券信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ExpiryTimeEnd | string | 否 | 代金券終止過期時間，格式：yyyy-MM-ddTHH:mm:ssZ | 2018-08-01T00:00:00Z |
| ExpiryTimeStart | string | 否 | 代金券起始過期時間，格式：yyyy-MM-ddTHH:mm:ssZ | 2018-09-01T00:00:00Z |
| EffectiveOrNot | boolean | 否 | 代金券是否生效。取值范圍：
| true |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "Success",
"Message": "Successful！",
"RequestId": "147B566E-DB4C-4E43-BDBB-5DB1D9D268DB",
"Success": true,
"Data": {
"CashCoupon": [
{
"Status": "Available",
"ExpiryTime": "2018-08-10T00:00:00Z",
"GrantedTime": "2018-08-02T15:15:50Z",
"NominalValue": "100.00",
"EffectiveTime": "2018-08-02T15:15:50Z",
"ApplicableScenarios": "阿里云按量付費賬單,阿里云新購",
"CashCouponId": 34534253254325,
"ApplicableProducts": "通用",
"CashCouponNo": "Q-b1485def8f04a",
"Balance": "100.00",
"Description": "該代金券用于產品功能驗證的測試"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 400 | NotApplicable | This API is not applicable for caller. |
| 400 | NotAuthorized | This API is not authorized for caller. |
| 400 | MissingParameter | Some parameters arte mandatoryfor this request. |
| 400 | InvalidParameter | Some parameter sare not valid. |
| 400 | InvalidOwner | The specifiedowner doesn’t belong to caller |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
| 500 | UndefinedError | The request processing has failed due to some unknown error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-19 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |