查詢環(huán)境列表。
調(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í)別，取值為寫(xiě)入（Write）、讀?。≧ead）或列出（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)操作 |
|---|---|---|---|---|
| apig:ListEnvironments | list | *Environment acs:apig:{#regionId}:{#accountId}:environment/* |
| 無(wú) |
請(qǐng)求語(yǔ)法
GET /v1/environments HTTP/1.1
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| nameLike | string | 否 | 環(huán)境名稱，模糊搜索。 | test |
| aliasLike | string | 否 | 環(huán)境別名，模糊搜索。 | 測(cè)試 |
| gatewayId | string | 否 | 網(wǎng)關(guān) id，精確搜索。 | gw-cptv6ktlhtgnqr73h8d1 |
| gatewayNameLike | string | 否 | 網(wǎng)關(guān)名稱，模糊搜索。 | test-gw |
| pageNumber | integer | 否 | 頁(yè)碼，默認(rèn) 1 | 1 |
| pageSize | integer | 否 | 每頁(yè)大小，默認(rèn) 10 | 10 |
| resourceGroupId | string | 否 | 資源組 ID。 | rg-aek2nqpppkzplmq |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"requestId": "CE857A85-251D-5018-8103-A38957D71E20",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 25,
"items": [
{
"environmentId": "env-cq7l5s5lhtgi6qasrdc0",
"name": "test",
"alias": "測(cè)試環(huán)境",
"description": "這是xxx的xx項(xiàng)目測(cè)試環(huán)境",
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "商品中心預(yù)發(fā)環(huán)境專有網(wǎng)絡(luò)"
},
"engineVersion": "2.0.7"
},
"subDomainInfos": [
{
"domainId": "d-cpudb0llhtgl2djvq2sg",
"name": "abc.com",
"protocol": "HTTP",
"networkType": "Intranet"
}
],
"default": false,
"createTimestamp": 1721116090326,
"updateTimestamp": 1721116090326,
"resourceGroupId": "rg-xxxx"
}
]
}
}錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-11-20 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |