文档

QueryPrepaidCards - 账户卡包查询

更新时间:
一键部署

查询用户卡包信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:QueryPrepaidCardsREAD
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ExpiryTimeEndstring

卡包过期时间止,格式:yyyy-MM-ddTHH:mm:ssZ。

2018-08-01T00:00:00Z
ExpiryTimeStartstring

卡包过期时间起,格式:yyyy-MM-ddTHH:mm:ssZ。

2018-08-01T00:00:00Z
EffectiveOrNotboolean

卡包是否生效。取值范围:

  • true。
  • false。
true

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful
RequestIdstring

请求 ID。

7EA6C02D-06D0-4213-9C3B-E67910F7D1EB
Successboolean

是否成功。

true
Dataobject []

返回数据。

Statusstring

取值:

  • Available:有效。
  • Expired:过期。
  • Cancelled:作废。
Available
ExpiryTimestring

卡包失效时间。

2019-08-04T01:39:11Z
GrantedTimestring

卡包发放时间。

2018-08-03T01:39:11Z
NominalValuestring

面额。

100.00
EffectiveTimestring

卡包生效时间。

2018-08-03T01:39:11Z
PrepaidCardNostring

卡包编码。

Q-7edaab979fc9
ApplicableScenariosstring

适用场景描述。

test
PrepaidCardIdlong

卡包 ID。

213432432
ApplicableProductsstring

适用产品描述。

通用
Balancestring

剩余金额。

100.00

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "7EA6C02D-06D0-4213-9C3B-E67910F7D1EB",
  "Success": true,
  "Data": {
    "PrepaidCard": [
      {
        "Status": "Available",
        "ExpiryTime": "2019-08-04T01:39:11Z",
        "GrantedTime": "2018-08-03T01:39:11Z",
        "NominalValue": "100.00",
        "EffectiveTime": "2018-08-03T01:39:11Z",
        "PrepaidCardNo": "Q-7edaab979fc9",
        "ApplicableScenarios": "test",
        "PrepaidCardId": 213432432,
        "ApplicableProducts": "通用",
        "Balance": "100.00"
      }
    ]
  }
}

JSON格式

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "7EA6C02D-06D0-4213-9C3B-E67910F7D1EB",
  "Success": true,
  "Data": {
    "PrepaidCard": [
      {
        "Status": "Available",
        "ExpiryTime": "2019-08-04T01:39:11Z",
        "GrantedTime": "2018-08-03T01:39:11Z",
        "NominalValue": "100.00",
        "EffectiveTime": "2018-08-03T01:39:11Z",
        "PrepaidCardNo": "Q-7edaab979fc9",
        "ApplicableScenarios": "test",
        "PrepaidCardId": 213432432,
        "ApplicableProducts": "通用",
        "Balance": "100.00"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400NotApplicableThis API is not applicable for caller.
400NotAuthorizedThis API is not authorized for caller.
400MissingParameter Some parameters arte mandatoryfor this request.
400InvalidParameterSome parameters are not valid.
400InvalidOwnerThe specifiedowner doesn’t belong to caller
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.
500UndefinedErrorThe request processing has failed due to some unknown error.

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈