查詢環境。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apig:GetEnvironment | none | *Environment acs:apig:{#regionId}:{#accountId}:environment/{#EnvironmentId} |
| 無 |
請求語法
GET /v1/environments/{environmentId} HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| environmentId | string | 是 | 環境 id。 | env-cq7l5s5lhtgi6qasrdc0 |
| withVpcInfo | boolean | 否 | 標志是否攜帶 VPC 信息。 | true |
| withStatistics | boolean | 否 | 是否返回線上資源信息。 | true |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "3F8EE674-BB08-5E92-BE6F-E4756A748B0F",
"code": "Ok",
"message": "success",
"data": {
"environmentId": "env-cq7l5s5lhtgi6qasrdc0\n",
"name": "test",
"alias": "測試環境",
"description": "這是xxx的xx項目測試環境",
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "商品中心預發環境專有網絡"
},
"engineVersion": "2.0.7"
},
"subDomainInfos": [
{
"domainId": "d-cpudb0llhtgl2djvq2sg",
"name": "abc.com",
"protocol": "HTTP",
"networkType": "Intranet"
}
],
"default": true,
"createTimestamp": 1719386834548,
"updateTimestamp": 1719386834548,
"resourceGroupId": "rg-aekz4us4iruleja",
"statisticsInfo": {
"totalCount": 1,
"resourceStatistics": [
{
"resourceType": "HttpApi",
"resourceCount": 10
}
]
}
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-20 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-11-01 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-09-06 | OpenAPI 入參發生變更 | 查看變更詳情 |