全部產品
Search
文件中心

Simple Message Queue (formerly MNS):ChangeMessageVisibility

更新時間:Oct 25, 2024

調用ChangeMessageVisibility介面,修改被消費過並且還處於Inactive狀態的訊息與其下次可被消費的時間間隔。

授權資訊

預設僅限阿里雲帳號使用本介面,RAM使用者只有在被授予了相關API操作許可權後方可使用。本介面的授權資訊如下表所示。更多資訊,請參見授權策略和樣本

Name

Value

API

ChangeMessageVisibility

RAM授權操作

mns:ChangeMessageVisibility

資源

acs:mns:$region:$accountid:/queues/$queueName/messages

請求訊息

請求訊息由請求行、URL參數、HTTP頭和訊息體四部分組成:

  • 請求行

    PUT /queues/$queueName/messages?receiptHandle=<receiptHandle>&visibilityTimeout=<visibilitytimeout> HTTP/1.1

  • URI參數

    參數名稱

    類型

    是否必選

    樣本值

    描述

    ReceiptHandle

    String

    MbZj6wDWli+QEauMZc8ZRv37sIW2iJKq3M9Mx/KSbkJ0

    上次消費後返回的訊息的ReceiptHandle。更多資訊,請參見ReceiveMessage

    VisibilityTimeout

    Integer

    50

    將訊息的可見度逾時時間設定為當前入參值,單位:秒。

    取值範圍 [1, 43200]秒,即1秒~12小時。

  • 特有Request Header

    無。

  • Request Body

    無。

返回訊息

返回訊息由返回狀態行、HTTP頭和訊息體三部分組成:

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    無。

  • Response Body

    參數名稱

    類型

    樣本值

    說明

    ReceiptHandle

    String

    TbZj6wDWli+9CEauMZc8ZRv37sIW2iJKq3M9Mx/TS1

    本次修改訊息VisibilityTimeout時返回的臨時控制代碼,用於刪除和修改狀態為Inactive的訊息,在NextVisibleTime時間之前有效。

    NextVisibleTime

    Long

    1250700979298000

    下次可被再次消費的時間,取值為從1970年01月01日00:00:00 000開始的毫秒數。

樣本

請求樣本:

PUT /queues/$queueName/messages
?receiptHandle=MbZj6wDWli+QEauMZc8ZRv37sIW2iJKq3M9Mx/KSbkJ0&visibilityTimeout=50 HTTP/1.1
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 28 May 2012 22:32:00 GMT
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXA****           

返回樣本:

HTTP/1.1 200 OK
x-mns-request-id:512B2A634403E52B1956****
x-mns-version: 2015-06-06

<?xml version="1.0" encoding="UTF-8"?>
<ChangeVisibility xmlns="http://mns.aliyuncs.com/doc/v1/">
    <ReceiptHandle>TbZj6wDWli+9CEauMZc8ZRv37sIW2iJKq3M9Mx/TS1</ReceiptHandle >
    <NextVisibleTime>1250700979298000</NextVisibleTime>
</ChangeVisibility>            

錯誤碼

錯誤碼錯誤資訊HTTP狀態代碼描述內容
InvalidArgumentThe value of Element should between Low and High seconds/bytes.400參數值非法,請根據提示調整。
ReceiptHandleErrorThe receipt handle you provide is not valid.400請求參數不合法。
QueueNotExistThe queue name you provided is not exist.404隊列不存在,請先建立隊列。
MessageNotExistThe receipt handle you provided has expired.404消費訊息過慢導致訊息重新回到隊列產生新的ReceiptHandle,之前的ReceiptHandle失效。請加快消費速度或者增加隊列的不可見時間。