调用SetDomainWebSocketStatus开通或关闭自定义域名WebSocket-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

文档备案控制台

输入文档关键字查找

开通或关闭自定义域名的WebSocket。

调试

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

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:SetDomainWebSocketStatus

update

*ApiGroup

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

无

无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	指定要操作 API 所属分组 ID	cf976e63b70c4993807e7bb9345d4695
DomainName	string	是	自定义域名	ac.fluvet.cn
ActionValue	string	是	操作参数值	OPEN
WSSEnable	string	否	是否开启 WSS	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	61A16D46-EC04-5288-8A18-811B0F536CC2

示例

正常返回示例

JSON格式

{
  "RequestId": "61A16D46-EC04-5288-8A18-811B0F536CC2"
}

错误码

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

变更历史

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

上一篇：SetDomainCertificate - 为自定义域名添加SSL证书下一篇：SetWildcardDomainPatterns - 设置通配符域名模式

该文章对您有帮助吗？