- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
更新自定义事件通道
功能介绍
更新自定义事件通道定义。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/{project_id}/channels/{channel_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户资源空间ID |
channel_id |
是 |
String |
指定查询的事件通道ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
通道描述 |
enterprise_project_id |
否 |
String |
企业项目id |
cross_account |
否 |
Boolean |
跨账号开关 |
policy |
否 |
Object |
策略 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
通道ID |
name |
String |
通道名称 |
description |
String |
通道描述 |
provider_type |
String |
通道提供方类型,OFFICIAL:官方事件通道;CUSTOM:自定义事件通道;PARTNER:伙伴事件通道 |
created_time |
String |
创建UTC时间 |
updated_time |
String |
更新UTC时间 |
enterprise_project_id |
String |
企业项目id |
请求示例
更新自定义事件通道
PUT https://{endpoint}/v1/{project_id}/channels/{channel_id}
{
"description" : "first channel",
"enterprise_project_id" : "string",
"cross_account" : true,
"policy" : {
"additionalProp1" : {
"Sid" : "allow_account_to_put_events",
"Effect" : "Allow",
"Principal" : {
"additionalProp1" : {
"IAM" : [ "domainID" ]
},
"additionalProp2" : {
"IAM" : [ "domainID" ]
},
"additionalProp3" : {
"IAM" : [ "domainID" ]
}
},
"Action" : "eg:channels:putEvents",
"Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
},
"additionalProp2" : {
"Sid" : "allow_account_to_put_events",
"Effect" : "Allow",
"Principal" : {
"additionalProp1" : {
"IAM" : [ "domainID" ]
},
"additionalProp2" : {
"IAM" : [ "domainID" ]
},
"additionalProp3" : {
"IAM" : [ "domainID" ]
}
},
"Action" : "eg:channels:putEvents",
"Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
},
"additionalProp3" : {
"Sid" : "allow_account_to_put_events",
"Effect" : "Allow",
"Principal" : {
"additionalProp1" : {
"IAM" : [ "domainID" ]
},
"additionalProp2" : {
"IAM" : [ "domainID" ]
},
"additionalProp3" : {
"IAM" : [ "domainID" ]
}
},
"Action" : "eg:channels:putEvents",
"Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel"
}
}
}
响应示例
状态码:200
Information
{
"id" : "bd14144e-8f3c-43d6-bdfd-bf09b52c2b96",
"name" : "channel",
"description" : "first channel",
"provider_type" : "CUSTOM",
"created_time" : "2021-12-09 09:00:00",
"updated_time" : "2021-12-09 09:00:00",
"enterprise_project_id" : "string"
}
状态码
状态码 |
描述 |
---|---|
200 |
Information |
错误码
请参见错误码。