调用SetDomain为API分组绑定自定义域名-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:SetDomain

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	API 分组 ID，系统生成，全局唯一	927d50c0f2e54b359919923d908bb015
DomainName	string	是	自定义域名	api.demo.com
BindStageName	string	否	域名要指定环境访问。不设置该值，则表示该域名能访问所有环境。如果指定了某个具体的环境，则该域名只能访问这个环境。可选值： TEST PRE RELEASE 当要修改为全部环境都可访问时，则将该值设置为空串（“”）即可。	RELEASE
CustomDomainType	string	否	指定域名要绑定的类型：公网或者内网。默认为 INTERNET。可选值： INTERNET：公网类型 INTRANET：内网类型, 当指定了内网类型后，就不允许该域名从公网请求过来。	INTERNET
IsForce	boolean	否	该字段用于当域名冲突时，是否强制绑定该域名。如果选择 true，则会强制在该分组绑定此域名，另外冲突的分组上的域名会自动解绑。该操作有一定风险，请谨慎操作。	false
IsHttpRedirectToHttps	boolean	否	是否将 http 重定向到 https	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一标识	0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
DomainLegalStatus	string	域名合法状态，取值： NORMAL：正常 ABNORMAL：异常，该状态会影响 API 调用，需尽快解决	NORMAL
GroupId	string	API 分组 ID，系统生成，全局唯一	927d50c0f2e54b359919923d908bb015
SubDomain	string	系统给分组绑定的二级域名，用于测试 API 调用	xxx-cn-hangzhou.alicloudapi.com
DomainName	string	自定义域名	api.demo.com
DomainBindingStatus	string	自定义域名绑定状态 BINDING：正常 BOUND：未生效	BINDING
DomainRemark	string	域名相关备注，如描述域名异常状态原因	无
DomainWebSocketStatus	string	使用 WebSocket 功能的域名状态	NORMAL

示例

正常返回示例

JSON格式

{
  "RequestId": "0AA90E87-3506-5AA6-AFFB-A4D53B4F6231",
  "DomainLegalStatus": "NORMAL",
  "GroupId": "927d50c0f2e54b359919923d908bb015",
  "SubDomain": "xxx-cn-hangzhou.alicloudapi.com",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "无",
  "DomainWebSocketStatus": "NORMAL"
}

错误码

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

变更历史

更多信息，参考变更详情。