UpdateHttpTriggerConfig - 更新云函数的HTTP触发配置

更新时间:
复制为 MD 格式

更新云函数的HTTP触发配置。

接口说明

开启 HTTP 触发功能,系统会为开启 HTTP 触发功能的 Space 分配一个默认域名,然后再结合 UpdateFunction 接口给云函数设置一个触发路径,之后就可以通过 HTTP 请求来触发云函数调用。您可以绑定自己的域名来使用 HTTP 触发的功能,要求您的域名必须接入阿里云备案。您还可以给您的自定义域名绑定 HTTPS 证书,之后可以使用 HTTPS 协议加自定义域名来访问。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mpserverless:UpdateHttpTriggerConfig

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

EnableService

boolean

设置是否开启 HTTP 触发功能。取值:

  • true:表示开启 HTTP 触发功能。

  • false:表示关闭 HTTP 触发功能。

true

SpaceId

string

服务空间 ID。

34C45988-2B24-****-A4DC-4D6C952890D8

CustomDomain

string

自定义域名。不传该字段表示不更新自定义域名,设置为空字符串表示删除自定义域名。

在绑定自定义域名前,要求您的域名已经接入阿里云备案,并且已配置解析 CNAME 到 CustomDomainCname。

abc.xxx.com

CustomDomainCertificate

string

自定义域名的 HTTPS 证书。必须和 CustomDomainPrivateKey 一起使用,不传这两个字段表示不更新证书,都传空字符串表示删除证书。

-----BEGIN CERTIFICATE----- MIIFK****GCSqGSIb3DQEBCwUA= -----END CERTIFICATE-----

CustomDomainPrivateKey

string

自定义域名的 HTTPS 证书的私钥。必须和 CustomDomainCertificate 一起使用,不传这两个字段表示不更新证书,都传空字符串表示删除证书。

-----BEGIN PRIVATE KEY----- MIIEwA******DmUwVD0M74ECwZw= -----END PRIVATE KEY-----

返回参数

名称

类型

描述

示例值

object

EnableService

boolean

是否开启了 HTTP 触发功能。

true

CustomDomainCname

string

HTTP 触发绑定的自定义域名的 CNAME 地址。

724d************795a2.custom.bspapp.com

RequestId

string

请求 ID。

34C45988-2B24-****-A4DC-4D6C952890D8

DefaultEndpoint

string

HTTP 触发的默认域名。

724dade5-492f-426b-a5df-ff****0795a2.bspapp.com

CustomDomainCertificateInfo

string

HTTP 触发绑定的自定义域名的证书信息。

{"notAfter":"2021-09-28T08:21:42Z","notBefore":"2021-06-30T08:21:43Z","subject":"CN=*.example.com"}

CustomDomain

string

HTTP 触发绑定的自定义域名。

abc.example.com

示例

正常返回示例

JSON格式

{
  "EnableService": true,
  "CustomDomainCname": "724d************795a2.custom.bspapp.com",
  "RequestId": "34C45988-2B24-****-A4DC-4D6C952890D8",
  "DefaultEndpoint": "724dade5-492f-426b-a5df-ff****0795a2.bspapp.com",
  "CustomDomainCertificateInfo": "{\"notAfter\":\"2021-09-28T08:21:42Z\",\"notBefore\":\"2021-06-30T08:21:43Z\",\"subject\":\"CN=*.example.com\"}",
  "CustomDomain": "abc.example.com"
}

错误码

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

变更历史

更多信息,参考变更详情