调用DescribeBackendInfo查询后端服务的信息_API 网关(API Gateway)-阿里云帮助中心

查询后端服务的信息以及在各个环境上配置的后端地址。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeBackendInfo	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
BackendId	string	是	后端服务 ID	739b68751c0b4e899e04d0c92b6d0be7

返回参数

名称	类型	描述	示例值
	object	返回数据
RequestId	string	请求 ID	0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
BackendInfo	object	后端服务信息
BackendName	string	后端服务名称	testoss2
BackendType	string	后端服务类型	HTTP
ModifiedTime	string	后端服务修改时间	2017-12-11T15:18:09+08:00
Description	string	描述信息	add
CreatedTime	string	后端服务创建时间	2021-11-22T11:10:46+08:00
BackendId	string	后端服务 ID	6fc978bb63574146b766863dd7bdf661
BackendModels	array<object>	后端服务在环境上的配置信息
	object	后端服务在环境上的配置信息
BackendModelId	string	后端服务在环境上的配置 ID	5c4995d08e8b4954b0f326e8e4f2b97d
StageModeId	string	环境 ID	6fc978bb63574146b766863dd7bdf661
Description	string	描述信息	testDvs 1
GmtCreate	string	创建时间	2021-12-20T03:22:03.000+0000
GmtModified	string	修改时间	2021-12-20T03:22:03.000+0000
StageName	string	环境名称	RELEASE
BackendConfig	object	后端配置
ServiceAddress	string	后端服务地址	10.0.0.1
HttpTargetHostName	string	HTTP 类型后端服务的 host	test.com
Type	string	后端服务类型。	VPC
VpcConfig	object	后端为 VPC 的信息
VpcId	string	专用网络 ID	vpc-wz9v96hqi6d14744sxqmx
InstanceId	string	专用网络中的实例 ID（ECS/SLB）	i-uf6iaale3gfef9t9cb41
Port	long	实例对应的端口号	8080
VpcAccessId	string	vpc 授权 ID	2zej3ehuzg9m77kvwnfpn
Name	string	VPC 配置名称	dypls-cn-beijing-slb-pre
VpcScheme	string	http/https 协议	http
VpcTargetHostName	string	vpc 类型后端服务的 host	openapi.alipan.com
FunctionComputeConfig	object	后端为函数计算的信息
FcType	string	函数计算服务类型	HttpTrigger
FcRegionId	string	函数计算服务的区域 ID。	cn-hangzhou
ServiceName	string	函数计算定义的 ServiceName	myservice
FunctionName	string	函数计算定义的 FunctionName	edge_function
RoleArn	string	Ram 授权给 API 网关访问函数计算的 arn	acs:ram::31985*:role/aliyunserviceroleforbastionhostpam
Qualifier	string	函数别名	testQualifier
FcBaseUrl	string	函数计算服务根路径	https://t*****.ap-***.fcapp.run/
OnlyBusinessPath	boolean	后端只接收业务 path	false
OssConfig	object	后端为 OSS 的信息
OssRegionId	string	OSS 服务地域 ID	cn-hangzhou
BucketName	string	OSS 桶名	my_bucket
EventBridgeConfig	object	后端为 EventBridge 的配置
EventBridgeRegionId	string	事件总线服务所在区域 ID	cn-hangzhou
EventSource	string	事件来源。	dds_driver
EventBus	string	事件总线	testBus
RoleArn	string	Ram 授权给 EventBridge 的 arn	acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport
MockConfig	object	Mock 配置信息
MockResult	string	Mock 返回结果	test
MockStatusCode	string	Mock 返回状态码	200
MockHeaders	array<object>	Mock 返回的 Header
	object	Mock 信息
HeaderName	string	Header 参数名。	test
HeaderValue	string	参数对应的值。	123
DiscoveryConfig	object	服务发现类型后端的配置信息
RcType	string	注册中心类型	NACOS
NacosConfig	object	Nacos 配置信息
ServerAddress	string	Nacos 服务地址	http://1xx.2xx.3xx.4xx:8848
Namespace	string	注册在 Nacos 上的微服务所在的命名空间 ID	public
GroupName	string	注册在 Nacos 上的微服务所在的分组名称	DEFAULT_GROUP
ServiceName	string	微服务名称	service-provider
Clusters	string	微服务所在的集群名称	cluster1
AuthType	string	鉴权方式	PASSWORD
UserName	string	用户名	username
Password	string	密码	password
AccessKey	string	具有 mse 资源管理权限的子账号的 accessKey	A5FIDxxxxxx
SecretKey	string	具有 mse 资源管理权限的子账号的 secretKey	dl5loxxxxxx
ZookeeperConfig	object	Zookeeper 配置信息
ConnectString	string	Zookeeper 服务器连接地址	http://192.168.1.xxx:2181
Namespace	string	命名空间	provider
ServiceName	string	服务名称	service
ServiceTimeout	integer	后端服务超时时间，单位：毫秒	10000
EdasConfig	object	Edas 配置信息
MicroserviceNamespaceName	string	Edas 微服务命名空间名称	Edas-Nacos
MicroserviceNamespaceId	string	Edas 微服务命名空间 ID	cn-hangzhou:edasNacos
MicroserviceNamespace	string	Edas 微服务命名空间 ID	cn-hangzhou:edasNacos
ServiceName	string	服务名称	service
EdasAppId	string	Edas 应用 ID	6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx
RegistryType	string	注册类型	EDAS
MseInstanceId	string	MSE 注册中心实例 ID	mse-cn-jia3n1rxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "0AA90E87-3506-5AA6-AFFB-A4D53B4F6231",
  "BackendInfo": {
    "BackendName": "testoss2",
    "BackendType": "HTTP",
    "ModifiedTime": "2017-12-11T15:18:09+08:00",
    "Description": "add",
    "CreatedTime": "2021-11-22T11:10:46+08:00",
    "BackendId": "6fc978bb63574146b766863dd7bdf661",
    "BackendModels": [
      {
        "BackendModelId": "5c4995d08e8b4954b0f326e8e4f2b97d",
        "StageModeId": "6fc978bb63574146b766863dd7bdf661",
        "Description": "testDvs 1",
        "GmtCreate": "2021-12-20T03:22:03.000+0000",
        "GmtModified": "2021-12-20T03:22:03.000+0000",
        "StageName": "RELEASE",
        "BackendConfig": {
          "ServiceAddress": "10.0.0.1",
          "HttpTargetHostName": "test.com",
          "Type": "VPC",
          "VpcConfig": {
            "VpcId": "vpc-wz9v96hqi6d14744sxqmx",
            "InstanceId": "i-uf6iaale3gfef9t9cb41",
            "Port": 8080,
            "VpcAccessId": "2zej3ehuzg9m77kvwnfpn",
            "Name": "dypls-cn-beijing-slb-pre",
            "VpcScheme": "http",
            "VpcTargetHostName": "openapi.alipan.com"
          },
          "FunctionComputeConfig": {
            "FcType": "HttpTrigger",
            "FcRegionId": "cn-hangzhou",
            "ServiceName": "myservice",
            "FunctionName": "edge_function",
            "RoleArn": "acs:ram::31985*:role/aliyunserviceroleforbastionhostpam",
            "Qualifier": "testQualifier",
            "FcBaseUrl": "https://t*******.ap-*****.fcapp.run/",
            "OnlyBusinessPath": false
          },
          "OssConfig": {
            "OssRegionId": "cn-hangzhou",
            "BucketName": "my_bucket"
          },
          "EventBridgeConfig": {
            "EventBridgeRegionId": "cn-hangzhou",
            "EventSource": "dds_driver",
            "EventBus": "testBus",
            "RoleArn": "acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport"
          },
          "MockConfig": {
            "MockResult": "test\n",
            "MockStatusCode": "200",
            "MockHeaders": [
              {
                "HeaderName": "test\n",
                "HeaderValue": "123"
              }
            ]
          },
          "DiscoveryConfig": {
            "RcType": "NACOS",
            "NacosConfig": {
              "ServerAddress": "http://1xx.2xx.3xx.4xx:8848",
              "Namespace": "public",
              "GroupName": "DEFAULT_GROUP",
              "ServiceName": "service-provider",
              "Clusters": "cluster1",
              "AuthType": "PASSWORD",
              "UserName": "username",
              "Password": "password",
              "AccessKey": "A5FIDxxxxxx",
              "SecretKey": "dl5loxxxxxx"
            },
            "ZookeeperConfig": {
              "ConnectString": "http://192.168.1.xxx:2181",
              "Namespace": "provider",
              "ServiceName": "service"
            }
          },
          "ServiceTimeout": 10000,
          "EdasConfig": {
            "MicroserviceNamespaceName": "Edas-Nacos",
            "MicroserviceNamespaceId": "cn-hangzhou:edasNacos",
            "MicroserviceNamespace": "cn-hangzhou:edasNacos\n",
            "ServiceName": "service",
            "EdasAppId": "6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx",
            "RegistryType": "EDAS",
            "MseInstanceId": "mse-cn-jia3n1rxxxx"
          }
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-12-27	OpenAPI 返回结构发生变更	查看变更详情
2023-11-09	OpenAPI 返回结构发生变更	查看变更详情
2023-09-19	OpenAPI 返回结构发生变更	查看变更详情
2023-06-03	OpenAPI 返回结构发生变更	查看变更详情
2023-05-12	OpenAPI 返回结构发生变更	查看变更详情
2022-09-22	OpenAPI 返回结构发生变更	查看变更详情