SubmitAtiAgentRegisterInfo - 注册Agent - 步骤三:提交注册

更新时间:
复制 MD 格式

提交Agent注册信息

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。

eyJhbGciOiJIUzI1NiIsInR5cC.....

AgentRegisterInfoId

string

Agent 注册 ID。由阿里云 ATS 平台自动生成,在阿里云 ATS 平台具有全局唯一性。在 Agent 注册过程中自动生成,通过 API 注册、查询流程中,该 ID 必须全程携带,需调用接口 ListAtiAgentRegisterInfos 查询目标 Agent 后从应答内容获取 AgentRegisterInfoId

2074753647748672512

IdentityCsr

string

身份证书 CSR 请求。可以参考 ATS 控制台 注册 agent 第三步 提供的身份证书 CSR 请求指导命令生成

-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFAD... (中间是一长串经过 Base64 编码的数据) ... -----END CERTIFICATE-----

ServerCertPem

string

服务器证书,即注册 Agent 使用域名(主机地址)对应的证书。

-----BEGIN CERTIFICATE----- KsdeFSAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFAD... (中间是一长串经过 Base64 编码的数据) ... -----END CERTIFICATE-----

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

唯一请求识别码。

6856BCF6-11D6-4D7E-AC53-FD579933522B

Status

boolean

Agent 状态,包含:

  • 草稿:Agent 注册表单正在填写中,尚未正式提交注册。草稿状态下仅支持修改和详情操作,不支持其他操作

  • Private CA 待签发:Agent 注册已正式提交。阿里云已完成 ACME DNS-01 预检,并将注册信息及生成的 DNS 记录同步提交给 CNNIC。当前正在等待 CNNIC 审核通过后签发 Private CA 并完成 TL 封存。

  • DNS 待验证:CNNIC 已审核通过并签发 Private CA 证书 + 完成 TL 封存,但用户的 DNS 记录尚未验证通过。等待用户在域名解析中添加对应 DNS 记录并完成验证。

  • 活跃:全部流程完成:Private CA 证书已签发、TL 已封存、DNS 记录已验证。Agent 已激活,可被全网发现和信任验证。

  • 已过期:Agent 身份证书已过期,用户未在有效期内完成证书更新。

  • 已吊销:Agent 证书已吊销,DNS 记录已清理,Agent 不可被发现和信任验证。不可恢复为活跃状态。

Private CA 待签发

AccessDeniedDetail

object

访问被拒绝详细信息,只有 RAM 校验失败才会返回此字段。

AuthAction

string

尝试执行的未授权操作。

AddRspDomainServerHoldStatusForGateway

AuthPrincipalDisplayName

string

授权主体显示名称。

2015555733387XXXX

AuthPrincipalOwnerId

string

授权主体所有者 ID。

10469733312XXX

AuthPrincipalType

string

身份类型

SubUser

EncodedDiagnosticMessage

string

加密后的完整诊断信息。

AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==

NoPermissionType

string

导致鉴权失败的原因。具体取值为:

  • ExplicitDeny:显示拒绝

  • ImplicitDeny:隐式拒绝

ImplicitDeny

PolicyType

string

策略类型。

DlpSend

示例

正常返回示例

JSON格式

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Status": true,
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGateway",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

错误码

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

变更历史

更多信息,参考变更详情