文档首页 > > API参考> 附录> 待下线接口> 查询订购关系列表

查询订购关系列表

分享
更新时间: 2020/03/20 GMT+08:00

功能介绍

该接口即将下线。

合作伙伴平台可以调用该接口查询某个客户的订购关系。

注意事项:

该接口既可以使用合作伙伴AK/SK或者Token调用,也可以使用客户Token调用。用合作伙伴自身的AK/SK或者Token调用的情况下,只能查询到客户使用其接受合作伙伴拨款的账户支付的订购关系。

URI

GET /v1.0/{domain_id}/common/order-mgr/subscriptions/detail

表1 URI参数说明

参数

是否必选

取值范围

描述

domain_id

最大长度:64

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

customer_order_id

String

最大长度:64

订单ID。

customer_id

String

最大长度:64

客户ID,获取方法请参见如何获取客户的customer_id/domain_id

cloud_service_type

String

最大长度:100

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

resource_type_code

String

最大长度:100

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。具体请参见资源类型

period_type

Integer

[0-6]

周期类型。

  • 2:月
  • 3:年
  • 5:一次性

be_id

String

最大长度:64

合作伙伴对应的运营实体ID。

请从表4中获取响应参数“beid”的值。

main_subscription_id

String

最大长度:64

主订购关系ID。

subscription_id

String

最大长度:64

订购关系ID。

status

String

最大长度:64

订购关系状态。

  • 1:未生效
  • 2:已生效
  • 3:已过期
  • 4:已冻结
  • 5:宽限期
  • 6:冻结中(预留)
  • 7:冻结恢复中(预留)
  • 8:正在关闭(预留)

subscription_type

Integer

[0-1]

是否只查询主订购关系。

  • 0:同时查主从订购关系
  • 1:只查主订购关系

请求示例

GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/common/order-mgr/subscriptions/detail HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

描述

error_code

String

状态码。

具体请参见状态码

error_msg

String

错误描述信息。

subscriptions

List<SubscriptionModel>

客户订单信息。

具体请参见表2

表2 SubscriptionModel

参数

参数类型

描述

subscriptionId

String

订购关系ID。

customerId

String

客户ID。

parentId

String

父订购关系ID。

azCode

String

可用区域。

status

Integer

订购关系状态。

  • 1:未生效
  • 2:已生效
  • 3:已过期
  • 4:已冻结
  • 5:宽限期
  • 6:冻结中(预留)
  • 7:冻结恢复中(预留)
  • 8:正在关闭(预留)

beId

String

合作伙伴运营实体ID。

与请求参数中的“be_id”一致。

dataCenterId

String

数据中心ID。

regionId

String

区域ID。

regionCode

String

区域代码。

validTime

String

订购关系生效时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

createTime

String

创建时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

lastUpdateTime

String

最近一次修改时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

expireTime

String

订购关系失效时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

nextExpireTime

String

下一个订购关系失效时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

gracePeriodEndtime

String

宽限期截止时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

retentionPeriodEndTime

String

保留期截止时间。

UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。

distributorId

String

分销商ID。

extendParams

String

扩展参数。

expireMode

Integer

到期策略。

cancelFlag

Integer

订购关系退订状态。

mainSubscriptionId

String

主订购关系ID。

chargePolicy

Integer

扣费策略,在周期性扣费的时候使用。

  • 1:期初扣费
  • 2:期末扣费

periodCount

Integer

产品计费周期数目。

chargingMode

Integer

扣费方式。

  • 0:按需扣费
  • 1:包周期计费
  • 3:一次性扣费

periodType

Integer

订购的周期类型。

  • 0:天
  • 1:周
  • 2:月
  • 3:年
  • 4:小时
  • 5:一次性
  • 6:按需
  • 7:按用量报表使用

periodNum

Integer

订购的周期数目。

isLock

Integer

锁定状态。

  • 0:未锁定
  • 1:锁定

lockReasonType

Integer

锁定原因类型。

lockScope

String

锁定范围。

  • 0:ALL
  • 1:续订
  • 2:变更规格
  • 3:变更增加实例
  • 4:退订

zoneId

String

区ID。

expireReason

Integer

到期原因。

autoRenewPeriodType

Integer

自动续订配置的周期类型。

autoRenewPeriodNum

Integer

自动续订配置的周期数。

instanceInfo

Instance

实例信息。

具体请参见表3

表3 Instance

参数

参数类型

描述

services

List<Service>

服务信息。

具体请参见表5

目前预留,实际返回为空。

resources

List<Resource>

资源信息。

具体请参见表4

表4 Resource

参数

参数类型

取值范围

描述

resourceId

String

最大长度:64

最小长度:0

资源ID。

resourceName

String

最大长度:256

最小长度:0

资源名称。

tenantId

String

最大长度:64

最小长度:0

租户ID。

regionId

String

最大长度:64

最小长度:0

区域ID。

cloudServiceType

String

最大长度:100

最小长度:0

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

resourceTypeCode

String

最大长度:64

最小长度:0

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。具体请参见资源类型

resourceSpecCode

String

最大长度:64

最小长度:0

资源规格代码。

extendParams

String

最大长度:4096

最小长度:0

扩展参数。

status

Integer

最大值:8

最小值:1

资源状态。

表5 Service

参数

参数类型

取值范围

描述

serviceId

String

最大长度:64

最小长度:0

服务ID。

serviceCode

String

最大长度:64

最小长度:0

服务代码。

serviceType

String

最大长度:64

最小长度:0

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

resources

List<Resource>

-

资源信息。

具体请参见表4

extendParams

String

最大长度:4096

最小长度:0

扩展参数。

响应示例:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time   

{
    "subscriptions": [
    {
        "subscriptionId": "01154-10000014-0",
        "customerId": "a20481aa3ed244aeb78bd1de705b676d",
        "parentId": null,
        "azCode": null,
        "status": 2,
        "beId": "beid",
        "dataCenterId": "DC0020159904387D34",
        "regionId": "DC00101537847ED673",
        "regionCode": "DC00101537847ED673",
        "validTime": "2017-09-02T15:59:58Z",
        "createTime": "2017-02-26T19:32:51Z",
        "lastUpdateTime": "2017-09-04T12:37:08Z",
        "expireTime": "2019-02-26T15:59:59Z",
        "nextExpireTime": null,
        "gracePeriodEndtime": "2019-02-27T15:59:59Z",
        "retentionPeriodEndTime": "2019-02-28T15:59:59Z",
        "distributorId": "distributeid",
        "extendParams": "",
        "expireMode": 0,
        "cancelFlag": 1,
        "mainSubscriptionId": null,
        "chargePolicy": null,
        "periodCount": null,
        "chargingMode": 1,
        "periodType": 3,
        "periodNum": 2,
        "isLock": 0,
        "lockReasonType": null,
        "lockScope": null,
        "zoneId": null,
        "expireReason": 0,
        "autoRenewPeriodType": null,
        "autoRenewPeriodNum": null,
        "instanceInfo": {
            "services": [],
            "resources": [
            {
                "resourceId": "d9013a46f5b44fd6b3e4ff0ff79a9d34",
                "resourceName": null,
                "tenantId": "b81d6b5543734237b137274192a8fa98",
                "regionId": "DC00101537847ED673",
                "cloudServiceType": "hws.service.type.dec",
                "resourceTypeCode": "hws.resource.type.vpc",
                "resourceSpecCode": null,
                "extendParams": null,
                "status": 1
            }
            ]
        }
    }

    ],
    "error_code": "CBC.0000",
    "error_msg": "Success"
}

状态码

状态码

描述

CBC.0000

成功

CBC.0999

其他错误

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区