DescribeBackendInfo API Reference for Backend Service Details - API Gateway

Query backend service information and the backend addresses configured in each environment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeBackendInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackendId	string	No	Backend service ID.	739b68751c0b4e899e04d0c92b6d0be7

Response elements

Element	Type	Description	Example
	object	Returned data.
RequestId	string	Request ID.	0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
BackendInfo	object	Backend service information.
BackendName	string	Backend service name.	testoss2
BackendType	string	Backend service type.	HTTP
ModifiedTime	string	Backend service modification time.	2017-12-11T15:18:09+08:00
Description	string	Description.	add
CreatedTime	string	Backend service creation time.	2021-11-22T11:10:46+08:00
BackendId	string	Backend service ID.	6fc978bb63574146b766863dd7bdf661
BackendModels	array<object>	Backend service configuration information in environments.
	array<object>	Backend service configuration information in environments.
BackendModelId	string	Backend service configuration ID in environments.	5c4995d08e8b4954b0f326e8e4f2b97d
StageModeId	string	Environment ID.	6fc978bb63574146b766863dd7bdf661
Description	string	Description.	testDvs 1
GmtCreate	string	Creation time.	2021-12-20T03:22:03.000+0000
GmtModified	string	Modification time.	2021-12-20T03:22:03.000+0000
StageName	string	Environment name.	RELEASE
BackendConfig	object	Backend configuration.
ServiceAddress	string	Backend service endpoint.	10.0.0.1
HttpTargetHostName	string	Host of the HTTP backend service.	test.com
Type	string	Backend service type.	VPC
VpcConfig	object	VPC backend information.
VpcId	string	VPC ID.	vpc-wz9v96hqi6d14744sxqmx
InstanceId	string	Instance ID (ECS/SLB) in the VPC.	i-uf6iaale3gfef9t9cb41
Port	integer	Port number of the instance.	8080
VpcAccessId	string	VPC authorization ID.	2zej3ehuzg9m77kvwnfpn
Name	string	VPC configuration name.	dypls-cn-beijing-slb-pre
VpcScheme	string	HTTP/HTTPS protocol.	http
VpcTargetHostName	string	Host of the VPC backend service.	openapi.alipan.com
FunctionComputeConfig	object	Function Compute backend information.
FcType	string	Function Compute service type.	HttpTrigger
FcRegionId	string	Region ID of the Function Compute service.	cn-hangzhou
ServiceName	string	ServiceName defined in Function Compute.	myservice
FunctionName	string	FunctionName defined in Function Compute.	edge_function
RoleArn	string	RAM role ARN that grants API Gateway permission to access Function Compute.	acs:ram::31985*:role/aliyunserviceroleforbastionhostpam
Qualifier	string	Function alias.	testQualifier
FcBaseUrl	string	Root path of the Function Compute service.	https://t*****.ap-***.fcapp.run/
OnlyBusinessPath	boolean	The backend only accepts business paths.	false
TriggerName	string
OssConfig	object	OSS backend information.
OssRegionId	string	Region ID of the OSS service.	cn-hangzhou
BucketName	string	OSS bucket name.	my_bucket
EventBridgeConfig	object	EventBridge backend configuration.
EventBridgeRegionId	string	Region ID of the EventBridge service.	cn-hangzhou
EventSource	string	Event source.	dds_driver
EventBus	string	Event bus.	testBus
RoleArn	string	RAM role ARN that grants EventBridge permission.	acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport
MockConfig	object	Mock configuration information.
MockResult	string	Mock return result.	test
MockStatusCode	string	Mock return status code.	200
MockHeaders	array<object>	Mock return headers.
	object	Mock information.
HeaderName	string	Header parameter name.	test
HeaderValue	string	Corresponding parameter value.	123
DiscoveryConfig	object	Configuration information for service discovery backend.
RcType	string	Registry type.	NACOS
NacosConfig	object	Nacos configuration information.
ServerAddress	string	Nacos service endpoint.	http://1xx.2xx.3xx.4xx:8848
Namespace	string	Namespace ID of the microservice registered in Nacos.	public
GroupName	string	Group name of the microservice registered in Nacos.	DEFAULT_GROUP
ServiceName	string	Microservice name.	service-provider
Clusters	string	Cluster name where the microservice resides.	cluster1
AuthType	string	Authentication method.	PASSWORD
UserName	string	Username.	username
Password	string	Password.	password
AccessKey	string	AccessKey of the RAM user with MSE Resource Management permissions.	A5FIDxxxxxx
SecretKey	string	SecretKey of the RAM user with MSE Resource Management permissions.	dl5loxxxxxx
ZookeeperConfig	object	Zookeeper configuration information.
ConnectString	string	Zookeeper server connection address.	http://192.168.1.xxx:2181
Namespace	string	Namespace.	provider
ServiceName	string	Service name.	service
ServiceTimeout	integer	Backend service timeout period in milliseconds.	10000
EdasConfig	object	EDAS configuration information.
MicroserviceNamespaceName	string	EDAS microservice namespace name.	Edas-Nacos
MicroserviceNamespaceId	string	EDAS microservice namespace ID.	cn-hangzhou:edasNacos
MicroserviceNamespace	string	EDAS microservice namespace ID.	cn-hangzhou:edasNacos
ServiceName	string	Service name.	service
EdasAppId	string	EDAS application ID.	6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx
RegistryType	string	Registry type.	EDAS
MseInstanceId	string	MSE registry instance ID.	mse-cn-jia3n1rxxxx

Examples

Success response

JSON format

{
  "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,
            "TriggerName": ""
          },
          "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"
          }
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.