全部产品
Search

搜索本产品

    云消息队列 RocketMQ 版：OnsInstanceBaseInfo - 查询实例基本信息和收发消息的接入点

    文档中心

    云消息队列 RocketMQ 版：OnsInstanceBaseInfo - 查询实例基本信息和收发消息的接入点

    更新时间：Dec 03, 2024

    调用OnsInstanceBaseInfo接口查询实例基本信息和收发消息的接入点。

    接口说明

    注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。
    客户端需要通过接入点接入云消息队列 RocketMQ 版完成消息的收发，可通过调用本接口查询实例接入点。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    需查询实例的 ID。

    		MQ_INST_138015630679****_BAAy1Hac

    返回参数

    名称类型描述示例值
    object
    InstanceBaseInfoobject

    实例信息对象。

    Endpointsobject

    各个协议的接入点。

    TcpEndpointstring

    TCP 协议内网接入点。

    		http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
    TcpInternetEndpointstring

    TCP 协议公网接入点。

    • 仅西南１（成都）、华北 1（青岛）或华南 1（深圳）地域的实例支持 TCP 协议公网接入点。
    • 若您需要使用 TCP 协议公网接入点，您需要将客户端 SDK 升级至对应版本：
    • 使用 TCP 协议公网接入点需要收取公网流量费用。具体计费信息，请参见公网流量费用。
    		http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
    HttpInternetEndpointstring

    HTTP 协议公网接入点。

    		http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    HttpInternalEndpointstring

    HTTP 协议内网接入点。

    		http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
    HttpInternetSecureEndpointstring

    HTTPS 协议公网接入点。

    		https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    IndependentNamingboolean

    实例是否有命名空间。取值说明如下：

    • true：拥有独立命名空间，资源命名确保实例内唯一，跨实例之间可重名。

    • false：无独立命名空间，实例内或者跨实例之间，资源命名必须全局唯一。

    		true
    MaxTpslong

    消息收发 TPS 上限。取值如下： 5000、10000、20000、50000、100000、200000、300000、500000、800000、1000000。

    详细的解释以购买页的说明为准。

    说明 该参数仅适用于云消息队列 RocketMQ 版铂金版实例。
    		10000
    Remarkstring

    备注。

    		ons-cn-m7r1r5f****
    InstanceNamestring

    实例名称。

    长度限制为 3～64 个字符，可以是中文、英文、数字、短划线（-）以及下划线（_）。

    		test
    ReleaseTimelong

    铂金版实例过期时间。

    		1603555200000
    TopicCapacityinteger

    该实例下允许创建的 Topic 数量上限。取值如下： 25、50、100、300、500。

    说明 该参数仅适用于云消息队列 RocketMQ 版铂金版实例。
    		50
    InstanceStatusinteger

    实例状态。取值说明如下：

    • 0：铂金版实例部署中

    • 2：标准版实例已欠费

    • 5：标准版实例或铂金版实例服务中

    • 7：铂金版实例升级中且服务可用

    		5
    InstanceIdstring

    实例 ID。

    		MQ_INST_138015630679****_BAAy1Hac
    InstanceTypeinteger

    实例类型。取值说明如下：

    • 1：标准版（后付费）实例

    • 2：铂金版（包年包月）实例

    云消息队列 RocketMQ 版的实例类型和规格信息，请参见实例规格。

    		2
    CreateTimestring

    实例的创建时间。 该参数值的格式为毫秒级 Unix 时间戳。

    		1570701259403
    spInstanceIdstring

    实例的商品售卖 ID。

    		ons-cn-m7r1r5f****
    spInstanceTypeinteger

    实例的售卖类型。

    枚举值：
    • 1：标准版（后付费）实例。
    • 2：铂金版（包年包月）实例。
    		1
    RequestIdstring

    公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。

    		6CC46974-65E8-4C20-AB07-D20D102E****

    示例

    正常返回示例

    JSON格式

    {
  "InstanceBaseInfo": {
    "Endpoints": {
      "TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "TcpInternetEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80",
      "HttpInternetEndpoint": "http://138015630679****.mqrest.cn-chengdu.aliyuncs.com",
      "HttpInternalEndpoint": "http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com",
      "HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-chengdu.aliyuncs.com"
    },
    "IndependentNaming": true,
    "MaxTps": 10000,
    "Remark": "ons-cn-m7r1r5f****",
    "InstanceName": "test",
    "ReleaseTime": 1603555200000,
    "TopicCapacity": 50,
    "InstanceStatus": 5,
    "InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType": 2,
    "CreateTime": "1570701259403",
    "spInstanceId": "ons-cn-m7r1r5f****",
    "spInstanceType": 1
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-09-14OpenAPI 返回结构发生变更查看变更详情
    2022-09-14OpenAPI 返回结构发生变更查看变更详情
    2021-09-14OpenAPI 返回结构发生变更查看变更详情