GetEnvironment - 查询环境

查询环境。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:GetEnvironmentnone
*全部资源
*

请求语法

GET /v1/environments/{environmentId} HTTP/1.1

请求参数

名称类型必填描述示例值
environmentIdstring

环境 id。

env-cq7l5s5lhtgi6qasrdc0

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,用于追溯 API 调用链路。

3F8EE674-BB08-5E92-BE6F-E4756A748B0F
codestring

响应码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

environmentIdstring

环境 id。

env-cq7l5s5lhtgi6qasrdc0
namestring

环境名称。

test
aliasstring

环境别名。

测试环境
descriptionstring

环境描述信息。

这是xxx的xx项目测试环境
gatewayInfoGatewayInfo

网关信息

subDomainInfosarray

子域名列表。

subDomainInfoSubDomainInfo

子域名信息。

defaultboolean

是否默认环境。

true
createTimestamplong

创建时间戳。

1719386834548
updateTimestamplong

更新时间戳。

1719386834548

示例

正常返回示例

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": "",
    "statisticsInfo": {
      "totalCount": 0,
      "resourceStatistics": [
        {
          "resourceType": "HttpApi",
          "resourceCount": 10
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-01OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-09-06OpenAPI 入参发生变更查看变更详情