文档中心

消息队列 RocketMQ版

终端节点服务

CreatePrivateLink - 创建私网连接终端节点服务

调用 CreatePrivateLink 接口创建私网连接终端节点服务。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreatePrivateLink

要执行的操作，取值：CreatePrivateLink。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnngndgwer232****

RocketMQ 实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：rocketmq-cnngndgwer232****

RocketMQ 实例 ID。

PrivateLinkId string 示例值：epsvc-2fe630gurkl37k5gf****

终端节点服务 ID。

请求示例

POST /?Action=CreatePrivateLink&Version=2023-01-01 HTTP/1.1​
Host: rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260525T022909Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260525/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-cnngndgwer232****"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260525102914151097210053EA9424",​
    "Action": "CreatePrivateLink",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "InstanceId": "rocketmq-cnngndgwer232****",​
    "PrivateLinkId": "epsvc-2fe630gurkl37k5gf****"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPara	The specified parameter is not valid.	参数值无效。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.06.01 11:01:38

这个页面对您有帮助吗？

有用

无用