SetDomain_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
apigateway:SetDomain
Update
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

请求参数

字段名称字段详情
GroupIdstring

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

示例值:927d50c0f2e54b359919923d908bb015参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
DomainNamestring

自定义域名

示例值:api.demo.com
BindStageNamestring

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

示例值:RELEASE
CustomDomainTypestring

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

示例值:INTERNET
IsForceboolean

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

示例值:false
IsHttpRedirectToHttpsboolean

是否将 http 重定向到 https

示例值:false

返回参数

字段名称字段详情
RequestIdstring

请求唯一标识

示例值:0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
DomainLegalStatusstring

域名合法状态,取值:展开详情

示例值:NORMAL
GroupIdstring

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

示例值:927d50c0f2e54b359919923d908bb015
SubDomainstring

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

示例值:xxx-cn-hangzhou.alicloudapi.com
DomainNamestring

自定义域名

示例值:api.demo.com
DomainBindingStatusstring

自定义域名绑定状态展开详情

示例值:BINDING
DomainRemarkstring

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

示例值:
DomainWebSocketStatusstring

使用 WebSocket 功能的域名状态

示例值:NORMAL

返回示例

变更历史

暂无变更历史

相关示例

2024年08月20日