通过此接口查询指定资源类型的元数据详情

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

请求示例

{
  "query": {
    "TypeName": "Volcengine::IAM::User"
  },
  "body": {}
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202509221244390553D266CB736238E724",
    "Region": "cn-beijing"
  },
  "Result": {
    "Trn": "trn:cloudcontrol:cn-beijing:2000000191:resource_type/Volcengine::IAM::User/000003",
    "TypeName": "Volcengine::IAM::User",
    "Description": "IAM子用户是访问控制的一种身份，由账号或是拥有权限的用户创建。用户被授予权限后，可登录控制台或使用访问密钥调用API访问云资源。",
    "CreateTime": "2025-09-17 12:43:42",
    "Visibility": "PUBLIC",
    "Schema": {
      "typeName": "Volcengine::IAM::User",
      "description": "IAM子用户是访问控制的一种身份，由账号或是拥有权限的用户创建。用户被授予权限后，可登录控制台或使用访问密钥调用API访问云资源。",
      "tagging": {
        "taggable": true,
        "tagOnCreate": true,
        "tagUpdatable": true
      },
      "definitions": {
        "AccessKey": {
          "description": "子用户的访问密钥。",
          "properties": {
            "AccessKeyId": {
              "description": "访问密钥ID。",
              "type": "string"
            },
            "CreateDate": {
              "description": "访问密钥创建时间。",
              "type": "string"
            },
            "Status": {
              "description": "访问密钥状态。Active代表启用，Inactive代表禁用。",
              "type": "string"
            },
            "UpdateDate": {
              "description": "访问密钥更新时间。",
              "type": "string"
            },
            "UserName": {
              "description": "访问密钥Secret。",
              "type": "string"
            }
          },
          "type": "object"
        },
        "...":"...",
        "Tag": {
          "description": "资源标签。",
          "required": [
            "Key",
            "Value"
          ],
          "properties": {
            "Key": {
              "description": "标签键。",
              "type": "string"
            },
            "Value": {
              "description": "标签值。",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "properties": {
        "AccessKey": {
          "description": "子用户的访问密钥。",
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/definitions/AccessKey"
          },
          "insertionOrder": false
        },
        "AccountId": {
          "description": "子用户归属的主账号。",
          "type": "number"
        },
        "CreateDate": {
          "description": "子用户对应的创建时间。",
          "type": "string",
          "semantic": "createdTime"
        },
        "Description": {
          "description": "子用户对应的描述信息，长度不超过255。",
          "type": "string",
          "semantic": "description"
        },
        "DisplayName": {
          "description": "子用户对应的展示名称，用户显示名。长度1~128，仅支持中文、英文、数字、空格和.-_@符号。",
          "maxLength": 128,
          "type": "string"
        },
        "Email": {
          "description": "子用户对应的电子邮件地址。",
          "type": "string"
        },
        "EmailIsVerify": {
          "description": "子用户电子邮件地址是否已验证。true代表已验证，false代表未验证。",
          "type": "boolean"
        },
        "Groups": {
          "description": "子用户归属的用户组。",
          "uniqueItems": true,
          "type": "array",
          "items": {
            "type": "string"
          },
          "insertionOrder": false
        },
        "LoginProfile": {
          "description": "子用户的登录配置。",
          "$ref": "#/definitions/LoginProfile"
        },
        "MobilePhone": {
          "description": "子用户对应的手机号。",
          "maxLength": 20,
          "type": "string"
        },
        "MobilePhoneIsVerify": {
          "description": "子用户手机号是否已验证。true代表已验证，false代表未验证。",
          "type": "boolean"
        },
        "Policies": {
          "description": "子用户对应的权限策略。",
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Policy"
          },
          "insertionOrder": false
        },
        "SecurityConfig": {
          "description": "子用户的操作保护配置。",
          "$ref": "#/definitions/SecurityConfig"
        },
        "Tags": {
          "description": "子用户对应的资源标签。",
          "uniqueItems": true,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tag"
          },
          "insertionOrder": false,
          "semantic": "tags"
        },
        "Trn": {
          "description": "子用户对应的Trn表达式。",
          "type": "string"
        },
        "UpdateDate": {
          "description": "子用户对应的更新时间。",
          "type": "string",
          "semantic": "updatedTime"
        },
        "UserId": {
          "description": "子用户的ID。",
          "format": "int64",
          "type": "integer",
          "semantic": "resourceId"
        },
        "UserName": {
          "description": "子用户名称，用户名。长度1~64，支持英文、数字、下划线、和.-@符号。",
          "maxLength": 64,
          "minLength": 1,
          "type": "string",
          "semantic": "resourceName"
        }
      },
      "required": [
        "UserName"
      ],
      "readOnlyProperties": [
        "/properties/AccountId",
        "/properties/Trn",
        "/properties/UserId",
        "/properties/CreateDate",
        "/properties/UpdateDate",
        "/properties/SecurityConfig/SafeAuthClose",
        "/properties/SecurityConfig/SafeAuthExemptDuration",
        "/properties/AccessKey"
      ],
      "writeOnlyProperties": [
        "/properties/LoginProfile/Password"
      ],
      "createOnlyProperties": [
        "/properties/UserName"
      ],
      "primaryIdentifier": [
        "/properties/UserName"
      ],
      "additionalProperties": false,
      "handlers": {
        "create": {
          "permissions": [
            "iam:CreateUser",
            "iam:AddUserToGroup",
            "iam:RemoveUserFromGroup",
            "iam:AttachUserPolicy",
            "iam:DetachUserPolicy",
            "iam:ListGroupsForUser",
            "iam:ListAttachedUserPolicies",
            "iam:GetSecurityConfig",
            "iam:SetSecurityConfig",
            "iam:GetUser",
            "iam:GetLoginProfile",
            "iam:UpdateLoginProfile",
            "iam:ListAccessKeys"
          ]
        },
        "delete": {
          "permissions": [
            "iam:DeleteUser",
            "iam:GetUser",
            "iam:ListAccessKeys"
          ]
        },
        "list": {
          "permissions": [
            "iam:ListUsers"
          ]
        },
        "read": {
          "permissions": [
            "iam:ListGroupsForUser",
            "iam:ListAttachedUserPolicies",
            "iam:GetUser",
            "iam:GetLoginProfile",
            "iam:GetSecurityConfig",
            "iam:ListAccessKeys"
          ]
        },
        "update": {
          "permissions": [
            "iam:GetUser",
            "iam:UpdateUser",
            "iam:UntagResources",
            "iam:TagResources",
            "iam:ListAttachedUserPolicies",
            "iam:AttachUserPolicy",
            "iam:DetachUserPolicy",
            "iam:ListGroupsForUser",
            "iam:AddUserToGroup",
            "iam:RemoveUserFromGroup",
            "iam:GetLoginProfile",
            "iam:UpdateLoginProfile",
            "iam:GetSecurityConfig",
            "iam:SetSecurityConfig",
            "iam:ListAccessKeys"
          ]
        }
      }
    },
    "PublisherName": "Volcano Engine",
    "LatestPublicVersion": "v0.1.0",
    "PublicVersion": "v0.0.0",
    "TestsStatus": "PASSED",
    "TestsStatusDescription": "TEST: Warning, No Test Suite\n",
    "IsDefaultVersion": true,
    "DefaultVersionId": "000003",
    "UpdateTime": "2025-09-17 12:43:42"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。