首页 API 网关 开发指南 API参考指南 API目录 域名 SetDomain - 给指定分组绑定自定义域名

SetDomain - 给指定分组绑定自定义域名

给指定API分组绑定自定义域名。

调试

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

调试

授权信息

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

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

请求参数

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

API分组 ID,系统生成,全局唯一

927d50c0f2e54b359919923d908bb015
DomainNamestring

自定义域名

api.demo.com
BindStageNamestring

域名要指定环境访问。不设置该值,则表示该域名能访问所有环境。

如果指定了某个具体的环境,则该域名只能访问这个环境。 可选值:

  • TEST
  • PRE
  • RELEASE

当要修改为全部环境都可访问时,则将该值设置为空串(“”)即可。

RELEASE
CustomDomainTypestring

指定域名要绑定的类型:公网或者内网。默认为INTERNET。可选值:

  • INTERNET:公网类型
  • INTRANET:内网类型, 当指定了内网类型后,就不允许该域名从公网请求过来。
INTERNET
IsForceboolean

该字段用于当域名冲突时,是否强制绑定该域名。如果选择true,则会强制在该分组绑定此域名,另外冲突的分组上的域名会自动解绑。该操作有一定风险,请谨慎操作。

false
IsHttpRedirectToHttpsboolean

是否将http重定向到https

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求唯一标识

0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
DomainLegalStatusstring

域名合法状态,取值:

  • NORMAL:正常
  • ABNORMAL:异常,该状态会影响API调用,需尽快解决
NORMAL
GroupIdstring

API分组 ID,系统生成,全局唯一

927d50c0f2e54b359919923d908bb015
SubDomainstring

系统给分组绑定的二级域名,用于测试API调用

xxx-cn-hangzhou.alicloudapi.com
DomainNamestring

自定义域名

api.demo.com
DomainBindingStatusstring

自定义域名绑定状态

  • BINDING:正常
  • BOUND:未生效
BINDING
DomainRemarkstring

域名相关备注,如描述域名异常状态原因

DomainWebSocketStatusstring

使用WebSocket功能的域名状态

NORMAL

错误码

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

阿里云首页 API 网关 相关技术圈