GetConsumerAuthorizationRule - 获取消费者授权规则

获取消费者授权规则。

调试

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

授权信息

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

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

请求语法

GET /v1/consumers/{consumerId}/authorization-rules/{consumerAuthorizationRuleId} HTTP/1.1

请求参数

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

根据特定的消费者授权规则 ID 过滤接口列表,响应中的接口列表仅包含已授权的接口。

car-ctgdn8em1hko5krqq03g
consumerIdstring

消费者 ID。

cs-ctgdn2um1hkossul8gvg

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

53102737-1E4E-5A8B-8E0A-4184B0959B84
consumerIdstring

消费者 ID。

cs-ctgdn2um1hkossul8gvg
consumerAuthorizationRuleIdstring

根据特定的消费者授权规则 ID 过滤接口列表,响应中的接口列表仅包含已授权的接口。

car-ctgdn8em1hko5krqq03g
apiInfoHttpApiApiInfo

API 信息。

environmentInfoEnvironmentInfo

环境信息。

gatewayInfoGatewayInfo

网关信息。

resourceTypestring

资源类型。

API
expireStatusstring

失效状态。

true
expireModestring

失效模式。LongTerm、ShortTerm,二选一。

LongTerm
expireTimestamplong

到期时间。

1750852089975
createTimestamplong

创建时间戳。单位: 毫秒。

1750852089975
updateTimestamplong

更新时间戳。单位: 毫秒。

1750852089975
deployStatusstring

API 在当前环境的发布状态

""

示例

正常返回示例

JSON格式

{
  "requestId": "53102737-1E4E-5A8B-8E0A-4184B0959B84",
  "consumerId": "cs-ctgdn2um1hkossul8gvg",
  "consumerAuthorizationRuleId": "car-ctgdn8em1hko5krqq03g",
  "apiInfo": {
    "httpApiId": "api-xxx",
    "name": "test",
    "protocols": [
      "HTTP"
    ],
    "basePath": "/v1",
    "description": "测试专用API",
    "versionInfo": {
      "enable": true,
      "scheme": "Query",
      "headerName": "my-version",
      "queryName": "myVersion",
      "version": "v1"
    },
    "environments": [
      {
        "environmentId": "env-xxx",
        "backendScene": "SingleService",
        "backendType": "Service",
        "serviceConfigs": [
          {
            "gatewayServiceId": "gs-xxx",
            "name": "demo-service",
            "protocol": "HTTP",
            "port": 8080,
            "weight": 100,
            "version": "v1",
            "match": {
              "default": true,
              "conditions": [
                {
                  "type": "Query",
                  "key": "color",
                  "value": "gray",
                  "operator": "equal"
                }
              ]
            },
            "serviceId": "svc-xxx"
          }
        ],
        "customDomains": [
          {
            "domainId": "d-xxx",
            "name": "www.example.com",
            "protocol": "HTTP"
          }
        ],
        "name": "test",
        "alias": "test",
        "gatewayInfo": {
          "gatewayId": "gw-xxx",
          "name": "test"
        },
        "deployStatus": "Deployed",
        "subDomains": [
          {
            "domainId": "d-xxx",
            "name": "www.example.com",
            "protocol": "HTTP",
            "networkType": "Internet"
          }
        ]
      }
    ],
    "ingressInfo": {
      "sourceId": "src-xxx",
      "ingressClass": "mse",
      "watchNamespace": "default",
      "environmentInfo": {
        "environmentId": "env-xxx"
      },
      "k8sClusterInfo": {
        "clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
      },
      "overrideIngressIp": true
    },
    "type": "Rest",
    "resourceGroupId": "rg-xxx",
    "aiProtocols": [
      "OpenAI/v1"
    ],
    "deployConfigs": [
      {
        "customDomainIds": [
          "d-xxx"
        ],
        "environmentId": "env-xxx",
        "backendScene": "SingleService",
        "serviceConfigs": [
          {
            "serviceId": "svc-xxx",
            "weight": 100,
            "modelNamePattern": "qwen-*",
            "modelName": "qwen-max"
          }
        ],
        "policyConfigs": [
          {
            "type": "AiFallback",
            "enable": true,
            "aiFallbackConfig": {
              "serviceIds": [
                "svc-xxx"
              ]
            }
          }
        ],
        "autoDeploy": true,
        "gatewayId": "gw-xx",
        "routeBackend": {
          "scene": "Single",
          "services": [
            {
              "serviceId": "service-cq2bmmdlhtgj***",
              "name": "item-service",
              "protocol": "HTTP",
              "port": 0,
              "weight": 49,
              "version": "v1"
            }
          ]
        },
        "customDomainInfos": [
          {
            "domainId": "d-cshee6dlhtgkf4muio3g",
            "name": "hello-server.com",
            "protocol": "HTTP"
          }
        ],
        "subDomains": [
          {
            "domainId": "d-csmn42um1hksudfk9eng",
            "name": "test",
            "protocol": "HTTP",
            "networkType": "Intranet"
          }
        ],
        "gatewayInfo": {
          "gatewayId": "gw-cq7og15lhtgi6qasrj60",
          "name": "apitest-gw",
          "vpcInfo": {
            "vpcId": "vpc-uf664nyle5kh***",
            "name": "商品中心预发环境专有网络"
          },
          "engineVersion": "2.0.7"
        },
        "mock": {
          "enable": false,
          "responseCode": 200,
          "responseContent": "Mock测试"
        },
        "gatewayType": "API"
      }
    ],
    "enabelAuth": true,
    "authConfig": {
      "authType": "Jwt",
      "authMode": "NoAuth"
    },
    "deployCntMap": {
      "key": {
        "deployedCnt": 3,
        "Cnt": 5
      }
    },
    "gatewayId": "gw-cpv4sqdl****"
  },
  "environmentInfo": {
    "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
    "name": "test",
    "alias": "测试环境",
    "description": "这是xxxxx项目测试环境",
    "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": false,
    "createTimestamp": 1721116090326,
    "updateTimestamp": 1721116090326,
    "resourceGroupId": "rg-xxxx"
  },
  "gatewayInfo": {
    "gatewayId": "gw-cq7og15lhtgi6qasrj60",
    "name": "apitest-gw",
    "vpcInfo": {
      "vpcId": "vpc-uf664nyle5kh***",
      "name": "商品中心预发环境专有网络"
    },
    "engineVersion": "2.0.7"
  },
  "resourceType": "API",
  "expireStatus": true,
  "expireMode": "LongTerm",
  "expireTimestamp": 1750852089975,
  "createTimestamp": 1750852089975,
  "updateTimestamp": 1750852089975,
  "deployStatus": ""
}

错误码

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