ListPrincipals - 获取分享主体--资源管理-火山引擎

文档中心

导航

ListPrincipals - 获取分享主体

最近更新时间：2025.03.03 16:21:37首次发布时间：2025.03.03 16:21:37

获取分享主体

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListPrincipals	要执行的操作，取值：ListPrincipals。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
ResourceTrn	String	否	trn:vpc:cn-beijing:2000000000:subnet/subnet-rr1***0x57crloqp	资源Trn
ResourceType	String	否	vpc:subnet	资源类型
NextToken	String	否	aljsakljca***asdjekdjqe	当前页的Token
MaxResults	Long	否	10	最大数量
Principals	Array of String	否	2000000000,trn:organization::2000000000:organization/74399781619,trn:organization::2000000000:ou/74734524402	关联的Principals列表（Principal是指被共享方，用户、组织或者组织单元），如果是用户，传参用户id；如果是组织或组织单元，则传值组织或组织单元完整的五段式Trn
ResourceShareTrns	Array of String	否	trn:resource_share:cn-beijing:2000000000:resource_share/rs-03119c96,trn:resource_share:cn-beijing:2000000000:resource_share/rs-03ijdiqo128kj	资源共享trn列表

返回参数

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

参数	类型	示例值	描述
Principals	Array of Object	[ { "Id":"2000000000", "External":false, "ResourceShares": [ { "ShareTime": "2024-06-25T01:09:54+08:00", "ResourceShareTrn": "trn:vpc:cn-beijing:2000000000:subnet/subnet-3***5147px00tanx", "ResourceShareName": "sharexxx" } ] } ]	关联的Principals列表
NextToken	String	aljsakljca***djoiqji13d	下一页的Token

请求示例

GET /?Action=ListPrincipals&Version=2024-01-01&NextToken=jdkajdkd***akdskmd&MaxResults=10 HTTP/1.1
Host: x.y.z
X-Date: 20250224T135317Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250224/cn-beijing/resource_share/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250224214123859BC212C3674E068D01",
    "Action": "ListPrincipals",
    "Version": "2024-01-01",
    "Service": "resource_share",
    "Region": "cn-beijing"
  },
  "Result": {
    "Principals": [
      {
        "Id": "2000000000",
        "External": true,
        "ResourceShares": [
          {
            "ShareTime": "2024-05-14T20:45:15+08:00",
            "ResourceShareTrn": "trn:resource_share:cn-beijing:2100000001:resource_share/rs-05***6f465d",
            "ResourceShareName": "share-demo"
          }
        ]
      }
    ],
    "NextToken": "adelsaks***daldkwqdj"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	Parameter [%s] is invalid, error: %v	无效的参数，具体无效的参数在会在Error Message中给出
400	MissingParameter	Required parameter[%v] is not found	参数缺失，具体缺失的参数在会在Error Message中给出
500	InternalError	Something went wrong in internal service, please try again later	服务内部系统错误，往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认