Alibaba Cloud アカウント配下の Topic を照会します。クエリ結果はページ分割できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
mns:ListTopic |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNum |
integer |
任意 |
返される結果のページ番号。有効な値: 1 ~ 100000000。指定値が 1 未満の場合、デフォルト値は 1 になります。指定値が 100000000 を超える場合、デフォルト値は 100000000 になります。 |
1 |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。有効な値: 10 ~ 50。指定値が 10 未満の場合、デフォルト値は 10 になります。指定値が 50 を超える場合、デフォルト値は 50 になります。 |
20 |
| TopicName |
string |
任意 |
Topic 名。 |
test |
| Tag |
array<object> |
任意 |
タグのリスト。 |
|
|
object |
任意 |
タグキーに対応するタグ値。 |
||
| Key |
string |
任意 |
タグキー。 |
tag1 |
| Value |
string |
任意 |
タグ値。 |
test |
| TopicType |
string |
任意 |
Topic のタイプ。有効な値:
|
normal |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
06273500-249F-5863-121D-74D51123**** |
| Code |
integer |
応答コード。 |
200 |
| Status |
string |
応答のステータス。 |
Success |
| Message |
string |
応答メッセージ。 |
operation success |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| Data |
object |
応答データ。 |
|
| PageNum |
integer |
返される結果のページ番号。 |
1 |
| PageSize |
integer |
各ページに返されるエントリ数。 |
50 |
| Total |
integer |
結果の総数。 |
130 |
| PageData |
array<object> |
現在のページに返される結果。 |
|
|
array<object> |
データ項目。 |
||
| TopicName |
string |
Topic 名。 |
demo-topic |
| MessageCount |
integer |
Topic 内のメッセージ数。 |
0 |
| MaxMessageSize |
integer |
Topic に送信できるメッセージ本文の長さの最大値。単位: バイト。 |
65536 |
| MessageRetentionPeriod |
integer |
Topic 内のメッセージの保持期間の最大値。メッセージが Topic に送信された時間から指定された期間が経過すると、ユーザーへのプッシュが成功したかどうかに関係なく、メッセージは削除されます。単位: 秒。 |
86400 |
| CreateTime |
integer |
Topic が作成された時間。値は、協定世界時 (UTC) の UNIX タイムスタンプ (秒単位) です。 |
1449554962 |
| LastModifyTime |
integer |
Topic の属性が最後に変更済みとなった時間。値は、協定世界時 (UTC) の UNIX タイムスタンプ (秒単位) です。 |
1449554962 |
| LoggingEnabled |
boolean |
ログ管理特徴が有効かどうかを示します。有効な値:
|
True |
| TopicUrl |
string |
Topic の URL。 |
http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic |
| TopicInnerUrl |
string |
Topic の内部 URL。 |
http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic |
| Tags |
array<object> |
リソースタグのリスト。 |
|
|
object |
タグキーに対応するタグ値。 |
||
| TagKey |
string |
タグキー。 |
tag1 |
| TagValue |
string |
タグ値。 |
test |
| TopicType |
string |
Topic のタイプ。有効な値:
|
normal |
| EnableSSE |
boolean |
サーバー側暗号化が有効かどうかを指定します。有効な値: true および false。 |
true |
| SseType |
string |
サーバー側暗号化のメソッド。有効な値: SMQ および KMS。 |
KMS |
| SseAlgorithm |
string |
サーバー側暗号化アルゴリズム。現在、AES-256-GCM がサポートされています。このパラメーターが指定されていない場合、デフォルトのアルゴリズムが使用されます。 |
AES-256-GCM |
| KmsKeyId |
string |
KMS キーの ID。 |
key-xxx |
| EncryptionEnabled |
boolean |
サーバー側暗号化が有効かどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "06273500-249F-5863-121D-74D51123****",
"Code": 200,
"Status": "Success",
"Message": "operation success",
"Success": true,
"Data": {
"PageNum": 1,
"PageSize": 50,
"Total": 130,
"PageData": [
{
"TopicName": "demo-topic",
"MessageCount": 0,
"MaxMessageSize": 65536,
"MessageRetentionPeriod": 86400,
"CreateTime": 1449554962,
"LastModifyTime": 1449554962,
"LoggingEnabled": true,
"TopicUrl": "http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic",
"TopicInnerUrl": "http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic",
"Tags": [
{
"TagKey": "tag1",
"TagValue": "test"
}
],
"TopicType": "normal",
"EnableSSE": true,
"SseType": "KMS",
"SseAlgorithm": "AES-256-GCM",
"KmsKeyId": "key-xxx",
"EncryptionEnabled": true
}
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。