查询网关已订阅的服务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mse:ListGatewayService | get | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 页码。 | 1 |
PageSize | integer | 否 | 分页大小。 | 10 |
OrderItem | string | 否 | 排序属性。 | GmtCreate |
DescSort | boolean | 否 | 排序。 | false |
FilterParams | object | 否 | 过滤条件,格式为{"key1":"value1"}。 | |
Name | string | 否 | 服务名。 | test |
SourceType | string | 否 | 来源类型。 | MSE |
Namespace | string | 否 | 命名空间。 | public |
GroupName | string | 否 | 分组。 | test |
GatewayUniqueId | string | 是 | 网关唯一标识 ID。 | gw-5017305290e14centbrveca**** |
ServiceProtocol | string | 否 | 服务协议。
| HTTP |
AcceptLanguage | string | 否 | 返回信息的语言类型:
| zh |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F46CDBA4-B1EE-5C94-8A48-51C10177****",
"HttpStatusCode": 200,
"Message": "You are not authorized to perform this operation.",
"Code": 200,
"Success": true,
"Data": {
"TotalSize": 9,
"PageNumber": 1,
"PageSize": 10,
"Result": [
{
"Id": 1,
"Name": "test",
"GatewayUniqueId": "gw-5017305290e14centbrveca****",
"GatewayId": 1,
"SourceType": "MSE",
"Namespace": "public",
"GroupName": "test",
"SourceId": 2,
"ServiceNameInRegistry": "test",
"MetaInfo": "{}",
"Ips": [
"127.0.2.1"
],
"GmtCreate": "2022-01-07 18:07:57",
"GmtModified": "2022-01-07 18:07:57",
"Versions": [
{
"Name": "v1"
}
],
"ServiceProtocol": "HTTP",
"ServicePort": 80,
"HealehStatus": "Unhealthy",
"HealthStatus": "Unhealthy",
"HealthCheck": true,
"HealthCheckInfo": {
"Check": true,
"Protocol": "TCP",
"Timeout": 2,
"Interval": 2,
"HealthyThreshold": 2,
"UnhealthyThreshold": 2,
"HttpPath": "/health",
"HttpHost": "http://172.168.0.1",
"ExpectedStatuses": [
200
]
},
"UnhealthyEndpoints": [
"172.168.0.1"
],
"GatewayTrafficPolicy": {
"Tls": {
"Mode": "SIMPLE",
"CertId": "5******-cn-hangzhou",
"CaCertId": "5******-cn-hangzhou",
"CaCertContent": "content",
"SubjectAltNames": [
"name"
],
"Sni": "name-sni"
},
"LoadBalancerSettings": {
"LoadbalancerType": "RANDOM",
"ConsistentHashLBConfig": {
"ParameterName": "param",
"HttpCookie": {
"Name": "name",
"Path": "/path",
"Ttl": "360"
},
"MinimumRingSize": 10000,
"ConsistentHashLBType": "HEADER"
},
"WarmupDuration": 10
}
},
"Ports": [
8080
],
"ServiceFQDN": ""
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalRequest | Invalid request:%s | 非法请求: %s |
400 | InvalidParameter | Parameter error:%s | 请求参数错误:%s |
403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s |
404 | NotFound | Not found:%s | 资源不存在:%s |
500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-03-31 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-02-22 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-02-22 | API 内部配置变更,不影响调用 | 查看变更详情 |