調(diào)用ListTransitRouterMulticastDomains接口查詢組播域的狀態(tài)、組播域ID、組播域的描述等信息。
接口說(shuō)明
- RegionId 必須和 CenId 組合使用，不能單獨(dú)使用，否則將不會(huì)顯示組播域的信息。 但 TransitRouterId 和 TransitRouterMulticastDomainId 可以單獨(dú)使用。
- 調(diào)用接口時(shí)請(qǐng)確保輸入的參數(shù)值無(wú)誤。如果您輸入的參數(shù)有誤調(diào)用接口后仍然會(huì)返回 RequestId，但不會(huì)顯示組播域的詳細(xì)信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cen:ListTransitRouterMulticastDomains | list | *TransitRouterMulticastDomain acs:cen:*:{#accountId}:centransitroutermulticast/**TransitRouterMulticastDomain acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 | 123e4567-e89b-12d3-a456-426655440000 |
| CenId | string | 否 | 云企業(yè)網(wǎng)實(shí)例 ID。 | cen-a7syd349kne38g**** |
| TransitRouterId | string | 否 | 轉(zhuǎn)發(fā)路由器實(shí)例 ID。 | tr-p0wr9p28r92d598y6**** |
| TransitRouterMulticastDomainId | string | 否 | 組播域 ID。 | tr-mcast-domain-3r3bvbypxqheej**** |
| RegionId | string | 否 | 轉(zhuǎn)發(fā)路由器實(shí)例所屬地域 ID。 您可以通過(guò)調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
| MaxResults | long | 否 | 分批次查詢時(shí)每次顯示的條目數(shù)。默認(rèn)值：20。 | 20 |
| NextToken | string | 否 | 是否擁有下一次查詢的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| Tag | array<object> | 否 | 標(biāo)簽信息。 一次最多支持輸入 20 個(gè)標(biāo)簽信息。 | |
| object | 否 | |||
| Key | string | 否 | 資源的標(biāo)簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個(gè)字符，不能以 一次最多支持輸入 20 個(gè)標(biāo)簽的標(biāo)簽鍵。 | TagKey |
| Value | string | 否 | 資源的標(biāo)簽值。 標(biāo)簽值可以為空或輸入不超過(guò) 128 個(gè)字符的字符串，不能以 每一個(gè)標(biāo)簽鍵對(duì)應(yīng)一個(gè)標(biāo)簽值，一次最多支持輸入 20 個(gè)標(biāo)簽鍵對(duì)應(yīng)的標(biāo)簽值。 | TagValue |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2",
"TotalCount": 1,
"MaxResults": 20,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TransitRouterMulticastDomains": [
{
"TransitRouterMulticastDomainId": "tr-mcast-domain-3r3bvbypxqheej****",
"TransitRouterMulticastDomainName": "nametest",
"TransitRouterMulticastDomainDescription": "desctest",
"Status": "Active",
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
],
"TransitRouterId": "tr-bp1c23ijrl6d6c226h***",
"RegionId": "cn-hangzhou",
"CenId": "cen-h19xdb0qy2b3irka8z"
}
]
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is illegal. | 參數(shù)中指定的NextToken不合法。 |
| 400 | IllegalParam.TrInstance | The specified TrInstance is illegal. | 參數(shù)中指定的TrInstance不合法。 |
| 400 | IllegalParam.CenId | The specified CenId is illegal. | 指定的cenId不合法。 |
| 400 | IllegalParam.MaxResults | The specified MaxResults is illegal. | MaxResults非法。 |
| 400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號(hào)無(wú)權(quán)限操作。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-08-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-07-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |