查询后端服务的信息以及在各个环境上配置的后端地址。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:DescribeBackendInfo | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BackendId | string | 是 | 后端服务 ID | 739b68751c0b4e899e04d0c92b6d0be7 |
返回参数
示例
正常返回示例
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 返回结构发生变更 | 查看变更详情 |