CreateInstanceIpWhitelist - 建立IP白名單 - ApsaraMQ for RocketMQ

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:CreateInstanceIpWhitelist

create

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求文法

POST /instances/{instanceId}/ip/whitelist HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	rmq-cn-7e22ody****

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求體對象。
ipWhitelists	array	是	IP 白名單列表
	string	是	IP 白名單	0.0.0.0/0

返回參數

名稱	類型	描述	樣本值
	object	Result
requestId	string	請求 ID	A07B41BD-6DD3-5349-9E76-00303DF04BBE
success	boolean	是否成功	true
data	boolean	返回結果	true
code	string	錯誤碼	MissingInstanceId
message	string	錯誤資訊	The instance cannot be found.
httpStatusCode	integer	HTTP 狀態代碼	400
dynamicCode	string	動態錯誤碼	InstanceId
dynamicMessage	string	動態錯誤資訊	InstanceId
accessDeniedDetail	string	訪問拒絕詳細資料，有且僅有在因 RAM 無許可權拒絕使用者訪問的情境	xxx

樣本

正常返回樣本

JSON格式

{
  "requestId": "A07B41BD-6DD3-5349-9E76-00303DF04BBE",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。