文档首页/ 交换数据空间 EDS/ API参考/ API/ 订阅管理/ 我的订阅
更新时间：2024-11-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

我的订阅

功能介绍

我的订阅。

URI

GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参考获取项目ID。

instance_id

是

String

实例ID，开通的交换数据平台实例ID。

获取方法请参考获取实例ID。

connector_id

是

String

连接器ID，指定交换数据平台下连接器的ID。

获取方法请参考获取连接器ID。
表2 Query参数

参数

是否必选

参数类型

描述

subscription_id

否

String

订阅ID。

参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。

status

否

String

审批状态。

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

  • 最小值：0
  • 最大值：999999
  • 缺省值：0

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。

  • 最小值：1
  • 最大值：999
  • 缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

Array of SubscriptionResponse objects

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表5 SubscriptionResponse

参数

参数类型

描述

offer_id

String

Offer ID。

offer_name

String

Offer名称。

subscription_id

String

订阅返回ID。

subscription_reason

String

订阅理由。

status

String

订阅状态：

  • WAIT_TO_APPROVE：待审批
  • REJECTED：已驳回
  • PASSED：已通过
  • REVOKED：已撤销

枚举值：

  • WAIT_TO_APPROVE
  • REJECTED
  • PASSED
  • REVOKED

create_time

String

创建时间。

creator

String

创建人。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

Object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

data

Object

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

我的订阅。

GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions?offset=0&limit=10

响应示例

状态码： 200

OK

  • 订阅列表。 
    {
  "data" : [ {
    "offer_id" : "6168c382-5184-4ec8-8a04-************",
    "offer_name" : "offer-mysql-20231129AA",
    "subscription_id" : "90bedec2-2efc-41d4-8223-************",
    "subscription_reason" : "Subscribe by OpenApi.",
    "status" : "WAIT_TO_APPROVE",
    "create_time" : "2023-12-01T17:53:03Z",
    "creator" : "************"
  }, {
    "offer_id" : "b74b4c6b-0c00-4a9d-86c3-************",
    "offer_name" : "offer-mysql-20231129AA",
    "subscription_id" : "7343b305-75f9-4979-ade0-************",
    "subscription_reason" : "Subscribe by OpenApi.",
    "status" : "WAIT_TO_APPROVE",
    "create_time" : "2023-12-01T17:47:23Z",
    "creator" : "************"
  } ],
  "total" : 2,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 订阅管理

相关文档