用于更新指定域名的状态属性信息。
接口说明
请求说明
本接口专为网关用户设计,允许他们更新指定域名的状态属性。
必须提供
OperatorType,OperatorId,DomainName参数以标识要修改的具体网关下的特定域名的状态。可选参数包括
AddStatusList,DeleteStatusList,包含Status和StatusMsg这些用来标识需要增加或者删除的域名状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
幂等参数 |
443F1A21-XXXX-55C4-93E1-FF020DF93D7B |
| OperatorType |
string |
是 |
操作类型,固定 registryGateway 枚举值:
|
registryGateway |
| OperatorId |
string |
是 |
操作 ID,网关 ID |
gatewayId001 |
| DomainName |
string |
是 |
需要修改状态的域名 |
example.com |
| AddStatusList |
array<object> |
否 |
添加域名状态集合 |
[{"Status":"renewProhibited","StatusMsg":"test"}] |
|
object |
否 |
|||
| Status |
string |
否 |
域名状态 枚举值:
|
serverDeleteProhibited |
| StatusMsg |
string |
否 |
状态描述信息 |
实名认证未通过,增加serverUpdateProhibited状态 |
| DeleteStatusList |
array<object> |
否 |
删除域名状态集合 |
[{"Status":"renewProhibited","StatusMsg":"test"}] |
|
object |
否 |
|||
| Status |
string |
否 |
域名状态 枚举值:
|
serverDeleteProhibited |
| StatusMsg |
string |
否 |
状态描述信息 |
实名认证通过,删除serverUpdateProhibited状态 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求唯一标识 |
0629502C-XXXX-5DC9-A8ED-2ED73A2E3931 |
| Success |
boolean |
请求是否成功, |
true |
| RecoverableError |
boolean |
请求失败能否重试, |
true |
| Data |
object |
返回数据列表。 |
|
| DomainName |
string |
域名名称。 |
example.com |
| StatusList |
array<object> |
任务状态信息 |
|
|
object |
任务状态信息 |
||
| DomainName |
string |
域名。 |
uptp.test.abchina.com.cn |
| Status |
string |
当前域名状态。 |
serverUpdateProhibited |
| StatusMsg |
string |
域名状态 Msg |
实名认证未通过,增加serverUpdateProhibited状态 |
| AccessDeniedDetail |
object |
访问被拒绝详细信息,只有 RAM 校验失败才会返回此字段。 |
|
| AuthAction |
string |
尝试执行的未授权操作。 |
CreateUser |
| AuthPrincipalDisplayName |
string |
授权主体显示名称。 |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
授权主体所有者 ID。 |
10469733312XXX |
| AuthPrincipalType |
string |
身份类型 |
SubUser |
| EncodedDiagnosticMessage |
string |
加密后的完整诊断信息。 |
AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ== |
| NoPermissionType |
string |
导致鉴权失败的原因。具体取值为: ExplicitDeny:显示拒绝 ImplicitDeny:隐式拒绝 |
ImplicitDeny |
| PolicyType |
string |
策略类型。 |
DlpSend |
示例
正常返回示例
JSON格式
{
"RequestId": "0629502C-XXXX-5DC9-A8ED-2ED73A2E3931",
"Success": true,
"RecoverableError": true,
"Data": {
"DomainName": "example.com",
"StatusList": [
{
"DomainName": "uptp.test.abchina.com.cn",
"Status": "serverUpdateProhibited",
"StatusMsg": "实名认证未通过,增加serverUpdateProhibited状态"
}
]
},
"AccessDeniedDetail": {
"AuthAction": "CreateUser",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Alirs.Operator.NotAuthorized | The operator does not belong to the cloud account. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。