Query Details of CRS Order

Last updated: 2020-06-04 18:19:42

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new Redis API 3.0 which is standardized and faster.

    1. API Description

    This API (DescribeRedisDealDetail) is used to query the details of an order.
    Domain name for API request: redis.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called.The Action field for this API is DescribeRedisDealDetail.

    Parameter Name Required Type Description
    dealIds.n Yes String An array of order numbers, with the array subscript starting from 0

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed.
    message String Error message description. A null value indicates a success
    codeDesc String Description of error code at business side. For a successful operation, "Success" will be returned. In case of an error, a message describing the reason for the error will be returned.
    dealDetails Array Returned array of orders

    Array dealDetails is composed as follows:

    Parameter Name Type Description
    dealDetails.dealId String Order ID. Use this ID when calling the cloud API
    dealDetails.dealName String Long order ID. Use this ID when reporting the order-related problems to customer service
    dealDetails.zoneId Int ID of availability zone
    dealDetails.goodsNum Int Number of instances associated with the order
    dealDetails.creater String UIN of creator
    dealDetails.creatTime String Creation time of order
    dealDetails.overdueTime String Expiration time of order
    dealDetails.endTime String Completion time of order
    dealDetails.status Int Order status
    1: Unpaid
    2: Paid, Undelivered
    3: Delivering
    4: Delivery succeeded
    5: Delivery failed
    6: Refunded
    7: Order closed
    8: Order expired
    9: Order invalidated
    10: Product invalidated
    11: Payment by agent rejected
    12: Payment is in progress
    dealDetails.description String Description of order status
    dealDetails.price Int Actual total price of order (in 0.01 CNY)
    dealDetails.goodsDetail Array Returned array. goodsDetail varies with different orders

    goodsDetail array of created instance:

    Parameter Name Type Description
    memSize int Capacity of instance (in MB)
    timeSpan int Purchased usage period. The unit is subject to timeUnit
    timeUnit String Unit of purchased usage period. m - month, d - day
    redisIds Array List of associated redisIds

    goodsDetail array of renewed instance:

    Parameter Name Type Description
    curDeadline String Expiration time of instance before renewal
    memSize int Capacity of instance (in MB)
    timeSpan int Purchased usage period. The unit is subject to timeUnit
    timeUnit String Unit of purchased usage period. m - month, d - day
    redisIds Array List of associated redisIds

    goodsDetail array of upgraded instance:

    Parameter Name Type Description
    oldMemSize int Capacity of instance before upgrade (in MB)
    newMemsize int Capacity of instance after upgrade (in MB)
    redisIds Array List of associated redisIds

    4. Error Codes

    The following error codes include the business logic error codes for this API.

    Error Code Error Message Error Description
    11059 DealIdNotFound Order ID does not exist

    5. Example

    Input

    https://redis.api.qcloud.com/v2/index.php?Action=DescribeRedisDealDetail
    &dealIds.0=432583
    &dealIds.1=432586
    &dealIds.2=432587
    

    Output

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "dealDetails": [
            {
                "dealId": "432583",
                "dealName": "20160712110021",
                "zoneId": 100002,
                "goodsNum": 1,
                "creater": "3227991405",
                "creatTime": "2016-07-12 21:10:11",
                "overdueTime": "2016-07-27 21:10:11",
                "endTime": "2016-07-12 21:11:17",
                "status": 4,
                "description": "Delivery succeeded",
                "price": 16000,
                "goodsDetail": {
                    "memSize": 1024,
                    "timeSpan": 2,
                    "timeUnit": "m",
                    "redisIds": [
                        "crs-ifmymj41"
                    ]
                }
            },
            {
                "dealId": "432586",
                "dealName": "20160712110027",
                "zoneId": 100002,
                "goodsNum": 1,
                "creater": "3227991405",
                "creatTime": "2016-07-12 22:05:43",
                "overdueTime": "2016-07-27 22:05:43",
                "endTime": "2016-07-12 22:05:45",
                "status": 4,
                "description": "Delivery succeeded",
                "price": 8000,
                "goodsDetail": {
                    "curDeadline": "2016-09-12 21:10:13",
                    "memSize": 1024,
                    "timeSpan": 1,
                    "timeUnit": "m",
                    "redisIds": [
                        "crs-ifmymj41"
                    ]
                }
            },
            {
                "dealId": "432587",
                "dealName": "20160712110029",
                "zoneId": 100002,
                "goodsNum": 1,
                "creater": "3227991405",
                "creatTime": "2016-07-12 22:15:55",
                "overdueTime": "2016-07-27 22:15:55",
                "endTime": "2016-07-12 22:16:59",
                "status": 4,
                "description": "Delivery succeeded",
                "price": 24460,
                "goodsDetail": {
                    "oldMemSize": 1024,
                    "newMemsize": 2048,
                    "redisIds": [
                        "crs-ifmymj41"
                    ]
                }
            }
        ]
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help