云加密机获取安全组详情-其他接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cloudhsm.tencentcloudapi.com 。

获取安全组详情

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUsgRule。
Version	是	String	公共参数，本接口取值：2019-11-12。
Region	是	String	公共参数，详见产品支持的地域列表。
SgIds.N	是	Array of String	根据安全组Id获取安全组详情示例值：["xxxxxxxxxxxx\n"]

3. 输出参数

参数名称	类型	描述
SgRules	Array of UsgRuleDetail	安全组详情注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	安全组详情数量注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取安全组详情

输入示例

https://cloudhsm.tencentcloudapi.com/?Action=DescribeUsgRule
&SgIds.0=xxxxxxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "SgRules": [
            {
                "Version": 0,
                "SgId": "UsgIdxxxxx",
                "SgName": "UsgNamexxxxxx",
                "SgRemark": "xxxxxxxx",
                "CreateTime": "2006-01-02 15:04:05",
                "InBound": [
                    {
                        "Ip": "xxxxx",
                        "Id": "xxxxxxx",
                        "AddressModule": "xxxxxx",
                        "Proto": "tcp",
                        "Port": "80",
                        "ServiceModule": "xxxxxx",
                        "Desc": "xxxxxx",
                        "Action": "DROP"
                    }
                ],
                "OutBound": [
                    {
                        "Ip": "xxxxx",
                        "Id": "xxxxxxx",
                        "AddressModule": "xxxxxx",
                        "Proto": "tcp",
                        "Port": "80",
                        "ServiceModule": "xxxxxx",
                        "Desc": "xxxxxx",
                        "Action": "DROP"
                    }
                ]
            }
        ],
        "RequestId": "6010cd3d-a85a-4e00-b37b-22606d017420"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。